Package org.opencms.workplace.tools.accounts

Class CmsUsersList

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.list.A_CmsListDialog

org.opencms.workplace.tools.accounts.A_CmsUsersList

org.opencms.workplace.tools.accounts.CmsUsersList

public class CmsUsersList
extends A_CmsUsersList

Main system user account management view.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_ID	list id constant.

Fields inherited from class org.opencms.workplace.tools.accounts.A_CmsUsersList

LIST_ACTION_ACTIVATE, LIST_ACTION_DEACTIVATE, LIST_ACTION_DELETE, LIST_ACTION_EDIT, LIST_ACTION_GROUPS, LIST_ACTION_ROLE, LIST_ACTION_ROLES, LIST_COLUMN_ACTIVATE, LIST_COLUMN_DELETE, LIST_COLUMN_DISPLAY, LIST_COLUMN_EDIT, LIST_COLUMN_EMAIL, LIST_COLUMN_ENABLED, LIST_COLUMN_GROUPS, LIST_COLUMN_LASTLOGIN, LIST_COLUMN_LOGIN, LIST_COLUMN_NAME, LIST_COLUMN_ROLE, LIST_DEFACTION_EDIT, LIST_DETAIL_ADDRESS, LIST_DETAIL_GROUPS, LIST_DETAIL_ROLES, LIST_MACTION_ACTIVATE, LIST_MACTION_DEACTIVATE, LIST_MACTION_DELETE, PATH_BUTTONS

Fields inherited from class org.opencms.workplace.list.A_CmsListDialog

ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, KEY_META_DATA_CACHE, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, m_lazy, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

Constructor Summary

Constructors

Constructor	Description
CmsUsersList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
CmsUsersList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean lazy)	Public constructor with JSP variables.
CmsUsersList(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor.
CmsUsersList(org.opencms.jsp.CmsJspActionElement jsp, boolean lazy)	Public constructor.

Method Summary

Modifier and Type	Method	Description
protected String	getGroupIcon()	Returns the path the group icon.
protected List<CmsListItem>	getListItems()	Should generate a list with the list items to be displayed.
protected org.opencms.file.CmsUserSearchParameters	getSearchParams()	Gets the search parameters.
protected org.opencms.file.CmsUserSearchParameters.SortKey	getSortKey(String column)	Gets the sort key for a column.
protected List<org.opencms.file.CmsUser>	getUsers()	Returns a list of users.
protected org.opencms.file.CmsUser	readUser(String name)	Reads the user.
protected void	setColumns(CmsListMetadata metadata)	Should create the columns and add them to the given list metadata object.
protected void	setDeleteAction(CmsListColumnDefinition deleteCol)	Sets the needed delete action(s).
protected void	setEditAction(CmsListColumnDefinition editCol)	Sets the needed edit action(s).

Methods inherited from class org.opencms.workplace.tools.accounts.A_CmsUsersList

executeListMultiActions, executeListSingleActions, fillDetails, getParamOufqn, getRoleIcon, initMessages, makeListItemForUser, setIndependentActions, setMultiActions, setParamOufqn, setUserData, validateParamaters

Methods inherited from class org.opencms.workplace.list.A_CmsListDialog

actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getMetadataCache, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, writeDialog

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

Methods inherited from class java.lang.Object

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

Field Details

LIST_ID

public static final String LIST_ID

list id constant.

See Also:

• Constant Field Values

Constructor Details

CmsUsersList

public CmsUsersList(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsUsersList

public CmsUsersList(org.opencms.jsp.CmsJspActionElement jsp,
 boolean lazy)

Public constructor.

Parameters:

jsp - an initialized JSP action element

lazy - the lazy flag

CmsUsersList

public CmsUsersList(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

CmsUsersList

public CmsUsersList(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res,
 boolean lazy)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Details

getGroupIcon

protected String getGroupIcon()

Description copied from class: A_CmsUsersList

Returns the path the group icon.

Specified by:

getGroupIcon in class A_CmsUsersList

Returns:

the path to the group icon

See Also:

• A_CmsUsersList.getGroupIcon()

getListItems

protected List<CmsListItem> getListItems()
                                  throws org.opencms.main.CmsException

Description copied from class: A_CmsListDialog

Should generate a list with the list items to be displayed.

Overrides:

getListItems in class A_CmsUsersList

Returns:

a list of CmsListItems

Throws:

org.opencms.main.CmsException - if something goes wrong

See Also:

• A_CmsUsersList.getListItems()

getSearchParams

protected org.opencms.file.CmsUserSearchParameters getSearchParams()
                                                            throws org.opencms.main.CmsException

Gets the search parameters.

Returns:

the search parameters

Throws:

org.opencms.main.CmsException - if something goes wrong

getSortKey

protected org.opencms.file.CmsUserSearchParameters.SortKey getSortKey(String column)

Gets the sort key for a column.

Parameters:

column - a column

Returns:

the sort key

getUsers

protected List<org.opencms.file.CmsUser> getUsers()
                                           throws org.opencms.main.CmsException

Description copied from class: A_CmsUsersList

Returns a list of users.

Specified by:

getUsers in class A_CmsUsersList

Returns:

the list of all users

Throws:

org.opencms.main.CmsException - if something goes wrong

See Also:

• A_CmsUsersList.getUsers()

readUser

protected org.opencms.file.CmsUser readUser(String name)
                                     throws org.opencms.main.CmsException

Description copied from class: A_CmsUsersList

Reads the user.

Specified by:

readUser in class A_CmsUsersList

Parameters:

name - the name of the user to read

Returns:

the user

Throws:

org.opencms.main.CmsException - if something goes wrong

See Also:

• A_CmsUsersList.readUser(java.lang.String)

setColumns

protected void setColumns(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should create the columns and add them to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Overrides:

setColumns in class A_CmsUsersList

Parameters:

metadata - the list metadata

See Also:

• A_CmsUsersList.setColumns(org.opencms.workplace.list.CmsListMetadata)

setDeleteAction

protected void setDeleteAction(CmsListColumnDefinition deleteCol)

Description copied from class: A_CmsUsersList

Sets the needed delete action(s).

Specified by:

setDeleteAction in class A_CmsUsersList

Parameters:

deleteCol - the list column for deletion.

See Also:

• A_CmsUsersList.setDeleteAction(org.opencms.workplace.list.CmsListColumnDefinition)

setEditAction

protected void setEditAction(CmsListColumnDefinition editCol)

Description copied from class: A_CmsUsersList

Sets the needed edit action(s).

Specified by:

setEditAction in class A_CmsUsersList

Parameters:

editCol - the list column for edition.

See Also:

• A_CmsUsersList.setEditAction(org.opencms.workplace.list.CmsListColumnDefinition)