Package org.forgerock.opendj.ldap

Enum DereferenceAliasesPolicy

    • Enum Constant Detail

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

      • values

        public static DereferenceAliasesPolicy[] 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 (DereferenceAliasesPolicy c : DereferenceAliasesPolicy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

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