org.weborganic.bastille.security
Enum AuthenticationResult

java.lang.Object
  java.lang.Enum<AuthenticationResult>
      org.weborganic.bastille.security.AuthenticationResult

All Implemented Interfaces:

Serializable, Comparable<AuthenticationResult>

public enum AuthenticationResult
extends Enum<AuthenticationResult>

An enumeration for the results of authentication methods such as login and logout.

Since:

0.6.2

Enum Constant Summary

ALREADY_LOGGED_IN
The user was already logged in.

ALREADY_LOGGED_OUT
The user was already logged out.

INCORRECT_DETAILS
The login failed because the user provided incorrect details.

INSUFFICIENT_DETAILS
The login could not proceed because the user provided insufficient details.

LOGGED_IN
The login succeeded and resulted in the user being logged in.

LOGGED_OUT
The user has been logged out.

Method Summary

static AuthenticationResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOGGED_IN

public static final AuthenticationResult LOGGED_IN

The login succeeded and resulted in the user being logged in.

ALREADY_LOGGED_IN

public static final AuthenticationResult ALREADY_LOGGED_IN

The user was already logged in.

INSUFFICIENT_DETAILS

public static final AuthenticationResult INSUFFICIENT_DETAILS

The login could not proceed because the user provided insufficient details.

INCORRECT_DETAILS

public static final AuthenticationResult INCORRECT_DETAILS

The login failed because the user provided incorrect details.

LOGGED_OUT

public static final AuthenticationResult LOGGED_OUT

The user has been logged out.

ALREADY_LOGGED_OUT

public static final AuthenticationResult ALREADY_LOGGED_OUT

The user was already logged out.

Method Detail

values

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

Returns:

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

valueOf

public static AuthenticationResult 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