org.apache.jetspeed.layout.impl
Class GetUserListAction

java.lang.Object
  org.apache.jetspeed.layout.impl.BaseUserAction
      org.apache.jetspeed.layout.impl.GetUserListAction

All Implemented Interfaces:

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

public class GetUserListAction
extends BaseUserAction
implements org.apache.jetspeed.ajax.AjaxAction, org.apache.jetspeed.ajax.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
private String	PARAM_ALL
private String	PARAM_GUEST
private String	PARAM_OFFILE
private String	PARAM_USERINFO
private String	protectionScope
private org.apache.jetspeed.container.session.PortalSessionsManager	psm
private org.apache.jetspeed.statistics.PortalStatistics	pstats

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(String template, String errorTemplate, org.apache.jetspeed.security.UserManager um, org.apache.jetspeed.statistics.PortalStatistics pstats, org.apache.jetspeed.container.session.PortalSessionsManager psm)

GetUserListAction(String template, String errorTemplate, org.apache.jetspeed.security.UserManager um, org.apache.jetspeed.statistics.PortalStatistics pstats, org.apache.jetspeed.container.session.PortalSessionsManager psm, RolesSecurityBehavior securityBehavior)

GetUserListAction(String template, String errorTemplate, org.apache.jetspeed.security.UserManager um, org.apache.jetspeed.statistics.PortalStatistics pstats, org.apache.jetspeed.container.session.PortalSessionsManager psm, RolesSecurityBehavior securityBehavior, String protectionScope)

Method Summary

private Map	getUserInfo(String username) Helper method to get the user information of an user as Map.
boolean	run(org.apache.jetspeed.request.RequestContext requestContext, Map resultMap)

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

pstats

private org.apache.jetspeed.statistics.PortalStatistics pstats

psm

private org.apache.jetspeed.container.session.PortalSessionsManager psm

protectionScope

private String protectionScope

PARAM_GUEST

private final String PARAM_GUEST

See Also:

Constant Field Values

PARAM_USERINFO

private final String PARAM_USERINFO

See Also:

Constant Field Values

PARAM_OFFILE

private final String PARAM_OFFILE

See Also:

Constant Field Values

PARAM_ALL

private final String PARAM_ALL

See Also:

Constant Field Values

Constructor Detail

GetUserListAction

public GetUserListAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.security.UserManager um,
                         org.apache.jetspeed.statistics.PortalStatistics pstats,
                         org.apache.jetspeed.container.session.PortalSessionsManager psm)

GetUserListAction

public GetUserListAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.security.UserManager um,
                         org.apache.jetspeed.statistics.PortalStatistics pstats,
                         org.apache.jetspeed.container.session.PortalSessionsManager psm,
                         RolesSecurityBehavior securityBehavior)

GetUserListAction

public GetUserListAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.security.UserManager um,
                         org.apache.jetspeed.statistics.PortalStatistics pstats,
                         org.apache.jetspeed.container.session.PortalSessionsManager psm,
                         RolesSecurityBehavior securityBehavior,
                         String protectionScope)

Method Detail

run

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

Specified by:

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

Throws:

org.apache.jetspeed.ajax.AJAXException

getUserInfo

private Map getUserInfo(String username)
                 throws org.apache.jetspeed.security.SecurityException,
                        BackingStoreException

Helper method to get the user information of an user as Map.

Parameters:

username - Name of the user of request

Returns:

Map containing the user information keyed by the name of the attribute.

Throws:

org.apache.jetspeed.security.SecurityException

BackingStoreException