Package org.forgerock.openig.fapi.apiclient.response

Class ResponseFlowFetchApiClientFilter

java.lang.Object

org.forgerock.openig.fapi.apiclient.response.ResponseFlowFetchApiClientFilter

All Implemented Interfaces:

Filter

public class ResponseFlowFetchApiClientFilter
extends Object
implements Filter

The filter is specialized for use in an IG route where the client_id needs to be retrieved on the response flow. This is typically necessary when IG acts as a reverse proxy for an OAuth 2.0 endpoint of the Authorization Server (AS). This setup ensures that the AS has successfully authenticated the client before the ApiClient data is fetched.

The ApiClient is fetched from the data store using the OAuth2.0 client_id as the key. The client_id is determined using configurable ClientIdRetriever which can retrieve the value from the Context, Request or Response object.

The ApiClient that is fetched is placed into a pre-existing ApiClientFapiContext for upstream filters. It requires PrepareApiClientContextFilter prior in the filer chain.

Constructor Summary

Constructors

Constructor	Description
ResponseFlowFetchApiClientFilter(ApiClientService apiClientService, ClientIdRetriever clientIdRetriever)	Constructor a ResponseFlowFetchApiClientFilter with a specific ClientIdRetriever.

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

ResponseFlowFetchApiClientFilter

public ResponseFlowFetchApiClientFilter(ApiClientService apiClientService,
 ClientIdRetriever clientIdRetriever)

Constructor a ResponseFlowFetchApiClientFilter with a specific ClientIdRetriever.

Parameters:

apiClientService - the ApiClientService to use

clientIdRetriever - the ClientIdRetriever to use

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.