All Superinterfaces:: 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
`default AccessLogWriter`	`accessLogWriter()`	Deprecated. Access via `config()`.
`void`	`addAdditionalResponseHeader(CharSequence name, Object value)`	Adds a header with the specified `name` and `value`.
`void`	`addAdditionalResponseTrailer(CharSequence name, Object value)`	Adds a trailer with the specified `name` and `value`.
`HttpHeaders`	`additionalResponseHeaders()`	Returns the `HttpHeaders` which will be included when a `Service` sends an `HttpResponse`.
`HttpHeaders`	`additionalResponseTrailers()`	Returns the `HttpHeaders` which is included 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.
`static ServiceRequestContextBuilder`	`builder(HttpRequest request)`	Returns a new `ServiceRequestContextBuilder` created from the specified `HttpRequest`.
`void`	`clearRequestTimeout()`	Clears the previously scheduled request timeout, if any.
`InetAddress`	`clientAddress()`	Returns the address of the client who initiated this request.
`ServiceConfig`	`config()`	Returns the `ServiceConfig` of the `Service` that is handling the current `Request`.
`static ServiceRequestContext`	`current()`	Returns the server-side context of the `Request` that is being handled in the current thread.
`static ServiceRequestContext`	`currentOrNull()`	Returns the server-side context of the `Request` that is being handled in the current thread.
`String`	`decodedMappedPath()`	Returns the `RequestContext.decodedPath()` with its context path removed.
`default void`	`extendRequestTimeout(Duration adjustment)`	Deprecated. Use `setRequestTimeout(TimeoutMode, Duration)`} with `TimeoutMode.EXTEND`.
`default void`	`extendRequestTimeoutMillis(long adjustmentMillis)`	Deprecated. Use `setRequestTimeoutMillis(TimeoutMode, long)`} with `TimeoutMode.EXTEND`.
`<A extends SocketAddress> A`	`localAddress()`	Returns the local address of this request.
`static <T> T`	`mapCurrent(Function<? super ServiceRequestContext,T> mapper, Supplier<T> defaultValueSupplier)`	Maps the server-side context of the `Request` that is being handled in the current thread.
`String`	`mappedPath()`	Returns the `RequestContext.path()` with its context path removed.
`long`	`maxRequestLength()`	Returns the maximum length of the current `Request`.
`void`	`mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder> mutator)`	Mutates the `HttpHeaders` which will be included when a `Service` sends an `HttpResponse`.
`void`	`mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder> mutator)`	Mutates the `HttpHeaders` which is included along with any other trailers when a `Service` completes an `HttpResponse`.
`MediaType`	`negotiatedResponseMediaType()`	Returns the negotiated producible media type.
`ServiceRequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)`	Deprecated.
`static ServiceRequestContext`	`of(HttpRequest request)`	Returns a new `ServiceRequestContext` created from the specified `HttpRequest`.
`default String`	`pathParam(String name)`	Returns the value of the specified path parameter.
`Map<String,String>`	`pathParams()`	Returns the path parameters mapped by the `Route` associated with the `Service` that is handling the current `Request`.
`ProxiedAddresses`	`proxiedAddresses()`	Returns the proxied addresses of the current `Request`.
`default SafeCloseable`	`push()`	Pushes this context to the thread-local stack.
`<A extends SocketAddress> A`	`remoteAddress()`	Returns the remote address of this request.
`HttpRequest`	`request()`	Returns the `HttpRequest` associated with this context.
`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 `requestTimeoutMillis()`.
`long`	`requestTimeoutMillis()`	Returns the amount of time allowed from the start time of the `Request` until receiving the current `Request` and sending the corresponding `Response` completely.
`default ServiceRequestContext`	`root()`	Returns the root `ServiceRequestContext` of this context.
`default Route`	`route()`	Deprecated. Access via `config()`.
`RoutingContext`	`routingContext()`	Returns the `RoutingContext` used to find the `Service`.
`RpcRequest`	`rpcRequest()`	Returns the `RpcRequest` associated with this context, or `null` if there's no `RpcRequest` associated with this context.
`default Server`	`server()`	Deprecated. Access via `config()`.
`default HttpService`	`service()`	Deprecated. Access via `config()`.
`void`	`setAdditionalResponseHeader(CharSequence name, Object value)`	Sets a header with the specified `name` and `value`.
`void`	`setAdditionalResponseTrailer(CharSequence name, Object value)`	Sets a trailer with the specified `name` and `value`.
`void`	`setMaxRequestLength(long maxRequestLength)`	Sets the maximum length of the current `Request`.
`default void`	`setRequestTimeout(TimeoutMode mode, Duration requestTimeout)`	Schedules the request timeout that is triggered when the `Request` is not fully received or the corresponding `Response` is not sent completely within the specified `TimeoutMode` and the specified `requestTimeout`.
`default void`	`setRequestTimeout(Duration requestTimeout)`	Schedules the request timeout that is triggered when the `Request` is not fully received or the corresponding `Response` is not sent completely within the specified amount time from now.
`default void`	`setRequestTimeoutAfter(Duration requestTimeout)`	Deprecated. Use `setRequestTimeout(TimeoutMode, Duration)`} with `TimeoutMode.SET_FROM_NOW`.
`default void`	`setRequestTimeoutAfterMillis(long requestTimeoutMillis)`	Deprecated. Use `setRequestTimeoutMillis(TimeoutMode, long)`} with `TimeoutMode.SET_FROM_NOW`.
`default void`	`setRequestTimeoutAt(Instant requestTimeoutAt)`	Deprecated. This method will be removed without a replacement.
`void`	`setRequestTimeoutAtMillis(long requestTimeoutAtMillis)`	Deprecated. This method will be removed without a replacement.
`void`	`setRequestTimeoutHandler(Runnable requestTimeoutHandler)`	Sets a handler to run when the request times out.
`default void`	`setRequestTimeoutMillis(long requestTimeoutMillis)`	Schedules the request timeout that is triggered when the `Request` is not fully received or the corresponding `Response` is not sent completely within the specified amount time from now.
`void`	`setRequestTimeoutMillis(TimeoutMode mode, long requestTimeoutMillis)`	Schedules the request timeout that is triggered when the `Request` is not fully received or the corresponding `Response` is not sent completely within the specified `TimeoutMode` and the specified `requestTimeoutMillis`.
`default boolean`	`verboseResponses()`	Deprecated. Access via `config()`.
`default VirtualHost`	`virtualHost()`	Deprecated. Access via `config()`.

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

alloc, attr, attrs, computeAttrIfAbsent, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, isTimedOut, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, ownAttr, ownAttrs, path, query, replace, sessionProtocol, setAttr, setAttrIfAbsent, sslSession, timeoutNow, updateRequest, updateRpcRequest

Method Details

current

static ServiceRequestContext current()

Returns the server-side context of the Request that is being handled in the current thread. If the context is a ClientRequestContext, RequestContext.root() is returned.

Throws:

IllegalStateException - if the context is unavailable in the current thread or the current context is a ClientRequestContext and RequestContext.root() is null
currentOrNull

@Nullable static ServiceRequestContext currentOrNull()

Returns the server-side context of the Request that is being handled in the current thread. If the context is a ClientRequestContext, RequestContext.root() is returned.

Returns:

the ServiceRequestContext available in the current thread, or null if unavailable.
mapCurrent

@Nullable static <T> T mapCurrent(Function<? super ServiceRequestContext,T> mapper, @Nullable Supplier<T> defaultValueSupplier)

Maps the server-side context of the Request that is being handled in the current thread.

Parameters:

mapper - the Function that maps the ServiceRequestContext

defaultValueSupplier - the Supplier that provides the value when the context is unavailable in the current thread. If null, the null will be returned when the context is unavailable in the current thread.

Throws:

IllegalStateException - if the current context is not a ServiceRequestContext.
of

static ServiceRequestContext of(HttpRequest request)

Returns a new ServiceRequestContext created from the specified HttpRequest. 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.

See Also:

ServiceRequestContextBuilder
builder

static ServiceRequestContextBuilder builder(HttpRequest request)

Returns a new ServiceRequestContextBuilder created from the specified HttpRequest.
root

@Nonnull default ServiceRequestContext root()

Returns the root ServiceRequestContext of this context. This method always returns this.

Specified by:

root in interface RequestContext

Returns:

this
request

@Nonnull HttpRequest request()

Returns the HttpRequest associated with this context.

Specified by:

request in interface RequestContext
rpcRequest

@Nullable RpcRequest rpcRequest()

Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context. For example, this method will return null when the request being handled is 1) not an RPC request or 2) not decoded into an RPC request yet.

Specified by:

rpcRequest in interface RequestContext
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
clientAddress

InetAddress clientAddress()

Returns the address of the client who initiated this request.
push

default SafeCloseable push()
Pushes this context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block:
```
 try (SafeCloseable ignored = ctx.push()) {
     ...
 }
 
```
In order to call this method, the current thread-local state must meet one of the following conditions:
- the thread-local does not have any RequestContext in it
- the thread-local has the same ServiceRequestContext as this - reentrance
- the thread-local has the ClientRequestContext whose RequestContext.root() is the same ServiceRequestContext as this
Otherwise, this method will throw an IllegalStateException.
Specified by:

push in interface RequestContext
newDerivedContext

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

Deprecated.

Description copied from interface: RequestContext

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

Specified by:

newDerivedContext in interface RequestContext
config

ServiceConfig config()

Returns the ServiceConfig of the Service that is handling the current Request.
server

@Deprecated default Server server()

Deprecated.
Access via config().

Returns the Server that is handling the current Request.
virtualHost

@Deprecated default VirtualHost virtualHost()

Deprecated.
Access via config().

Returns the VirtualHost that is handling the current Request.
route

@Deprecated default Route route()

Deprecated.
Access via config().

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

RoutingContext routingContext()

Returns the RoutingContext used to find the Service.
pathParams

Map<String,String> pathParams()

Returns the path parameters mapped by the Route 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

@Deprecated default HttpService service()

Deprecated.
Access via config().

Returns the HttpService that is handling the current Request.
blockingTaskExecutor

ScheduledExecutorService blockingTaskExecutor()

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.
mappedPath

String mappedPath()

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

String decodedMappedPath()

Returns the RequestContext.decodedPath() 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.
requestTimeoutMillis

long requestTimeoutMillis()

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

void clearRequestTimeout()

Clears the previously scheduled request timeout, if any. Note that calling this will prevent the request from ever being timed out.
setRequestTimeoutMillis

default void setRequestTimeoutMillis(long requestTimeoutMillis)
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified amount time from now. Note that the specified requestTimeout must be positive. This value is initially set from ServiceConfig.requestTimeoutMillis(). This method is a shortcut for setRequestTimeoutMillis(TimeoutMode.SET_FROM_NOW, requestTimeoutMillis).
For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeoutMillis(1000);
 
```
Parameters:

requestTimeoutMillis - the amount of time allowed in milliseconds from now

setRequestTimeoutMillis

void setRequestTimeoutMillis(TimeoutMode mode, long requestTimeoutMillis)

Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeoutMillis.

Timeout mode	description
`TimeoutMode.SET_FROM_NOW`	Sets a given amount of timeout from the current time.
`TimeoutMode.SET_FROM_START`	Sets a given amount of timeout since the current `Request` began processing.
`TimeoutMode.EXTEND`	Extends the previously scheduled timeout by the given amount of timeout.

For example:


 ServiceRequestContext ctx = ...;
 // Schedules a timeout from the start time of the request
 ctx.setRequestTimeoutMillis(TimeoutMode.SET_FROM_START, 2000);
 assert ctx.requestTimeoutMillis() == 2000;
 ctx.setRequestTimeoutMillis(TimeoutMode.SET_FROM_START, 1000);
 assert ctx.requestTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setRequestTimeoutMillis(TimeoutMode.SET_FROM_NOW, 3000);

 // Extends the previously scheduled timeout.
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.setRequestTimeoutMillis(TimeoutMode.EXTEND, 1000);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.extendRequestTimeoutMillis(TimeoutMode.EXTEND, -500);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;

setRequestTimeout

default void setRequestTimeout(Duration requestTimeout)
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified amount time from now. Note that the specified requestTimeout must be positive. This value is initially set from ServiceConfig.requestTimeoutMillis(). This method is a shortcut for setRequestTimeout(TimeoutMode.SET_FROM_NOW, requestTimeout).
For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeout(Duration.ofSeconds(1));
 
```
Parameters:

requestTimeout - the amount of time allowed from now

setRequestTimeout

default void setRequestTimeout(TimeoutMode mode, Duration requestTimeout)

Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeout.

Timeout mode	description
`TimeoutMode.SET_FROM_NOW`	Sets a given amount of timeout from the current time.
`TimeoutMode.SET_FROM_START`	Sets a given amount of timeout since the current `Request` began processing.
`TimeoutMode.EXTEND`	Extends the previously scheduled timeout by the given amount of timeout.

For example:


 ServiceRequestContext ctx = ...;
 // Schedules a timeout from the start time of the request
 ctx.setRequestTimeout(TimeoutMode.SET_FROM_START, Duration.ofSeconds(2));
 assert ctx.requestTimeoutMillis() == 2000;
 ctx.setRequestTimeout(TimeoutMode.SET_FROM_START, Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setRequestTimeout(TimeoutMode.SET_FROM_NOW, Duration.ofSeconds(3));

 // Extends the previously scheduled timeout.
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.setRequestTimeout(TimeoutMode.EXTEND, Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.setRequestTimeout(TimeoutMode.EXTEND, Duration.ofMillis(-500));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;

extendRequestTimeoutMillis

@Deprecated default void extendRequestTimeoutMillis(long adjustmentMillis)

Deprecated.
Use setRequestTimeoutMillis(TimeoutMode, long)} with TimeoutMode.EXTEND.
Extends the previously scheduled request timeout by the specified amount of adjustmentMillis. This method does nothing if no request timeout was scheduled previously. Note that a negative adjustment reduces the current timeout. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
For example:
```
 ServiceRequestContext ctx = ...;
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.extendRequestTimeoutMillis(1000);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.extendRequestTimeoutMillis(-500);
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;
 
```
Parameters:

adjustmentMillis - the amount of time in milliseconds to extend the current timeout by
extendRequestTimeout

@Deprecated default void extendRequestTimeout(Duration adjustment)

Deprecated.
Use setRequestTimeout(TimeoutMode, Duration)} with TimeoutMode.EXTEND.
Extends the previously scheduled request timeout by the specified amount of adjustment. This method does nothing if no response timeout was scheduled previously. Note that a negative adjustment reduces the current timeout. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
For example:
```
 ServiceRequestContext ctx = ...;
 long oldRequestTimeoutMillis = ctx.requestTimeoutMillis();
 ctx.extendRequestTimeout(Duration.ofSeconds(1));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 1000;
 ctx.extendRequestTimeout(Duration.ofMillis(-500));
 assert ctx.requestTimeoutMillis() == oldRequestTimeoutMillis + 500;
 
```
Parameters:

adjustment - the amount of time to extend the current timeout by
setRequestTimeoutAfterMillis

@Deprecated default void setRequestTimeoutAfterMillis(long requestTimeoutMillis)

Deprecated.
Use setRequestTimeoutMillis(TimeoutMode, long)} with TimeoutMode.SET_FROM_NOW.
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified amount of time from now. Note that the specified requestTimeoutMillis must be positive. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeoutAfterMillis(1000);
 
```
Parameters:

requestTimeoutMillis - the amount of time allowed in milliseconds from now
setRequestTimeoutAfter

@Deprecated default void setRequestTimeoutAfter(Duration requestTimeout)

Deprecated.
Use setRequestTimeout(TimeoutMode, Duration)} with TimeoutMode.SET_FROM_NOW.
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified amount time from now. Note that the specified requestTimeout must be positive. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeoutAfter(Duration.ofSeconds(1));
 
```
Parameters:

requestTimeout - the amount of time allowed from now
setRequestTimeoutAtMillis

@Deprecated void setRequestTimeoutAtMillis(long requestTimeoutAtMillis)

Deprecated.
This method will be removed without a replacement. Use setRequestTimeout(TimeoutMode, Duration) or clearRequestTimeout().
Schedules the request timeout that is triggered at the specified time represented as the number since the epoch (1970-01-01T00:00:00Z). Note that the request will be timed out immediately if the specified time is before now. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 long responseTimeoutAt = Instant.now().plus(1, ChronoUnit.SECONDS).toEpochMilli();
 ctx.setRequestTimeoutAtMillis(responseTimeoutAt);
 
```
Parameters:

requestTimeoutAtMillis - the request timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
setRequestTimeoutAt

@Deprecated default void setRequestTimeoutAt(Instant requestTimeoutAt)

Deprecated.
This method will be removed without a replacement. Use setRequestTimeout(TimeoutMode, Duration) or clearRequestTimeout().
Schedules the request timeout that is triggered at the specified time represented as the number since the epoch (1970-01-01T00:00:00Z). Note that the request will be timed out immediately if the specified time is before now. The initial timeout is set from ServiceConfig.requestTimeoutMillis().
For example:
```
 ServiceRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setRequestTimeoutAt(Instant.now().plus(1, ChronoUnit.SECONDS));
 
```
Parameters:

requestTimeoutAt - the request timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
requestTimeoutHandler

@Nullable 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 requestTimeoutMillis().

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(ResponseHeaders.of(HttpStatus.OK,
                                   HttpHeaderNames.CONTENT_TYPE, MediaType.PLAIN_TEXT_UTF_8));
      res.write(HttpData.ofUtf8("Request timed out."));
      res.close();
   });
   ...

maxRequestLength

long maxRequestLength()

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.

See Also:

ContentTooLargeException
setMaxRequestLength

void setMaxRequestLength(long maxRequestLength)

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.

See Also:

ContentTooLargeException
verboseResponses

@Deprecated default boolean verboseResponses()

Deprecated.
Access via config().

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.
accessLogWriter

@Deprecated default AccessLogWriter accessLogWriter()

Deprecated.
Access via config().

Returns the AccessLogWriter.
additionalResponseHeaders

HttpHeaders additionalResponseHeaders()

Returns the HttpHeaders which will be included when a Service sends an HttpResponse.
setAdditionalResponseHeader

void setAdditionalResponseHeader(CharSequence name, Object 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.
addAdditionalResponseHeader

void addAdditionalResponseHeader(CharSequence name, Object value)

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

void mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder> mutator)

Mutates the HttpHeaders which will be included when a Service sends an HttpResponse.

Parameters:

mutator - the Consumer that mutates the additional response headers
additionalResponseTrailers

HttpHeaders additionalResponseTrailers()

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

void setAdditionalResponseTrailer(CharSequence name, Object value)

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.
addAdditionalResponseTrailer

void addAdditionalResponseTrailer(CharSequence name, Object value)

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

void mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder> mutator)

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

Parameters:

mutator - the Consumer that mutates the additional trailers
proxiedAddresses

ProxiedAddresses proxiedAddresses()

Returns the proxied addresses of the current Request.

Interface ServiceRequestContext

Method Summary

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

Method Details