Package org.forgerock.http.filter

Class TransactionIdInboundFilter

java.lang.Object

org.forgerock.http.filter.TransactionIdInboundFilter

All Implemented Interfaces:

Filter

public class TransactionIdInboundFilter
extends Object
implements Filter

This filter is responsible to create the 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SYSPROP_TRUST_TRANSACTION_HEADER	The system property to allow to trust the HTTP header X-ForgeRock-TransactionId.

Constructor Summary

Constructors

Constructor	Description
TransactionIdInboundFilter()	Deprecated. Replaced by TransactionIdInboundFilter(boolean)
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.

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSPROP_TRUST_TRANSACTION_HEADER

public static final String SYSPROP_TRUST_TRANSACTION_HEADER

The system property to allow to trust the HTTP header X-ForgeRock-TransactionId.

See Also:

Constant Field Values

Constructor Detail

TransactionIdInboundFilter

@Deprecated
public TransactionIdInboundFilter()

Deprecated.

Replaced by TransactionIdInboundFilter(boolean)

Constructor that reads the value of the boolean 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(boolean) constructor should be used.

TransactionIdInboundFilter

public TransactionIdInboundFilter(boolean trustTransactionIdHeader)

Constructor that defines whether or not HTTP request transaction ID headers should be trusted.

Parameters:

trustTransactionIdHeader - true to trust HTTP request transaction ID headers and false otherwise

TransactionIdInboundFilter

public TransactionIdInboundFilter(BooleanSupplier trustTransactionIdHeader)

Constructor that defines whether or not HTTP request transaction ID headers should be trusted.

Parameters:

trustTransactionIdHeader - returns true to trust HTTP request transaction ID headers and false otherwise

Method Detail

filter

public Promise<Response,NeverThrowsException> filter(Context context,
                                                           Request request,
                                                           Handler next)

Description copied from interface: Filter

Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls 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.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.