org.apache.jetspeed.layout.impl
Class GetUserListAction

java.lang.Object
  extended by org.apache.jetspeed.layout.impl.BaseUserAction
      extended by org.apache.jetspeed.layout.impl.GetUserListAction
All Implemented Interfaces:
AjaxAction, AjaxBuilder, Constants

public class GetUserListAction
extends BaseUserAction
implements AjaxAction, AjaxBuilder, Constants

Returns the list of currently logged in users and optionally also the offline users and number of guest user sessions AJAX action: action: getuserlist AJAX Parameters: guest: whether we should return also the guest sessions true | false (default) userinfo: whether we should include also userinfo true | false (default) offline: whether we should include offline users true | false (default) all: return every bits and piece there is true | false (default)

Version:
$Id: $
Author:
Mikko Wuokko

Field Summary
protected  org.apache.commons.logging.Log log
           
 
Fields inherited from class org.apache.jetspeed.layout.impl.BaseUserAction
errorTemplate, securityBehavior, template, userManager
 
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
GetUserListAction(java.lang.String template, java.lang.String errorTemplate, UserManager um, PortalStatistics pstats, PortalSessionsManager psm)
           
GetUserListAction(java.lang.String template, java.lang.String errorTemplate, UserManager um, PortalStatistics pstats, PortalSessionsManager psm, RolesSecurityBehavior securityBehavior)
           
GetUserListAction(java.lang.String template, java.lang.String errorTemplate, UserManager um, PortalStatistics pstats, PortalSessionsManager psm, RolesSecurityBehavior securityBehavior, java.lang.String protectionScope)
           
 
Method Summary
 boolean run(RequestContext requestContext, java.util.Map resultMap)
          The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.
 
Methods inherited from class org.apache.jetspeed.layout.impl.BaseUserAction
buildContext, buildErrorContext, checkAccess, createNewPageOnEdit, getActionParameter, getErrorTemplate, getFragmentIdFromLocation, getParentFragmentById, getTemplate, isTrue, runBatch, searchForParentFragmentById
 
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
 

Field Detail

log

protected org.apache.commons.logging.Log log
Constructor Detail

GetUserListAction

public GetUserListAction(java.lang.String template,
                         java.lang.String errorTemplate,
                         UserManager um,
                         PortalStatistics pstats,
                         PortalSessionsManager psm)

GetUserListAction

public GetUserListAction(java.lang.String template,
                         java.lang.String errorTemplate,
                         UserManager um,
                         PortalStatistics pstats,
                         PortalSessionsManager psm,
                         RolesSecurityBehavior securityBehavior)

GetUserListAction

public GetUserListAction(java.lang.String template,
                         java.lang.String errorTemplate,
                         UserManager um,
                         PortalStatistics pstats,
                         PortalSessionsManager psm,
                         RolesSecurityBehavior securityBehavior,
                         java.lang.String protectionScope)
Method Detail

run

public boolean run(RequestContext requestContext,
                   java.util.Map resultMap)
            throws AJAXException
Description copied from interface: AjaxAction
The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.

Specified by:
run in interface AjaxAction
Parameters:
requestContext - The Jetspeed Request Context
resultMap - map of action parameters passed to the builder context
Returns:
success is true, failure is false
Throws:
AJAXException


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.