org.apache.jetspeed.layout.impl
Class GetPortletsAction

java.lang.Object
  org.apache.jetspeed.layout.impl.BasePortletAction
      org.apache.jetspeed.layout.impl.GetPortletsAction

All Implemented Interfaces:

Comparator, org.apache.jetspeed.ajax.AjaxAction, org.apache.jetspeed.ajax.AjaxBuilder, Constants

public class GetPortletsAction
extends BasePortletAction
implements org.apache.jetspeed.ajax.AjaxAction, org.apache.jetspeed.ajax.AjaxBuilder, Constants, Comparator

Get Portlets retrieves the portlet list available to the current subject AJAX Parameters: filter = (optional)filter to lookup portlets using fulltext search

Version:

$Id: $

Author:

David Gurney, David Sean Taylor

Field Summary

protected static org.apache.commons.logging.Log	log
static String	PORTLET_ICON
private org.apache.jetspeed.components.portletregistry.PortletRegistry	registry
private org.apache.jetspeed.search.SearchEngine	searchEngine
private org.apache.jetspeed.security.SecurityAccessController	securityAccessController

Fields inherited from class org.apache.jetspeed.layout.impl.BasePortletAction

errorTemplate, pageManager, securityBehavior, template

Fields inherited from interface org.apache.jetspeed.layout.impl.Constants

ABS, ACTION, CARTESIAN, COL, CUSTOM_MENUS, DEFAULT_LAYOUT, DESKTOP_EXTENDED, DESKTOP_PAGE_DECORATIONS, DESKTOP_PORTLET_DECORATIONS, DESTINATION, DOWN, FILTER, FOLDER, FOLDERS, FORMAT, FRAGMENTID, FRAGMENTS, GUESTUSERS, HEIGHT, INCLUDE_MENU_DEFS, IPADDRESS, LAYOUT, LAYOUTID, LAYOUTS, LEFT, LINK, LINKS, MENU, MENU_CONTEXT, MENU_DEFINITIONS, MENU_LOCALE, MENU_NAME, METADATA, NEWCOL, NEWROW, OFFLINE, OLD_DESKTOP_EXTENDED, OLD_HEIGHT, OLD_PORTLET_MODE, OLD_WIDTH, OLD_WINDOW_STATE, OLD_X, OLD_Y, OLD_Z, OLDCOL, OLDROW, ONLINE, PAGE, PAGE_DECORATIONS, PAGE_QUALIFIED_CREATE_ON_EDIT, PAGES, PORTLET_DECORATIONS, PORTLET_MODE, PORTLETENTITY, PORTLETID, PORTLETS, PROFILED_PATH, REASON, RESOURCE_NAME, RIGHT, ROLES, ROW, SECURITY_DEFS, SECURITY_OWNER, SECURITY_REFS, SESSIONS, SHORT_TITLE, SIZES, SOURCE, STANDARD_MENUS, STATUS, TITLE, TYPE, UP, USER_IS_ANONYMOUS, USERINFO, USERNAME, USERS, WIDTH, WINDOW_STATE, X, Y, Z

Constructor Summary

GetPortletsAction(String template, String errorTemplate)

GetPortletsAction(String template, String errorTemplate, org.apache.jetspeed.page.PageManager pageManager, org.apache.jetspeed.components.portletregistry.PortletRegistry registry, org.apache.jetspeed.search.SearchEngine searchEngine, org.apache.jetspeed.security.SecurityAccessController securityAccessController, org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior)

Method Summary

int	compare(Object obj1, Object obj2)
protected org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite	getPortletFromParsedObject(org.apache.jetspeed.search.ParsedObject po)
List	retrievePortlets(org.apache.jetspeed.request.RequestContext requestContext, String filter)
boolean	run(org.apache.jetspeed.request.RequestContext requestContext, Map resultMap)

Methods inherited from class org.apache.jetspeed.layout.impl.BasePortletAction

buildContext, buildErrorContext, checkAccess, createNewPageOnEdit, getActionParameter, getErrorTemplate, getFragmentIdFromLocation, getFragmentIdFromLocation, getNonNullActionParameter, getParentFragmentById, getTemplate, isCreateNewPageOnEditEnabled, isPageQualifiedForCreateNewPageOnEdit, runBatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jetspeed.ajax.AjaxAction

checkAccess, runBatch

Methods inherited from interface org.apache.jetspeed.ajax.AjaxBuilder

buildContext, buildErrorContext, getErrorTemplate, getTemplate

Methods inherited from interface java.util.Comparator

equals

Field Detail

log

protected static final org.apache.commons.logging.Log log

registry

private org.apache.jetspeed.components.portletregistry.PortletRegistry registry

searchEngine

private org.apache.jetspeed.search.SearchEngine searchEngine

securityAccessController

private org.apache.jetspeed.security.SecurityAccessController securityAccessController

PORTLET_ICON

public static final String PORTLET_ICON

See Also:

Constant Field Values

Constructor Detail

GetPortletsAction

public GetPortletsAction(String template,
                         String errorTemplate)

GetPortletsAction

public GetPortletsAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.page.PageManager pageManager,
                         org.apache.jetspeed.components.portletregistry.PortletRegistry registry,
                         org.apache.jetspeed.search.SearchEngine searchEngine,
                         org.apache.jetspeed.security.SecurityAccessController securityAccessController,
                         org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior)

Method Detail

run

public boolean run(org.apache.jetspeed.request.RequestContext requestContext,
                   Map resultMap)

Specified by:

run in interface org.apache.jetspeed.ajax.AjaxAction

retrievePortlets

public List retrievePortlets(org.apache.jetspeed.request.RequestContext requestContext,
                             String filter)

getPortletFromParsedObject

protected org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite getPortletFromParsedObject(org.apache.jetspeed.search.ParsedObject po)

compare

public int compare(Object obj1,
                   Object obj2)

Specified by:

compare in interface Comparator