org.apache.directory.server.core.api

Enum ReferralHandlingMode

java.lang.Object

java.lang.Enum<ReferralHandlingMode>

org.apache.directory.server.core.api.ReferralHandlingMode

All Implemented Interfaces:

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

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

Enumeration for referral handling modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOLLOW
IGNORE
THROW
THROW_FINDING_BASE

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	jndiValue The JNDI Context.REFERRAL key's value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getJndiValue() Gets the equivalent JNDI Context.REFERRAL key's value for this enumeration constant.
static ReferralHandlingMode	getModeFromJndi(java.lang.String jndiValue) Gets the enumeration constant for the JNDI Context.REFERRAL key's value.
static ReferralHandlingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReferralHandlingMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

THROW

public static final ReferralHandlingMode THROW

FOLLOW

public static final ReferralHandlingMode FOLLOW

IGNORE

public static final ReferralHandlingMode IGNORE

THROW_FINDING_BASE

public static final ReferralHandlingMode THROW_FINDING_BASE

Field Detail

jndiValue

private final java.lang.String jndiValue

The JNDI Context.REFERRAL key's value.

See Also:

Context#REFERRAL

Method Detail

values

public static ReferralHandlingMode[] 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 (ReferralHandlingMode c : ReferralHandlingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

getJndiValue

public java.lang.String getJndiValue()

Gets the equivalent JNDI Context.REFERRAL key's value for this enumeration constant.

Returns:

the equivalent JNDI Context.REFERRAL key's value

See Also:

Context#REFERRAL

getModeFromJndi

public static final ReferralHandlingMode getModeFromJndi(java.lang.String jndiValue)

Gets the enumeration constant for the JNDI Context.REFERRAL key's value.

Parameters:

jndiValue - the JNDI Context.REFERRAL key's value

Returns:

the referral handling mode enumeration constant

Throws:

java.lang.IllegalArgumentException - if the value is not a recognized value

See Also:

Context#REFERRAL