Package org.forgerock.openig.fapi.resource.apiclient

Class FetchApiClientFilter

java.lang.Object

org.forgerock.openig.fapi.resource.apiclient.FetchApiClientFilter

All Implemented Interfaces:

Filter

public class FetchApiClientFilter
extends Object
implements Filter

Fetch ApiClients in a data store from incoming access_token's client_id and place it into a ApiClientFapiContext for downstream handlers.

This filters requires contexts below to have been created by prior filters:

• OAuth2Context: coming, for example, from OAuth2ResourceServerFilter
• ApiClientFapiContext: coming from PrepareApiClientContextFilter

Constructor Summary

Constructors

Constructor	Description
FetchApiClientFilter(ApiClientService apiClientService, String accessTokenClientIdClaim)	FetchApiClientFilter constructor, though this filter shouldn't be initiated directly as it is managed as part of FapiResourceFilterChainHeaplet.

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

FetchApiClientFilter

public FetchApiClientFilter(ApiClientService apiClientService,
 String accessTokenClientIdClaim)

FetchApiClientFilter constructor, though this filter shouldn't be initiated directly as it is managed as part of FapiResourceFilterChainHeaplet.

Parameters:

apiClientService - the ApiClientService to retrieve api client information

accessTokenClientIdClaim - the claims to find the client_id

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.