io.reactivex.netty.contexts

Class ThreadLocalRequestCorrelator

java.lang.Object

io.reactivex.netty.contexts.ThreadLocalRequestCorrelator

All Implemented Interfaces:

ContextCapturer, RequestCorrelator

public class ThreadLocalRequestCorrelator
extends java.lang.Object
implements RequestCorrelator

An implementation of RequestCorrelator that fetches ContextsContainer and request Identifer from ThreadLocal variables.
The usage of this correlator assumes that every EventLoopGroup used by all RxClients in use for the propagation of these contexts, uses ContextAwareEventLoopGroup.
In case, the application is using any other threadpools, the invariant of the thread state copied from one thread to another is maintained.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThreadLocalRequestCorrelator.ThreadStateHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.ThreadLocal<ThreadLocalRequestCorrelator.ThreadStateHolder>	state

Constructor Summary

Constructors

Constructor and Description
ThreadLocalRequestCorrelator()

Method Summary

Modifier and Type	Method and Description
void	beforeNewClientRequest(java.lang.String requestId, ContextsContainer contextsContainer) A callback before a client request is made.
void	dumpThreadState()
void	dumpThreadState(java.io.PrintStream outputStream)
ContextsContainer	getContextForClientRequest(java.lang.String requestId) This method does the correlation between the inbound ContextsContainer to a fresh client request.
static ContextsContainer	getCurrentContextContainer()
static java.lang.String	getCurrentRequestId()
java.lang.String	getRequestIdForClientRequest() This does the correlation between an inbound request and all outbound requests that are made during the processing of the same request.
<V> java.util.concurrent.Callable<V>	makeClosure(java.util.concurrent.Callable<V> original) Encloses the passed Callable into a closure so that it can capture the contexts as it exists when this Callable is created and use it during the context's execution, which happens in a different thread.
java.lang.Runnable	makeClosure(java.lang.Runnable original) Encloses the passed Runnable into a closure so that it can capture the contexts as it exists when this Runnable is created and use it during the context's execution, which happens in a different thread.
void	onClientProcessingEnd(java.lang.String requestId) A callback when a client is done with the processing of the passed requestId.
void	onNewServerRequest(java.lang.String requestId, ContextsContainer contextsContainer) A callback for a fresh request on the underlying channel.
void	onServerProcessingEnd(java.lang.String requestId) A callback when the entire request processing is over for the passed requestId

Methods inherited from class java.lang.Object

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

Field Detail

state

protected static final java.lang.ThreadLocal<ThreadLocalRequestCorrelator.ThreadStateHolder> state

Constructor Detail

ThreadLocalRequestCorrelator

public ThreadLocalRequestCorrelator()

Method Detail

getRequestIdForClientRequest

public java.lang.String getRequestIdForClientRequest()

Description copied from interface: RequestCorrelator

This does the correlation between an inbound request and all outbound requests that are made during the processing of the same request.

Specified by:

getRequestIdForClientRequest in interface RequestCorrelator

Returns:

The request id, if exists. null otherwise.

getContextForClientRequest

public ContextsContainer getContextForClientRequest(java.lang.String requestId)

Description copied from interface: RequestCorrelator

This method does the correlation between the inbound ContextsContainer to a fresh client request.

Specified by:

getContextForClientRequest in interface RequestCorrelator

Parameters:

requestId - Request Id for this request. Can be null

Returns:

ContextsContainer for this request, if any. null if none exists.

onNewServerRequest

public void onNewServerRequest(java.lang.String requestId,
                               ContextsContainer contextsContainer)

Description copied from interface: RequestCorrelator

A callback for a fresh request on the underlying channel.

Specified by:

onNewServerRequest in interface RequestCorrelator

Parameters:

requestId - Request Id for this request.

contextsContainer - Container for this request.

beforeNewClientRequest

public void beforeNewClientRequest(java.lang.String requestId,
                                   ContextsContainer contextsContainer)

Description copied from interface: RequestCorrelator

A callback before a client request is made. This will almost always be identical to RequestCorrelator.onNewServerRequest(String, ContextsContainer). This method is provided to be explicit on when these callbacks are made.
This will generally be made at a different point (usually when the connection is established by the client for making a request) than RequestCorrelator.getRequestIdForClientRequest() and RequestCorrelator.getContextForClientRequest(String) which is the reason why this context setting is required.

Specified by:

beforeNewClientRequest in interface RequestCorrelator

Parameters:

requestId - Request Id for this request.

contextsContainer - Container for this request.

onClientProcessingEnd

public void onClientProcessingEnd(java.lang.String requestId)

Description copied from interface: RequestCorrelator

A callback when a client is done with the processing of the passed requestId.
All implementations must be aware of the fact that there may be many clients invoked in a processing of a single request,

Specified by:

onClientProcessingEnd in interface RequestCorrelator

Parameters:

requestId - Request id for which the processing is over.

onServerProcessingEnd

public void onServerProcessingEnd(java.lang.String requestId)

Description copied from interface: RequestCorrelator

A callback when the entire request processing is over for the passed requestId

Specified by:

onServerProcessingEnd in interface RequestCorrelator

Parameters:

requestId - Request id for which the processing is over.

getCurrentContextContainer

public static ContextsContainer getCurrentContextContainer()

getCurrentRequestId

public static java.lang.String getCurrentRequestId()

makeClosure

public <V> java.util.concurrent.Callable<V> makeClosure(java.util.concurrent.Callable<V> original)

Description copied from interface: ContextCapturer

Encloses the passed Callable into a closure so that it can capture the contexts as it exists when this Callable is created and use it during the context's execution, which happens in a different thread.

Specified by:

makeClosure in interface ContextCapturer

Type Parameters:

V - Return type of the Callable

Parameters:

original - Original Callable to be invoked from the closure.

Returns:

The closure enclosing the original Callable

makeClosure

public java.lang.Runnable makeClosure(java.lang.Runnable original)

Description copied from interface: ContextCapturer

Encloses the passed Runnable into a closure so that it can capture the contexts as it exists when this Runnable is created and use it during the context's execution, which happens in a different thread.

Specified by:

makeClosure in interface ContextCapturer

Parameters:

original - Original Runnable to be invoked from the closure.

Returns:

The closure enclosing the original Runnable

dumpThreadState

public void dumpThreadState()

dumpThreadState

public void dumpThreadState(java.io.PrintStream outputStream)