Package org.opencms.security

Interface I_CmsPrincipal

All Superinterfaces:
Principal, Serializable
All Known Implementing Classes:
CmsGroup, CmsHistoryPrincipal, CmsPrincipal, CmsRoleAsPrincipal, CmsUser
public interface I_CmsPrincipal extends Principal, Serializable
Representation of an identity in the cms (currently user or group), used to define permissions on a resource.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FLAG_CORE_LIMIT
    Upper limit for core flags, any principal object with flags greater than this value will be filtered out.
    static final int
    FLAG_DISABLED
    This flag is set for disabled principals in the database.
    static final int
    FLAG_ENABLED
    This flag is set for enabled principals in the database.
    static final int
    FLAG_GROUP_ROLE
    Flag to indicate a role group.
    static final int
    FLAG_GROUP_VIRTUAL
    Flag to indicate a virtual group role, after this bit we need to encode a number between 0 and CmsRole.getSystemRoles().size()-1 so we will need up to 4 more bits.
    static final int
    FLAG_USER_MANAGED
    Flag to indicate a user is not able to manage himself.
    static final int
    FLAG_USER_WEBUSER
    Flag to indicate a user is a webuser.
    static final String
    PRINCIPAL_GROUP
    Identifier for group principals.
    static final String
    PRINCIPAL_USER
    Identifier for user principals.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkName(String name)
    Checks if the provided principal name is valid and can be used as an argument value for setName(String).
    boolean
    equals(Object obj)
    Compares the given object with this principal.
    String
    getDescription()
    Returns the description of this principal.
    String
    getDescription(Locale locale)
    Returns the description of this principal.
    int
    getFlags()
    Returns the flags of this principal.
    CmsUUID
    getId()
    Returns the unique id of this principal.
    String
    getName()
    Returns the unique name of this principal.
    String
    getOuFqn()
    Returns the fully qualified name of the associated organizational unit.
    String
    getPrefixedName()
    Returns this principals unique name prefixed with it's type.
    String
    getSimpleName()
    Returns the simple name of this organizational unit.
    int
    hashCode()
    Returns the hash code of this object.
    boolean
    isEnabled()
    Returns true if this principal is enabled.
    boolean
    isGroup()
    Returns true if this principal is of type CmsGroup.
    boolean
    isUser()
    Returns true if this principal is of type CmsUser.
    void
    setDescription(String description)
    Sets the description of this principal.
    void
    setEnabled(boolean enabled)
    Enables (or disables) this principal, depending on the given status.
    void
    setFlags(int value)
    Sets this principals flags to the specified value.
    void
    setName(String name)
    Sets the unique name of this principal.

    Methods inherited from interface java.security.Principal

    implies, toString

  • Field Details

  • Method Details

    • checkName

      void checkName(String name)
      Checks if the provided principal name is valid and can be used as an argument value for setName(String).

      Parameters:
      name - the principal name to check

    • equals

      boolean equals(Object obj)
      Compares the given object with this principal.

      Specified by:
      equals in interface Principal
      Overrides:
      equals in class Object
      Parameters:
      obj - object to compare
      Returns:
      true if the object is equal

    • getDescription

      String getDescription()
      Returns the description of this principal.

      Returns:
      the description of this principal

    • getDescription

      String getDescription(Locale locale)
      Returns the description of this principal.

      Parameters:
      locale - locale of the description
      Returns:
      the description of this principal

    • getFlags

      int getFlags()
      Returns the flags of this principal.

      The principal flags are used to store special information about the principals state encoded bitwise. Usually the flags int value should not be directly accessed. Utility methods like isEnabled() provide a much easier way to access the information contained in the flags.

      Returns:
      the flags of this principal

    • getId

      CmsUUID getId()
      Returns the unique id of this principal.

      Returns:
      the unique id of this principal

    • getName

      String getName()
      Returns the unique name of this principal.

      Specified by:
      getName in interface Principal
      Returns:
      the unique name of this principal

    • getOuFqn

      String getOuFqn()
      Returns the fully qualified name of the associated organizational unit.

      Returns:
      the fully qualified name of the associated organizational unit

    • getPrefixedName

      String getPrefixedName()
      Returns this principals unique name prefixed with it's type.

      The type prefix can either be PRINCIPAL_GROUP. (for groups) or PRINCIPAL_USER. (for users).

      Returns:
      this principals unique name prefixed with this principals type

    • getSimpleName

      String getSimpleName()
      Returns the simple name of this organizational unit.
      Returns:
      the simple name of this organizational unit.

    • hashCode

      int hashCode()
      Returns the hash code of this object.

      Specified by:
      hashCode in interface Principal
      Overrides:
      hashCode in class Object
      Returns:
      the hash code

    • isEnabled

      boolean isEnabled()
      Returns true if this principal is enabled.

      A principal may be disabled in order to disable it, for example to prevent logins of a user. If a principal is just disabled but not deleted, the credentials of the principal in the VFS are still valid.

      Returns:
      true if this principal is enabled

    • isGroup

      boolean isGroup()
      Returns true if this principal is of type CmsGroup.

      Returns:
      true if this principal is of type CmsGroup

    • isUser

      boolean isUser()
      Returns true if this principal is of type CmsUser.

      Returns:
      true if this principal is of type CmsUser

    • setDescription

      void setDescription(String description)
      Sets the description of this principal.

      Parameters:
      description - the principal description to set

    • setEnabled

      void setEnabled(boolean enabled)
      Enables (or disables) this principal, depending on the given status.

      Parameters:
      enabled - the principal status to set

    • setFlags

      void setFlags(int value)
      Sets this principals flags to the specified value.

      The principal flags are used to store special information about the principals state encoded bitwise. Usually the flags integer value should not be directly accessed. Utility methods like setEnabled(boolean) provide a much easier way to manipulate the information contained in the flags.

      Parameters:
      value - the value to set this principals flags to

    • setName

      void setName(String name)
      Sets the unique name of this principal.

      Parameters:
      name - the unique name of this principal to set