org.picketlink.authentication.web

Class FormAuthenticationScheme

java.lang.Object

org.picketlink.authentication.web.FormAuthenticationScheme

All Implemented Interfaces:

HTTPAuthenticationScheme

public class FormAuthenticationScheme
extends Object
implements HTTPAuthenticationScheme

An implementation of HTTPAuthenticationScheme that supports the Servlet Specification FORM Authentication Scheme

Since:

June 06, 2013

Author:

Anil Saldhana

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORM_ERROR_PAGE_INIT_PARAM
static String	FORM_LOGIN_PAGE_INIT_PARAM
static String	J_PASSWORD
static String	J_SECURITY_CHECK
static String	J_USERNAME
static String	SAVED_REQUEST
static String	STATE

Constructor Summary

Constructors

Constructor and Description
FormAuthenticationScheme(javax.servlet.FilterConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	challengeClient(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Challenges the client if no credentials were supplied or the credentials were not extracted in order to continue with the authentication.
void	extractCredential(javax.servlet.http.HttpServletRequest request, DefaultLoginCredentials creds) Extracts the credentials from the given HttpServletRequest and populate the DefaultLoginCredentials with them.
boolean	postAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs any post-authentication logic regarding of the authentication result.

Methods inherited from class java.lang.Object

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

Field Detail

FORM_LOGIN_PAGE_INIT_PARAM

public static final String FORM_LOGIN_PAGE_INIT_PARAM

See Also:

Constant Field Values

FORM_ERROR_PAGE_INIT_PARAM

public static final String FORM_ERROR_PAGE_INIT_PARAM

See Also:

Constant Field Values

J_SECURITY_CHECK

public static final String J_SECURITY_CHECK

See Also:

Constant Field Values

J_USERNAME

public static final String J_USERNAME

See Also:

Constant Field Values

J_PASSWORD

public static final String J_PASSWORD

See Also:

Constant Field Values

SAVED_REQUEST

public static final String SAVED_REQUEST

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

Constructor Detail

FormAuthenticationScheme

public FormAuthenticationScheme(javax.servlet.FilterConfig config)

Method Detail

extractCredential

public void extractCredential(javax.servlet.http.HttpServletRequest request,
                     DefaultLoginCredentials creds)

Description copied from interface: HTTPAuthenticationScheme

Extracts the credentials from the given HttpServletRequest and populate the DefaultLoginCredentials with them.

Specified by:

extractCredential in interface HTTPAuthenticationScheme

challengeClient

public void challengeClient(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
                     throws IOException

Description copied from interface: HTTPAuthenticationScheme

Challenges the client if no credentials were supplied or the credentials were not extracted in order to continue with the authentication.

Specified by:

challengeClient in interface HTTPAuthenticationScheme

Throws:

IOException

postAuthentication

public boolean postAuthentication(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                           throws IOException

Description copied from interface: HTTPAuthenticationScheme

Performs any post-authentication logic regarding of the authentication result.

Specified by:

postAuthentication in interface HTTPAuthenticationScheme

Returns:

true if the processing should continue, false if the processing should stop.

Throws:

IOException