Package org.forgerock.openig.filter

Class HttpBasicAuthFilter

java.lang.Object

org.forgerock.openig.filter.HttpBasicAuthFilter

All Implemented Interfaces:

org.forgerock.http.Filter

public class HttpBasicAuthFilter
extends Object
implements org.forgerock.http.Filter

Performs authentication through the HTTP Basic authentication scheme. For more information, see RFC 2617.

If challenged for authentication via a 401 Unauthorized status code by the server, this filter will retry the request with credentials attached.

Once an HTTP authentication challenge (status code 401) is issued from the remote server, all subsequent requests to that remote server that pass through the filter will include the user credentials.

Credentials are cached in the session to allow subsequent requests to automatically include authentication credentials. If authentication fails (including the case of no credentials yielded from the username or password expressions, then the processing is diverted to the authentication failure handler.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpBasicAuthFilter.Heaplet	Creates and initializes an HTTP basic authentication filter in a heap environment.

Constructor Summary

Constructors

Constructor	Description
HttpBasicAuthFilter(Expression<String> username, Expression<String> password, org.forgerock.http.Handler failureHandler)	Builds a HttpBasicAuthFilter with required expressions and error handler.

Method Summary

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<org.forgerock.http.protocol.Response,org.forgerock.util.promise.NeverThrowsException>	filter(org.forgerock.services.context.Context context, org.forgerock.http.protocol.Request request, org.forgerock.http.Handler next)
void	setCacheHeader(boolean cacheHeader)	Decide if we cache the password header result (defaults to true).

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpBasicAuthFilter

public HttpBasicAuthFilter(Expression<String> username,
                           Expression<String> password,
                           org.forgerock.http.Handler failureHandler)

Builds a HttpBasicAuthFilter with required expressions and error handler.

Parameters:

username - the expression that yields the username to supply during authentication.

password - the expression that yields the password to supply during authentication.

failureHandler - the Handler to dispatch to if authentication fails.

Method Detail

setCacheHeader

public void setCacheHeader(boolean cacheHeader)

Decide if we cache the password header result (defaults to true).

Parameters:

cacheHeader - cache (or not) the Authorization header

filter

public org.forgerock.util.promise.Promise<org.forgerock.http.protocol.Response,org.forgerock.util.promise.NeverThrowsException> filter(org.forgerock.services.context.Context context,
                                                                                                                                             org.forgerock.http.protocol.Request request,
                                                                                                                                             org.forgerock.http.Handler next)

Specified by:

filter in interface org.forgerock.http.Filter