ClientRequestContextWrapper (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.common.RequestContextWrapper<ClientRequestContext>
- - com.linecorp.armeria.client.ClientRequestContextWrapper

All Implemented Interfaces:: ClientRequestContext, RequestContext

public class ClientRequestContextWrapper
extends RequestContextWrapper<ClientRequestContext>
implements ClientRequestContext

Wraps an existing ClientRequestContext.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ClientRequestContextWrapper(ClientRequestContext delegate)
Creates a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`ClientRequestContextWrapper(ClientRequestContext delegate)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated 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`.
`void`	`clearResponseTimeout()` Clears the previously scheduled response timeout, if any.
`Endpoint`	`endpoint()` Returns the remote `Endpoint` of the current `Request`.
`EndpointGroup`	`endpointGroup()` Returns the `EndpointGroup` used for the current `Request`.
`void`	`extendResponseTimeout(Duration adjustment)` Extends the previously scheduled response timeout by the specified amount of `adjustment`.
`void`	`extendResponseTimeoutMillis(long adjustmentMillis)` Extends the previously scheduled response timeout by the specified amount of `adjustmentMillis`.
`String`	`fragment()` Returns the fragment part of the URI of the current `Request`, as defined in the section 3.5 of RFC3986.
`long`	`maxResponseLength()` Returns the maximum length of the received `Response`.
`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`.
`ClientOptions`	`options()` Returns the `ClientOptions` of the current `Request`.
`<V> V`	`ownAttr(io.netty.util.AttributeKey<V> key)` Returns the value mapped to the given `AttributeKey` or `null` if there's no value set by `RequestContext.setAttr(AttributeKey, Object)` or `RequestContext.setAttrIfAbsent(AttributeKey, Object)`.
`Iterator<Map.Entry<io.netty.util.AttributeKey<?>,Object>>`	`ownAttrs()` Returns the `Iterator` of all `Map.Entry`s this context contains.
`boolean`	`removeAdditionalRequestHeader(CharSequence name)` Removes all headers with the specified `name`.
`Runnable`	`responseTimeoutHandler()` Returns `Response` timeout handler which is executed when the `Response` is not completely received within the allowed `ClientRequestContext.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.
`ServiceRequestContext`	`root()` Returns the `ServiceRequestContext` whose `Service` invokes the `Client` `Request` which created this `ClientRequestContext`, or `null` if this client request was not made in the context of a server request.
`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)` Deprecated.
`void`	`setResponseTimeoutAfter(Duration responseTimeout)` Schedules the response timeout that is triggered when the `Response` is not fully received within the specified amount of time from now.
`void`	`setResponseTimeoutAfterMillis(long responseTimeoutMillis)` Schedules the response timeout that is triggered when the `Response` is not fully received within the specified amount of time from now.
`void`	`setResponseTimeoutAt(Instant responseTimeoutAt)` Schedules the response timeout that is triggered at the specified time represented as the number of milliseconds since the epoch (`1970-01-01T00:00:00Z`).
`void`	`setResponseTimeoutAtMillis(long responseTimeoutAtMillis)` Schedules the response timeout that is triggered at the specified time represented as the number since the epoch (`1970-01-01T00:00:00Z`).
`void`	`setResponseTimeoutHandler(Runnable responseTimeoutHandler)` Sets a handler to run when the response times out.
`void`	`setResponseTimeoutMillis(long responseTimeoutMillis)` Deprecated.
`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 class com.linecorp.armeria.common.RequestContextWrapper
alloc, attr, attrs, computeAttrIfAbsent, decodedPath, delegate, eventLoop, id, localAddress, log, logBuilder, meterRegistry, method, path, query, remoteAddress, request, rpcRequest, sessionProtocol, setAttr, setAttrIfAbsent, sslSession, updateRequest, updateRpcRequest

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.client.ClientRequestContext
attr, attrs, builder, builder, builder, current, currentOrNull, mapCurrent, newDerivedContext, of, of, of, push, request, rpcRequest

Methods inherited from interface com.linecorp.armeria.common.RequestContext
alloc, computeAttrIfAbsent, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, localAddress, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, mapCurrent, meterRegistry, method, path, push, push, push, pushIfAbsent, query, rejectPromise, remoteAddress, replace, resolvePromise, sessionProtocol, setAttr, setAttrIfAbsent, sslSession, updateRequest, updateRpcRequest

- Constructor Detail
  - ClientRequestContextWrapper
```
protected ClientRequestContextWrapper(ClientRequestContext delegate)
```
    Creates a new instance.
- Method Detail
  - root
```
public ServiceRequestContext root()
```
    Description copied from interface: ClientRequestContext
    
    Returns the ServiceRequestContext whose Service invokes the Client Request which created this ClientRequestContext, or null if this client request was not made in the context of a server request.
    
    Specified by:
    
    root in interface ClientRequestContext
  - ownAttr
```
public <V> V ownAttr(io.netty.util.AttributeKey<V> key)
```
    Description copied from interface: ClientRequestContext
    
    Returns the value mapped to the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object) or RequestContext.setAttrIfAbsent(AttributeKey, Object). Unlike ClientRequestContext.attr(AttributeKey), this does not search in ClientRequestContext.root().
    
    Specified by:
    
    ownAttr in interface ClientRequestContext
    
    See Also:
    
    ClientRequestContext.attr(AttributeKey)
  - ownAttrs
```
public Iterator<Map.Entry<io.netty.util.AttributeKey<?>,Object>> ownAttrs()
```
    Description copied from interface: ClientRequestContext
    
    Returns the Iterator of all Map.Entrys this context contains. Unlike ClientRequestContext.attrs(), this does not iterate ClientRequestContext.root().
    
    Specified by:
    
    ownAttrs in interface ClientRequestContext
    
    See Also:
    
    ClientRequestContext.attrs()
  - newDerivedContext
```
public ClientRequestContext newDerivedContext(RequestId id,
                                              HttpRequest req,
                                              RpcRequest rpcReq,
                                              Endpoint endpoint)
```
    Description copied from interface: ClientRequestContext
    
    Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having different Request, Endpoint and its own RequestLog.
    
    Specified by:
    
    newDerivedContext in interface ClientRequestContext
  - endpointGroup
```
public EndpointGroup endpointGroup()
```
    Description copied from interface: ClientRequestContext
    
    Returns the EndpointGroup used for the current Request.
    
    Specified by:
    
    endpointGroup in interface ClientRequestContext
    
    Returns:
    
    the EndpointGroup if a user specified an EndpointGroup when initiating a Request. null if a user specified an Endpoint.
  - endpoint
```
public Endpoint endpoint()
```
    Description copied from interface: ClientRequestContext
    
    Returns the remote Endpoint of the current Request.
    
    Specified by:
    
    endpoint in interface ClientRequestContext
    
    Returns:
    
    the remote Endpoint, or null if the Request has failed because its remote Endpoint couldn't be determined.
  - fragment
```
public String fragment()
```
    Description copied from interface: ClientRequestContext
    
    Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
    
    Specified by:
    
    fragment in interface ClientRequestContext
    
    Returns:
    
    the fragment part of the request URI, or null if no fragment was specified
  - options
```
public ClientOptions options()
```
    Description copied from interface: ClientRequestContext
    
    Returns the ClientOptions of the current Request.
    
    Specified by:
    
    options in interface ClientRequestContext
  - writeTimeoutMillis
```
public long writeTimeoutMillis()
```
    Description copied from interface: ClientRequestContext
    
    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.
    
    Specified by:
    
    writeTimeoutMillis in interface ClientRequestContext
  - setWriteTimeoutMillis
```
public void setWriteTimeoutMillis(long writeTimeoutMillis)
```
    Description copied from interface: ClientRequestContext
    
    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.
    
    Specified by:
    
    setWriteTimeoutMillis in interface ClientRequestContext
  - setWriteTimeout
```
public void setWriteTimeout(Duration writeTimeout)
```
    Description copied from interface: ClientRequestContext
    
    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.
    
    Specified by:
    
    setWriteTimeout in interface ClientRequestContext
  - responseTimeoutMillis
```
public long responseTimeoutMillis()
```
    Description copied from interface: ClientRequestContext
    
    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.
    
    Specified by:
    
    responseTimeoutMillis in interface ClientRequestContext
  - clearResponseTimeout
```
public void clearResponseTimeout()
```
    Description copied from interface: ClientRequestContext
    
    Clears the previously scheduled response timeout, if any. Note that calling this will prevent the response from ever being timed out.
    
    Specified by:
    
    clearResponseTimeout in interface ClientRequestContext
  - setResponseTimeoutMillis
```
@Deprecated
public void setResponseTimeoutMillis(long responseTimeoutMillis)
```
    Deprecated.
    
    Description copied from interface: ClientRequestContext
    Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time since the Response started or Request was fully sent. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 ctx.setResponseTimeoutMillis(1000);
 assert ctx.responseTimeoutMillis() == 1000;
 ctx.setResponseTimeoutMillis(2000);
 assert ctx.responseTimeoutMillis() == 2000;
 
```
    Specified by:
    
    setResponseTimeoutMillis in interface ClientRequestContext
    
    Parameters:
    
    responseTimeoutMillis - the amount of time allowed in milliseconds from the beginning of the response
  - setResponseTimeout
```
@Deprecated
public void setResponseTimeout(Duration responseTimeout)
```
    Deprecated.
    
    Description copied from interface: ClientRequestContext
    Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time since the Response started or Request was fully sent. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 ctx.setResponseTimeout(Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == 1000;
 ctx.setResponseTimeout(Duration.ofSeconds(2));
 assert ctx.responseTimeoutMillis() == 2000;
 
```
    Specified by:
    
    setResponseTimeout in interface ClientRequestContext
    
    Parameters:
    
    responseTimeout - the amount of time allowed from the beginning of the response
  - extendResponseTimeoutMillis
```
public void extendResponseTimeoutMillis(long adjustmentMillis)
```
    Description copied from interface: ClientRequestContext
    Extends the previously scheduled response timeout by the specified amount of adjustmentMillis. This method does nothing if no response timeout was scheduled previously. Note that a negative adjustmentMillis reduces the current timeout. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.extendResponseTimeoutMillis(1000);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.extendResponseTimeoutMillis(-500);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;
 
```
    Specified by:
    
    extendResponseTimeoutMillis in interface ClientRequestContext
    
    Parameters:
    
    adjustmentMillis - the amount of time in milliseconds to extend the current timeout by
  - extendResponseTimeout
```
public void extendResponseTimeout(Duration adjustment)
```
    Description copied from interface: ClientRequestContext
    Extends the previously scheduled response 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 ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.extendResponseTimeout(Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.extendResponseTimeout(Duration.ofMillis(-500));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;
 
```
    Specified by:
    
    extendResponseTimeout in interface ClientRequestContext
    
    Parameters:
    
    adjustment - the amount of time to extend the current timeout by
  - setResponseTimeoutAfterMillis
```
public void setResponseTimeoutAfterMillis(long responseTimeoutMillis)
```
    Description copied from interface: ClientRequestContext
    Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now. Note that the specified responseTimeoutMillis must be positive. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutAfterMillis(1000);
 
```
    Specified by:
    
    setResponseTimeoutAfterMillis in interface ClientRequestContext
    
    Parameters:
    
    responseTimeoutMillis - the amount of time allowed in milliseconds from now
  - setResponseTimeoutAfter
```
public void setResponseTimeoutAfter(Duration responseTimeout)
```
    Description copied from interface: ClientRequestContext
    Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now. Note that the specified responseTimeout must be positive. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutAfter(Duration.ofSeconds(1));
 
```
    Specified by:
    
    setResponseTimeoutAfter in interface ClientRequestContext
    
    Parameters:
    
    responseTimeout - the amount of time allowed from now
  - setResponseTimeoutAtMillis
```
public void setResponseTimeoutAtMillis(long responseTimeoutAtMillis)
```
    Description copied from interface: ClientRequestContext
    Schedules the response timeout that is triggered at the specified time represented as the number since the epoch (1970-01-01T00:00:00Z). Note that the response will be timed out immediately if the specified time is before now. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 long responseTimeoutAt = Instant.now().plus(1, ChronoUnit.SECONDS).toEpochMilli();
 ctx.setResponseTimeoutAtMillis(responseTimeoutAt);
 
```
    Specified by:
    
    setResponseTimeoutAtMillis in interface ClientRequestContext
    
    Parameters:
    
    responseTimeoutAtMillis - the response timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
  - setResponseTimeoutAt
```
public void setResponseTimeoutAt(Instant responseTimeoutAt)
```
    Description copied from interface: ClientRequestContext
    Schedules the response timeout that is triggered at the specified time represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z). Note that the response will be timed out immediately if the specified time is before now. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
    For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutAt(Instant.now().plus(1, ChronoUnit.SECONDS));
 
```
    Specified by:
    
    setResponseTimeoutAt in interface ClientRequestContext
    
    Parameters:
    
    responseTimeoutAt - the response timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
  - responseTimeoutHandler
```
public Runnable responseTimeoutHandler()
```
    Description copied from interface: ClientRequestContext
    
    Returns Response timeout handler which is executed when the Response is not completely received within the allowed ClientRequestContext.responseTimeoutMillis() or the default ClientOption.RESPONSE_TIMEOUT_MILLIS.
    
    Specified by:
    
    responseTimeoutHandler in interface ClientRequestContext
  - setResponseTimeoutHandler
```
public void setResponseTimeoutHandler(Runnable responseTimeoutHandler)
```
    Description copied from interface: ClientRequestContext
    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."));
 });
 ...
 
```
    Specified by:
    
    setResponseTimeoutHandler in interface ClientRequestContext
  - maxResponseLength
```
public long maxResponseLength()
```
    Description copied from interface: ClientRequestContext
    
    Returns the maximum length of the received Response. This value is initially set from ClientOption.MAX_RESPONSE_LENGTH.
    
    Specified by:
    
    maxResponseLength in interface ClientRequestContext
    
    Returns:
    
    the maximum length of the response. 0 if unlimited.
    
    See Also:
    
    ContentTooLargeException
  - setMaxResponseLength
```
public void setMaxResponseLength(long maxResponseLength)
```
    Description copied from interface: ClientRequestContext
    
    Sets the maximum length of the received Response. This value is initially set from ClientOption.MAX_RESPONSE_LENGTH. Specify 0 to disable the limit of the length of a response.
    
    Specified by:
    
    setMaxResponseLength in interface ClientRequestContext
    
    See Also:
    
    ContentTooLargeException
  - additionalRequestHeaders
```
public HttpHeaders additionalRequestHeaders()
```
    Description copied from interface: ClientRequestContext
    
    Returns an HttpHeaders which is included when a Client sends an HttpRequest.
    
    Specified by:
    
    additionalRequestHeaders in interface ClientRequestContext
  - setAdditionalRequestHeader
```
public void setAdditionalRequestHeader(CharSequence name,
                                       Object value)
```
    Description copied from interface: ClientRequestContext
    
    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.
    
    Specified by:
    
    setAdditionalRequestHeader in interface ClientRequestContext
  - setAdditionalRequestHeaders
```
public void setAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from interface: ClientRequestContext
    
    Clears the current header and sets the specified HttpHeaders which is included when a Client sends an HttpRequest.
    
    Specified by:
    
    setAdditionalRequestHeaders in interface ClientRequestContext
  - addAdditionalRequestHeader
```
public void addAdditionalRequestHeader(CharSequence name,
                                       Object value)
```
    Description copied from interface: ClientRequestContext
    
    Adds a header with the specified name and value. The header will be included when a Client sends an HttpRequest.
    
    Specified by:
    
    addAdditionalRequestHeader in interface ClientRequestContext
  - addAdditionalRequestHeaders
```
public void addAdditionalRequestHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from interface: ClientRequestContext
    
    Adds the specified HttpHeaders which is included when a Client sends an HttpRequest.
    
    Specified by:
    
    addAdditionalRequestHeaders in interface ClientRequestContext
  - removeAdditionalRequestHeader
```
public boolean removeAdditionalRequestHeader(CharSequence name)
```
    Description copied from interface: ClientRequestContext
    
    Removes all headers with the specified name.
    
    Specified by:
    
    removeAdditionalRequestHeader in interface ClientRequestContext
    
    Returns:
    
    true if at least one entry has been removed

Class ClientRequestContextWrapper

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.linecorp.armeria.client.ClientRequestContext

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

Constructor Detail

ClientRequestContextWrapper

Method Detail

root

ownAttr

ownAttrs

newDerivedContext

endpointGroup

endpoint

fragment

options

writeTimeoutMillis

setWriteTimeoutMillis

setWriteTimeout

responseTimeoutMillis

clearResponseTimeout

setResponseTimeoutMillis

setResponseTimeout

extendResponseTimeoutMillis

extendResponseTimeout

setResponseTimeoutAfterMillis

setResponseTimeoutAfter

setResponseTimeoutAtMillis

setResponseTimeoutAt

responseTimeoutHandler

setResponseTimeoutHandler

maxResponseLength

setMaxResponseLength

additionalRequestHeaders

setAdditionalRequestHeader

setAdditionalRequestHeaders

addAdditionalRequestHeader

addAdditionalRequestHeaders

removeAdditionalRequestHeader