ClientRequestContext (filter-service-metrics 1.12 1.12 API)

All Superinterfaces:

io.netty.util.AttributeMap, RequestContext

All Known Implementing Classes:

ClientRequestContextWrapper, DefaultClientRequestContext
```
public interface ClientRequestContext
extends RequestContext
```
Provides information about a Request, its Response and its related utilities. Every client request has its own ClientRequestContext instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addAdditionalRequestHeader(CharSequence name, Object value)` Adds a header with the specified `name` and `value`.
`void`	`addAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Adds the specified `HttpHeaders` which is included when a `Client` sends an `HttpRequest`.
`HttpHeaders`	`additionalRequestHeaders()` Returns an `HttpHeaders` which is included when a `Client` sends an `HttpRequest`.
`static ClientRequestContextBuilder`	`builder(HttpRequest request)` Returns a new `ClientRequestContextBuilder` created from the specified `HttpRequest`.
`static ClientRequestContextBuilder`	`builder(RpcRequest request, String uri)` Returns a new `ClientRequestContextBuilder` created from the specified `RpcRequest` and `uri`.
`static ClientRequestContextBuilder`	`builder(RpcRequest request, URI uri)` Returns a new `ClientRequestContextBuilder` created from the specified `RpcRequest` and `URI`.
`static ClientRequestContext`	`current()` Returns the client-side context of the `Request` that is being handled in the current thread.
`static ClientRequestContext`	`currentOrNull()` Returns the client-side context of the `Request` that is being handled in the current thread.
`Endpoint`	`endpoint()` Returns the remote `Endpoint` of the current `Request`.
`EndpointSelector`	`endpointSelector()` Returns the `EndpointSelector` used for the current `Request`.
`String`	`fragment()` Returns the fragment part of the URI of the current `Request`, as defined in the section 3.5 of RFC3986.
`static <T> T`	`mapCurrent(Function<? super ClientRequestContext,T> mapper, Supplier<T> defaultValueSupplier)` Maps the client-side context of the `Request` that is being handled in the current thread.
`long`	`maxResponseLength()` Returns the maximum length of the received `Response`.
`default ClientRequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)` Creates a new `ClientRequestContext` whose properties and `Attribute`s are copied from this `ClientRequestContext`, except having a different `Request` and its own `RequestLog`.
`ClientRequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq, Endpoint endpoint)` Creates a new `ClientRequestContext` whose properties and `Attribute`s are copied from this `ClientRequestContext`, except having different `Request`, `Endpoint` and its own `RequestLog`.
`static ClientRequestContext`	`of(HttpRequest request)` Returns a new `ClientRequestContext` created from the specified `HttpRequest`.
`static ClientRequestContext`	`of(RpcRequest request, String uri)` Returns a new `ClientRequestContext` created from the specified `RpcRequest` and URI.
`static ClientRequestContext`	`of(RpcRequest request, URI uri)` Returns a new `ClientRequestContext` created from the specified `RpcRequest` and `URI`.
`ClientOptions`	`options()` Returns the `ClientOptions` of the current `Request`.
`boolean`	`removeAdditionalRequestHeader(CharSequence name)` Removes all headers 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`	`responseTimeoutHandler()` Returns `Response` timeout handler which is executed when the `Response` is not completely received within the allowed `responseTimeoutMillis()` or the default `ClientOption.RESPONSE_TIMEOUT_MILLIS`.
`long`	`responseTimeoutMillis()` Returns the amount of time allowed until receiving the `Response` completely since the transfer of the `Response` started.
`RpcRequest`	`rpcRequest()` Returns the `RpcRequest` associated with this context, or `null` if there's no `RpcRequest` associated with this context.
`void`	`setAdditionalRequestHeader(CharSequence name, Object value)` Sets a header with the specified `name` and `value`.
`void`	`setAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Clears the current header and sets the specified `HttpHeaders` which is included when a `Client` sends an `HttpRequest`.
`void`	`setMaxResponseLength(long maxResponseLength)` Sets the maximum length of the received `Response`.
`void`	`setResponseTimeout(Duration responseTimeout)` Sets the amount of time allowed until receiving the `Response` completely since the transfer of the `Response` started.
`void`	`setResponseTimeoutHandler(Runnable responseTimeoutHandler)` Sets a handler to run when the response times out.
`void`	`setResponseTimeoutMillis(long responseTimeoutMillis)` Sets the amount of time allowed until receiving the `Response` completely since the transfer of the `Response` started.
`void`	`setWriteTimeout(Duration writeTimeout)` Returns the amount of time allowed until the initial write attempt of the current `Request` succeeds.
`void`	`setWriteTimeoutMillis(long writeTimeoutMillis)` Returns the amount of time allowed until the initial write attempt of the current `Request` succeeds.
`long`	`writeTimeoutMillis()` Returns the amount of time allowed until the initial write attempt of the current `Request` succeeds.

Methods inherited from interface com.linecorp.armeria.common.RequestContext
alloc, attrs, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, invokeOnChildCallbacks, invokeOnEnterCallbacks, invokeOnExitCallbacks, isTimedOut, localAddress, 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, remoteAddress, resolvePromise, sessionProtocol, sslSession, updateRequest, updateRpcRequest

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

- Method Detail
  - current
```
static ClientRequestContext current()
```
    Returns the client-side context of the Request that is being handled in the current thread.
    
    Specified by:
    
    current in interface RequestContext
    
    Throws:
    
    IllegalStateException - if the context is unavailable in the current thread or the current context is not a ClientRequestContext.
  - currentOrNull
```
@Nullable
static ClientRequestContext currentOrNull()
```
    Returns the client-side context of the Request that is being handled in the current thread.
    
    Specified by:
    
    currentOrNull in interface RequestContext
    
    Returns:
    
    the ClientRequestContext available in the current thread, or null if unavailable.
    
    Throws:
    
    IllegalStateException - if the current context is not a ClientRequestContext.
  - mapCurrent
```
@Nullable
static <T> T mapCurrent(Function<? super ClientRequestContext,T> mapper,
                                  @Nullable
                                  Supplier<T> defaultValueSupplier)
```
    Maps the client-side context of the Request that is being handled in the current thread.
    
    Parameters:
    
    mapper - the Function that maps the ClientRequestContext
    
    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 ClientRequestContext.
  - of
```
static ClientRequestContext of(HttpRequest request)
```
    Returns a new ClientRequestContext 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:
    
    ClientRequestContextBuilder
  - of
```
static ClientRequestContext of(RpcRequest request,
                               String uri)
```
    Returns a new ClientRequestContext created from the specified RpcRequest and URI. 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:
    
    ClientRequestContextBuilder
  - of
```
static ClientRequestContext of(RpcRequest request,
                               URI uri)
```
    Returns a new ClientRequestContext created from the specified RpcRequest and URI. 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:
    
    ClientRequestContextBuilder
  - builder
```
static ClientRequestContextBuilder builder(HttpRequest request)
```
    Returns a new ClientRequestContextBuilder created from the specified HttpRequest.
  - builder
```
static ClientRequestContextBuilder builder(RpcRequest request,
                                           String uri)
```
    Returns a new ClientRequestContextBuilder created from the specified RpcRequest and uri.
  - builder
```
static ClientRequestContextBuilder builder(RpcRequest request,
                                           URI uri)
```
    Returns a new ClientRequestContextBuilder created from the specified RpcRequest and URI.
  - request
```
@Nullable
HttpRequest request()
```
    Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet. For example, when you send an RPC request, this method will return null until the RPC request is translated into an HTTP request.
    
    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 you are not sending an RPC request but just a plain HTTP request.
    
    Specified by:
    
    rpcRequest in interface RequestContext
  - newDerivedContext
```
default ClientRequestContext newDerivedContext(RequestId id,
                                               @Nullable
                                               HttpRequest req,
                                               @Nullable
                                               RpcRequest rpcReq)
```
    Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having a different Request and its own RequestLog.
    
    Specified by:
    
    newDerivedContext in interface RequestContext
  - newDerivedContext
```
ClientRequestContext newDerivedContext(RequestId id,
                                       @Nullable
                                       HttpRequest req,
                                       @Nullable
                                       RpcRequest rpcReq,
                                       Endpoint endpoint)
```
    Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having different Request, Endpoint and its own RequestLog.
  - endpointSelector
```
@Nullable
EndpointSelector endpointSelector()
```
    Returns the EndpointSelector used for the current Request.
    
    Returns:
    
    the EndpointSelector if a user specified a group Endpoint. null if a user specified a host Endpoint.
  - endpoint
```
@Nullable
Endpoint endpoint()
```
    Returns the remote Endpoint of the current Request.
    
    Returns:
    
    the remote Endpoint. null if the Request has failed because its remote Endpoint couldn't be determined.
  - options
```
ClientOptions options()
```
    Returns the ClientOptions of the current Request.
  - fragment
```
@Nullable
String fragment()
```
    Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
    
    Returns:
    
    the fragment part of the request URI, or null if no fragment was specified
  - writeTimeoutMillis
```
long writeTimeoutMillis()
```
    Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOption.WRITE_TIMEOUT_MILLIS.
  - setWriteTimeoutMillis
```
void setWriteTimeoutMillis(long writeTimeoutMillis)
```
    Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOption.WRITE_TIMEOUT_MILLIS.
  - setWriteTimeout
```
void setWriteTimeout(Duration writeTimeout)
```
    Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOption.WRITE_TIMEOUT_MILLIS.
  - responseTimeoutMillis
```
long responseTimeoutMillis()
```
    Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
  - setResponseTimeoutMillis
```
void setResponseTimeoutMillis(long responseTimeoutMillis)
```
    Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
  - setResponseTimeout
```
void setResponseTimeout(Duration responseTimeout)
```
    Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
  - responseTimeoutHandler
```
@Nullable
Runnable responseTimeoutHandler()
```
    Returns Response timeout handler which is executed when the Response is not completely received within the allowed responseTimeoutMillis() or the default ClientOption.RESPONSE_TIMEOUT_MILLIS.
  - setResponseTimeoutHandler
```
void setResponseTimeoutHandler(Runnable responseTimeoutHandler)
```
    Sets a handler to run when the response times out. responseTimeoutHandler must abort the response, e.g., by calling StreamMessage.abort(Throwable). If not set, the response will be closed with ResponseTimeoutException.
    For example,
```
 HttpResponseWriter res = HttpResponse.streaming();
 ctx.setResponseTimeoutHandler(() -> {
    res.abort(new IllegalStateException("Server is in a bad state."));
 });
 ...
 
```
  - maxResponseLength
```
long maxResponseLength()
```
    Returns the maximum length of the received Response. This value is initially set from ClientOption.MAX_RESPONSE_LENGTH.
    
    See Also:
    
    ContentTooLargeException
  - setMaxResponseLength
```
void setMaxResponseLength(long maxResponseLength)
```
    Sets the maximum length of the received Response. This value is initially set from ClientOption.MAX_RESPONSE_LENGTH.
    
    See Also:
    
    ContentTooLargeException
  - additionalRequestHeaders
```
HttpHeaders additionalRequestHeaders()
```
    Returns an HttpHeaders which is included when a Client sends an HttpRequest.
  - setAdditionalRequestHeader
```
void setAdditionalRequestHeader(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 Client sends an HttpRequest.
  - setAdditionalRequestHeaders
```
void setAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Clears the current header and sets the specified HttpHeaders which is included when a Client sends an HttpRequest.
  - addAdditionalRequestHeader
```
void addAdditionalRequestHeader(CharSequence name,
                                Object value)
```
    Adds a header with the specified name and value. The header will be included when a Client sends an HttpRequest.
  - addAdditionalRequestHeaders
```
void addAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Adds the specified HttpHeaders which is included when a Client sends an HttpRequest.
  - removeAdditionalRequestHeader
```
boolean removeAdditionalRequestHeader(CharSequence name)
```
    Removes all headers with the specified name.
    
    Returns:
    
    true if at least one entry has been removed

Interface ClientRequestContext

Method Summary

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

Methods inherited from interface io.netty.util.AttributeMap

Method Detail

current

currentOrNull

mapCurrent

of

of

of

builder

builder

builder

request

rpcRequest

newDerivedContext

newDerivedContext

endpointSelector

endpoint

options

fragment

writeTimeoutMillis

setWriteTimeoutMillis

setWriteTimeout

responseTimeoutMillis

setResponseTimeoutMillis

setResponseTimeout

responseTimeoutHandler

setResponseTimeoutHandler

maxResponseLength

setMaxResponseLength

additionalRequestHeaders

setAdditionalRequestHeader

setAdditionalRequestHeaders

addAdditionalRequestHeader

addAdditionalRequestHeaders

removeAdditionalRequestHeader