Enum EnumRight

    • Enum Constant Detail

      • READ

        public static final EnumRight READ
        Read entries and attributes, or use an LDAP control or extended operation.
        See Also:
        Aci.ACI_READ
      • 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
      • SEARCH

        public static final EnumRight SEARCH
        Search the ACI targets.

        Combine with read to read the search results.

        See Also:
        Aci.ACI_SEARCH
      • 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 Detail

      • values

        public static EnumRight[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (EnumRight c : EnumRight.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static EnumRight valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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.