Package org.opends.server.authorization.dseecompat

Enum Class EnumRight

java.lang.Object
java.lang.Enum<EnumRight>
org.opends.server.authorization.dseecompat.EnumRight
All Implemented Interfaces:
Serializable, Comparable<EnumRight>, java.lang.constant.Constable
public enum EnumRight extends Enum<EnumRight>
This class provides an enumeration of the ACI rights.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADD
    Entry creation, as for an LDAP add operation.
    ALL
    All permissions, except export, import, proxy.
    COMPARE
    Attribute value comparison, as for an LDAP compare operation.
    DELETE
    Entry deletion, as for an LDAP delete operation.
    EXPORT
    Entry export during a modify DN operation.
    IMPORT
    Entry import during a modify DN operation.
    PROXY
    Access the ACI target using the rights of another user.
    READ
    Read entries and attributes, or use an LDAP control or extended operation.
    SEARCH
    Search the ACI targets.
    SELFWRITE
    Add or delete own DN from a group.
    WRITE
    Modify attributes on ACI target entries.

  • Method Summary

    Modifier and Type
    Method
    Description
    static EnumRight
    decode(String right)
    Creates an enumeration of the right name.
    static Set<EnumRight>
    getEnumRight(int rightsMask)
    Return the EnumRight corresponding to the provided rightsMask.
    static int
    getMask(EnumRight right)
    Returns bit mask associated with the specified right.
    String
    getRight()
    Returns the string representation of the right.
    static boolean
    hasRights(int rightsMask, int rights)
    Checks if the provided rights mask has the specified rights.
    boolean
    isRight(String right)
    Checks if the enumeration is equal to the right name.
    static EnumRight
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static EnumRight[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • READ

      public static final EnumRight READ
      Read entries and attributes, or use an LDAP control or extended operation.
      See Also:
      • Aci.ACI_READ

    • WRITE

      public static final EnumRight WRITE
      Modify attributes on ACI target entries.
      See Also:
      • Aci.ACI_WRITE

    • ADD

      public static final EnumRight ADD
      Entry creation, as for an LDAP add operation.
      See Also:
      • Aci.ACI_ADD

    • DELETE

      public static final EnumRight DELETE
      Entry deletion, as for an LDAP delete operation.
      See Also:
      • Aci.ACI_DELETE

    • COMPARE

      public static final EnumRight COMPARE
      Attribute value comparison, as for an LDAP compare operation.
      See Also:
      • Aci.ACI_COMPARE

    • SELFWRITE

      public static final EnumRight SELFWRITE
      Add or delete own DN from a group.
      See Also:
      • Aci.ACI_SELF

    • PROXY

      public static final EnumRight PROXY
      Access the ACI target using the rights of another user.
      See Also:
      • Aci.ACI_PROXY

    • IMPORT

      public static final EnumRight IMPORT
      Entry import during a modify DN operation.

      Despite the name, this action is unrelated to LDIF import operations.

      See Also:
      • Aci.ACI_IMPORT

    • EXPORT

      public static final EnumRight EXPORT
      Entry export during a modify DN operation.

      Despite the name, this action is unrelated to LDIF export operations.

      See Also:
      • Aci.ACI_EXPORT

    • ALL

      public static final EnumRight ALL
      All permissions, except export, import, proxy.
      See Also:
      • Aci.ACI_ALL

  • Method Details

    • values

      public static EnumRight[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static EnumRight valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getRight

      public String getRight()
      Returns the string representation of the right.
      Returns:
      the string representation of the right

    • isRight

      public boolean isRight(String right)
      Checks if the enumeration is equal to the right name.
      Parameters:
      right - The name of the right to check.
      Returns:
      True if the right is equal to the enumeration's.

    • decode

      public static EnumRight decode(String right)
      Creates an enumeration of the right name.
      Parameters:
      right - The name of the right.
      Returns:
      An enumeration of the right or null if the name is invalid.

    • getMask

      public static int getMask(EnumRight right)
      Returns bit mask associated with the specified right.
      Parameters:
      right - The right enumeration to return the mask for.
      Returns:
      The bit mask associated with the right.

    • getEnumRight

      public static Set<EnumRight> getEnumRight(int rightsMask)
      Return the EnumRight corresponding to the provided rightsMask.
      Parameters:
      rightsMask - the rights mask for which to return the corresponding EnumRight
      Returns:
      EnumRight corresponding to the provided rightsMask.

    • hasRights

      public static boolean hasRights(int rightsMask, int rights)
      Checks if the provided rights mask has the specified rights.
      Parameters:
      rightsMask - The rights mask to look into.
      rights - The rights to check for.
      Returns:
      true if the rights mask has the specified rights, false otherwise.