Package com.unboundid.ldap.sdk.unboundidds.controls

Enum EntryRight

java.lang.Object
java.lang.Enum<EntryRight>
com.unboundid.ldap.sdk.unboundidds.controls.EntryRight
All Implemented Interfaces:
Serializable, Comparable<EntryRight>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum EntryRight extends Enum<EntryRight>
This enum contains the set of possible entry-level rights that may be described in an entry retrieved with the get effective rights control.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

  • 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
    The entry right that indicates that the user has sufficient permission to add a subordinate of the target entry.
    DELETE
    The entry right that indicates that the user has sufficient permission to delete the target entry.
    PROXY
    The entry right that indicates that the user has sufficient permission to perform operations involving proxied authorization with the entry.
    READ
    The entry right that indicates that the user has sufficient permission to perform read operations with the entry.
    WRITE
    The entry right that indicates that the user has sufficient permission to perform write operations with the entry.

  • Method Summary

    Modifier and Type
    Method
    Description
    static EntryRight
    forName(String name)
    Retrieves the entry right for the specified name.
    String
    getName()
    Retrieves the name of this entry right.
    String
    toString()
    Retrieves a string representation of this entry right.
    static EntryRight
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static EntryRight[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ADD

      public static final EntryRight ADD
      The entry right that indicates that the user has sufficient permission to add a subordinate of the target entry.

    • DELETE

      public static final EntryRight DELETE
      The entry right that indicates that the user has sufficient permission to delete the target entry.

    • READ

      public static final EntryRight READ
      The entry right that indicates that the user has sufficient permission to perform read operations with the entry.

    • WRITE

      public static final EntryRight WRITE
      The entry right that indicates that the user has sufficient permission to perform write operations with the entry.

    • PROXY

      public static final EntryRight PROXY
      The entry right that indicates that the user has sufficient permission to perform operations involving proxied authorization with the entry.

  • Method Details

    • values

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

    • valueOf

      public static EntryRight 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

    • getName

      @NotNull public String getName()
      Retrieves the name of this entry right.
      Returns:
      The name of this entry right.

    • forName

      @Nullable public static EntryRight forName(@NotNull String name)
      Retrieves the entry right for the specified name.
      Parameters:
      name - The name for which to retrieve the corresponding entry right.
      Returns:
      The requested entry right, or null if there is no such right.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this entry right.
      Overrides:
      toString in class Enum<EntryRight>
      Returns:
      A string representation of this entry right.