Package org.forgerock.openig.filter

Class HeaderFilter

java.lang.Object

org.forgerock.openig.filter.HeaderFilter

All Implemented Interfaces:

Filter

public final class HeaderFilter
extends Object
implements Filter

Removes headers from and adds headers to a message.

 {
      "type": "HeaderFilter",
      "config": {
        "messageType"  : Expression<String>            [REQUIRED - Perform the header transformations on either the
                                                                   REQUEST or RESPONSE.]
        "remove"       : [Expression<String>]          [OPTIONAL - List of header names to remove. Default : empty]
        "add"          : {                             [OPTIONAL - Headers to add. Default: empty]
          "header-name": ["runtimeExpression<String>"] [REQUIRED - the header name to add and its values.]
        },
        "replace"      : {                             [OPTIONAL - Headers to remove then add. Default: empty]
          "header-name": ["runtimeExpression<String>"] [REQUIRED - the header name to replace with the new values.]
        },
      }
 }
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderFilter.Heaplet	Creates and initializes a header 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 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.