Package ch.tocco.nice2.security.api.auth

Enum Class ImmutableChallenge.State

java.lang.Object

java.lang.Enum<ImmutableChallenge.State>

ch.tocco.nice2.security.api.auth.ImmutableChallenge.State

All Implemented Interfaces:

Serializable, Comparable<ImmutableChallenge.State>, Constable

Enclosing interface:

ImmutableChallenge

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

The final states of a authentication challenge.

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
CANCELLED	Aborts the authentication process as soon as this state is encountered.
FAILED	Used for indicating a failed login attempt.
SUCCESS	Used for indicating a successfull login attempt.

Method Summary

Modifier and Type	Method	Description
abstract ImmutableChallenge.State	min(ImmutableChallenge.State other)	Return the lower value of this and other, where CANCELLED < FAILED < SUCCESS.
static ImmutableChallenge.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImmutableChallenge.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

SUCCESS

public static final ImmutableChallenge.State SUCCESS

Used for indicating a successfull login attempt. Other handlers are still asked to vote.

FAILED

public static final ImmutableChallenge.State FAILED

Used for indicating a failed login attempt. Other handlers are still asked to vote.

CANCELLED

public static final ImmutableChallenge.State CANCELLED

Aborts the authentication process as soon as this state is encountered. Authentication has been failed.

Method Details

values

public static ImmutableChallenge.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 ImmutableChallenge.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

min

public abstract ImmutableChallenge.State min(ImmutableChallenge.State other)

Return the lower value of this and other, where CANCELLED < FAILED < SUCCESS.