public class EnforcerFilter extends GenericFilter
EnforcerFilter
makes sure that the handled Exchange
verifies a condition.
If the condition is not verified, it simply throws a HandlerException
(that actually stops the chain
execution).logger, storage
Constructor and Description |
---|
EnforcerFilter(Expression enforcement,
Filter delegate)
Creates a new
EnforcerFilter delegating to the given Filter if the enforcement expression yields
true. |
public EnforcerFilter(Expression enforcement, Filter delegate)
EnforcerFilter
delegating to the given Filter
if the enforcement expression yields
true.enforcement
- Expression
that needs to evaluates to true for the delegating Filter to be executed.delegate
- Filter instance to delegate to.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.