@NonNullByDefault

Package com.linecorp.armeria.common

Common types.

Starting points

• RequestContext

Interface Summary

Interface	Description
AggregatedHttpObject	A complete HTTP headers and content that are readily available.
AggregatedHttpRequest	A complete HTTP request whose content is readily available as a single HttpData.
AggregatedHttpResponse	A complete HTTP response whose content is readily available as a single HttpData.
ContextAwareEventLoop	A delegating EventLoop that sets the RequestContext before executing any submitted tasks.
ContextAwareScheduledExecutorService	A delegating ScheduledExecutorService that sets the RequestContext before executing any submitted tasks.
ContextHolder	A holder of RequestContext.
Cookie	An interface defining an HTTP cookie.
Cookies	An immutable Set of Cookies.
Http1HeaderNaming	Converts a normalized HTTP/2 header name to another HTTP/1 header name.
HttpData	HTTP/2 data that contains a chunk of bytes.
HttpHeaders	Immutable HTTP/2 headers.
HttpHeadersBuilder	Builds an HttpHeaders.
HttpMessage	A streamed HTTP/2 message.
HttpObject	The common interface for HTTP/2 message objects, HttpHeaders and HttpData.
HttpRequest	A streamed HTTP/2 Request.
HttpRequestDuplicator	A duplicator that duplicates a HttpRequest into one or more HttpRequests, which publish the same elements.
HttpRequestWriter	An HttpRequest that can have HttpObjects written to it.
HttpResponse	A streamed HTTP/2 Response.
HttpResponseDuplicator	A duplicator that duplicates a HttpResponse into one or more HttpResponses, which publish the same elements.
HttpResponseWriter	An HttpResponse that can have HttpObjects written to it.
QueryParams	Immutable HTTP query parameters.
QueryParamsBuilder	Builds a QueryParams.
Request	A request.
RequestContext	Provides information about a Request, its Response and related utilities.
RequestContextStorage	The storage for storing RequestContext.
RequestContextStorageProvider	Creates a new RequestContextStorage dynamically via Java SPI (Service Provider Interface).
RequestHeaders	Immutable HTTP/2 headers for an HttpRequest.
RequestHeadersBuilder	Builds a RequestHeaders.
RequestId	An identifier of a Request-Response pair.
Response	A response stream or a holder of the future result value.
ResponseHeaders	Immutable HTTP/2 headers for an HttpResponse.
ResponseHeadersBuilder	Builds a ResponseHeaders.
RpcRequest	An RPC Request.
RpcResponse	An RPC Response.
SplitHttpResponse	An HttpResponse which splits a stream of HttpObjects into HTTP headers and payloads.

Class Summary

Class	Description
AbstractHttpRequestBuilder	Builds a new HttpRequest.
AbstractRequestContextBuilder	Provides the information required for building a RequestContext.
CacheControl	Directives for HTTP caching mechanisms in requests or responses.
ClientCacheControl	Directives for HTTP caching mechanisms in requests.
ClientCacheControlBuilder	Creates a new ClientCacheControl using the builder pattern.
CommonPools	Provides the common shared thread pools and EventLoopGroups which is used when not overridden.
CompletableRpcResponse	An RpcResponse implementation which is initially incomplete and can be completed later.
ContentDisposition	Representation of the Content-Disposition type and parameters as defined in RFC 6266.
ContentDispositionBuilder	A builder class for creating ContentDisposition.
CookieBuilder	Builds a Cookie.
FilteredHttpRequest	An HttpRequest that filters objects as they are published.
FilteredHttpResponse	An HttpResponse that filters objects as they are published.
Flags	The system properties that affect Armeria's runtime behavior.
HttpHeaderNames	Contains constant definitions for the HTTP header field names.
HttpRequestBuilder	Builds a new HttpRequest.
HttpStatus	HTTP response code and its description.
MediaType	Represents an Internet Media Type (also known as a MIME Type or Content Type).
MediaTypeNames	String constants defined in MediaType class.
MediaTypeSet	An immutable Set of MediaTypes which provides useful methods for content negotiation.
NonWrappingRequestContext	A skeletal RequestContext implementation that helps to implement a non-wrapping RequestContext.
RequestContextStorageWrapper	Wraps an existing RequestContextStorage.
RequestContextWrapper<T extends RequestContext>	Wraps an existing RequestContext.
Scheme	A pair of SerializationFormat and SessionProtocol.
SerializationFormat	Serialization format of a remote procedure call and its reply.
SerializationFormatProvider	Registers the SerializationFormats dynamically via Java SPI (Service Provider Interface).
SerializationFormatProvider.Entry	A registration entry of a SerializationFormat.
ServerCacheControl	Directives for HTTP caching mechanisms in responses.
ServerCacheControlBuilder	Creates a new ServerCacheControl using the builder pattern.

Enum Summary

Enum	Description
ByteBufAccessMode	Specifies the way a ByteBuf is retrieved from an HttpData.
HttpMethod	HTTP request method.
HttpStatusClass	The class of HTTP status.
SessionProtocol	Session-level protocol that provides facilities such as framing and flow control.

Exception Summary

Exception	Description
CancellationException	A RuntimeException raised when a requested invocation is forced to stop before its completion.
ClosedSessionException	A RuntimeException raised when the connection to the remote peer has been closed unexpectedly.
ContentTooLargeException	A RuntimeException raised when the length of request or response content exceeds its limit.
ProtocolViolationException	A RuntimeException raised when a remote peer violated the current SessionProtocol.
TimeoutException	A RuntimeException raised when a requested invocation does not complete before its deadline.