io.reactivex.netty.contexts.http

Class HttpRequestIdProvider

java.lang.Object

io.reactivex.netty.contexts.http.HttpRequestIdProvider

All Implemented Interfaces:

RequestIdGenerator, RequestIdProvider

public class HttpRequestIdProvider
extends java.lang.Object
implements RequestIdProvider

An implementation of RequestIdProvider for HTTP protocol.
This implementation honors HTTP pipelining and hence maintains a queue of request Ids generated on the same connection. The request Ids from the queue are removed when a response is set in the order they were received.
Since, HTTP pipelining defines that the responses should be sent from the server in the same order they were received, this implementation uses a Queue to store and find request Ids for the responses sent from here.

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<java.util.concurrent.ConcurrentLinkedQueue<java.lang.String>>	REQUEST_IDS_KEY

Constructor Summary

Constructors

Constructor and Description
HttpRequestIdProvider(RequestIdGenerator requestIdGenerator, RequestCorrelator requestCorrelator, java.lang.String requestIdHeaderName)
HttpRequestIdProvider(java.lang.String requestIdHeaderName, RequestCorrelator requestCorrelator)

Method Summary

Modifier and Type	Method and Description
java.lang.String	beforeClientRequest(io.netty.util.AttributeMap clientAttributeMap) This does the correlation between an inbound request and all outbound requests that are made during the processing of the same request.
java.lang.String	beforeServerResponse(ContextKeySupplier responseKeySupplier, io.netty.util.AttributeMap channelAttributeMap) This is primarily for response-request correlation for protocols that support multiple requests on the same connection, eg: using HTTP pipelining.
java.lang.String	getRequestIdContextKeyName() Name of the context key (to be obtained via ContextKeySupplier) that is to be used to transfer the request identifier from one machine to another.
java.lang.String	newRequestId(ContextKeySupplier keySupplier, io.netty.util.AttributeMap channelAttributeMap) Generates a globally unique request identifier.
java.lang.String	onClientResponse(io.netty.util.AttributeMap clientAttributeMap) Specifies the request id to be used while receiving a response for a client.
java.lang.String	onServerRequest(ContextKeySupplier keySupplier, io.netty.util.AttributeMap channelAttributeMap) Inspects the keySupplier or context to see if there is a request Id already defined for this request.

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_IDS_KEY

public static final io.netty.util.AttributeKey<java.util.concurrent.ConcurrentLinkedQueue<java.lang.String>> REQUEST_IDS_KEY

Constructor Detail

HttpRequestIdProvider

public HttpRequestIdProvider(RequestIdGenerator requestIdGenerator,
                             RequestCorrelator requestCorrelator,
                             java.lang.String requestIdHeaderName)

HttpRequestIdProvider

public HttpRequestIdProvider(java.lang.String requestIdHeaderName,
                             RequestCorrelator requestCorrelator)

Method Detail

newRequestId

public java.lang.String newRequestId(ContextKeySupplier keySupplier,
                                     io.netty.util.AttributeMap channelAttributeMap)

Description copied from interface: RequestIdGenerator

Generates a globally unique request identifier.

Specified by:

newRequestId in interface RequestIdGenerator

Parameters:

keySupplier - ContextKeySupplier for the request.

channelAttributeMap - Channel attribute map, normally obtained as ChannelHandlerContext.channel()

Returns:

The newly generated request id.

onServerRequest

public java.lang.String onServerRequest(ContextKeySupplier keySupplier,
                                        io.netty.util.AttributeMap channelAttributeMap)

Description copied from interface: RequestIdProvider

Inspects the keySupplier or context to see if there is a request Id already defined for this request. If it is, then it returns the same, else returns null * This method is NOT idempotent

Specified by:

onServerRequest in interface RequestIdProvider

Parameters:

keySupplier - The key supplier where usually an externally defined request Id is present.

channelAttributeMap - Channel attribute map, normally obtained as ChannelHandlerContext.channel()

Returns:

The request Identified or null if none exists.

beforeServerResponse

public java.lang.String beforeServerResponse(ContextKeySupplier responseKeySupplier,
                                             io.netty.util.AttributeMap channelAttributeMap)

Description copied from interface: RequestIdProvider

This is primarily for response-request correlation for protocols that support multiple requests on the same connection, eg: using HTTP pipelining.
This method is NOT idempotent

Specified by:

beforeServerResponse in interface RequestIdProvider

Parameters:

responseKeySupplier - ContextKeySupplier for the response.

channelAttributeMap - Channel attribute map, normally obtained as ChannelHandlerContext.channel()

Returns:

The request id, if exists. null otherwise.

beforeClientRequest

public java.lang.String beforeClientRequest(io.netty.util.AttributeMap clientAttributeMap)

Description copied from interface: RequestIdProvider

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

Specified by:

beforeClientRequest in interface RequestIdProvider

Parameters:

clientAttributeMap - Client's channel attribute map, normally obtained as ChannelHandlerContext.channel()

Returns:

The request id, if exists. null otherwise.

onClientResponse

public java.lang.String onClientResponse(io.netty.util.AttributeMap clientAttributeMap)

Description copied from interface: RequestIdProvider

Specifies the request id to be used while receiving a response for a client.
This method is NOT idempotent

Specified by:

onClientResponse in interface RequestIdProvider

Parameters:

clientAttributeMap - Client's channel attribute map, normally obtained as ChannelHandlerContext.channel()

Returns:

The request id, if exists. null otherwise.

getRequestIdContextKeyName

public java.lang.String getRequestIdContextKeyName()

Description copied from interface: RequestIdProvider

Name of the context key (to be obtained via ContextKeySupplier) that is to be used to transfer the request identifier from one machine to another.

Specified by:

getRequestIdContextKeyName in interface RequestIdProvider

Returns:

The name of the context key for request id.