public class EntityExtractFilter extends Object implements Filter
messageType
is MessageType.REQUEST
, or
after the request is handled if it is MessageType.RESPONSE
. Each pattern can have
an associated template, which is applied to its match result.
The extraction results are contained in a Map
object, whose location is specified
by the target
expression. For a given matched pattern, the value stored in the map
is either the result of applying its associated pattern template (if specified) or the
match result itself otherwise.
StreamPatternExtractor
,
PatternTemplate
Modifier and Type | Class and Description |
---|---|
static class |
EntityExtractFilter.Heaplet
Creates and initializes an entity extract handler in a heap environment.
|
Constructor and Description |
---|
EntityExtractFilter(MessageType type,
LeftValueExpression<?> target)
Builds an EntityExtractFilter that will act either on
MessageType.REQUEST or MessageType.RESPONSE
flow, extracting patterns into the given target Expression . |
EntityExtractFilter(MessageType type,
LeftValueExpression<?> target,
Charset charset)
Builds an EntityExtractFilter that will act either on
MessageType.REQUEST or MessageType.RESPONSE
flow, extracting patterns into the given target Expression . |
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.
|
StreamPatternExtractor |
getExtractor()
Returns the regular expression patterns extractor.
|
public EntityExtractFilter(MessageType type, LeftValueExpression<?> target)
MessageType.REQUEST
or MessageType.RESPONSE
flow, extracting patterns into the given target
Expression
. The Charset
used is the one
of the message.type
- Specifies the execution flow to be executed intarget
- Expression that yields the target object that will contain the mapped extraction resultspublic EntityExtractFilter(MessageType type, LeftValueExpression<?> target, Charset charset)
MessageType.REQUEST
or MessageType.RESPONSE
flow, extracting patterns into the given target
Expression
. The Charset
used is the one
specified.type
- Specifies the execution flow to be executed intarget
- Expression that yields the target object that will contain the mapped extraction resultscharset
- Overrides the character set encoding specified in message. If null
, the message encoding is usedpublic StreamPatternExtractor getExtractor()
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.