Package com.linecorp.armeria.client

Class DefaultClientRequestContext

java.lang.Object

com.linecorp.armeria.common.NonWrappingRequestContext

com.linecorp.armeria.client.DefaultClientRequestContext

All Implemented Interfaces:

ClientRequestContext, RequestContext

@UnstableApi
public final class DefaultClientRequestContext
extends NonWrappingRequestContext
implements ClientRequestContext

Default ClientRequestContext implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultClientRequestContext(MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, HttpMethod method, String path, @Nullable String query, @Nullable String fragment, ClientOptions options, @Nullable HttpRequest req, @Nullable RpcRequest rpcReq, RequestOptions requestOptions, long requestStartTimeNanos, long requestStartTimeMicros, boolean hasBaseUri)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addAdditionalRequestHeader(CharSequence name, Object value)	Adds a header with the specified name and value.
HttpHeaders	additionalRequestHeaders()	Returns an HttpHeaders which will be included when a Client sends an HttpRequest.
ByteBufAllocator	alloc()	Returns the ByteBufAllocator for this RequestContext.
void	cancel(Throwable cause)	Cancels the current Request with a Throwable.
@Nullable Throwable	cancellationCause()	Returns the cause of cancellation, null if the request has not been cancelled.
protected @Nullable Channel	channel()	Returns the Channel that is handling this request, or null if the connection is not established yet.
void	clearResponseTimeout()	Clears the previously scheduled response timeout, if any.
Endpoint	endpoint()	Returns the remote Endpoint of the current Request.
EndpointGroup	endpointGroup()	Returns the EndpointGroup used for the current Request.
ContextAwareEventLoop	eventLoop()	Returns the ContextAwareEventLoop that is handling the current Request.
void	finishInitialization(boolean success)	Completes the whenInitialized() with the specified value.
@Nullable String	fragment()	Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
CompletableFuture<Boolean>	init(EndpointGroup endpointGroup)	Initializes this context with the specified EndpointGroup.
RequestLogAccess	log()	Returns the RequestLogAccess that provides the access to the RequestLog, which contains the information collected while processing the current Request.
RequestLogBuilder	logBuilder()	Returns the RequestLogBuilder that collects the information about the current Request.
long	maxResponseLength()	Returns the maximum length of the received Response.
void	mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder> mutator)	Mutates the HttpHeaders which will be included when a Client sends an HttpRequest.
ClientRequestContext	newDerivedContext(RequestId id, @Nullable HttpRequest req, @Nullable RpcRequest rpcReq, @Nullable Endpoint endpoint)	Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having different Request, Endpoint and its own RequestLog.
ClientOptions	options()	Returns the ClientOptions of the current Request.
long	responseTimeoutMillis()	Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started or the Request was fully sent.
@Nullable ServiceRequestContext	root()	Returns the root ServiceRequestContext of this context.
void	setAdditionalRequestHeader(CharSequence name, Object value)	Sets a header with the specified name and value.
void	setMaxResponseLength(long maxResponseLength)	Sets the maximum length of the received Response.
void	setResponseTimeout(TimeoutMode mode, Duration responseTimeout)	Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent.
void	setResponseTimeoutMillis(TimeoutMode mode, long responseTimeoutMillis)	Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent.
void	setWriteTimeout(Duration writeTimeout)	Sets the amount of time allowed until the initial write attempt of the current Request succeeds.
void	setWriteTimeoutMillis(long writeTimeoutMillis)	Sets the amount of time allowed until the initial write attempt of the current Request succeeds.
@Nullable SSLSession	sslSession()	The SSLSession for this request if the connection is made over TLS, or null if the connection is not established yet or the connection is not a TLS connection.
String	toString()
protected void	validateHeaders(RequestHeaders headers)	Validates the specified RequestHeaders.
CompletableFuture<Boolean>	whenInitialized()	Returns a CompletableFuture that will be completed if this ClientRequestContext is initialized with an EndpointGroup.
CompletableFuture<Throwable>	whenResponseCancelled()	Returns a CompletableFuture which is completed with a Throwable cancellation cause after the ClientRequestContext has been cancelled.
CompletableFuture<Throwable>	whenResponseCancelling()	Returns a CompletableFuture which is completed with a Throwable cancellation cause when the ClientRequestContext is about to get cancelled.
CompletableFuture<Void>	whenResponseTimedOut()	Deprecated.
CompletableFuture<Void>	whenResponseTimingOut()	Deprecated.
long	writeTimeoutMillis()	Returns the amount of time allowed until the initial write attempt of the current Request succeeds.

Methods inherited from class com.linecorp.armeria.common.NonWrappingRequestContext

attr, attrs, decodedPath, hook, hook, id, localAddress, meterRegistry, method, ownAttr, ownAttrs, path, query, remoteAddress, request, rpcRequest, sessionProtocol, setAttr, unsafeUpdateRequest, updateRequest, updateRpcRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.ClientRequestContext

cancel, push, request, rpcRequest, setResponseTimeout, setResponseTimeoutMillis, timeoutNow

Methods inherited from interface com.linecorp.armeria.common.RequestContext

attr, attrs, decodedPath, hasAttr, hasOwnAttr, id, isCancelled, isTimedOut, localAddress, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, ownAttr, ownAttrs, path, query, remoteAddress, replace, run, run, sessionProtocol, setAttr, updateRequest, updateRpcRequest

Constructor Details

DefaultClientRequestContext

public DefaultClientRequestContext(MeterRegistry meterRegistry,
 SessionProtocol sessionProtocol,
 RequestId id,
 HttpMethod method,
 String path,
 @Nullable
 @Nullable String query,
 @Nullable
 @Nullable String fragment,
 ClientOptions options,
 @Nullable
 @Nullable HttpRequest req,
 @Nullable
 @Nullable RpcRequest rpcReq,
 RequestOptions requestOptions,
 long requestStartTimeNanos,
 long requestStartTimeMicros,
 boolean hasBaseUri)

Creates a new instance. Note that init(EndpointGroup) method must be invoked to finish the construction of this context.

Parameters:

sessionProtocol - the SessionProtocol of the invocation

id - the RequestId that contains the identifier of the current Request and Response pair.

req - the HttpRequest associated with this context

rpcReq - the RpcRequest associated with this context

requestStartTimeNanos - System.nanoTime() value when the request started.

requestStartTimeMicros - the number of microseconds since the epoch, e.g. System.currentTimeMillis() * 1000.

hasBaseUri - whether a Client which initiates this ClientRequestContext was created with a base URI.

Method Details

init

public CompletableFuture<Boolean> init(EndpointGroup endpointGroup)

Initializes this context with the specified EndpointGroup. This method must be invoked to finish the construction of this context.

Returns:

true if the initialization has succeeded. false if the initialization has failed and this context's RequestLog has been completed with the cause of the failure.

whenInitialized

public CompletableFuture<Boolean> whenInitialized()

Returns a CompletableFuture that will be completed if this ClientRequestContext is initialized with an EndpointGroup.

See Also:

init(EndpointGroup)

finishInitialization

public void finishInitialization(boolean success)

Completes the whenInitialized() with the specified value.

root

@Nullable
public @Nullable ServiceRequestContext root()

Description copied from interface: RequestContext

Returns the root ServiceRequestContext of this context.

Specified by:

root in interface RequestContext

Returns:

the root ServiceRequestContext, or null if this context was not created in the context of a server request.

newDerivedContext

public ClientRequestContext newDerivedContext(RequestId id,
 @Nullable
 @Nullable HttpRequest req,
 @Nullable
 @Nullable RpcRequest rpcReq,
 @Nullable
 @Nullable Endpoint endpoint)

Description copied from interface: ClientRequestContext

Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having different Request, Endpoint and its own RequestLog.

Note that this method does not copy the RequestLog properties to the derived context.

Specified by:

newDerivedContext in interface ClientRequestContext

validateHeaders

protected void validateHeaders(RequestHeaders headers)

Description copied from class: NonWrappingRequestContext

Validates the specified RequestHeaders. By default, this method will raise an IllegalArgumentException if it does not have ":scheme" or ":authority" header.

Overrides:

validateHeaders in class NonWrappingRequestContext

channel

@Nullable
protected @Nullable Channel channel()

Description copied from class: NonWrappingRequestContext

Returns the Channel that is handling this request, or null if the connection is not established yet.

Specified by:

channel in class NonWrappingRequestContext

eventLoop

public ContextAwareEventLoop eventLoop()

Description copied from interface: RequestContext

Returns the ContextAwareEventLoop that is handling the current Request. The ContextAwareEventLoop sets this RequestContext as the current context before executing any submitted tasks. If you want to use EventLoop without setting this context, call ContextAwareEventLoop.withoutContext() and use the returned EventLoop.

Specified by:

eventLoop in interface RequestContext

alloc

public ByteBufAllocator alloc()

Description copied from interface: RequestContext

Returns the ByteBufAllocator for this RequestContext. Any buffers created by this ByteBufAllocator must be reference-counted. If you don't know what this means, you should probably use byte[] or ByteBuffer directly instead of calling this method.

Specified by:

alloc in interface RequestContext

sslSession

@Nullable
public @Nullable SSLSession sslSession()

Description copied from interface: RequestContext

The SSLSession for this request if the connection is made over TLS, or null if the connection is not established yet or the connection is not a TLS connection.

Specified by:

sslSession in interface RequestContext

options

public ClientOptions options()

Description copied from interface: ClientRequestContext

Returns the ClientOptions of the current Request.

Specified by:

options in interface ClientRequestContext

endpointGroup

public EndpointGroup endpointGroup()

Description copied from interface: ClientRequestContext

Returns the EndpointGroup used for the current Request.

Specified by:

endpointGroup in interface ClientRequestContext

Returns:

the EndpointGroup if a user specified an EndpointGroup when initiating a Request. null if a user specified an Endpoint.

endpoint

public Endpoint endpoint()

Description copied from interface: ClientRequestContext

Returns the remote Endpoint of the current Request.

Specified by:

endpoint in interface ClientRequestContext

Returns:

the remote Endpoint, or null if the Request has failed because its remote Endpoint couldn't be determined.

fragment

@Nullable
public @Nullable String fragment()

Description copied from interface: ClientRequestContext

Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.

Specified by:

fragment in interface ClientRequestContext

Returns:

the fragment part of the request URI, or null if no fragment was specified

writeTimeoutMillis

public long writeTimeoutMillis()

Description copied from interface: ClientRequestContext

Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOptions.WRITE_TIMEOUT_MILLIS.

Specified by:

writeTimeoutMillis in interface ClientRequestContext

setWriteTimeoutMillis

public void setWriteTimeoutMillis(long writeTimeoutMillis)

Description copied from interface: ClientRequestContext

Sets the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOptions.WRITE_TIMEOUT_MILLIS.

Specified by:

setWriteTimeoutMillis in interface ClientRequestContext

setWriteTimeout

public void setWriteTimeout(Duration writeTimeout)

Description copied from interface: ClientRequestContext

Sets the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOptions.WRITE_TIMEOUT_MILLIS.

Specified by:

setWriteTimeout in interface ClientRequestContext

responseTimeoutMillis

public long responseTimeoutMillis()

Description copied from interface: ClientRequestContext

Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started or the Request was fully sent. This value is initially set from ClientOptions.RESPONSE_TIMEOUT_MILLIS.

Specified by:

responseTimeoutMillis in interface ClientRequestContext

clearResponseTimeout

public void clearResponseTimeout()

Description copied from interface: ClientRequestContext

Clears the previously scheduled response timeout, if any. Note that calling this will prevent the response from ever being timed out.

Specified by:

clearResponseTimeout in interface ClientRequestContext

setResponseTimeoutMillis

public void setResponseTimeoutMillis(TimeoutMode mode,
 long responseTimeoutMillis)

Description copied from interface: ClientRequestContext

Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent. This value is initially set from ClientOptions.RESPONSE_TIMEOUT_MILLIS.

timeout mode description

Timeout mode	description
TimeoutMode.SET_FROM_NOW	Sets a given amount of timeout from the current time.
TimeoutMode.SET_FROM_START	Sets a given amount of timeout since the current Response began processing.
TimeoutMode.EXTEND	Extends the previously scheduled timeout by the given amount of timeout.

For example:

 ClientRequestContext ctx = ...;
 // Schedules a timeout from the start time of the response
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, 2000);
 assert ctx.responseTimeoutMillis() == 2000;
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, 1000);
 assert ctx.responseTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_NOW, 3000);

 // Extends the previously scheduled timeout.
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.setResponseTimeoutMillis(TimeoutMode.EXTEND, 1000);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.extendResponseTimeoutMillis(TimeoutMode.EXTEND, -500);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;
 

Specified by:

setResponseTimeoutMillis in interface ClientRequestContext

setResponseTimeout

public void setResponseTimeout(TimeoutMode mode,
 Duration responseTimeout)

Description copied from interface: ClientRequestContext

Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent. This value is initially set from ClientOptions.RESPONSE_TIMEOUT_MILLIS.

timeout mode description

Timeout mode	description
TimeoutMode.SET_FROM_NOW	Sets a given amount of timeout from the current time.
TimeoutMode.SET_FROM_START	Sets a given amount of timeout since the current Response began processing.
TimeoutMode.EXTEND	Extends the previously scheduled timeout by the given amount of timeout.

For example:

 ClientRequestContext ctx = ...;
 // Schedules a timeout from the start time of the response
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, Duration.ofSeconds(2));
 assert ctx.responseTimeoutMillis() == 2000;
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_NOW, Duration.ofSeconds(3));

 // Extends the previously scheduled timeout.
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.setResponseTimeoutMillis(TimeoutMode.EXTEND, Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.setResponseTimeoutMillis(TimeoutMode.EXTEND, Duration.ofMillis(-500));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;
 

Specified by:

setResponseTimeout in interface ClientRequestContext

maxResponseLength

public long maxResponseLength()

Description copied from interface: ClientRequestContext

Returns the maximum length of the received Response. This value is initially set from ClientOptions.MAX_RESPONSE_LENGTH.

Specified by:

maxResponseLength in interface ClientRequestContext

Returns:

the maximum length of the response. 0 if unlimited.

See Also:

ContentTooLargeException

setMaxResponseLength

public void setMaxResponseLength(long maxResponseLength)

Description copied from interface: ClientRequestContext

Sets the maximum length of the received Response. This value is initially set from ClientOptions.MAX_RESPONSE_LENGTH. Specify 0 to disable the limit of the length of a response.

Specified by:

setMaxResponseLength in interface ClientRequestContext

See Also:

ContentTooLargeException

additionalRequestHeaders

public HttpHeaders additionalRequestHeaders()

Description copied from interface: ClientRequestContext

Returns an HttpHeaders which will be included when a Client sends an HttpRequest.

Specified by:

additionalRequestHeaders in interface ClientRequestContext

setAdditionalRequestHeader

public void setAdditionalRequestHeader(CharSequence name,
 Object value)

Description copied from interface: ClientRequestContext

Sets a header with the specified name and value. This will remove all previous values associated with the specified name. The header will be included when a Client sends an HttpRequest.

Specified by:

setAdditionalRequestHeader in interface ClientRequestContext

addAdditionalRequestHeader

public void addAdditionalRequestHeader(CharSequence name,
 Object value)

Description copied from interface: ClientRequestContext

Adds a header with the specified name and value. The header will be included when a Client sends an HttpRequest.

Specified by:

addAdditionalRequestHeader in interface ClientRequestContext

mutateAdditionalRequestHeaders

public void mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder> mutator)

Description copied from interface: ClientRequestContext

Mutates the HttpHeaders which will be included when a Client sends an HttpRequest.

Specified by:

mutateAdditionalRequestHeaders in interface ClientRequestContext

Parameters:

mutator - the Consumer that mutates the additional request headers

log

public RequestLogAccess log()

Description copied from interface: RequestContext

Returns the RequestLogAccess that provides the access to the RequestLog, which contains the information collected while processing the current Request.

Specified by:

log in interface RequestContext

logBuilder

public RequestLogBuilder logBuilder()

Description copied from interface: RequestContext

Returns the RequestLogBuilder that collects the information about the current Request.

Specified by:

logBuilder in interface RequestContext

cancel

public void cancel(Throwable cause)

Description copied from interface: RequestContext

Cancels the current Request with a Throwable.

Specified by:

cancel in interface RequestContext

cancellationCause

@Nullable
public @Nullable Throwable cancellationCause()

Description copied from interface: RequestContext

Returns the cause of cancellation, null if the request has not been cancelled.

Specified by:

cancellationCause in interface RequestContext

whenResponseCancelling

public CompletableFuture<Throwable> whenResponseCancelling()

Description copied from interface: ClientRequestContext

Returns a CompletableFuture which is completed with a Throwable cancellation cause when the ClientRequestContext is about to get cancelled. If the response is handled successfully without cancellation, the CompletableFuture won't complete.

Specified by:

whenResponseCancelling in interface ClientRequestContext

whenResponseCancelled

public CompletableFuture<Throwable> whenResponseCancelled()

Description copied from interface: ClientRequestContext

Returns a CompletableFuture which is completed with a Throwable cancellation cause after the ClientRequestContext has been cancelled. RequestContext.isCancelled() will always return true when the returned CompletableFuture is completed. If the response is handled successfully without cancellation, the CompletableFuture won't complete.

Specified by:

whenResponseCancelled in interface ClientRequestContext

whenResponseTimingOut

@Deprecated
public CompletableFuture<Void> whenResponseTimingOut()

Deprecated.

Description copied from interface: ClientRequestContext

Returns a CompletableFuture which is completed when the ClientRequestContext is about to get timed out. If the response is handled successfully or not cancelled by timeout, the CompletableFuture won't complete.

Specified by:

whenResponseTimingOut in interface ClientRequestContext

whenResponseTimedOut

@Deprecated
public CompletableFuture<Void> whenResponseTimedOut()

Deprecated.

Description copied from interface: ClientRequestContext

Returns a CompletableFuture which is completed after the ClientRequestContext has been timed out. RequestContext.isTimedOut() will always return true when the returned CompletableFuture is completed. If the response is handled successfully or not cancelled by timeout, the CompletableFuture won't complete.

Specified by:

whenResponseTimedOut in interface ClientRequestContext

toString

public String toString()

Overrides:

toString in class Object