Package com.linecorp.armeria.server

Class ServiceRequestContextBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContextBuilder

com.linecorp.armeria.server.ServiceRequestContextBuilder

public final class ServiceRequestContextBuilder
extends AbstractRequestContextBuilder

Builds a new ServiceRequestContext. 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
ServiceRequestContextBuilder	alloc(io.netty.buffer.ByteBufAllocator alloc)	Sets the ByteBufAllocator.
ServiceRequestContext	build()	Returns a new ServiceRequestContext created with the properties of this builder.
ServiceRequestContextBuilder	defaultLogName(String defaultLogName)	Sets the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).
ServiceRequestContextBuilder	defaultServiceName(String defaultServiceName)	Sets the default value of the RequestOnlyLog.serviceName() property which is used when no service name was set via RequestLogBuilder.name(String, String).
ServiceRequestContextBuilder	defaultServiceNaming(ServiceNaming defaultServiceNaming)	Sets the default naming rule for the RequestOnlyLog.serviceName().
ServiceRequestContextBuilder	eventLoop(io.netty.channel.EventLoop eventLoop)	Sets the EventLoop that handles the request.
ServiceRequestContextBuilder	id(RequestId id)	Sets the RequestId.
ServiceRequestContextBuilder	localAddress(InetSocketAddress localAddress)	Sets the local socket address of the connection.
ServiceRequestContextBuilder	meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)	Sets the MeterRegistry.
ServiceRequestContextBuilder	proxiedAddresses(ProxiedAddresses proxiedAddresses)	Sets the ProxiedAddresses of the request.
ServiceRequestContextBuilder	remoteAddress(InetSocketAddress remoteAddress)	Sets the remote socket address of the connection.
ServiceRequestContextBuilder	requestStartTime(long requestStartTimeNanos, long requestStartTimeMicros)	Sets the request start time of the request.
ServiceRequestContextBuilder	route(Route route)	Sets the Route of the request.
ServiceRequestContextBuilder	routingResult(RoutingResult routingResult)	Sets the RoutingResult of the request.
ServiceRequestContextBuilder	serverConfigurator(Consumer<? super ServerBuilder> serverConfigurator)	Adds the Consumer that configures the given ServerBuilder.
ServiceRequestContextBuilder	service(HttpService service)	Sets the Service that handles the request.
ServiceRequestContextBuilder	sessionProtocol(SessionProtocol sessionProtocol)	Sets the SessionProtocol of the request.
ServiceRequestContextBuilder	sslSession(SSLSession sslSession)	Sets the SSLSession of the connection.
ServiceRequestContextBuilder	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, 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

service

public ServiceRequestContextBuilder service(HttpService service)

Sets the Service that handles the request. If not set, a dummy Service, which always returns a "405 Method Not Allowed" response, is used.

defaultServiceName

public ServiceRequestContextBuilder defaultServiceName(String defaultServiceName)

Sets the default value of the RequestOnlyLog.serviceName() property which is used when no service name was set via RequestLogBuilder.name(String, String).

Parameters:

defaultServiceName - the default log name.

defaultServiceNaming

public ServiceRequestContextBuilder defaultServiceNaming(ServiceNaming defaultServiceNaming)

Sets the default naming rule for the RequestOnlyLog.serviceName(). If set, the service name will be converted according to given naming rule.

Parameters:

defaultServiceNaming - the default service naming.

defaultLogName

public ServiceRequestContextBuilder defaultLogName(String defaultLogName)

Sets the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).

Parameters:

defaultLogName - the default log name.

route

public ServiceRequestContextBuilder route(Route route)

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

routingResult

public ServiceRequestContextBuilder routingResult(RoutingResult routingResult)

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

proxiedAddresses

public ServiceRequestContextBuilder proxiedAddresses(ProxiedAddresses proxiedAddresses)

Sets the ProxiedAddresses of the request. If not set, ServiceRequestContext.proxiedAddresses() will return null.

serverConfigurator

public ServiceRequestContextBuilder serverConfigurator(Consumer<? super ServerBuilder> serverConfigurator)

Adds the Consumer that configures the given ServerBuilder. The Consumers added by this method will be invoked when this builder builds a dummy Server. This may be useful when you need to update the default settings of the dummy Server, such as ServerBuilder.maxRequestLength(long).

build

public ServiceRequestContext build()

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

meterRegistry

public ServiceRequestContextBuilder 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 ServiceRequestContextBuilder 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 ServiceRequestContextBuilder 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 ServiceRequestContextBuilder sessionProtocol(SessionProtocol sessionProtocol)

Description copied from class: AbstractRequestContextBuilder

Sets the SessionProtocol of the request.

Overrides:

sessionProtocol in class AbstractRequestContextBuilder

id

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