Package org.forgerock.opendj.ldap

Enum Class DereferenceAliasesPolicy

java.lang.Object
java.lang.Enum<DereferenceAliasesPolicy>
org.forgerock.opendj.ldap.DereferenceAliasesPolicy
All Implemented Interfaces:
Serializable, Comparable<DereferenceAliasesPolicy>, java.lang.constant.Constable
public enum DereferenceAliasesPolicy extends Enum<DereferenceAliasesPolicy>
A Search operation alias dereferencing policy as defined in RFC 4511 section 4.5.1.3 is used to indicate whether alias entries (as defined in RFC 4512) are to be dereferenced during stages of a Search operation. The act of dereferencing an alias includes recursively dereferencing aliases that refer to aliases.
See Also:

  • Enum Constant Details

    • NEVER

      public static final DereferenceAliasesPolicy NEVER
      Do not dereference aliases in searching or in locating the base object of a Search operation.

    • IN_SEARCHING

      public static final DereferenceAliasesPolicy IN_SEARCHING
      While searching subordinates of the base object, dereference any alias within the scope of the Search operation. Dereferenced objects become the vertices of further search scopes where the Search operation is also applied. If the search scope is WHOLE_SUBTREE, the Search continues in the subtree(s) of any dereferenced object. If the search scope is SINGLE_LEVEL, the search is applied to any dereferenced objects and is not applied to their subordinates.

    • FINDING_BASE

      public static final DereferenceAliasesPolicy FINDING_BASE
      Dereference aliases in locating the base object of a Search operation, but not when searching subordinates of the base object.

    • ALWAYS

      public static final DereferenceAliasesPolicy ALWAYS
      Dereference aliases both in searching and in locating the base object of a Search operation.

  • Method Details

    • values

      public static DereferenceAliasesPolicy[] 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 DereferenceAliasesPolicy 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

    • valueOf

      public static DereferenceAliasesPolicy valueOf(int intValue)
      Returns the alias dereferencing policy having the specified integer value as defined in RFC 4511 section 4.5.1.
      Parameters:
      intValue - The integer value of the alias dereferencing policy.
      Returns:
      The dereference aliases policy, or null if there was no alias dereferencing policy associated with intValue.

    • immutableValues

      public static List<DereferenceAliasesPolicy> immutableValues()
      Returns an unmodifiable list containing the set of available alias dereferencing policies indexed on their integer value as defined in RFC 4511 section 4.5.1.
      Returns:
      An unmodifiable list containing the set of available alias dereferencing policies.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<DereferenceAliasesPolicy>