io.reactivex.netty.contexts

Interface RequestCorrelator

All Superinterfaces:

ContextCapturer

All Known Implementing Classes:

ThreadLocalRequestCorrelator

public interface RequestCorrelator
extends ContextCapturer

Passing contexts from inbound request processing to outbound request sending can be very application specific. Some applications may just use a single thread between the inbound and outbound processing and some may spawn off multiple threads to process the request and hence needs to transfer the ContextsContainer instance from the server processing the request to a client sending an outbound request as part of the original request processing.
Since, this is application specific, this module delegates this particular decision to an implementation of this interface. The actual implementation can choose a medium specific to their application.

Method Summary

Modifier and Type	Method and Description
void	beforeNewClientRequest(java.lang.String requestId, ContextsContainer contextsContainer) A callback before a client request is made.
ContextsContainer	getContextForClientRequest(java.lang.String requestId) This method does the correlation between the inbound ContextsContainer to a fresh client request.
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.
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 interface io.reactivex.netty.contexts.ContextCapturer

makeClosure, makeClosure

Method Detail

getRequestIdForClientRequest

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.

Returns:

The request id, if exists. null otherwise.

getContextForClientRequest

ContextsContainer getContextForClientRequest(java.lang.String requestId)

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

Parameters:

requestId - Request Id for this request. Can be null

Returns:

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

onNewServerRequest

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

A callback for a fresh request on the underlying channel.

Parameters:

requestId - Request Id for this request.

contextsContainer - Container for this request.

beforeNewClientRequest

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

A callback before a client request is made. This will almost always be identical to 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 getRequestIdForClientRequest() and getContextForClientRequest(String) which is the reason why this context setting is required.

Parameters:

requestId - Request Id for this request.

contextsContainer - Container for this request.

onClientProcessingEnd

void onClientProcessingEnd(java.lang.String requestId)

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,

Parameters:

requestId - Request id for which the processing is over.

onServerProcessingEnd

void onServerProcessingEnd(java.lang.String requestId)

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

Parameters:

requestId - Request id for which the processing is over.