public class ScriptableFilter extends AbstractScriptableHeapObject implements Filter
globals- the Map of global variables which persist across successive invocations of the script
exchange- the HTTP exchange
http- an OpenIG HTTP client which may be used for performing outbound HTTP requests
ldap- an OpenIG LDAP client which may be used for performing LDAP requests such as LDAP authentication
logger- the OpenIG logger
next- the next handler in the filter chain.
NOTE: at the moment only Groovy is supported.
|Modifier and Type||Class and Description|
Creates and initializes a scriptable filter in a heap environment.
|Modifier and Type||Method and Description|
Filters the request and/or response of an exchange.
public void filter(Exchange exchange, Handler next) throws HandlerException, IOException
exchange.requestcontains 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.responsecontains 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
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.