public class AssignmentFilter extends GenericFilter
Modifier and Type | Class and Description |
---|---|
static class |
AssignmentFilter.Heaplet
Creates and initializes an assignment filter in a heap environment.
|
logger, storage
Constructor and Description |
---|
AssignmentFilter() |
Modifier and Type | Method and Description |
---|---|
AssignmentFilter |
addRequestBinding(Expression target)
Registers an unconditional (always executed) binding on the request flow.
|
AssignmentFilter |
addRequestBinding(Expression target,
Expression value)
Registers an unconditional (always executed) binding on the request flow.
|
AssignmentFilter |
addRequestBinding(Expression condition,
Expression target,
Expression value)
Registers a conditional binding on the request flow.
|
AssignmentFilter |
addResponseBinding(Expression target)
Registers an unconditional (always executed) binding on the response flow.
|
AssignmentFilter |
addResponseBinding(Expression target,
Expression value)
Registers an unconditional (always executed) binding on the response flow.
|
AssignmentFilter |
addResponseBinding(Expression condition,
Expression target,
Expression value)
Registers a conditional binding on the response flow.
|
void |
filter(Exchange exchange,
Handler next)
Filters the request and/or response of an exchange.
|
public AssignmentFilter()
public AssignmentFilter addRequestBinding(Expression target)
target
- Expression that yields the target object whose value is to be setpublic AssignmentFilter addRequestBinding(Expression target, Expression value)
Expression
.target
- Expression that yields the target object whose value is to be setvalue
- Expression that yields the value to be set in the target (may be null)public AssignmentFilter addRequestBinding(Expression condition, Expression target, Expression value)
Expression
.condition
- Condition to evaluate to determine if assignment should occur (may be null, aka
unconditional)target
- Expression that yields the target object whose value is to be setvalue
- Expression that yields the value to be set in the target (may be null)public AssignmentFilter addResponseBinding(Expression target)
target
- Expression that yields the target object whose value is to be setpublic AssignmentFilter addResponseBinding(Expression target, Expression value)
Expression
.target
- Expression that yields the target object whose value is to be setvalue
- Expression that yields the value to be set in the target (may be null)public AssignmentFilter addResponseBinding(Expression condition, Expression target, Expression value)
Expression
.condition
- Condition to evaluate to determine if assignment should occur (may be null, aka
unconditional)target
- Expression that yields the target object whose value is to be setvalue
- Expression that yields the value to be set in the target (may be null)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.