com.linecorp.armeria.client

Class DefaultClientRequestContext

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContext

com.linecorp.armeria.common.NonWrappingRequestContext

com.linecorp.armeria.client.DefaultClientRequestContext

All Implemented Interfaces:

ClientRequestContext, RequestContext, io.netty.util.AttributeMap

public class DefaultClientRequestContext
extends NonWrappingRequestContext
implements ClientRequestContext

Default ClientRequestContext implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultClientRequestContext(ClientFactory factory, MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, HttpMethod method, String path, String query, String fragment, ClientOptions options, HttpRequest req, RpcRequest rpcReq) Creates a new instance.
DefaultClientRequestContext(io.netty.channel.EventLoop eventLoop, MeterRegistry meterRegistry, SessionProtocol sessionProtocol, RequestId id, HttpMethod method, String path, String query, String fragment, ClientOptions options, HttpRequest req, RpcRequest rpcReq) 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.
io.netty.buffer.ByteBufAllocator	alloc() Returns the ByteBufAllocator for this RequestContext.
protected io.netty.channel.Channel	channel() Returns the Channel that is handling this request, or null if the connection is not established yet.
Endpoint	endpoint() Returns the remote Endpoint of the current Request.
EndpointSelector	endpointSelector() Returns the EndpointSelector used for the current Request.
io.netty.channel.EventLoop	eventLoop() Returns the EventLoop that is handling 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.
boolean	init(Endpoint endpoint) Initializes this context with the specified Endpoint.
RequestLog	log() Returns the RequestLog that contains the information about 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.
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.
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.
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, hasAttr, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, localAddress, meterRegistry, method, onChild, onEnter, onExit, path, query, remoteAddress, request, rpcRequest, sessionProtocol, unsafeUpdateRequest, 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, 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

attrs, contextAwareEventLoop, contextAwareExecutor, decodedPath, executor, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, localAddress, 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, updateRequest, updateRpcRequest

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

DefaultClientRequestContext

public DefaultClientRequestContext(io.netty.channel.EventLoop eventLoop,
                                   MeterRegistry meterRegistry,
                                   SessionProtocol sessionProtocol,
                                   RequestId id,
                                   HttpMethod method,
                                   String path,
                                   @Nullable
                                   String query,
                                   @Nullable
                                   String fragment,
                                   ClientOptions options,
                                   @Nullable
                                   HttpRequest req,
                                   @Nullable
                                   RpcRequest rpcReq)

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

Parameters:

eventLoop - the EventLoop associated with this context

sessionProtocol - the SessionProtocol of the invocation

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

req - the HttpRequest associated with this context

rpcReq - the RpcRequest associated with this context

DefaultClientRequestContext

public DefaultClientRequestContext(ClientFactory factory,
                                   MeterRegistry meterRegistry,
                                   SessionProtocol sessionProtocol,
                                   RequestId id,
                                   HttpMethod method,
                                   String path,
                                   @Nullable
                                   String query,
                                   @Nullable
                                   String fragment,
                                   ClientOptions options,
                                   @Nullable
                                   HttpRequest req,
                                   @Nullable
                                   RpcRequest rpcReq)

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

Parameters:

factory - the ClientFactory which is used to acquire an EventLoop

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

Method Detail

init

public boolean init(Endpoint endpoint)

Initializes this context with the specified Endpoint. 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.

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

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 io.netty.channel.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 io.netty.channel.EventLoop eventLoop()

Description copied from interface: RequestContext

Returns the EventLoop that is handling the current Request.

Specified by:

eventLoop in interface RequestContext

sslSession

@Nullable
public 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

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

@Nullable
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

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

log

public RequestLog log()

Description copied from interface: RequestContext

Returns the RequestLog that contains the information about 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

toString

public String toString()

Overrides:

toString in class Object

alloc

public io.netty.buffer.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