Package org.forgerock.openig.tools

Class HeadlessAuthenticationFilter

java.lang.Object

org.forgerock.openig.tools.HeadlessAuthenticationFilter

All Implemented Interfaces:

Filter

public class HeadlessAuthenticationFilter
extends Object
implements Filter

Provides an OpenAM SSO Token in the given header name for downstream components.

If the request failed with a 401 UNAUTHORIZED, a unique attempt to refresh the SSO token is tried.

See Also:

• OPENAM REST API status codes

Constructor Summary

Constructors

Constructor	Description
HeadlessAuthenticationFilter(String headerName, AsyncRefreshableSupplier<SsoToken,AuthenticationException> tokenSupplier)	Creates a HeadlessAuthenticationFilter which will provide an AM SSO Token in the given header name for downstream components.

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.

Methods inherited from class java.lang.Object

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

Constructor Details

HeadlessAuthenticationFilter

public HeadlessAuthenticationFilter(String headerName,
 AsyncRefreshableSupplier<SsoToken,AuthenticationException> tokenSupplier)

Creates a HeadlessAuthenticationFilter which will provide an AM SSO Token in the given header name for downstream components.

Parameters:

headerName - The header where to place the SSO token of the agent

tokenSupplier - The SSO Token supplier

Method Details

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 calls next.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.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.