public class HeaderFilter extends GenericFilter
Modifier and Type | Class and Description |
---|---|
static class |
HeaderFilter.Heaplet
Creates and initializes a header filter in a heap environment.
|
logger, storage
Constructor and Description |
---|
HeaderFilter(MessageType messageType)
Builds a HeaderFilter processing either the incoming or outgoing message.
|
Modifier and Type | Method and Description |
---|---|
void |
filter(Exchange exchange,
Handler next)
Filters the request and/or response of an exchange.
|
Headers |
getAddedHeaders()
Returns the header fields to add to the message.
|
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 Headers getAddedHeaders()
public void filter(Exchange exchange, Handler next) throws HandlerException, IOException
Filter
exchange.request
contains the request to be filtered. To pass the request to the next filter or handler
in the chain, the filter calls next.handle(exchange)
. After this call,
exchange.response
contains the response that can be filtered.
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(exchange)
and creating its own response object the exchange. The
filter is also at liberty to replace a response with another of its own after the call
to next.handle(exchange)
.
Important note: If an existing response exists in the exchange object
and the filter intends to replace it with its own, it must first check to see if the
existing response has an entity, and if it does, must call its close
method in
order to signal that the processing of the response from a remote server is complete.
exchange
- the exchange containing the request and response to filter.next
- the next filter or handler in the chain to handle the exchange.HandlerException
- if an exception occurred handling the exchange.IOException
- if an I/O exception occurred.Copyright © 2014 ForgeRock AS. All rights reserved.