org.picketlink.http.authentication

Interface HttpAuthenticationScheme<C extends AuthenticationSchemeConfiguration>

All Known Implementing Classes:

BasicAuthenticationScheme, DigestAuthenticationScheme, FormAuthenticationScheme, TokenAuthenticationScheme, X509AuthenticationScheme

public interface HttpAuthenticationScheme<C extends AuthenticationSchemeConfiguration>

Basis for the HTTP Authentication Schemes such as BASIC, FORM, DIGEST and CLIENT-CERT. Applications can provide their own authentication schemes by implementing this interface. Implementations must be valid CDI beans, and do support injection.

Author:

Pedro Silva, Jonathan Fuerth, Max Barkley

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(C config) Called one time during initialization.
void	onPostAuthentication(HttpServletRequest request, HttpServletResponse response) Performs any post-authentication logic regarding of the authentication result.

Method Detail

initialize

void initialize(C config)

Called one time during initialization.

Parameters:

config - The configuration.

extractCredential

void extractCredential(HttpServletRequest request,
                     DefaultLoginCredentials creds)

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.

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

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.

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

void onPostAuthentication(HttpServletRequest request,
                        HttpServletResponse response)

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

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.