Package com.linecorp.armeria.server

Interface ServiceRequestContext

All Superinterfaces:

AttributeMap, RequestContext

All Known Implementing Classes:

DefaultServiceRequestContext, ServiceRequestContextWrapper

public interface ServiceRequestContext
extends RequestContext

Provides information about an invocation and related utilities. Every request being handled has its own ServiceRequestContext 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.
ExecutorService	blockingTaskExecutor()	Returns the ExecutorService that could be used for executing a potentially long-running task.
<A extends SocketAddress> A	localAddress()	Returns the local address of this request.
Logger	logger()	Deprecated. Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
String	mappedPath()	Returns the path with its context path removed.
long	maxRequestLength()	Returns the maximum length of the current Request.
default MediaType	negotiatedProduceType()	Deprecated. Use negotiatedResponseMediaType().
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.
default String	pathParam(String name)	Returns the value of the specified path parameter.
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.
<A extends SocketAddress> A	remoteAddress()	Returns the remote address of this request.
boolean	removeAdditionalResponseHeader(AsciiString name)	Removes all headers with the specified name.
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	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.
VirtualHost	virtualHost()	Returns the VirtualHost that is handling the current Request.

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface com.linecorp.armeria.common.RequestContext

alloc, attrs, contextAwareEventLoop, contextAwareExecutor, eventLoop, executor, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, log, logBuilder, 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, sslSession

Method Detail

remoteAddress

@Nonnull
<A extends SocketAddress> A remoteAddress()

Returns the remote address of this request.

Specified by:

remoteAddress in interface RequestContext

localAddress

@Nonnull
<A extends SocketAddress> A localAddress()

Returns the local address of this request.

Specified by:

localAddress in interface RequestContext

newDerivedContext

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

newDerivedContext

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

server

Server server()

Returns the Server that is handling the current Request.

virtualHost

VirtualHost virtualHost()

Returns the VirtualHost that is handling the current Request.

pathMapping

PathMapping pathMapping()

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

pathMappingContext

PathMappingContext pathMappingContext()

Returns the PathMappingContext used to find the Service.

pathParams

Map<String,String> pathParams()

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

pathParam

@Nullable
default String pathParam(String name)

Returns the value of the specified path parameter.

service

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

Returns the Service that is handling the current Request.

blockingTaskExecutor

ExecutorService blockingTaskExecutor()

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.

mappedPath

String mappedPath()

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

negotiatedResponseMediaType

@Nullable
MediaType negotiatedResponseMediaType()

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

negotiatedProduceType

@Deprecated
@Nullable
default MediaType negotiatedProduceType()

Deprecated.

Use negotiatedResponseMediaType().

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

logger

@Deprecated
Logger logger()

Deprecated.

Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.

Returns the Logger of the Service.

requestTimeoutMillis

long requestTimeoutMillis()

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

setRequestTimeoutMillis

void setRequestTimeoutMillis(long requestTimeoutMillis)

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

setRequestTimeout

void setRequestTimeout(Duration requestTimeout)

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

setRequestTimeoutHandler

void setRequestTimeoutHandler(Runnable requestTimeoutHandler)

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();
   });
   ...
 

maxRequestLength

long maxRequestLength()

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.

See Also:

ContentTooLargeException

setMaxRequestLength

void setMaxRequestLength(long maxRequestLength)

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.

See Also:

ContentTooLargeException

additionalResponseHeaders

HttpHeaders additionalResponseHeaders()

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

setAdditionalResponseHeader

void setAdditionalResponseHeader(AsciiString name,
                                 String value)

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.

setAdditionalResponseHeaders

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.

addAdditionalResponseHeader

void addAdditionalResponseHeader(AsciiString name,
                                 String value)

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

addAdditionalResponseHeaders

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

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

removeAdditionalResponseHeader

boolean removeAdditionalResponseHeader(AsciiString name)

Removes all headers with the specified name.

Returns:

true if at least one entry has been removed

proxiedAddresses

@Nullable
ProxiedAddresses proxiedAddresses()

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