org.picketlink.http.internal.authentication.schemes

Class DigestAuthenticationScheme

java.lang.Object

org.picketlink.http.internal.authentication.schemes.DigestAuthenticationScheme

All Implemented Interfaces:

HttpAuthenticationScheme<DigestAuthenticationConfiguration>

public class DigestAuthenticationScheme
extends Object
implements HttpAuthenticationScheme<DigestAuthenticationConfiguration>

Author:

Shane Bryzak, anil saldhana, Pedro Igor

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REALM_NAME
static String	REALM_NAME_INIT_PARAM

Constructor Summary

Constructors

Constructor and Description
DigestAuthenticationScheme()

Method Summary

Methods

Modifier and Type	Method and Description
void	challengeClient(HttpServletRequest request, 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(HttpServletRequest request, DefaultLoginCredentials creds) Extracts the credentials from the given HttpServletRequest and populates the DefaultLoginCredentials with them.
void	initialize(DigestAuthenticationConfiguration config) Called one time during initialization.
void	onPostAuthentication(HttpServletRequest request, 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

REALM_NAME_INIT_PARAM

public static final String REALM_NAME_INIT_PARAM

See Also:

Constant Field Values

DEFAULT_REALM_NAME

public static final String DEFAULT_REALM_NAME

See Also:

Constant Field Values

Constructor Detail

DigestAuthenticationScheme

public DigestAuthenticationScheme()

Method Detail

initialize

public void initialize(DigestAuthenticationConfiguration config)

Description copied from interface: HttpAuthenticationScheme

Called one time during initialization.

Specified by:

initialize in interface HttpAuthenticationScheme<DigestAuthenticationConfiguration>

Parameters:

config - The configuration.

extractCredential

public void extractCredential(HttpServletRequest request,
                     DefaultLoginCredentials creds)

Description copied from interface: HttpAuthenticationScheme

Extracts the credentials from the given HttpServletRequest and populates the DefaultLoginCredentials with them. If the request is not an authentication attempt (as defined by the implementation), then creds is not affected.

Specified by:

extractCredential in interface HttpAuthenticationScheme<DigestAuthenticationConfiguration>

Parameters:

request - The current request, to examine for authentication information.

creds - The credentials instance that will be populated with the credentials found in the request, if any.

challengeClient

public void challengeClient(HttpServletRequest request,
                   HttpServletResponse response)

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<DigestAuthenticationConfiguration>

Parameters:

request - The current request, which may be used to obtain a RequestDispatcher if needed. If this method is called, the rest of the filter chain will not be processed, so implementations are free to read the request body if they so choose.

response - The current response, which can be used to send HTTP error results, redirects, or for sending additional challenge headers.

onPostAuthentication

public void onPostAuthentication(HttpServletRequest request,
                        HttpServletResponse response)

Description copied from interface: HttpAuthenticationScheme

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

Specified by:

onPostAuthentication in interface HttpAuthenticationScheme<DigestAuthenticationConfiguration>

Parameters:

request - The current request, which may be used to obtain a RequestDispatcher if needed.

response - The current response, which can be used to send an HTTP response, or a redirect.