Package com.isode.dsapi.util

Enum Class SaslConfiguration.Rules

java.lang.Object

java.lang.Enum<SaslConfiguration.Rules>

com.isode.dsapi.util.SaslConfiguration.Rules

All Implemented Interfaces:

Serializable, Comparable<SaslConfiguration.Rules>, Constable

Enclosing class:

SaslConfiguration

public static enum SaslConfiguration.Rules
extends Enum<SaslConfiguration.Rules>

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_DIRECTORY
DOMAINPART_SEARCH
SINGLE_SEARCH
TWO_SEARCHES

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns rule description.
int	getId()	Returns rule ID used in directory configuration
static SaslConfiguration.Rules	getRule(int id)	Returns mapping rule for specific ID or null if there is no rule mapping associated with given ID.
static SaslConfiguration.Rules	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SaslConfiguration.Rules[]	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_DIRECTORY

public static final SaslConfiguration.Rules ACTIVE_DIRECTORY

DOMAINPART_SEARCH

public static final SaslConfiguration.Rules DOMAINPART_SEARCH

TWO_SEARCHES

public static final SaslConfiguration.Rules TWO_SEARCHES

SINGLE_SEARCH

public static final SaslConfiguration.Rules SINGLE_SEARCH

Method Details

values

public static SaslConfiguration.Rules[] 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 SaslConfiguration.Rules 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

getId

public int getId()

Returns rule ID used in directory configuration

Returns:

ID

getDescription

public String getDescription()

Returns rule description.

Returns:

rule description (not null)

getRule

public static SaslConfiguration.Rules getRule(int id)

Returns mapping rule for specific ID or null if there is no rule mapping associated with given ID.

Parameters:

id - mapping rule ID

Returns:

mapping rule (null possible)