Package org.jivesoftware.openfire.net

Enum Class SASLAuthentication.Status

java.lang.Object

java.lang.Enum<SASLAuthentication.Status>

org.jivesoftware.openfire.net.SASLAuthentication.Status

All Implemented Interfaces:

Serializable, Comparable<SASLAuthentication.Status>, Constable

Enclosing class:

SASLAuthentication

public static enum SASLAuthentication.Status
extends Enum<SASLAuthentication.Status>

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	SASL negotiation has been successful.
authenticatedAwaitingFeatures	SASL negotiation has been successful, but the response (including stream features) will be delivered asynchronously (e.g. when Bind2 resource binding completes).
authenticatedResumed	SASL2 negotiation has been successful by inline-resuming a pre-existing session (XEP-0198 § 9.2).
failed	SASL negotiation has failed.
needResponse	Entity needs to respond last challenge.

Method Summary

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

needResponse

public static final SASLAuthentication.Status needResponse

Entity needs to respond last challenge. Session is still negotiatingSASL authentication.

failed

public static final SASLAuthentication.Status failed

SASL negotiation has failed. The entity may retry a few times before the connection is closed.

authenticated

public static final SASLAuthentication.Status authenticated

SASL negotiation has been successful.

authenticatedAwaitingFeatures

public static final SASLAuthentication.Status authenticatedAwaitingFeatures

SASL negotiation has been successful, but the response (including stream features) will be delivered asynchronously (e.g. when Bind2 resource binding completes). The caller must not send stream features itself.

authenticatedResumed

public static final SASLAuthentication.Status authenticatedResumed

SASL2 negotiation has been successful by inline-resuming a pre-existing session (XEP-0198 § 9.2). The <success/> response (including the <resumed/> element) has already been delivered, over the resumed session, by SASLAuthentication. The caller must adopt the session referenced by SASLAuthentication.SASL2_RESUMED_SESSION session data, and must NOT send stream features, per XEP-0198 § 9.2.

Method Details

values

public static SASLAuthentication.Status[] 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 SASLAuthentication.Status 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