org.xwiki.security.authentication

Enum AuthenticationAction

java.lang.Object

java.lang.Enum<AuthenticationAction>

org.xwiki.security.authentication.AuthenticationAction

All Implemented Interfaces:

Serializable, Comparable<AuthenticationAction>

@Unstable
public enum AuthenticationAction
extends Enum<AuthenticationAction>

Possible actions for AuthenticationResourceReference.

Since:

13.1RC1

Version:

$Id: 8dec1e94ece1928e7bc722123a8b8475718199e2 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORGOT_USERNAME Action used to retrieve the username of a user.
RESET_PASSWORD Action used to reset the password of a user.

Method Summary

Modifier and Type	Method and Description
static AuthenticationAction	getFromRequestParameter(String parameter) Retrieve an action based on the request parameter.
String	getRequestParameter()
static AuthenticationAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationAction[]	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

RESET_PASSWORD

public static final AuthenticationAction RESET_PASSWORD

Action used to reset the password of a user.

FORGOT_USERNAME

public static final AuthenticationAction FORGOT_USERNAME

Action used to retrieve the username of a user.

Method Detail

values

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

Returns:

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

valueOf

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

getRequestParameter

public String getRequestParameter()

Returns:

the request parameter associated to this action.

getFromRequestParameter

public static AuthenticationAction getFromRequestParameter(String parameter)
                                                    throws IllegalArgumentException

Retrieve an action based on the request parameter.

Parameters:

parameter - the parameter from which to retrieve the action.

Returns:

an action associated to the given parameter.

Throws:

IllegalArgumentException - if the parameter is empty or if no action could be found based on it.