Package com.linecorp.armeria.server

Class ServiceRequestContextBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContextBuilder<ServiceRequestContextBuilder>

com.linecorp.armeria.server.ServiceRequestContextBuilder

public final class ServiceRequestContextBuilder
extends AbstractRequestContextBuilder<ServiceRequestContextBuilder>

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
ServiceRequestContext	build()	Returns a new ServiceRequestContext created with the properties of this builder.
ServiceRequestContextBuilder	clientAddress(InetAddress clientAddress)	Sets the client address of the request.
static ServiceRequestContextBuilder	of(HttpRequest request)	Returns a new ServiceRequestContextBuilder created from the specified HttpRequest.
ServiceRequestContextBuilder	pathMappingResult(PathMappingResult pathMappingResult)	Sets the PathMappingResult of the request.
ServiceRequestContextBuilder	proxiedAddresses(ProxiedAddresses proxiedAddresses)	Sets the ProxiedAddresses of the request.
ServiceRequestContextBuilder	serverConfigurator(Consumer<? super ServerBuilder> serverConfigurator)	Adds the Consumer that configures the given ServerBuilder.
ServiceRequestContextBuilder	service(Service<HttpRequest,HttpResponse> service)	Sets the Service that handles the request.

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

alloc, alloc, authority, eventLoop, eventLoop, fakeChannel, isRequestStartTimeSet, localAddress, localAddress, meterRegistry, meterRegistry, method, method, path, query, remoteAddress, remoteAddress, request, requestStartTime, requestStartTimeMicros, requestStartTimeNanos, sessionProtocol, sessionProtocol, sslSession, sslSession

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ServiceRequestContextBuilder of(HttpRequest request)

Returns a new ServiceRequestContextBuilder created from the specified HttpRequest.

service

public ServiceRequestContextBuilder service(Service<HttpRequest,HttpResponse> 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.

pathMappingResult

public ServiceRequestContextBuilder pathMappingResult(PathMappingResult pathMappingResult)

Sets the PathMappingResult 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.

clientAddress

public ServiceRequestContextBuilder clientAddress(InetAddress clientAddress)

Sets the client address of the request. If not set, ServiceRequestContext.clientAddress() will return the same value as ServiceRequestContext.remoteAddress().

serverConfigurator

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

Adds the Consumer that configures the given ServerBuilder. The Consumers added by thid 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 ServerConfig.defaultMaxRequestLength().

build

public ServiceRequestContext build()

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