Package com.isode.dsapi.config

Enum Class ChainPolicy

java.lang.Object

java.lang.Enum<ChainPolicy>

com.isode.dsapi.config.ChainPolicy

All Implemented Interfaces:

Serializable, Comparable<ChainPolicy>, Constable

public enum ChainPolicy
extends Enum<ChainPolicy>

Isode chain policy.

Since:

15.0

Author:

mv

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
DSP	DSP only
DSP_THEN_LDAP	DSP preferred
LDAP	LDAP only
LDAP_THEN_DSP	LDAP preferred
NO_CHAINING	No chaining

Method Summary

Modifier and Type	Method	Description
String	getDbStr()
String	getDescription()	Returns the description stored for the enumeration.
static ChainPolicy	getPolicy(int index)	Convert index to enum.
static ChainPolicy	getPolicy(String dbStr)	Convert DB string to enum.
String	toString()
String	userFriendlyStr()	Returns the user-friendly name stored for the enumeration.
static ChainPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChainPolicy[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_CHAINING

public static final ChainPolicy NO_CHAINING

No chaining

LDAP

public static final ChainPolicy LDAP

LDAP only

DSP

public static final ChainPolicy DSP

DSP only

LDAP_THEN_DSP

public static final ChainPolicy LDAP_THEN_DSP

LDAP preferred

DSP_THEN_LDAP

public static final ChainPolicy DSP_THEN_LDAP

DSP preferred

Method Details

values

public static ChainPolicy[] 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 ChainPolicy 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

getPolicy

public static ChainPolicy getPolicy(String dbStr)

Convert DB string to enum. If it does not match any chaining policy, NO_CHAINING is returned.

Parameters:

dbStr - String indicating policy in the DB, a null value corresponds to NO_CHAINING

Returns:

corresponding enum value, will not be null

getPolicy

public static ChainPolicy getPolicy(int index)

Convert index to enum.

Parameters:

index - integer indicating policy index

Returns:

corresponding enum value, NO_CHAINING if does not match any policy

userFriendlyStr

public String userFriendlyStr()

Returns the user-friendly name stored for the enumeration.

Returns:

non-null friendly string for the enum

getDescription

public String getDescription()

Returns the description stored for the enumeration.

Returns:

non-null description string for the enum

getDbStr

public String getDbStr()

Returns:

DB string for the enumeration, will be null for NO_CHAINING

toString

public String toString()

Overrides:

toString in class Enum<ChainPolicy>