Package com.linecorp.armeria.server

Class DefaultServiceRequestContext

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContext

com.linecorp.armeria.common.NonWrappingRequestContext

com.linecorp.armeria.server.DefaultServiceRequestContext

All Implemented Interfaces:

RequestContext, ServiceRequestContext, AttributeMap

public class DefaultServiceRequestContext
extends NonWrappingRequestContext
implements ServiceRequestContext

Default ServiceRequestContext implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultServiceRequestContext(ServiceConfig cfg, Channel ch, MeterRegistry meterRegistry, SessionProtocol sessionProtocol, PathMappingContext pathMappingContext, PathMappingResult pathMappingResult, Request request, SSLSession sslSession, ProxiedAddresses proxiedAddresses)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addAdditionalResponseHeader(AsciiString name, String value)	Adds a header with the specified name and value.
void	addAdditionalResponseHeaders(Headers<? extends AsciiString,? extends String,?> headers)	Adds the specified Headers which is included when a Service sends an HttpResponse.
HttpHeaders	additionalResponseHeaders()	Returns an immutable HttpHeaders which is included when a Service sends an HttpResponse.
ByteBufAllocator	alloc()	Returns the ByteBufAllocator for this RequestContext.
ExecutorService	blockingTaskExecutor()	Returns the ExecutorService that could be used for executing a potentially long-running task.
protected Channel	channel()	Returns the Channel that is handling this request, or null if the connection is not established yet.
EventLoop	eventLoop()	Returns the EventLoop that is handling the current Request.
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.
Logger	logger()	Returns the Logger of the Service.
String	mappedPath()	Returns the path with its context path removed.
long	maxRequestLength()	Returns the maximum length of the current Request.
MediaType	negotiatedResponseMediaType()	Returns the negotiated producible media type.
ServiceRequestContext	newDerivedContext()	Creates a new derived RequestContext which only the RequestLog is different from the deriving context.
ServiceRequestContext	newDerivedContext(Request request)	Creates a new derived RequestContext with the specified Request which the RequestLog is different from the deriving context.
PathMapping	pathMapping()	Returns the PathMapping associated with the Service that is handling the current Request.
PathMappingContext	pathMappingContext()	Returns the PathMappingContext used to find the Service.
Map<String,String>	pathParams()	Returns the path parameters mapped by the PathMapping associated with the Service that is handling the current Request.
ProxiedAddresses	proxiedAddresses()	Returns the proxied addresses if the current Request is received through a proxy.
boolean	removeAdditionalResponseHeader(AsciiString name)	Removes all headers with the specified name.
Runnable	requestTimeoutHandler()
long	requestTimeoutMillis()	Returns the amount of time allowed until receiving the current Request completely.
Server	server()	Returns the Server that is handling the current Request.
<T extends Service<HttpRequest,HttpResponse>> T	service()	Returns the Service that is handling the current Request.
void	setAdditionalResponseHeader(AsciiString name, String value)	Sets a header with the specified name and value.
void	setAdditionalResponseHeaders(Headers<? extends AsciiString,? extends String,?> headers)	Clears the current header and sets the specified Headers which is included when a Service sends an HttpResponse.
void	setMaxRequestLength(long maxRequestLength)	Sets the maximum length of the current Request.
void	setRequestTimeout(Duration requestTimeout)	Sets the amount of time allowed until receiving the current Request completely.
void	setRequestTimeoutChangeListener(RequestTimeoutChangeListener listener)	Sets the listener that is notified when the requestTimeoutMillis() request timeout} of the request is changed.
void	setRequestTimeoutHandler(Runnable requestTimeoutHandler)	Sets a handler to run when the request times out.
void	setRequestTimeoutMillis(long requestTimeoutMillis)	Sets the amount of time allowed until receiving the current Request completely.
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()
VirtualHost	virtualHost()	Returns the VirtualHost that is handling the current Request.

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 interface io.netty.util.AttributeMap

attr, hasAttr

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

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, contextAwareExecutor, executor, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, onChild, onEnter, onEnter, onExit, onExit, path, push, push, pushIfAbsent, query, rejectPromise, request, resolvePromise, sessionProtocol

Methods inherited from interface com.linecorp.armeria.server.ServiceRequestContext

localAddress, negotiatedProduceType, pathParam, remoteAddress

Constructor Detail

DefaultServiceRequestContext

public DefaultServiceRequestContext(ServiceConfig cfg,
                                    Channel ch,
                                    MeterRegistry meterRegistry,
                                    SessionProtocol sessionProtocol,
                                    PathMappingContext pathMappingContext,
                                    PathMappingResult pathMappingResult,
                                    Request request,
                                    @Nullable
                                    SSLSession sslSession,
                                    @Nullable
                                    ProxiedAddresses proxiedAddresses)

Creates a new instance.

Parameters:

ch - the Channel that handles the invocation

meterRegistry - the MeterRegistry that collects various stats

sessionProtocol - the SessionProtocol of the invocation

request - the request associated with this context

sslSession - the SSLSession for this invocation if it is over TLS

Method Detail

newDerivedContext

public ServiceRequestContext newDerivedContext()

Description copied from interface: RequestContext

Creates a new derived RequestContext which only the RequestLog is different from the deriving context. Note that the references of Attributes in the RequestContext.attrs() are copied as well.

Specified by:

newDerivedContext in interface RequestContext

Specified by:

newDerivedContext in interface ServiceRequestContext

newDerivedContext

public ServiceRequestContext newDerivedContext(Request request)

Description copied from interface: RequestContext

Creates a new derived RequestContext with the specified Request which the RequestLog is different from the deriving context. Note that the references of Attributes in the RequestContext.attrs() are copied as well.

Specified by:

newDerivedContext in interface RequestContext

Specified by:

newDerivedContext in interface ServiceRequestContext

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

server

public Server server()

Description copied from interface: ServiceRequestContext

Returns the Server that is handling the current Request.

Specified by:

server in interface ServiceRequestContext

virtualHost

public VirtualHost virtualHost()

Description copied from interface: ServiceRequestContext

Returns the VirtualHost that is handling the current Request.

Specified by:

virtualHost in interface ServiceRequestContext

pathMapping

public PathMapping pathMapping()

Description copied from interface: ServiceRequestContext

Returns the PathMapping associated with the Service that is handling the current Request.

Specified by:

pathMapping in interface ServiceRequestContext

pathMappingContext

public PathMappingContext pathMappingContext()

Description copied from interface: ServiceRequestContext

Returns the PathMappingContext used to find the Service.

Specified by:

pathMappingContext in interface ServiceRequestContext

pathParams

public Map<String,String> pathParams()

Description copied from interface: ServiceRequestContext

Returns the path parameters mapped by the PathMapping associated with the Service that is handling the current Request.

Specified by:

pathParams in interface ServiceRequestContext

service

public <T extends Service<HttpRequest,HttpResponse>> T service()

Description copied from interface: ServiceRequestContext

Returns the Service that is handling the current Request.

Specified by:

service in interface ServiceRequestContext

blockingTaskExecutor

public ExecutorService blockingTaskExecutor()

Description copied from interface: ServiceRequestContext

Returns the ExecutorService that could be used for executing a potentially long-running task. The ExecutorService will propagate the ServiceRequestContext automatically when running a task.

Note that performing a long-running task in Service.serve(ServiceRequestContext, Request) may block the Server's I/O event loop and thus should be executed in other threads.

Specified by:

blockingTaskExecutor in interface ServiceRequestContext

mappedPath

public String mappedPath()

Description copied from interface: ServiceRequestContext

Returns the path with its context path removed. This method can be useful for a reusable service bound at various path prefixes.

Specified by:

mappedPath in interface ServiceRequestContext

negotiatedResponseMediaType

@Nullable
public MediaType negotiatedResponseMediaType()

Description copied from interface: ServiceRequestContext

Returns the negotiated producible media type. If the media type negotiation is not used for the Service, null would be returned.

Specified by:

negotiatedResponseMediaType in interface ServiceRequestContext

eventLoop

public EventLoop eventLoop()

Description copied from interface: RequestContext

Returns the EventLoop that is handling the current Request.

Specified by:

eventLoop in interface RequestContext

logger

public Logger logger()

Description copied from interface: ServiceRequestContext

Returns the Logger of the Service.

Specified by:

logger in interface ServiceRequestContext

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

Overrides:

sslSession in class NonWrappingRequestContext

requestTimeoutMillis

public long requestTimeoutMillis()

Description copied from interface: ServiceRequestContext

Returns the amount of time allowed until receiving the current Request completely. This value is initially set from ServerConfig.defaultRequestTimeoutMillis().

Specified by:

requestTimeoutMillis in interface ServiceRequestContext

setRequestTimeoutMillis

public void setRequestTimeoutMillis(long requestTimeoutMillis)

Description copied from interface: ServiceRequestContext

Sets the amount of time allowed until receiving the current Request completely. This value is initially set from ServerConfig.defaultRequestTimeoutMillis().

Specified by:

setRequestTimeoutMillis in interface ServiceRequestContext

setRequestTimeout

public void setRequestTimeout(Duration requestTimeout)

Description copied from interface: ServiceRequestContext

Sets the amount of time allowed until receiving the current Request completely. This value is initially set from ServerConfig.defaultRequestTimeoutMillis().

Specified by:

setRequestTimeout in interface ServiceRequestContext

requestTimeoutHandler

@Nullable
public Runnable requestTimeoutHandler()

setRequestTimeoutHandler

public void setRequestTimeoutHandler(Runnable requestTimeoutHandler)

Description copied from interface: ServiceRequestContext

Sets a handler to run when the request times out. requestTimeoutHandler must close the response, e.g., by calling StreamWriter.close(). If not set, the response will be closed with HttpStatus.SERVICE_UNAVAILABLE.

For example,

   HttpResponseWriter res = HttpResponse.streaming();
   ctx.setRequestTimeoutHandler(() -> {
      res.write(HttpHeaders.of(HttpStatus.OK, MediaType.PLAIN_TEXT_UTF_8, "Request timed out."));
      res.close();
   });
   ...
 

Specified by:

setRequestTimeoutHandler in interface ServiceRequestContext

maxRequestLength

public long maxRequestLength()

Description copied from interface: ServiceRequestContext

Returns the maximum length of the current Request. This value is initially set from ServerConfig.defaultMaxRequestLength(). If 0, there is no limit on the request size.

Specified by:

maxRequestLength in interface ServiceRequestContext

See Also:

ContentTooLargeException

setMaxRequestLength

public void setMaxRequestLength(long maxRequestLength)

Description copied from interface: ServiceRequestContext

Sets the maximum length of the current Request. This value is initially set from ServerConfig.defaultMaxRequestLength(). If 0, there is no limit on the request size.

Specified by:

setMaxRequestLength in interface ServiceRequestContext

See Also:

ContentTooLargeException

additionalResponseHeaders

public HttpHeaders additionalResponseHeaders()

Description copied from interface: ServiceRequestContext

Returns an immutable HttpHeaders which is included when a Service sends an HttpResponse.

Specified by:

additionalResponseHeaders in interface ServiceRequestContext

setAdditionalResponseHeader

public void setAdditionalResponseHeader(AsciiString name,
                                        String value)

Description copied from interface: ServiceRequestContext

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 Service sends an HttpResponse.

Specified by:

setAdditionalResponseHeader in interface ServiceRequestContext

setAdditionalResponseHeaders

public void setAdditionalResponseHeaders(Headers<? extends AsciiString,? extends String,?> headers)

Description copied from interface: ServiceRequestContext

Clears the current header and sets the specified Headers which is included when a Service sends an HttpResponse.

Specified by:

setAdditionalResponseHeaders in interface ServiceRequestContext

addAdditionalResponseHeader

public void addAdditionalResponseHeader(AsciiString name,
                                        String value)

Description copied from interface: ServiceRequestContext

Adds a header with the specified name and value. The header will be included when a Service sends an HttpResponse.

Specified by:

addAdditionalResponseHeader in interface ServiceRequestContext

addAdditionalResponseHeaders

public void addAdditionalResponseHeaders(Headers<? extends AsciiString,? extends String,?> headers)

Description copied from interface: ServiceRequestContext

Adds the specified Headers which is included when a Service sends an HttpResponse.

Specified by:

addAdditionalResponseHeaders in interface ServiceRequestContext

removeAdditionalResponseHeader

public boolean removeAdditionalResponseHeader(AsciiString name)

Description copied from interface: ServiceRequestContext

Removes all headers with the specified name.

Specified by:

removeAdditionalResponseHeader in interface ServiceRequestContext

Returns:

true if at least one entry has been removed

proxiedAddresses

@Nullable
public ProxiedAddresses proxiedAddresses()

Description copied from interface: ServiceRequestContext

Returns the proxied addresses if the current Request is received through a proxy.

Specified by:

proxiedAddresses in interface ServiceRequestContext

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

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

setRequestTimeoutChangeListener

public void setRequestTimeoutChangeListener(RequestTimeoutChangeListener listener)

Sets the listener that is notified when the requestTimeoutMillis() request timeout} of the request is changed.

Note: This method is meant for internal use by server-side protocol implementation to reschedule a timeout task when a user updates the request timeout configuration.

toString

public String toString()

Overrides:

toString in class Object