ml.alternet.security.web.server

Class FormFieldConfiguration

java.lang.Object

ml.alternet.security.web.server.FormFieldConfiguration

public class FormFieldConfiguration
extends Object

Base class for handling form fields.

Author:

Philippe Poulard

Field Summary

Fields

Modifier and Type	Field and Description
protected String	ctxtPath The path to the Webapp.
protected Map<String,List<String>>	fields A map of {path, fields}.
static String	J_PASSWORD Form field name for the password.
static String	J_SECURITY_CHECK Target path for Form Authentication.
static String	J_USERNAME Form field name for the username.

Constructor Summary

Constructors

Constructor and Description
FormFieldConfiguration()

Method Summary

Modifier and Type	Method and Description
protected void	addLoginFormValue(javax.servlet.ServletContext webapp) Add the login form value if the authentication method is "Form" (that is to say, bound the form field "j_password" to the path "/j_security_check" in that context).
protected void	addValues(String path, String... formFields) Called by the extractor for each single parameter found in the configuration.
protected void	extract(javax.servlet.ServletContext webapp) Extract the parameters from the Webapp configuration.
protected List<String>	get(String path) Get the fields bound to a path.
static Optional<List<String>>	matches(javax.servlet.ServletContext webapp, javax.servlet.http.HttpServletRequest request) Check whether the path of an HTTP request matches one of those found in the configuration, and return the list of passwords fields that have to be captured in a request.
static Optional<List<String>>	matches(javax.servlet.ServletContext webapp, javax.servlet.http.HttpServletRequest request, Supplier<FormFieldConfiguration> factory) Check whether the path of an HTTP request matches one of those found in the configuration, and return the list of passwords fields that have to be captured in a request.
static void	reset(javax.servlet.ServletContext webapp) Remove this attribute from the Web application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

J_SECURITY_CHECK

public static final String J_SECURITY_CHECK

Target path for Form Authentication.

See Also:

Constant Field Values

J_USERNAME

public static final String J_USERNAME

Form field name for the username.

See Also:

Constant Field Values

J_PASSWORD

public static final String J_PASSWORD

Form field name for the password.

See Also:

Constant Field Values

ctxtPath

protected String ctxtPath

The path to the Webapp.

fields

protected Map<String,List<String>> fields

A map of {path, fields}.

Constructor Detail

FormFieldConfiguration

public FormFieldConfiguration()

Method Detail

extract

protected void extract(javax.servlet.ServletContext webapp)

Extract the parameters from the Webapp configuration.

<context-param>
    <param-name>ml.alternet.security.web.config.formFields</param-name>
    <param-value>
          /doRegister.html?pwd&confirmPwd,
          /doUpdatePassword.html?oldPwd&newPwd&confirmPwd
    </param-value>
</context-param>
 

Parameters:

webapp - The Web application.

addLoginFormValue

protected void addLoginFormValue(javax.servlet.ServletContext webapp)

Add the login form value if the authentication method is "Form" (that is to say, bound the form field "j_password" to the path "/j_security_check" in that context).

Parameters:

webapp - The Web application.

addValues

protected void addValues(String path,
                         String... formFields)

Called by the extractor for each single parameter found in the configuration.

Parameters:

path - The path

formFields - The fields

get

protected List<String> get(String path)

Get the fields bound to a path.

Parameters:

path - The path.

Returns:

The fields.

matches

public static Optional<List<String>> matches(javax.servlet.ServletContext webapp,
                                             javax.servlet.http.HttpServletRequest request)

Check whether the path of an HTTP request matches one of those found in the configuration, and return the list of passwords fields that have to be captured in a request.

Parameters:

webapp - The Web application.

request - The HTTP request.

Returns:

If the request matches the configuration, return the list of field names.

matches

public static Optional<List<String>> matches(javax.servlet.ServletContext webapp,
                                             javax.servlet.http.HttpServletRequest request,
                                             Supplier<FormFieldConfiguration> factory)

Check whether the path of an HTTP request matches one of those found in the configuration, and return the list of passwords fields that have to be captured in a request.

Parameters:

webapp - The Web application.

request - The HTTP request.

factory - For creating a specific instance of this class.

Returns:

If the request matches the configuration, return the list of field names.

reset

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

Remove this attribute from the Web application.

Parameters:

webapp - The Web application.