Package org.opencms.workplace.tools.accounts

Class CmsAccountsToolHandler

java.lang.Object
org.opencms.workplace.tools.A_CmsToolHandler
org.opencms.workplace.tools.CmsDefaultToolHandler
org.opencms.workplace.tools.accounts.CmsAccountsToolHandler
All Implemented Interfaces:
org.opencms.workplace.tools.I_CmsToolHandler
public class CmsAccountsToolHandler extends org.opencms.workplace.tools.CmsDefaultToolHandler
Users management tool handler that hides the tool if the current user has not the needed privileges.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PATH_KILL_SESSIONS
    Path for the kill session tool.
    static final String
    PATH_UNLOCK
    Path for the unlock tool.
    protected static final String
    VISIBILITY_ALL
    Visibility parameter value constant.

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

    ARG_PARAM_NAME, ARG_PATH_NAME, ARGS_PROPERTY_DEFINITION, ARGUMENT_SEPARATOR, DEFAULT_DISABLED_HELPTEXT, VALUE_SEPARATOR

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsAccountsToolHandler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisabledHelpText()
     
    protected String
    getPath(String jspName)
    Returns the path to the jsp.
    protected String
    getVisibilityFlag()
    Returns the visibility flag module parameter value.
    boolean
    isEnabled(org.opencms.workplace.CmsWorkplace wp)
     
    boolean
    isVisible(org.opencms.file.CmsObject cms)
     
    boolean
    isVisible(org.opencms.workplace.CmsWorkplace wp)
     

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

    isEnabled

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

    getConfirmationMessage, getGroup, getHelpText, getIconPath, getLink, getName, getParameters, getPath, getPosition, getShortName, getSmallIconPath, setConfirmationMessage, setDisabledHelpText, setGroup, setHelpText, setIconPath, setLink, setLink, setName, setParameters, setParameterString, setPath, setPosition, setShortName, setSmallIconPath, setup, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • getDisabledHelpText

      public String getDisabledHelpText()
      Specified by:
      getDisabledHelpText in interface org.opencms.workplace.tools.I_CmsToolHandler
      Overrides:
      getDisabledHelpText in class org.opencms.workplace.tools.A_CmsToolHandler
      See Also:
      • A_CmsToolHandler.getDisabledHelpText()

    • isEnabled

      public boolean isEnabled(org.opencms.workplace.CmsWorkplace wp)
      Specified by:
      isEnabled in interface org.opencms.workplace.tools.I_CmsToolHandler
      Overrides:
      isEnabled in class org.opencms.workplace.tools.A_CmsToolHandler
      See Also:
      • A_CmsToolHandler.isEnabled(org.opencms.workplace.CmsWorkplace)

    • isVisible

      public boolean isVisible(org.opencms.file.CmsObject cms)
      Specified by:
      isVisible in interface org.opencms.workplace.tools.I_CmsToolHandler
      Overrides:
      isVisible in class org.opencms.workplace.tools.CmsDefaultToolHandler
      See Also:
      • CmsDefaultToolHandler.isVisible(org.opencms.file.CmsObject)

    • isVisible

      public boolean isVisible(org.opencms.workplace.CmsWorkplace wp)
      Specified by:
      isVisible in interface org.opencms.workplace.tools.I_CmsToolHandler
      Overrides:
      isVisible in class org.opencms.workplace.tools.A_CmsToolHandler
      See Also:
      • A_CmsToolHandler.isVisible(org.opencms.workplace.CmsWorkplace)

    • getPath

      protected String getPath(String jspName)
      Returns the path to the jsp.

      Parameters:
      jspName - the jsp name
      Returns:
      the full path

    • getVisibilityFlag

      protected String getVisibilityFlag()
      Returns the visibility flag module parameter value.

      Returns:
      the visibility flag module parameter value