com.linecorp.armeria.server

Class ServiceRequestContextWrapper

java.lang.Object

com.linecorp.armeria.common.AbstractRequestContext

com.linecorp.armeria.common.RequestContextWrapper<ServiceRequestContext>

com.linecorp.armeria.server.ServiceRequestContextWrapper

All Implemented Interfaces:

RequestContext, ServiceRequestContext, io.netty.util.AttributeMap

public class ServiceRequestContextWrapper
extends RequestContextWrapper<ServiceRequestContext>
implements ServiceRequestContext

Wraps an existing ServiceRequestContext.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceRequestContextWrapper(ServiceRequestContext delegate) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
AccessLogWriter	accessLogWriter()
void	addAdditionalResponseHeader(CharSequence name, Object value) Adds a header with the specified name and value.
void	addAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Adds the specified HttpHeaders which is included when a Service sends an HttpResponse.
void	addAdditionalResponseTrailer(CharSequence name, Object value) Adds a trailer with the specified name and value.
void	addAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Adds the specified HttpHeaders which is included when a Service completes an HttpResponse.
HttpHeaders	additionalResponseHeaders() Returns an immutable HttpHeaders which is included when a Service sends an HttpResponse.
HttpHeaders	additionalResponseTrailers() Returns the HttpHeaders which is returned along with any other trailers when a Service completes an HttpResponse.
ScheduledExecutorService	blockingTaskExecutor() Returns the ScheduledExecutorService that could be used for executing a potentially long-running task.
InetAddress	clientAddress() Returns the address of the client who initiated this request.
String	decodedMappedPath() Returns the RequestContext.decodedPath() with its context path removed.
<A extends SocketAddress> A	localAddress() Returns the local address of this request, or null if the connection is not established yet.
org.slf4j.Logger	logger() Returns the Logger of the Service.
String	mappedPath() Returns the RequestContext.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(RequestId id, HttpRequest req, RpcRequest rpcReq) Creates a new RequestContext whose properties and Attributes are copied from this RequestContext, except having a different pair of HttpRequest and RpcRequest and its own RequestLog.
Map<String,String>	pathParams() Returns the path parameters mapped by the ServiceRequestContext.route() associated with the Service that is handling the current Request.
ProxiedAddresses	proxiedAddresses() Returns the proxied addresses of the current Request.
<A extends SocketAddress> A	remoteAddress() Returns the remote address of this request, or null if the connection is not established yet.
boolean	removeAdditionalResponseHeader(CharSequence name) Removes all headers with the specified name.
boolean	removeAdditionalResponseTrailer(CharSequence name) Removes all trailers with the specified name.
HttpRequest	request() Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
Runnable	requestTimeoutHandler() Returns Request timeout handler which is executed when receiving the current Request and sending the corresponding Response is not completely received within the allowed ServiceRequestContext.requestTimeoutMillis().
long	requestTimeoutMillis() Returns the amount of time allowed until receiving the current Request and sending the corresponding Response completely.
Route	route() Returns the Route associated with the Service that is handling the current Request.
RoutingContext	routingContext() Returns the RoutingContext used to find the Service.
Server	server() Returns the Server that is handling the current Request.
HttpService	service() Returns the HttpService that is handling the current Request.
void	setAdditionalResponseHeader(CharSequence name, Object value) Sets a header with the specified name and value.
void	setAdditionalResponseHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Clears the current header and sets the specified HttpHeaders which is included when a Service sends an HttpResponse.
void	setAdditionalResponseTrailer(CharSequence name, Object value) Sets a trailer with the specified name and value.
void	setAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Clears the current trailer and sets the specified HttpHeaders which is included when a Service completes 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 and sending the corresponding Response 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 and sending the corresponding Response completely.
boolean	verboseResponses() Returns whether the verbose response mode is enabled.
VirtualHost	virtualHost() Returns the VirtualHost that is handling the current Request.

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

alloc, attr, attrs, decodedPath, delegate, eventLoop, hasAttr, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, log, logBuilder, meterRegistry, method, onChild, onEnter, onExit, path, query, rpcRequest, sessionProtocol, sslSession, updateRequest, updateRpcRequest

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

contextAwareEventLoop, contextAwareExecutor, equals, executor, hashCode, isTimedOut, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, onEnter, onExit, push, push, pushIfAbsent, rejectPromise, resolvePromise, setTimedOut

Methods inherited from class java.lang.Object

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

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

builder, current, currentOrNull, isTimedOut, mapCurrent, negotiatedProduceType, of, pathParam, rpcRequest

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

alloc, attrs, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, onChild, onEnter, onEnter, onExit, onExit, path, push, push, push, push, pushIfAbsent, query, rejectPromise, resolvePromise, sessionProtocol, sslSession, updateRequest, updateRpcRequest

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

ServiceRequestContextWrapper

protected ServiceRequestContextWrapper(ServiceRequestContext delegate)

Creates a new instance.

Method Detail

request

@Nonnull
public HttpRequest request()

Description copied from interface: RequestContext

Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.

Specified by:

request in interface RequestContext

Specified by:

request in interface ServiceRequestContext

Overrides:

request in class RequestContextWrapper<ServiceRequestContext>

remoteAddress

@Nonnull
public <A extends SocketAddress> A remoteAddress()

Description copied from interface: RequestContext

Returns the remote address of this request, or null if the connection is not established yet.

Specified by:

remoteAddress in interface RequestContext

Specified by:

remoteAddress in interface ServiceRequestContext

Overrides:

remoteAddress in class RequestContextWrapper<ServiceRequestContext>

localAddress

@Nonnull
public <A extends SocketAddress> A localAddress()

Description copied from interface: RequestContext

Returns the local address of this request, or null if the connection is not established yet.

Specified by:

localAddress in interface RequestContext

Specified by:

localAddress in interface ServiceRequestContext

Overrides:

localAddress in class RequestContextWrapper<ServiceRequestContext>

clientAddress

public InetAddress clientAddress()

Description copied from interface: ServiceRequestContext

Returns the address of the client who initiated this request.

Specified by:

clientAddress in interface ServiceRequestContext

newDerivedContext

public ServiceRequestContext newDerivedContext(RequestId id,
                                               @Nullable
                                               HttpRequest req,
                                               @Nullable
                                               RpcRequest rpcReq)

Description copied from interface: RequestContext

Creates a new RequestContext whose properties and Attributes are copied from this RequestContext, except having a different pair of HttpRequest and RpcRequest and its own RequestLog.

Specified by:

newDerivedContext in interface RequestContext

Specified by:

newDerivedContext in interface ServiceRequestContext

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

route

public Route route()

Description copied from interface: ServiceRequestContext

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

Specified by:

route in interface ServiceRequestContext

routingContext

public RoutingContext routingContext()

Description copied from interface: ServiceRequestContext

Returns the RoutingContext used to find the Service.

Specified by:

routingContext in interface ServiceRequestContext

pathParams

public Map<String,String> pathParams()

Description copied from interface: ServiceRequestContext

Returns the path parameters mapped by the ServiceRequestContext.route() associated with the Service that is handling the current Request.

Specified by:

pathParams in interface ServiceRequestContext

service

public HttpService service()

Description copied from interface: ServiceRequestContext

Returns the HttpService that is handling the current Request.

Specified by:

service in interface ServiceRequestContext

blockingTaskExecutor

public ScheduledExecutorService blockingTaskExecutor()

Description copied from interface: ServiceRequestContext

Returns the ScheduledExecutorService that could be used for executing a potentially long-running task. The ScheduledExecutorService 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 RequestContext.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

decodedMappedPath

public String decodedMappedPath()

Description copied from interface: ServiceRequestContext

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

Specified by:

decodedMappedPath 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

logger

public org.slf4j.Logger logger()

Description copied from interface: ServiceRequestContext

Returns the Logger of the Service.

Specified by:

logger in interface ServiceRequestContext

requestTimeoutMillis

public long requestTimeoutMillis()

Description copied from interface: ServiceRequestContext

Returns the amount of time allowed until receiving the current Request and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().

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 and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().

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 and sending the corresponding Response completely. This value is initially set from ServiceConfig.requestTimeoutMillis().

Specified by:

setRequestTimeout in interface ServiceRequestContext

requestTimeoutHandler

@Nullable
public Runnable requestTimeoutHandler()

Description copied from interface: ServiceRequestContext

Returns Request timeout handler which is executed when receiving the current Request and sending the corresponding Response is not completely received within the allowed ServiceRequestContext.requestTimeoutMillis().

Specified by:

requestTimeoutHandler in interface ServiceRequestContext

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(ResponseHeaders.of(HttpStatus.OK,
                                   HttpHeaderNames.CONTENT_TYPE, MediaType.PLAIN_TEXT_UTF_8));
      res.write(HttpData.ofUtf8("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 ServiceConfig.maxRequestLength(). 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 ServiceConfig.maxRequestLength(). If 0, there is no limit on the request size.

Specified by:

setMaxRequestLength in interface ServiceRequestContext

See Also:

ContentTooLargeException

verboseResponses

public boolean verboseResponses()

Description copied from interface: ServiceRequestContext

Returns whether the verbose response mode is enabled. When enabled, the service responses will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the service responses will not expose such server-side details to the client.

Specified by:

verboseResponses in interface ServiceRequestContext

accessLogWriter

public AccessLogWriter accessLogWriter()

Specified by:

accessLogWriter in interface ServiceRequestContext

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(CharSequence name,
                                        Object 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(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from interface: ServiceRequestContext

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

Specified by:

setAdditionalResponseHeaders in interface ServiceRequestContext

addAdditionalResponseHeader

public void addAdditionalResponseHeader(CharSequence name,
                                        Object 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(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from interface: ServiceRequestContext

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

Specified by:

addAdditionalResponseHeaders in interface ServiceRequestContext

removeAdditionalResponseHeader

public boolean removeAdditionalResponseHeader(CharSequence 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

additionalResponseTrailers

public HttpHeaders additionalResponseTrailers()

Description copied from interface: ServiceRequestContext

Returns the HttpHeaders which is returned along with any other trailers when a Service completes an HttpResponse.

Specified by:

additionalResponseTrailers in interface ServiceRequestContext

setAdditionalResponseTrailer

public void setAdditionalResponseTrailer(CharSequence name,
                                         Object value)

Description copied from interface: ServiceRequestContext

Sets a trailer with the specified name and value. This will remove all previous values associated with the specified name. The trailer will be included when a Service completes an HttpResponse.

Specified by:

setAdditionalResponseTrailer in interface ServiceRequestContext

setAdditionalResponseTrailers

public void setAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from interface: ServiceRequestContext

Clears the current trailer and sets the specified HttpHeaders which is included when a Service completes an HttpResponse.

Specified by:

setAdditionalResponseTrailers in interface ServiceRequestContext

addAdditionalResponseTrailer

public void addAdditionalResponseTrailer(CharSequence name,
                                         Object value)

Description copied from interface: ServiceRequestContext

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

Specified by:

addAdditionalResponseTrailer in interface ServiceRequestContext

addAdditionalResponseTrailers

public void addAdditionalResponseTrailers(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from interface: ServiceRequestContext

Adds the specified HttpHeaders which is included when a Service completes an HttpResponse.

Specified by:

addAdditionalResponseTrailers in interface ServiceRequestContext

removeAdditionalResponseTrailer

public boolean removeAdditionalResponseTrailer(CharSequence name)

Description copied from interface: ServiceRequestContext

Removes all trailers with the specified name.

Specified by:

removeAdditionalResponseTrailer in interface ServiceRequestContext

Returns:

true if at least one entry has been removed

proxiedAddresses

public ProxiedAddresses proxiedAddresses()

Description copied from interface: ServiceRequestContext

Returns the proxied addresses of the current Request.

Specified by:

proxiedAddresses in interface ServiceRequestContext