ml.alternet.security.web.server

Enum AuthenticationMethod

java.lang.Object

java.lang.Enum<AuthenticationMethod>

ml.alternet.security.web.server.AuthenticationMethod

All Implemented Interfaces:

Serializable, Comparable<AuthenticationMethod>

public enum AuthenticationMethod
extends Enum<AuthenticationMethod>

Authentication methods.

Author:

Philippe Poulard

Enum Constant Summary

Enum Constants

Enum Constant and Description
Basic HTTP Basic Authentication.
Form Form Authentication.
None No authentication.
Other Other authentication.

Method Summary

Modifier and Type	Method and Description
static AuthenticationMethod	extract(javax.servlet.ServletContext webapp) Extract the authentication method from the init parameter of the Web application.
Credentials	getCredentials(javax.servlet.ServletRequest request) Get the user credentials after authentication.
static void	reset(javax.servlet.ServletContext webapp) Remove this attribute from the Web application.
static AuthenticationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationMethod[]	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

Basic

public static final AuthenticationMethod Basic

HTTP Basic Authentication.

Form

public static final AuthenticationMethod Form

Form Authentication.

Other

public static final AuthenticationMethod Other

Other authentication.

None

public static final AuthenticationMethod None

No authentication.

Method Detail

values

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

Returns:

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

valueOf

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

getCredentials

public Credentials getCredentials(javax.servlet.ServletRequest request)

Get the user credentials after authentication.

Parameters:

request - The request.

Returns:

The user credentials.

extract

public static AuthenticationMethod extract(javax.servlet.ServletContext webapp)

Extract the authentication method from the init parameter of the Web application.

<context-param>
    <param-name>ml.alternet.security.web.config.authenticationMethod</param-name>
    <param-value>Basic</param-value>
</context-param>
 

Once extracted, the parameter is set as an attribute of the application.

Parameters:

webapp - The Web application

Returns:

The non-null authentication method.

See Also:

reset(ServletContext)

reset

public static void reset(javax.servlet.ServletContext webapp)

Remove this attribute from the Web application.

Parameters:

webapp - The Web application.

See Also:

extract(ServletContext)