org.springframework.security.openid

Enum OpenIDAuthenticationStatus

java.lang.Object

java.lang.Enum<OpenIDAuthenticationStatus>

org.springframework.security.openid.OpenIDAuthenticationStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OpenIDAuthenticationStatus>

public enum OpenIDAuthenticationStatus
extends java.lang.Enum<OpenIDAuthenticationStatus>

Authentication status codes, based on JanRain status codes

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED This code indicates that the user cancelled their login request
ERROR This code indicates the server reported an error
FAILURE This code indicates a failed authentication request
SETUP_NEEDED This code indicates that the user needs to do additional work to prove their identity
SUCCESS This code indicates a successful authentication request

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final OpenIDAuthenticationStatus SUCCESS

This code indicates a successful authentication request

FAILURE

public static final OpenIDAuthenticationStatus FAILURE

This code indicates a failed authentication request

ERROR

public static final OpenIDAuthenticationStatus ERROR

This code indicates the server reported an error

SETUP_NEEDED

public static final OpenIDAuthenticationStatus SETUP_NEEDED

This code indicates that the user needs to do additional work to prove their identity

CANCELLED

public static final OpenIDAuthenticationStatus CANCELLED

This code indicates that the user cancelled their login request

Method Detail

values

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

Returns:

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

valueOf

public static OpenIDAuthenticationStatus valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<OpenIDAuthenticationStatus>