oracle.oud.types

Enum DereferenceAliasesPolicy

java.lang.Object

java.lang.Enum<DereferenceAliasesPolicy>

oracle.oud.types.DereferenceAliasesPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DereferenceAliasesPolicy>

public enum DereferenceAliasesPolicy
extends java.lang.Enum<DereferenceAliasesPolicy>

A Search operation alias dereferencing policy as defined in RFC 4511 section 4.5.1.3 is used to indicate whether or not 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:

RFC 4511 - Lightweight Directory Access Protocol (LDAP): The Protocol , RFC 4512 - Lightweight Directory Access Protocol (LDAP): Directory Information Models

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Dereference aliases both in searching and in locating the base object of a Search operation.
FINDING_BASE Dereference aliases in locating the base object of a Search operation, but not when searching subordinates of the base object.
IN_SEARCHING While searching subordinates of the base object, dereference any alias within the scope of the Search operation.
NEVER Do not dereference aliases in searching or in locating the base object of a Search operation.

Method Summary

Modifier and Type	Method and Description
int	intValue() Returns the integer value of this alias dereferencing policy as defined in RFC 4511 section 4.5.1.
java.lang.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 DereferenceAliasesPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DereferenceAliasesPolicy[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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.

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 java.lang.String toString()

Returns the string representation of this alias dereferencing policy.

Overrides:

toString in class java.lang.Enum<DereferenceAliasesPolicy>

Returns:

The string representation of this alias dereferencing policy.