Class HttpBasicAuthFilter
- java.lang.Object
-
- org.forgerock.openig.filter.HttpBasicAuthFilter
-
- All Implemented Interfaces:
Filter
public class HttpBasicAuthFilter extends Object implements 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
orpassword
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, Handler failureHandler)
Builds aHttpBasicAuthFilter
with required expressions and error handler.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Promise<Response,NeverThrowsException>
filter(Context context, Request request, Handler next)
Filters the request and/or response of an exchange.void
setCacheHeader(boolean cacheHeader)
Decide if we cache the password header result (defaults to true).
-
-
-
Constructor Detail
-
HttpBasicAuthFilter
public HttpBasicAuthFilter(Expression<String> username, Expression<String> password, Handler failureHandler)
Builds aHttpBasicAuthFilter
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 Promise<Response,NeverThrowsException> filter(Context context, Request request, Handler next)
Description copied from interface:Filter
Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter callsnext.handle(context, request)
.This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to
next.handle(context, request)
and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.
-
-