Package org.forgerock.openig.fapi.audit

Class FapiAuditFilter

java.lang.Object

org.forgerock.openig.fapi.audit.FapiAuditFilter

All Implemented Interfaces:

Filter

public class FapiAuditFilter
extends Object
implements Filter

This filter is responsible for reporting audit for FAPI route.

The filter should be installed as the first filter in the chain in order to get the most accurate response time data.

FapiAuditFilter expects to find some information in a dedicated FapiAuditContext which must be filled along the filter chain. This means that the context needs to be populated correctly prior to this filter processing the response.

The audit been published could be used to track calls and compute advanced metrics for FAPI requests using correlation id from this audit.

Constructor Summary

Constructors

Constructor	Description
FapiAuditFilter(RequestHandler auditServiceHandler, Clock clock)	Constructs a new FapiAuditFilter.

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

FapiAuditFilter

public FapiAuditFilter(RequestHandler auditServiceHandler,
 Clock clock)

Constructs a new FapiAuditFilter.

Parameters:

auditServiceHandler - The RequestHandler to publish the events.

clock - The Clock 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.