com.linecorp.armeria.common.AbstractRequestContextBuilder

Direct Known Subclasses:: ClientRequestContextBuilder, ServiceRequestContextBuilder

public abstract class AbstractRequestContextBuilder
extends Object

Provides the information required for building a RequestContext.

See Also:: ServiceRequestContextBuilder, ClientRequestContextBuilder

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractRequestContextBuilder(boolean server, HttpRequest req)`	Creates a new builder with the specified `HttpRequest`.
`protected`	`AbstractRequestContextBuilder(boolean server, RpcRequest rpcReq, URI uri)`	Creates a new builder with the specified `RpcRequest` and `URI`.

Method Summary

Modifier and Type	Method	Description
`protected ByteBufAllocator`	`alloc()`	Returns the `ByteBufAllocator`.
`AbstractRequestContextBuilder`	`alloc(ByteBufAllocator alloc)`	Sets the `ByteBufAllocator`.
`protected String`	`authority()`	Returns the authority of the request.
`protected EventLoop`	`eventLoop()`	Returns the `EventLoop` that handles the request.
`AbstractRequestContextBuilder`	`eventLoop(EventLoop eventLoop)`	Sets the `EventLoop` that handles the request.
`protected Channel`	`fakeChannel()`	Returns a fake `Channel` which is required internally when creating a context.
`protected RequestId`	`id()`	Returns the `RequestId`.
`AbstractRequestContextBuilder`	`id(RequestId id)`	Sets the `RequestId`.
`protected boolean`	`isRequestStartTimeSet()`	Returns whether the request start time has been specified.
`protected InetSocketAddress`	`localAddress()`	Returns the local socket address of the connection.
`AbstractRequestContextBuilder`	`localAddress(InetSocketAddress localAddress)`	Sets the local socket address of the connection.
`protected MeterRegistry`	`meterRegistry()`	Returns the `MeterRegistry`.
`AbstractRequestContextBuilder`	`meterRegistry(MeterRegistry meterRegistry)`	Sets the `MeterRegistry`.
`protected HttpMethod`	`method()`	Returns the `HttpMethod` of the request.
`protected AbstractRequestContextBuilder`	`method(HttpMethod method)`	Sets the `HttpMethod` of the request.
`protected String`	`path()`	Returns the path of the request, excluding the query part.
`protected String`	`query()`	Returns the query part of the request, excluding the leading question mark (`'?'`).
`protected InetSocketAddress`	`remoteAddress()`	Returns the remote socket address of the connection.
`AbstractRequestContextBuilder`	`remoteAddress(InetSocketAddress remoteAddress)`	Sets the remote socket address of the connection.
`protected HttpRequest`	`request()`	Returns the `HttpRequest` of the context.
`AbstractRequestContextBuilder`	`requestStartTime(long requestStartTimeNanos, long requestStartTimeMicros)`	Sets the request start time of the request.
`protected long`	`requestStartTimeMicros()`	Returns the number of microseconds since the epoch when the request started.
`protected long`	`requestStartTimeNanos()`	Returns the `System.nanoTime()` value when the request started.
`protected RpcRequest`	`rpcRequest()`	Returns the `RpcRequest` of the context.
`protected SessionProtocol`	`sessionProtocol()`	Returns the `SessionProtocol` of the request.
`AbstractRequestContextBuilder`	`sessionProtocol(SessionProtocol sessionProtocol)`	Sets the `SessionProtocol` of the request.
`protected SSLSession`	`sslSession()`	Returns the `SSLSession` of the connection.
`AbstractRequestContextBuilder`	`sslSession(SSLSession sslSession)`	Sets the `SSLSession` of the connection.
`protected boolean`	`timedOut()`	Returns whether a timeout is set.
`AbstractRequestContextBuilder`	`timedOut(boolean timedOut)`	Sets the specified `timedOut`.

Methods inherited from class java.lang.Object

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

Constructor Details
- AbstractRequestContextBuilder
  
  protected AbstractRequestContextBuilder(boolean server, HttpRequest req)
  
  Creates a new builder with the specified HttpRequest.
  
  Parameters:
  
  server - whether this builder will build a server-side context.
  
  req - the HttpRequest.
- AbstractRequestContextBuilder
  
  protected AbstractRequestContextBuilder(boolean server, RpcRequest rpcReq, URI uri)
  
  Creates a new builder with the specified RpcRequest and URI.
  
  Parameters:
  
  server - whether this builder will build a server-side context.
  
  rpcReq - the RpcRequest.
  
  uri - the URI of the request endpoint.
Method Details
- meterRegistry
  
  protected final MeterRegistry meterRegistry()
  
  Returns the MeterRegistry.
- meterRegistry
  
  public AbstractRequestContextBuilder meterRegistry(MeterRegistry meterRegistry)
  
  Sets the MeterRegistry. If not set, NoopMeterRegistry is used.
- eventLoop
  
  protected final EventLoop eventLoop()
  
  Returns the EventLoop that handles the request.
- eventLoop
  
  public AbstractRequestContextBuilder eventLoop(EventLoop eventLoop)
  
  Sets the EventLoop that handles the request. If not set, one of the CommonPools.workerGroup() is used.
- alloc
  
  protected final ByteBufAllocator alloc()
  
  Returns the ByteBufAllocator.
- alloc
  
  public AbstractRequestContextBuilder alloc(ByteBufAllocator alloc)
  
  Sets the ByteBufAllocator. If not set, ByteBufAllocator.DEFAULT is used.
- request
  
  @Nullable protected final HttpRequest request()
  
  Returns the HttpRequest of the context.
- rpcRequest
  
  @Nullable protected final RpcRequest rpcRequest()
  
  Returns the RpcRequest of the context.
- sessionProtocol
  
  protected final SessionProtocol sessionProtocol()
  
  Returns the SessionProtocol of the request.
- sessionProtocol
  
  public AbstractRequestContextBuilder sessionProtocol(SessionProtocol sessionProtocol)
  
  Sets the SessionProtocol of the request.
  
  Throws:
  
  IllegalArgumentException - if the specified SessionProtocol is not compatible with the scheme of the URI you specified when creating this builder. For example, you cannot specify SessionProtocol.H2C if you created this builder with h1c://example.com/.
- remoteAddress
  
  protected final InetSocketAddress remoteAddress()
  
  Returns the remote socket address of the connection.
- remoteAddress
  
  public AbstractRequestContextBuilder remoteAddress(InetSocketAddress remoteAddress)
  
  Sets the remote socket address of the connection. If not set, it is auto-generated with the localhost IP address (e.g. "127.0.0.1" or "::1").
- localAddress
  
  protected final InetSocketAddress localAddress()
  
  Returns the local socket address of the connection.
- localAddress
  
  public AbstractRequestContextBuilder localAddress(InetSocketAddress localAddress)
  
  Sets the local socket address of the connection. If not set, it is auto-generated with the localhost IP address (e.g. "127.0.0.1" or "::1").
- sslSession
  
  @Nullable protected final SSLSession sslSession()
  
  Returns the SSLSession of the connection.
  
  Returns:
  
  the SSLSession, or null if the SessionProtocol is not TLS.
- sslSession
  
  public AbstractRequestContextBuilder sslSession(SSLSession sslSession)
  
  Sets the SSLSession of the connection. If the current SessionProtocol is not TLS, the TLS version of the current SessionProtocol will be set automatically. For example, SessionProtocol.H2C will be automatically upgraded to SessionProtocol.H2. Note that upgrading the current SessionProtocol may trigger an IllegalArgumentException, as described in sessionProtocol(SessionProtocol).
- isRequestStartTimeSet
  
  protected final boolean isRequestStartTimeSet()
  
  Returns whether the request start time has been specified. If not specified, the builder will use the current time returned by requestStartTimeNanos() and requestStartTimeMicros() as the request start time.
- requestStartTimeNanos
  
  protected final long requestStartTimeNanos()
  
  Returns the System.nanoTime() value when the request started.
  
  Throws:
  
  IllegalStateException - if the request start time is unspecified.
- requestStartTimeMicros
  
  protected final long requestStartTimeMicros()
  
  Returns the number of microseconds since the epoch when the request started.
  
  Throws:
  
  IllegalStateException - if the request start time is unspecified.
- requestStartTime
  
  public AbstractRequestContextBuilder requestStartTime(long requestStartTimeNanos, long requestStartTimeMicros)
  
  Sets the request start time of the request.
  
  Parameters:
  
  requestStartTimeNanos - the System.nanoTime() value when the request started.
  
  requestStartTimeMicros - the number of microseconds since the epoch when the request started.
- method
  
  protected final HttpMethod method()
  
  Returns the HttpMethod of the request.
- method
  
  protected AbstractRequestContextBuilder method(HttpMethod method)
  
  Sets the HttpMethod of the request.
  
  Throws:
  
  IllegalArgumentException - if the specified HttpMethod is not same with the HttpMethod of the HttpRequest you specified when creating this builder. This exception is not thrown if you created a builder with an RpcRequest.
- authority
  
  protected final String authority()
  
  Returns the authority of the request.
- path
  
  protected final String path()
  
  Returns the path of the request, excluding the query part.
- id
  
  public AbstractRequestContextBuilder id(RequestId id)
  
  Sets the RequestId. If not set, a random RequestId is generated with RequestId.random().
- id
  
  protected final RequestId id()
  
  Returns the RequestId.
- query
  
  @Nullable protected final String query()
  
  Returns the query part of the request, excluding the leading question mark ('?').
  
  Returns:
  
  the query string, or null if there is no query.
- fakeChannel
  
  protected final Channel fakeChannel()
  
  Returns a fake Channel which is required internally when creating a context.
- timedOut
  
  protected final boolean timedOut()
  
  Returns whether a timeout is set.
- timedOut
  
  public AbstractRequestContextBuilder timedOut(boolean timedOut)
  
  Sets the specified timedOut. If the specified timedOut is true, RequestContext.isTimedOut() will always return true. This is useful for checking the behavior of a Service and Client when a request exceeds a deadline.

Class AbstractRequestContextBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details