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, AttributeMap

public class DefaultClientRequestContext
extends NonWrappingRequestContext
implements ClientRequestContext

Default ClientRequestContext implementation.

Field Summary

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

HTTP_HEADERS

Constructor Summary

Constructors

Constructor and Description
DefaultClientRequestContext(EventLoop eventLoop, MeterRegistry meterRegistry, SessionProtocol sessionProtocol, Endpoint endpoint, HttpMethod method, String path, String query, String fragment, ClientOptions options, Object request) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ByteBufAllocator	alloc() Returns the ByteBufAllocator for this RequestContext.
protected 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.
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.
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.
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.
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	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) Sets the amount of time allowed until sending out the current Request completely.
void	setWriteTimeoutMillis(long writeTimeoutMillis) Sets the amount of time allowed until sending out the current Request completely.
String	toString()
long	writeTimeoutMillis() Returns the amount of time allowed until sending out the current Request completely.

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

attr, attrs, hasAttr, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, localAddress, meterRegistry, method, onChild, onEnter, onExit, path, query, remoteAddress, request, sessionProtocol, sslSession

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

contextAwareEventLoop, equals, hashCode, isTimedOut, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, onEnter, onExit, 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.common.RequestContext

attrs, contextAwareEventLoop, current, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, localAddress, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, onChild, onEnter, onEnter, onExit, onExit, path, push, push, query, rejectPromise, remoteAddress, request, resolvePromise, sessionProtocol, sslSession

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

DefaultClientRequestContext

public DefaultClientRequestContext(EventLoop eventLoop,
                                   MeterRegistry meterRegistry,
                                   SessionProtocol sessionProtocol,
                                   Endpoint endpoint,
                                   HttpMethod method,
                                   String path,
                                   @Nullable
                                   String query,
                                   @Nullable
                                   String fragment,
                                   ClientOptions options,
                                   Object request)

Creates a new instance.

Parameters:

sessionProtocol - the SessionProtocol of the invocation

request - the request associated with this context

Method Detail

channel

protected 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 EventLoop eventLoop()

Description copied from interface: RequestContext

Returns the EventLoop that is handling the current Request.

Specified by:

eventLoop 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

endpoint

public Endpoint endpoint()

Description copied from interface: ClientRequestContext

Returns the remote Endpoint of the current Request.

Specified by:

endpoint in interface ClientRequestContext

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 an empty string if no fragment was specified

writeTimeoutMillis

public long writeTimeoutMillis()

Description copied from interface: ClientRequestContext

Returns the amount of time allowed until sending out the current Request completely. This value is initially set from ClientOption.DEFAULT_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 sending out the current Request completely. This value is initially set from ClientOption.DEFAULT_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 sending out the current Request completely. This value is initially set from ClientOption.DEFAULT_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.DEFAULT_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.DEFAULT_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.DEFAULT_RESPONSE_TIMEOUT_MILLIS.

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 ClientOption.DEFAULT_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.DEFAULT_MAX_RESPONSE_LENGTH.

Specified by:

setMaxResponseLength in interface ClientRequestContext

See Also:

ContentTooLargeException

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