org.apache.directory.api.ldap.model.message

Enum BindStatus

java.lang.Object

java.lang.Enum<BindStatus>

org.apache.directory.api.ldap.model.message.BindStatus

All Implemented Interfaces:

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

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

An enum used to store the BindRequest state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANONYMOUS We are in Anonymous state.
AUTHENTICATED The user has been authenticated
SASL_AUTH_PENDING We have received a SASL BindRequest
SIMPLE_AUTH_PENDING We have received a Simple BindRequest

Method Summary

Modifier and Type	Method and Description
static BindStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BindStatus[]	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

ANONYMOUS

public static final BindStatus ANONYMOUS

We are in Anonymous state. The user specifically required to be anonymous

SIMPLE_AUTH_PENDING

public static final BindStatus SIMPLE_AUTH_PENDING

We have received a Simple BindRequest

SASL_AUTH_PENDING

public static final BindStatus SASL_AUTH_PENDING

We have received a SASL BindRequest

AUTHENTICATED

public static final BindStatus AUTHENTICATED

The user has been authenticated

Method Detail

values

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

Returns:

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

valueOf

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