com.linecorp.armeria.client

Class ClientRequestContextWrapper

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContext

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

com.linecorp.armeria.client.ClientRequestContextWrapper

All Implemented Interfaces:

ClientRequestContext, RequestContext, io.netty.util.AttributeMap

public class ClientRequestContextWrapper
extends RequestContextWrapper<ClientRequestContext>
implements ClientRequestContext

Wraps an existing ClientRequestContext.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientRequestContextWrapper(ClientRequestContext delegate) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalRequestHeader(CharSequence name, Object value) Adds a header with the specified name and value.
void	addAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Adds the specified HttpHeaders which is included when a Client sends an HttpRequest.
HttpHeaders	additionalRequestHeaders() Returns an HttpHeaders which is included when a Client sends an HttpRequest.
Endpoint	endpoint() Returns the remote Endpoint of the current Request.
EndpointSelector	endpointSelector() Returns the EndpointSelector used for the current Request.
String	fragment() Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
long	maxResponseLength() Returns the maximum length of the received Response.
ClientRequestContext	newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq, 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.
boolean	removeAdditionalRequestHeader(CharSequence name) Removes all headers with the specified name.
Runnable	responseTimeoutHandler() Returns Response timeout handler which is executed when the Response is not completely received within the allowed ClientRequestContext.responseTimeoutMillis() or the default ClientOption.RESPONSE_TIMEOUT_MILLIS.
long	responseTimeoutMillis() Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started.
void	setAdditionalRequestHeader(CharSequence name, Object value) Sets a header with the specified name and value.
void	setAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Clears the current header and sets the specified HttpHeaders which is included when a Client sends an HttpRequest.
void	setMaxResponseLength(long maxResponseLength) Sets the maximum length of the received Response.
void	setResponseTimeout(Duration responseTimeout) Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started.
void	setResponseTimeoutHandler(Runnable responseTimeoutHandler) Sets a handler to run when the response times out.
void	setResponseTimeoutMillis(long responseTimeoutMillis) Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started.
void	setWriteTimeout(Duration writeTimeout) Returns the amount of time allowed until the initial write attempt of the current Request succeeds.
void	setWriteTimeoutMillis(long writeTimeoutMillis) Returns the amount of time allowed until the initial write attempt of the current Request succeeds.
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, decodedPath, delegate, eventLoop, hasAttr, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, localAddress, log, logBuilder, meterRegistry, method, onChild, onEnter, onExit, path, query, remoteAddress, request, rpcRequest, sessionProtocol, sslSession, updateRequest, updateRpcRequest

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

contextAwareEventLoop, contextAwareExecutor, equals, executor, hashCode, isTimedOut, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, onEnter, onExit, push, push, pushIfAbsent, rejectPromise, resolvePromise, setTimedOut

Methods inherited from class java.lang.Object

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

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

builder, builder, builder, current, currentOrNull, mapCurrent, newDerivedContext, of, of, of, request, rpcRequest

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

alloc, attrs, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, localAddress, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, onChild, onEnter, onEnter, onExit, onExit, path, push, push, push, push, pushIfAbsent, query, rejectPromise, remoteAddress, resolvePromise, sessionProtocol, sslSession, updateRequest, updateRpcRequest

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

ClientRequestContextWrapper

protected ClientRequestContextWrapper(ClientRequestContext delegate)

Creates a new instance.

Method Detail

newDerivedContext

public ClientRequestContext newDerivedContext(RequestId id,
                                              @Nullable
                                              HttpRequest req,
                                              @Nullable
                                              RpcRequest rpcReq,
                                              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.

Specified by:

newDerivedContext in interface ClientRequestContext

endpointSelector

public EndpointSelector endpointSelector()

Description copied from interface: ClientRequestContext

Returns the EndpointSelector used for the current Request.

Specified by:

endpointSelector in interface ClientRequestContext

Returns:

the EndpointSelector if a user specified a group Endpoint. null if a user specified a host 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. 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

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 ClientOption.WRITE_TIMEOUT_MILLIS.

Specified by:

writeTimeoutMillis in interface ClientRequestContext

setWriteTimeoutMillis

public void setWriteTimeoutMillis(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 ClientOption.WRITE_TIMEOUT_MILLIS.

Specified by:

setWriteTimeoutMillis in interface ClientRequestContext

setWriteTimeout

public void setWriteTimeout(Duration writeTimeout)

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 ClientOption.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. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.

Specified by:

responseTimeoutMillis in interface ClientRequestContext

setResponseTimeoutMillis

public void setResponseTimeoutMillis(long responseTimeoutMillis)

Description copied from interface: ClientRequestContext

Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.

Specified by:

setResponseTimeoutMillis in interface ClientRequestContext

setResponseTimeout

public void setResponseTimeout(Duration responseTimeout)

Description copied from interface: ClientRequestContext

Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.

Specified by:

setResponseTimeout in interface ClientRequestContext

responseTimeoutHandler

@Nullable
public Runnable responseTimeoutHandler()

Description copied from interface: ClientRequestContext

Returns Response timeout handler which is executed when the Response is not completely received within the allowed ClientRequestContext.responseTimeoutMillis() or the default ClientOption.RESPONSE_TIMEOUT_MILLIS.

Specified by:

responseTimeoutHandler in interface ClientRequestContext

setResponseTimeoutHandler

public void setResponseTimeoutHandler(Runnable responseTimeoutHandler)

Description copied from interface: ClientRequestContext

Sets a handler to run when the response times out. responseTimeoutHandler must abort the response, e.g., by calling StreamMessage.abort(Throwable). If not set, the response will be closed with ResponseTimeoutException.

For example,

 HttpResponseWriter res = HttpResponse.streaming();
 ctx.setResponseTimeoutHandler(() -> {
    res.abort(new IllegalStateException("Server is in a bad state."));
 });
 ...
 

Specified by:

setResponseTimeoutHandler 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 ClientOption.MAX_RESPONSE_LENGTH.

Specified by:

maxResponseLength in interface ClientRequestContext

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 ClientOption.MAX_RESPONSE_LENGTH.

Specified by:

setMaxResponseLength in interface ClientRequestContext

See Also:

ContentTooLargeException

additionalRequestHeaders

public HttpHeaders additionalRequestHeaders()

Description copied from interface: ClientRequestContext

Returns an HttpHeaders which is 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

setAdditionalRequestHeaders

public void setAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from interface: ClientRequestContext

Clears the current header and sets the specified HttpHeaders which is included when a Client sends an HttpRequest.

Specified by:

setAdditionalRequestHeaders 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

addAdditionalRequestHeaders

public void addAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from interface: ClientRequestContext

Adds the specified HttpHeaders which is included when a Client sends an HttpRequest.

Specified by:

addAdditionalRequestHeaders in interface ClientRequestContext

removeAdditionalRequestHeader

public boolean removeAdditionalRequestHeader(CharSequence name)

Description copied from interface: ClientRequestContext

Removes all headers with the specified name.

Specified by:

removeAdditionalRequestHeader in interface ClientRequestContext

Returns:

true if at least one entry has been removed