Package org.forgerock.openig.filter

Class HeaderFilter

java.lang.Object

org.forgerock.openig.filter.HeaderFilter

All Implemented Interfaces:

Filter

public class HeaderFilter
extends Object
implements Filter

Removes headers from and adds headers to a message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderFilter.Heaplet	Creates and initializes a header filter in a heap environment.

Constructor Summary

Constructors

Constructor	Description
HeaderFilter(MessageType messageType)	Builds a HeaderFilter processing either the incoming or outgoing message.

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.
MultiValueMap<String,Expression<String>>	getAddedHeaders()	Returns the header fields to add to the message, represented as a MultiMap of String to a List of String, each listed value representing an expression that will be evaluated.
CaseInsensitiveSet	getRemovedHeaders()	Returns the names of header fields to remove from the message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeaderFilter

public HeaderFilter(MessageType messageType)

Builds a HeaderFilter processing either the incoming or outgoing message.

Parameters:

messageType - MessageType.REQUEST or MessageType.RESPONSE

Method Detail

getRemovedHeaders

public CaseInsensitiveSet getRemovedHeaders()

Returns the names of header fields to remove from the message.

Returns:

the names of header fields to remove from the message.

getAddedHeaders

public MultiValueMap<String,Expression<String>> getAddedHeaders()

Returns the header fields to add to the message, represented as a MultiMap of String to a List of String, each listed value representing an expression that will be evaluated.

Returns:

the header fields to add to the message.

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.