public class HeaderFilter extends Object implements Filter
Modifier and Type | Class and Description |
---|---|
static class |
HeaderFilter.Heaplet
Creates and initializes a header filter in a heap environment.
|
Constructor and Description |
---|
HeaderFilter(MessageType messageType)
Builds a HeaderFilter processing either the incoming or outgoing message.
|
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.
|
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.
|
public HeaderFilter(MessageType messageType)
messageType
- MessageType.REQUEST
or MessageType.RESPONSE
public CaseInsensitiveSet getRemovedHeaders()
public MultiValueMap<String,Expression<String>> getAddedHeaders()
public Promise<Response,NeverThrowsException> filter(Context context, Request request, Handler next)
Filter
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.
Copyright 2011-2015 ForgeRock AS.