Package org.springframework.boot.autoconfigure.ldap

Enum Class LdapProperties.Referral

java.lang.Object

java.lang.Enum<LdapProperties.Referral>

org.springframework.boot.autoconfigure.ldap.LdapProperties.Referral

All Implemented Interfaces:

Serializable, Comparable<LdapProperties.Referral>, Constable

Enclosing class:

LdapProperties

public static enum LdapProperties.Referral
extends Enum<LdapProperties.Referral>

Define the methods to handle referrals.

Since:

3.5.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FOLLOW	Follow referrals automatically.
IGNORE	Ignore referrals.
THROW	Throw ReferralException when a referral is encountered.

Method Summary

Modifier and Type	Method	Description
static LdapProperties.Referral	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LdapProperties.Referral[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FOLLOW

public static final LdapProperties.Referral FOLLOW

Follow referrals automatically.

IGNORE

public static final LdapProperties.Referral IGNORE

Ignore referrals.

THROW

public static final LdapProperties.Referral THROW

Throw ReferralException when a referral is encountered.

Method Details

values

public static LdapProperties.Referral[] 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 LdapProperties.Referral 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