Package org.forgerock.opentelemetry.trace.chf

Class TracingOutboundFilter

java.lang.Object

org.forgerock.opentelemetry.trace.chf.TracingOutboundFilter

All Implemented Interfaces:

Filter

public final class TracingOutboundFilter
extends Object
implements Filter

A CHF Filter to insert tracing span info into a request that is sent outbound.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TracingOutboundFilter.TracingOutboundFilterConfig	Creates a configuration object used to instantiate a TracingInboundFilter.

Constructor Summary

Constructors

Constructor	Description
TracingOutboundFilter(TracingOutboundFilter.TracingOutboundFilterConfig config)	Constructor.

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

Constructor Details

TracingOutboundFilter

public TracingOutboundFilter(TracingOutboundFilter.TracingOutboundFilterConfig config)

Constructor.

Parameters:

config - a configuration object to instantiate a TracingOutboundFilter

Method Details

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.