Package org.forgerock.openig.filter.finance

Class FapiInteractionIdFilter

java.lang.Object

org.forgerock.openig.filter.finance.FapiInteractionIdFilter

All Implemented Interfaces:

Filter

public class FapiInteractionIdFilter
extends Object
implements Filter

A FapiInteractionIdFilter is responsible to manage the FAPI_INTERACTION_ID header value.

• Creating a new UUID header value if the request header is missing
• Propagating the request header downstream (if it as missing)
• Adding the header value back in the response

See Also:

OpenID Financial API - Protected resources provisions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FapiInteractionIdFilter.Heaplet	Creates and initializes a fapi interaction-id filter in a heap environment.

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

Method Detail

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.