public class TransactionIdInboundFilter extends Object implements Filter
TransactionIdContext
in the context's chain. If the incoming request
contains the header "X-ForgeRock-TransactionId" then it uses that value as the transaction id otherwise a new one is
generated.Modifier and Type | Field and Description |
---|---|
static String |
SYSPROP_TRUST_TRANSACTION_HEADER
The system property to allow to trust the HTTP header X-ForgeRock-TransactionId.
|
Constructor and Description |
---|
TransactionIdInboundFilter()
Deprecated.
|
TransactionIdInboundFilter(boolean trustTransactionIdHeader)
Constructor that defines whether or not HTTP request transaction ID headers should be trusted.
|
TransactionIdInboundFilter(BooleanSupplier trustTransactionIdHeader)
Constructor that defines whether or not HTTP request transaction ID headers should be trusted.
|
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.
|
public static final String SYSPROP_TRUST_TRANSACTION_HEADER
@Deprecated public TransactionIdInboundFilter()
TransactionIdInboundFilter.TransactionIdInboundFilter(boolean)
TransactionIdInboundFilter.SYSPROP_TRUST_TRANSACTION_HEADER
JVM system property,
to determine whether or not HTTP request transaction ID headers should be trusted. If the software application
uses utility classes to manage/override property values, then the TransactionIdInboundFilter.TransactionIdInboundFilter(boolean)
constructor should be used.public TransactionIdInboundFilter(boolean trustTransactionIdHeader)
trustTransactionIdHeader
- true
to trust HTTP request transaction ID headers and false
otherwisepublic TransactionIdInboundFilter(BooleanSupplier trustTransactionIdHeader)
trustTransactionIdHeader
- returns true
to trust HTTP request transaction ID headers and false
otherwisepublic 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 © 2010-2018, ForgeRock All Rights Reserved.