Package org.opencms.workplace.tools.accounts

Class A_CmsEditUserDialog

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsWidgetDialog
org.opencms.workplace.tools.accounts.A_CmsEditUserDialog
All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
Direct Known Subclasses:
CmsEditUserDialog
public abstract class A_CmsEditUserDialog extends CmsWidgetDialog
Dialog to edit new or existing user in the administration view.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    KEY_PREFIX
    localized messages Keys prefix.
    protected org.opencms.file.CmsUser
    m_user
    The user object that is edited on this dialog.
    static final String[]
    PAGES
    Defines which pages are valid for this dialog.
    static final String
    PARAM_USERID
    Request parameter name for the user id.

    Fields inherited from class org.opencms.workplace.CmsWidgetDialog

    ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

    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
    A_CmsEditUserDialog(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor with JSP action element.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    actionCommit()
    Commits the edited user to the db.
    protected String
    createDialogHtml(String dialog)
    Creates the dialog HTML for all defined widgets of the named dialog (page).
    protected abstract org.opencms.file.CmsUser
    createUser(String name, String pwd, String desc, Map<String,Object> info)
    Creates a new user.
    protected void
    defineWidgets()
    Creates the list of widgets for this dialog.
    String
    getAssignedOu()
    Returns the description of the parent ou.
    String
    getDescription()
    Returns the localized description of the user if the description is a key.
    String
    getGroup()
    Returns the group.
    String
    getLanguage()
    Returns the language.
    protected abstract String
    getListClass()
    Returns the dialog class name of the list to refresh.
    protected abstract String
    getListRootPath()
    Returns the root path for the list tool.
    String
    getName()
    Returns the simple name of the user object.
    protected String[]
    getPageArray()
    Returns the allowed pages for this dialog.
    String
    getParamOufqn()
    Returns the organizational unit fqn parameter value.
    String
    getParamUserid()
    Returns the user id parameter value.
    org.opencms.security.CmsPasswordInfo
    getPwdInfo()
    Returns the password information.
    String
    getRole()
    Returns the user role.
    String
    getSite()
    Returns the site.
    String
    getStartFolder()
    Returns the startFolder.
    String
    getStartProject()
    Returns the project.
    String
    getStartView()
    Returns the startView.
    protected void
    initMessages()
     
    protected void
    initUserObject()
    Initializes the user object to work with depending on the dialog state and request parameters.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    protected abstract boolean
    isEditable(org.opencms.file.CmsUser user)
    Tests if the given user is editable or not.
    boolean
    isEnabled()
    Return if user is enabled.
    protected boolean
    isNewUser()
    Checks if the new user dialog has to be displayed.
    protected boolean
    isPwdChangeAllowed(org.opencms.file.CmsUser user)
    Indicates if the pwd can be edited or not.
    boolean
    isSelfManagement()
    Returns the selfManagement.
    void
    setAssignedOu(String assignedOu)
    This method is only needed for displaying reasons.
    void
    setDescription(String description)
    Sets the description for the user.
    void
    setEnabled(boolean enabled)
    Sets if user is enabled.
    void
    setGroup(String group)
    Sets the group.
    void
    setLanguage(String language)
    Sets the language.
    void
    setName(String name)
    Sets the name of the user object.
    void
    setParamOufqn(String ouFqn)
    Sets the organizational unit fqn parameter value.
    void
    setParamUserid(String userId)
    Sets the user id parameter value.
    void
    setRole(String role)
    Sets the user role.
    void
    setSelfManagement(boolean selfManagement)
    Sets the selfManagement.
    void
    setSite(String site)
    Sets the site.
    void
    setStartFolder(String startFolder)
    Sets the startFolder.
    void
    setStartProject(String startProject)
    Sets the start project.
    void
    setStartView(String startView)
    Sets the startView.
    protected void
    validateParamaters()
    Should be overridden for parameter validation.
    protected abstract void
    writeUser(org.opencms.file.CmsUser user)
    Writes a user to the db.

    Methods inherited from class org.opencms.workplace.CmsWidgetDialog

    actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

    Methods inherited from class org.opencms.workplace.CmsDialog

    actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, 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, 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

    Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

    button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

  • Field Details

  • Constructor Details

    • A_CmsEditUserDialog

      public A_CmsEditUserDialog(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

      Parameters:
      jsp - an initialized JSP action element

  • Method Details

    • actionCommit

      public void actionCommit()
      Commits the edited user to the db.

      Specified by:
      actionCommit in class CmsWidgetDialog

    • getAssignedOu

      public String getAssignedOu()
      Returns the description of the parent ou.

      Returns:
      the description of the parent ou

    • getDescription

      public String getDescription()
      Returns the localized description of the user if the description is a key.

      Returns:
      the localized description of the user if the description is a key

    • getGroup

      public String getGroup()
      Returns the group.

      Returns:
      the group

    • getLanguage

      public String getLanguage()
      Returns the language.

      Returns:
      the language

    • getName

      public String getName()
      Returns the simple name of the user object.

      Returns:
      the simple name of the user object

    • getParamOufqn

      public String getParamOufqn()
      Returns the organizational unit fqn parameter value.

      Returns:
      the organizational unit fqn parameter value

    • getParamUserid

      public String getParamUserid()
      Returns the user id parameter value.

      Returns:
      the user id parameter value

    • getPwdInfo

      public org.opencms.security.CmsPasswordInfo getPwdInfo()
      Returns the password information.

      Returns:
      the password information

    • getRole

      public String getRole()
      Returns the user role.

      Returns:
      the user role

    • getSite

      public String getSite()
      Returns the site.

      Returns:
      the site

    • getStartFolder

      public String getStartFolder()
      Returns the startFolder.

      Returns:
      the startFolder

    • getStartProject

      public String getStartProject()
      Returns the project.

      Returns:
      the project

    • getStartView

      public String getStartView()
      Returns the startView.

      Returns:
      the startView

    • isEnabled

      public boolean isEnabled()
      Return if user is enabled.

      Returns:
      enabled status

    • isSelfManagement

      public boolean isSelfManagement()
      Returns the selfManagement.

      Returns:
      the selfManagement

    • setAssignedOu

      public void setAssignedOu(String assignedOu)
      This method is only needed for displaying reasons.

      Parameters:
      assignedOu - nothing to do with this parameter

    • setDescription

      public void setDescription(String description)
      Sets the description for the user.

      Parameters:
      description - the description for the user

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets if user is enabled.

      Parameters:
      enabled - is the user enabled

    • setGroup

      public void setGroup(String group)
      Sets the group.

      Parameters:
      group - the group to set

    • setLanguage

      public void setLanguage(String language)
      Sets the language.

      Parameters:
      language - the language to set

    • setName

      public void setName(String name)
      Sets the name of the user object.

      Parameters:
      name - the name of the user object

    • setParamOufqn

      public void setParamOufqn(String ouFqn)
      Sets the organizational unit fqn parameter value.

      Parameters:
      ouFqn - the organizational unit fqn parameter value

    • setParamUserid

      public void setParamUserid(String userId)
      Sets the user id parameter value.

      Parameters:
      userId - the user id parameter value

    • setRole

      public void setRole(String role)
      Sets the user role.

      Parameters:
      role - the user role

    • setSelfManagement

      public void setSelfManagement(boolean selfManagement)
      Sets the selfManagement.

      Parameters:
      selfManagement - the selfManagement to set

    • setSite

      public void setSite(String site)
      Sets the site.

      Parameters:
      site - the site to set

    • setStartFolder

      public void setStartFolder(String startFolder)
      Sets the startFolder.

      Parameters:
      startFolder - the startFolder to set

    • setStartProject

      public void setStartProject(String startProject)
      Sets the start project.

      Parameters:
      startProject - the start project to set

    • setStartView

      public void setStartView(String startView)
      Sets the startView.

      Parameters:
      startView - the startView to set

    • createDialogHtml

      protected String createDialogHtml(String dialog)
      Creates the dialog HTML for all defined widgets of the named dialog (page).

      This overwrites the method from the super class to create a layout variation for the widgets.

      Overrides:
      createDialogHtml in class CmsWidgetDialog
      Parameters:
      dialog - the dialog (page) to get the HTML for
      Returns:
      the dialog HTML for all defined widgets of the named dialog (page)

    • createUser

      protected abstract org.opencms.file.CmsUser createUser(String name, String pwd, String desc, Map<String,Object> info) throws org.opencms.main.CmsException
      Creates a new user.

      Parameters:
      name - the name
      pwd - the password
      desc - the description
      info - the additional information map
      Returns:
      the new user
      Throws:
      org.opencms.main.CmsException - if something goes wrong

    • defineWidgets

      protected void defineWidgets()
      Creates the list of widgets for this dialog.

      Specified by:
      defineWidgets in class CmsWidgetDialog

    • getListClass

      protected abstract String getListClass()
      Returns the dialog class name of the list to refresh.

      Returns:
      the list dialog class name

    • getListRootPath

      protected abstract String getListRootPath()
      Returns the root path for the list tool.

      Returns:
      the root path

    • getPageArray

      protected String[] getPageArray()
      Description copied from class: CmsWidgetDialog
      Returns the allowed pages for this dialog.

      Specified by:
      getPageArray in class CmsWidgetDialog
      Returns:
      the allowed pages for this dialog
      See Also:

    • initMessages

      protected void initMessages()
      Overrides:
      initMessages in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initMessages()

    • initUserObject

      protected void initUserObject()
      Initializes the user object to work with depending on the dialog state and request parameters.

      Two initializations of the user object on first dialog call are possible:

      • edit an existing user
      • create a new user

    • initWorkplaceRequestValues

      protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Overrides:
      initWorkplaceRequestValues in class CmsWidgetDialog
      See Also:
      • CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

    • isEditable

      protected abstract boolean isEditable(org.opencms.file.CmsUser user)
      Tests if the given user is editable or not.

      Not editable means that the user can only be activated and deactivated.

      Parameters:
      user - the user to test
      Returns:
      the editable flag

    • isNewUser

      protected boolean isNewUser()
      Checks if the new user dialog has to be displayed.

      Returns:
      true if the new user dialog has to be displayed

    • isPwdChangeAllowed

      protected boolean isPwdChangeAllowed(org.opencms.file.CmsUser user)
      Indicates if the pwd can be edited or not.

      Parameters:
      user - the edited cms user
      Returns:
      true if the pwd can be edited

    • validateParamaters

      protected void validateParamaters() throws Exception
      Description copied from class: CmsWidgetDialog
      Should be overridden for parameter validation.

      The exception is never seen by the user, so it can be just a new Exception().

      Overrides:
      validateParamaters in class CmsWidgetDialog
      Throws:
      Exception - if the parameters are not valid
      See Also:

    • writeUser

      protected abstract void writeUser(org.opencms.file.CmsUser user) throws org.opencms.main.CmsException
      Writes a user to the db.

      Parameters:
      user - the user to write
      Throws:
      org.opencms.main.CmsException - if something goes wrong