Package org.forgerock.openam.radius.server.spi.handlers.amhandler

Enum ContextHolder.AuthPhase

java.lang.Object

java.lang.Enum<ContextHolder.AuthPhase>

org.forgerock.openam.radius.server.spi.handlers.amhandler.ContextHolder.AuthPhase

All Implemented Interfaces:

Serializable, Comparable<ContextHolder.AuthPhase>

Enclosing class:

ContextHolder

public static enum ContextHolder.AuthPhase
extends Enum<ContextHolder.AuthPhase>

Indicates what phase of authentication we are in. The flow is the same as the order of declaration.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FINALIZING	The auth phase is in its final stage.
GATHERING_INPUT	The auth phase is that in which the user must add input.
STARTING	The auth phase is starting.
TERMINATED	The auth phase has terminated.

Method Summary

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

STARTING

public static final ContextHolder.AuthPhase STARTING

The auth phase is starting.

GATHERING_INPUT

public static final ContextHolder.AuthPhase GATHERING_INPUT

The auth phase is that in which the user must add input.

FINALIZING

public static final ContextHolder.AuthPhase FINALIZING

The auth phase is in its final stage.

TERMINATED

public static final ContextHolder.AuthPhase TERMINATED

The auth phase has terminated.

Method Detail

values

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

Returns:

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

valueOf

public static ContextHolder.AuthPhase 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