org.forgerock.http

Interface Filter

All Known Implementing Classes:

AuthenticationFilter, OpenApiRequestFilter, OptionsFilter, ResourceApiVersionRoutingFilter, ResourceApiVersionRoutingFilter, ResourceServerFilter, TransactionIdInboundFilter, TransactionIdOutboundFilter

public interface Filter

Filters the request and/or response of an HTTP exchange.

Method Summary

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

Method Detail

filter

Promise<Response,NeverThrowsException> filter(Context context,
                                              Request request,
                                              Handler next)

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.

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.