Package org.forgerock.opendj.ldap

Class DereferenceAliasesPolicy

java.lang.Object
org.forgerock.opendj.ldap.DereferenceAliasesPolicy
public final class DereferenceAliasesPolicy extends Object
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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final DereferenceAliasesPolicy
    ALWAYS
    Dereference aliases both in searching and in locating the base object of a Search operation.
    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.
    static final DereferenceAliasesPolicy
    IN_SEARCHING
    While searching subordinates of the base object, dereference any alias within the scope of the Search operation.
    static final DereferenceAliasesPolicy
    NEVER
    Do not dereference aliases in searching or in locating the base object of a Search operation.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    int
    hashCode()
     
    int
    intValue()
    Returns the integer value of this alias dereferencing policy as defined in RFC 4511 section 4.5.1.
    String
    toString()
    Returns the string representation of this alias dereferencing policy.
    static DereferenceAliasesPolicy
    valueOf(int intValue)
    Returns the alias dereferencing policy having the specified integer value as defined in RFC 4511 section 4.5.1.
    static List<DereferenceAliasesPolicy>
    values()
    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.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field 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

    • 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.

    • values

      public static List<DereferenceAliasesPolicy> values()
      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.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • intValue

      public int intValue()
      Returns the integer value of this alias dereferencing policy as defined in RFC 4511 section 4.5.1.
      Returns:
      The integer value of this alias dereferencing policy.

    • toString

      public String toString()
      Returns the string representation of this alias dereferencing policy.
      Overrides:
      toString in class Object
      Returns:
      The string representation of this alias dereferencing policy.