Package org.bremersee.ldaptive

Enum Class LdaptiveProperties.ConnectionStrategy

java.lang.Object

java.lang.Enum<LdaptiveProperties.ConnectionStrategy>

org.bremersee.ldaptive.LdaptiveProperties.ConnectionStrategy

All Implemented Interfaces:

Serializable, Comparable<LdaptiveProperties.ConnectionStrategy>, Constable, Supplier<org.ldaptive.ConnectionStrategy>

Enclosing class:

LdaptiveProperties

public static enum LdaptiveProperties.ConnectionStrategy
extends Enum<LdaptiveProperties.ConnectionStrategy>
implements Supplier<org.ldaptive.ConnectionStrategy>

The connection strategy.

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
ACTIVE_PASSIVE	Attempt each URL in the order provided for each connection.
DNS	Queries a DNS server for SRV records and uses those records to construct a list of URLs.
RANDOM	Attempt a random URL from a list of URLs.
ROUND_ROBIN	Attempt the next URL in the order provided for each connection.

Method Summary

Modifier and Type	Method	Description
org.ldaptive.ConnectionStrategy	get()
static LdaptiveProperties.ConnectionStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LdaptiveProperties.ConnectionStrategy[]	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

ACTIVE_PASSIVE

public static final LdaptiveProperties.ConnectionStrategy ACTIVE_PASSIVE

Attempt each URL in the order provided for each connection. The URLs are always tried in the order in which they were provided.

RANDOM

public static final LdaptiveProperties.ConnectionStrategy RANDOM

Attempt a random URL from a list of URLs.

ROUND_ROBIN

public static final LdaptiveProperties.ConnectionStrategy ROUND_ROBIN

Attempt the next URL in the order provided for each connection. URLs are rotated regardless of connection success or failure.

DNS

public static final LdaptiveProperties.ConnectionStrategy DNS

Queries a DNS server for SRV records and uses those records to construct a list of URLs. When configuring this strategy you must use your DNS server for ldapUrl in the form dns://my.server.com.

Method Details

values

public static LdaptiveProperties.ConnectionStrategy[] 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 LdaptiveProperties.ConnectionStrategy 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

get

public org.ldaptive.ConnectionStrategy get()

Specified by:

get in interface Supplier<org.ldaptive.ConnectionStrategy>