Package org.apache.qpid.protonj2.engine

Enum EngineSaslDriver.SaslState

java.lang.Object

java.lang.Enum<EngineSaslDriver.SaslState>

org.apache.qpid.protonj2.engine.EngineSaslDriver.SaslState

All Implemented Interfaces:

Serializable, Comparable<EngineSaslDriver.SaslState>

Enclosing interface:

EngineSaslDriver

public static enum EngineSaslDriver.SaslState
extends Enum<EngineSaslDriver.SaslState>

The SASL driver state used to determine at what point the current SASL negotiation process is currently in. If the state is 'none' then no SASL negotiations will be performed.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATED	Authentication succeeded
AUTHENTICATING	Engine started and set configuration in use
AUTHENTICATION_FAILED	Authentication failed
IDLE	Engine not started, context can be configured
NONE	No authentication layer configured.

Method Summary

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

IDLE

public static final EngineSaslDriver.SaslState IDLE

Engine not started, context can be configured

AUTHENTICATING

public static final EngineSaslDriver.SaslState AUTHENTICATING

Engine started and set configuration in use

AUTHENTICATED

public static final EngineSaslDriver.SaslState AUTHENTICATED

Authentication succeeded

AUTHENTICATION_FAILED

public static final EngineSaslDriver.SaslState AUTHENTICATION_FAILED

Authentication failed

NONE

public static final EngineSaslDriver.SaslState NONE

No authentication layer configured.

Method Detail

values

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

Returns:

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

valueOf

public static EngineSaslDriver.SaslState valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null