Package org.forgerock.openig.filter

Class ForwardedRequestFilter

java.lang.Object

org.forgerock.openig.filter.ForwardedRequestFilter

All Implemented Interfaces:

Filter

public final class ForwardedRequestFilter
extends Object
implements Filter

Rebase the UriRouterContext's Original URI with a computed scheme, host name and port.

This is useful for downstream filters when the request has been forwarded by an upstream application (for example, a TLS offloader).

 {
      "type": "ForwardedRequestFilter",
      "config": {
        "scheme"  : Expression<String>       [OPTIONAL - the scheme to rebase on to. Default : not replaced.]
        "host"    : Expression<String>       [OPTIONAL - the host to rebase on to. Default : not replaced.]
        "port"    : Expression<Number>       [OPTIONAL - the port to rebase on to. Default : not replaced.]
      }
 }
 
 

At least one of scheme, host or port must be defined.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForwardedRequestFilter.Heaplet	Creates and initializes an ForwardedRequestFilter 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.