Package com.linecorp.armeria.client

Class ClientRequestContextWrapper

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<ClientRequestContext>

com.linecorp.armeria.common.RequestContextWrapper<ClientRequestContext>

com.linecorp.armeria.client.ClientRequestContextWrapper

All Implemented Interfaces:

ClientRequestContext, RequestContext, Unwrappable

public class ClientRequestContextWrapper
extends RequestContextWrapper<ClientRequestContext>
implements ClientRequestContext

Wraps an existing ClientRequestContext.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClientRequestContextWrapper(ClientRequestContext delegate)	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.
String	authority()	Returns the authority which will eventually be sent when a Client sends an HttpRequest.
void	clearResponseTimeout()	Clears the previously scheduled response timeout, if any.
HttpHeaders	defaultRequestHeaders()	Returns the default HttpHeaders which will be included when a Client sends an HttpRequest.
Endpoint	endpoint()	Returns the remote Endpoint of the current Request.
EndpointGroup	endpointGroup()	Returns the EndpointGroup used for the current Request.
ExchangeType	exchangeType()	Returns the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.
String	fragment()	Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
Supplier<AutoCloseable>	hook()	Returns the hook which is invoked whenever this RequestContext is pushed to the RequestContextStorage.
void	hook(Supplier<? extends AutoCloseable> contextHook)	Adds a hook which is invoked whenever this RequestContext is pushed to the RequestContextStorage.
String	host()	Returns the host part of ClientRequestContext.authority(), without a port number.
boolean	isCancelled()	Returns whether this RequestContext has been cancelled.
boolean	isTimedOut()	Returns whether this RequestContext has been timed-out, that is the cancellation cause is an instance of TimeoutException.
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.
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.
ClientRequestContext	unwrapAll()	Unwraps this object and returns the innermost object being decorated.
URI	uri()	Returns the URI associated with the current Request.
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.RequestContextWrapper

alloc, attr, attrs, cancel, cancel, cancellationCause, decodedPath, delegate, eventLoop, hasAttr, hasOwnAttr, id, initiateConnectionShutdown, localAddress, log, logBuilder, meterRegistry, method, ownAttr, ownAttrs, path, query, remoteAddress, request, requestAutoAbortDelayMillis, root, rpcRequest, sessionProtocol, setAttr, setRequestAutoAbortDelay, setRequestAutoAbortDelayMillis, sslSession, timeoutNow, toString, updateRequest, updateRpcRequest

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, unwrap

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, initiateConnectionShutdown, push, request, rpcRequest, setResponseTimeout, setResponseTimeoutMillis, timeoutNow, unwrap

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

alloc, attr, attrs, cancel, cancellationCause, decodedPath, eventLoop, hasAttr, hasOwnAttr, id, localAddress, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, ownAttr, ownAttrs, path, query, remoteAddress, replace, requestAutoAbortDelayMillis, root, run, run, sessionProtocol, setAttr, setRequestAutoAbortDelay, setRequestAutoAbortDelayMillis, sslSession, updateRequest, updateRpcRequest

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

as, equalsIgnoreWrapper

Constructor Details

ClientRequestContextWrapper

protected ClientRequestContextWrapper(ClientRequestContext delegate)

Creates a new instance.

Method Details

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

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

public 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

authority

public String authority()

Description copied from interface: ClientRequestContext

Returns the authority which will eventually be sent when a Client sends an HttpRequest. This method checks the following locations and returns the first non-null value.

1. Either the HttpHeaderNames.HOST or HttpHeaderNames.AUTHORITY value from ClientRequestContext.additionalRequestHeaders().
2. The HttpRequest.authority() from ClientRequestContext.request().
3. ClientRequestContext.defaultRequestHeaders().
4. Endpoint.authority().

Specified by:

authority in interface ClientRequestContext

host

public String host()

Description copied from interface: ClientRequestContext

Returns the host part of ClientRequestContext.authority(), without a port number.

Specified by:

host in interface ClientRequestContext

uri

public URI uri()

Description copied from interface: RequestContext

Returns the URI associated with the current Request.

Specified by:

uri in interface ClientRequestContext

Specified by:

uri in interface RequestContext

Overrides:

uri in class RequestContextWrapper<ClientRequestContext>

See Also:

• ServiceRequestContext.uri()
• ClientRequestContext.uri()

options

public ClientOptions options()

Description copied from interface: ClientRequestContext

Returns the ClientOptions of the current Request.

Specified by:

options in interface ClientRequestContext

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

defaultRequestHeaders

public HttpHeaders defaultRequestHeaders()

Description copied from interface: ClientRequestContext

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

Note that the values of the default HttpHeaders could be overridden if the same HttpHeaderNames are defined in HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Specified by:

defaultRequestHeaders in interface ClientRequestContext

See Also:

• AbstractClientOptionsBuilder.addHeader(CharSequence, Object)

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

exchangeType

public ExchangeType exchangeType()

Description copied from interface: RequestContext

Returns the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.

Specified by:

exchangeType in interface ClientRequestContext

Specified by:

exchangeType in interface RequestContext

Overrides:

exchangeType in class RequestContextWrapper<ClientRequestContext>

hook

public void hook(Supplier<? extends AutoCloseable> contextHook)

Description copied from interface: RequestContext

Adds a hook which is invoked whenever this RequestContext is pushed to the RequestContextStorage. The AutoCloseable returned by contextHook will be called whenever this RequestContext is popped from the RequestContextStorage. This method is useful when you need to propagate a custom context in this RequestContext's scope.

Note:

• The contextHook is not invoked when this RequestContext.hook(Supplier) method is called thus you need to call it yourself if you want to apply the hook in the current thread.
• This operation is highly performance-sensitive operation, and thus it's not a good idea to run a time-consuming task.

Specified by:

hook in interface RequestContext

hook

public Supplier<AutoCloseable> hook()

Description copied from interface: RequestContext

Returns the hook which is invoked whenever this RequestContext is pushed to the RequestContextStorage. The SafeCloseable returned by the Supplier will be called whenever this RequestContext is popped from the RequestContextStorage.

Specified by:

hook in interface RequestContext

isCancelled

public boolean isCancelled()

Description copied from interface: RequestContext

Returns whether this RequestContext has been cancelled.

Specified by:

isCancelled in interface RequestContext

isTimedOut

public boolean isTimedOut()

Description copied from interface: RequestContext

Returns whether this RequestContext has been timed-out, that is the cancellation cause is an instance of TimeoutException.

Specified by:

isTimedOut 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

unwrapAll

public ClientRequestContext unwrapAll()

Description copied from interface: Unwrappable

Unwraps this object and returns the innermost object being decorated. If this Unwrappable is the innermost object, this method returns itself. For example:

 class Foo implements Unwrappable {}

 class Bar<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Bar(T delegate) {
         super(delegate);
     }
 }

 class Qux<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Qux(T delegate) {
         super(delegate);
     }
 }

 Foo foo = new Foo();
 assert foo.unwrapAll() == foo;

 Bar<Foo> bar = new Bar<>(foo);
 assert bar.unwrapAll() == foo;

 Qux<Bar<Foo>> qux = new Qux<>(bar);
 assert qux.unwrap() == bar;
 assert qux.unwrapAll() == foo;
 

Specified by:

unwrapAll in interface ClientRequestContext

Specified by:

unwrapAll in interface RequestContext

Specified by:

unwrapAll in interface Unwrappable

Overrides:

unwrapAll in class RequestContextWrapper<ClientRequestContext>