Package org.jivesoftware.openfire.sasl.task

Enum Class Sasl2Negotiation.State

java.lang.Object

java.lang.Enum<Sasl2Negotiation.State>

org.jivesoftware.openfire.sasl.task.Sasl2Negotiation.State

All Implemented Interfaces:

Serializable, Comparable<Sasl2Negotiation.State>, Constable

Enclosing class:

Sasl2Negotiation

public static enum Sasl2Negotiation.State
extends Enum<Sasl2Negotiation.State>

The point that a negotiation has reached. Used to reject protocol elements that arrive out of order.

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
AUTHENTICATED	The SASL exchange has succeeded.
AWAITING_NEXT	A <continue/> element has been sent; the peer is expected to select a task with <next/>.
AWAITING_TASK_DATA	A <task-data/> element has been sent; the peer is expected to respond in kind.
FINISHED	The negotiation has ended and has been torn down.
PRE_AUTHENTICATION	The <authenticate/> element has been seen; the SASL exchange is still in progress.

Method Summary

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

PRE_AUTHENTICATION

public static final Sasl2Negotiation.State PRE_AUTHENTICATION

The <authenticate/> element has been seen; the SASL exchange is still in progress.

AUTHENTICATED

public static final Sasl2Negotiation.State AUTHENTICATED

The SASL exchange has succeeded. No task has been offered (yet).

AWAITING_NEXT

public static final Sasl2Negotiation.State AWAITING_NEXT

A <continue/> element has been sent; the peer is expected to select a task with <next/>.

AWAITING_TASK_DATA

public static final Sasl2Negotiation.State AWAITING_TASK_DATA

A <task-data/> element has been sent; the peer is expected to respond in kind.

FINISHED

public static final Sasl2Negotiation.State FINISHED

The negotiation has ended and has been torn down. Written only by Sasl2TaskManager.endNegotiation(LocalSession, boolean), whose compare-and-swap on this value makes teardown idempotent when a connection close races with inbound processing. No other code may set it.

Method Details

values

public static Sasl2Negotiation.State[] 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 Sasl2Negotiation.State 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