Package com.linecorp.armeria.client

Class ClientRequestContextBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContextBuilder

com.linecorp.armeria.client.ClientRequestContextBuilder

public final class ClientRequestContextBuilder
extends AbstractRequestContextBuilder

Builds a new ClientRequestContext. Note that it is not usually required to create a new context by yourself, because Armeria will always provide a context object for you. However, it may be useful in some cases such as unit testing.

Method Summary

Modifier and Type	Method	Description
ClientRequestContextBuilder	alloc(io.netty.buffer.ByteBufAllocator alloc)	Sets the ByteBufAllocator.
ClientRequestContext	build()	Returns a new ClientRequestContext created with the properties of this builder.
ClientRequestContextBuilder	connectionTimings(ClientConnectionTimings connectionTimings)	Sets the ClientConnectionTimings of the request.
ClientRequestContextBuilder	endpoint(Endpoint endpoint)	Sets the Endpoint of the request.
ClientRequestContextBuilder	eventLoop(io.netty.channel.EventLoop eventLoop)	Sets the EventLoop that handles the request.
ClientRequestContextBuilder	id(RequestId id)	Sets the RequestId.
ClientRequestContextBuilder	localAddress(InetSocketAddress localAddress)	Sets the local socket address of the connection.
ClientRequestContextBuilder	meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)	Sets the MeterRegistry.
ClientRequestContextBuilder	method(HttpMethod method)	Sets the HttpMethod of the request.
ClientRequestContextBuilder	options(ClientOptions options)	Sets the ClientOptions of the client.
ClientRequestContextBuilder	remoteAddress(InetSocketAddress remoteAddress)	Sets the remote socket address of the connection.
ClientRequestContextBuilder	requestOptions(RequestOptions requestOptions)	Sets the RequestOptions.
ClientRequestContextBuilder	requestStartTime(long requestStartTimeNanos, long requestStartTimeMicros)	Sets the request start time of the request.
ClientRequestContextBuilder	sessionProtocol(SessionProtocol sessionProtocol)	Sets the SessionProtocol of the request.
ClientRequestContextBuilder	sslSession(SSLSession sslSession)	Sets the SSLSession of the connection.
ClientRequestContextBuilder	timedOut(boolean timedOut)	Sets the specified timedOut.

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

alloc, authority, eventLoop, fakeChannel, id, isRequestStartTimeSet, localAddress, meterRegistry, method, remoteAddress, request, requestStartTimeMicros, requestStartTimeNanos, requestTarget, rpcRequest, sessionProtocol, sslSession, timedOut

Methods inherited from class java.lang.Object

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

Method Details

method

public ClientRequestContextBuilder method(HttpMethod method)

Description copied from class: AbstractRequestContextBuilder

Sets the HttpMethod of the request.

Overrides:

method in class AbstractRequestContextBuilder

endpoint

public ClientRequestContextBuilder endpoint(Endpoint endpoint)

Sets the Endpoint of the request. If not set, it is auto-generated from the request authority.

options

public ClientRequestContextBuilder options(ClientOptions options)

Sets the ClientOptions of the client. If not set, ClientOptions.of() is used.

connectionTimings

public ClientRequestContextBuilder connectionTimings(ClientConnectionTimings connectionTimings)

Sets the ClientConnectionTimings of the request.

requestOptions

public ClientRequestContextBuilder requestOptions(RequestOptions requestOptions)

Sets the RequestOptions. If not set, RequestOptions.of() is used.

build

public ClientRequestContext build()

Returns a new ClientRequestContext created with the properties of this builder.

meterRegistry

public ClientRequestContextBuilder meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Description copied from class: AbstractRequestContextBuilder

Sets the MeterRegistry. If not set, NoopMeterRegistry is used.

Overrides:

meterRegistry in class AbstractRequestContextBuilder

eventLoop

public ClientRequestContextBuilder eventLoop(io.netty.channel.EventLoop eventLoop)

Description copied from class: AbstractRequestContextBuilder

Sets the EventLoop that handles the request. If not set, one of the CommonPools.workerGroup() is used.

Overrides:

eventLoop in class AbstractRequestContextBuilder

alloc

public ClientRequestContextBuilder alloc(io.netty.buffer.ByteBufAllocator alloc)

Description copied from class: AbstractRequestContextBuilder

Sets the ByteBufAllocator. If not set, ByteBufAllocator.DEFAULT is used.

Overrides:

alloc in class AbstractRequestContextBuilder

sessionProtocol

public ClientRequestContextBuilder sessionProtocol(SessionProtocol sessionProtocol)

Description copied from class: AbstractRequestContextBuilder

Sets the SessionProtocol of the request.

Overrides:

sessionProtocol in class AbstractRequestContextBuilder

id

public ClientRequestContextBuilder id(RequestId id)

Description copied from class: AbstractRequestContextBuilder

Sets the RequestId. If not set, a random RequestId is generated with RequestId.random().

Overrides:

id in class AbstractRequestContextBuilder

remoteAddress

public ClientRequestContextBuilder remoteAddress(InetSocketAddress remoteAddress)

Description copied from class: AbstractRequestContextBuilder

Sets the remote socket address of the connection. If not set, it is auto-generated with the localhost IP address (e.g. "127.0.0.1" or "::1").

Overrides:

remoteAddress in class AbstractRequestContextBuilder

localAddress

public ClientRequestContextBuilder localAddress(InetSocketAddress localAddress)

Description copied from class: AbstractRequestContextBuilder

Sets the local socket address of the connection. If not set, it is auto-generated with the localhost IP address (e.g. "127.0.0.1" or "::1").

Overrides:

localAddress in class AbstractRequestContextBuilder

sslSession

public ClientRequestContextBuilder sslSession(SSLSession sslSession)

Description copied from class: AbstractRequestContextBuilder

Sets the SSLSession of the connection. If the current SessionProtocol is not TLS, the TLS version of the current SessionProtocol will be set automatically. For example, SessionProtocol.H2C will be automatically upgraded to SessionProtocol.H2. Note that upgrading the current SessionProtocol may trigger an IllegalArgumentException, as described in AbstractRequestContextBuilder.sessionProtocol(SessionProtocol).

Overrides:

sslSession in class AbstractRequestContextBuilder

requestStartTime

public ClientRequestContextBuilder requestStartTime(long requestStartTimeNanos,
 long requestStartTimeMicros)

Description copied from class: AbstractRequestContextBuilder

Sets the request start time of the request.

Overrides:

requestStartTime in class AbstractRequestContextBuilder

Parameters:

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

requestStartTimeMicros - the number of microseconds since the epoch when the request started.

timedOut

public ClientRequestContextBuilder timedOut(boolean timedOut)

Description copied from class: AbstractRequestContextBuilder

Sets the specified timedOut. If the specified timedOut is true, RequestContext.isTimedOut() will always return true. This is useful for checking the behavior of a Service and Client when a request exceeds a deadline.

Overrides:

timedOut in class AbstractRequestContextBuilder