All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class |
Description |
AbortedStreamException |
|
AbstractBackoff |
|
AbstractClientFactory |
|
AbstractCompositeService<I extends Request,O extends Response> |
A skeletal Service implementation that enables composing multiple Service s into one.
|
AbstractCompositeServiceBuilder<T extends AbstractCompositeServiceBuilder<T,I,O>,I extends Request,O extends Response> |
|
AbstractHttpData |
Support APIs for creating well-behaved HttpData objects.
|
AbstractHttpFile |
|
AbstractHttpFileBuilder<B extends AbstractHttpFileBuilder<B>> |
A skeletal builder class which helps easier implementation of an HttpFile builder.
|
AbstractHttpService |
A skeletal HttpService for easier HTTP service implementation.
|
AbstractHttpVfs |
|
AbstractListenable<T> |
|
AbstractOption<T> |
A configuration option.
|
AbstractOptions |
A set of configuration options and their respective values.
|
AbstractOptionValue<O extends AbstractOption<V>,V> |
|
AbstractPathMapping |
|
AbstractRequestContext |
|
AbstractRequestContextBuilder<B extends AbstractRequestContextBuilder<B>> |
|
AbstractStreamMessageDuplicator<T,U extends StreamMessage<T>> |
Allows subscribing to a StreamMessage multiple times by duplicating the stream.
|
AccessLogWriter |
|
AccessLogWriters |
Deprecated.
|
AdditionalHeader |
Annotation for an additional HTTP header.
|
AdditionalHeaders |
|
AdditionalTrailer |
Annotation for an additional HTTP trailing header.
|
AdditionalTrailers |
|
AggregatedHttpFile |
An immutable variant of HttpFile which has its attributes and content readily available.
|
AggregatedHttpMessage |
A complete HTTP message whose content is readily available as a single HttpData .
|
AuthFailureHandler<I extends Request,O extends Response> |
A callback which is invoked to handle an authorization failure indicated by Authorizer .
|
Authorizer<T> |
Determines whether a given data is authorized for the service registered in.
|
AuthSuccessHandler<I extends Request,O extends Response> |
A callback which is invoked to handle an authorization success indicated by Authorizer .
|
AuthTokenExtractors |
A utility class that provides singleton instances of authorization token extractor functions.
|
Backoff |
Controls back off between attempts in a single retry operation.
|
BackoffWrapper |
|
BasicToken |
|
ByteArrayRequestConverterFunction |
|
ByteArrayResponseConverterFunction |
A response converter implementation which creates an HttpResponse with
content-type: application/binary or content-type: application/octet-stream .
|
ByteBufHttpData |
A HttpData that is backed by a ByteBuf for optimizing certain internal use cases.
|
CacheControl |
Directives for HTTP caching mechanisms in requests or responses.
|
CacheControlBuilder<B extends CacheControlBuilder<B>> |
|
CancelledSubscriptionException |
|
ChainedCorsPolicyBuilder |
|
ChainedVirtualHostBuilder |
|
CircuitBreaker |
A circuit breaker, which tracks the number of
success/failure requests and detects a remote service failure.
|
CircuitBreakerBuilder |
|
CircuitBreakerClient<I extends Request,O extends Response> |
A Client decorator that handles failures of remote invocation based on circuit breaker pattern.
|
CircuitBreakerClientBuilder<T extends CircuitBreakerClientBuilder<T,U,I,O>,U extends CircuitBreakerClient<I,O>,I extends Request,O extends Response> |
|
CircuitBreakerHttpClient |
A Client decorator that handles failures of HTTP requests based on circuit breaker pattern.
|
CircuitBreakerHttpClientBuilder |
|
CircuitBreakerListener |
|
CircuitBreakerListenerAdapter |
A skeletal CircuitBreakerListener implementation in order for a user to implement only the methods
what he or she really needs.
|
CircuitBreakerMapping |
|
CircuitBreakerRpcClient |
A Client decorator that handles failures of RPC remote invocation based on circuit breaker pattern.
|
CircuitBreakerRpcClientBuilder |
|
CircuitBreakerStrategy |
|
CircuitBreakerStrategyWithContent<T extends Response> |
|
CircuitState |
|
Client<I extends Request,O extends Response> |
|
ClientAddressSource |
A source which is used to get a client address.
|
ClientBuilder |
Creates a new client that connects to the specified URI using the builder pattern.
|
ClientBuilderParams |
Provides the construction parameters of a client.
|
ClientCacheControl |
Directives for HTTP caching mechanisms in requests.
|
ClientCacheControlBuilder |
|
ClientDecoration |
|
ClientDecorationBuilder |
|
ClientFactory |
Creates and manages clients.
|
ClientFactoryBuilder |
|
ClientFactoryProvider |
Creates a new ClientFactory dynamically via Java SPI (Service Provider Interface).
|
ClientOption<T> |
A client option.
|
ClientOptions |
|
ClientOptionsBuilder |
|
ClientOptionValue<T> |
|
ClientRequestContext |
Provides information about a Request , its Response and its related utilities.
|
ClientRequestContextBuilder |
|
ClientRequestContextWrapper |
|
Clients |
Creates a new client that connects to a specified URI .
|
ClosedClientFactoryException |
Deprecated.
|
ClosedPublisherException |
|
ClosedSessionException |
A RuntimeException raised when the connection to the remote peer has been closed unexpectedly.
|
CommonPools |
Provides the common shared thread pools and EventLoopGroup s which is used when not overridden.
|
CompletionActions |
Provides the common actions that are useful when handling a CompletionStage .
|
CompositeServiceEntry<I extends Request,O extends Response> |
|
ConcurrencyLimitingClient<I extends Request,O extends Response> |
An abstract Client decorator that limits the concurrent number of active requests.
|
ConcurrencyLimitingClient.Deferred<O extends Response> |
Provides the interface for updating the result of a Request execution when its Response
is ready.
|
ConcurrencyLimitingHttpClient |
A Client decorator that limits the concurrent number of active HTTP requests.
|
ConnectionPoolListener |
Listens to the client connection pool events.
|
ConnectionPoolListenerAdapter |
A skeletal ConnectionPoolListener implementation in order for a user to implement only the methods
what he or she really needs.
|
ConnectionPoolListenerWrapper |
|
ConnectionPoolLoggingListener |
|
Consumes |
Specifies a media type which would be consumed by the service method or class.
|
ConsumesBinary |
An alias for @Consumes("application/binary") .
|
ConsumesGroup |
The containing annotation type for Consumes .
|
ConsumesJson |
An alias for @Consumes("application/json; charset=utf-8") .
|
ConsumesOctetStream |
An alias for @Consumes("application/octet-stream") .
|
ConsumesText |
An alias for @Consumes("text/plain; charset=utf-8") .
|
ConsumeType |
Deprecated.
|
ConsumeTypes |
Deprecated.
|
ContentPreviewer |
|
ContentPreviewerFactory |
|
ContentTooLargeException |
A RuntimeException raised when the length of request or response content exceeds its limit.
|
Cookies |
An interface which holds decoded Cookie instances for an HTTP request.
|
CorsConfig |
|
CorsDecorator |
|
CorsDecoratorFactoryFunction |
|
CorsDecorators |
|
CorsDecoratorsFactoryFunction |
|
CorsPolicy |
Contains information of the CORS policy with the specified origins.
|
CorsPolicyBuilder |
|
CorsService |
|
CorsServiceBuilder |
|
DecoratingClient<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response> |
|
DecoratingClientFactory |
|
DecoratingClientFunction<I extends Request,O extends Response> |
A functional interface that enables building a SimpleDecoratingClient with
AbstractClientOptionsBuilder.decorator(DecoratingClientFunction) and
AbstractClientOptionsBuilder.rpcDecorator(DecoratingClientFunction) .
|
DecoratingService<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response> |
|
DecoratingServiceFunction<I extends Request,O extends Response> |
|
Decorator |
|
DecoratorFactory |
|
DecoratorFactoryFunction<T extends Annotation> |
A decorator factory which is used for a user-defined decorator annotation.
|
Decorators |
The containing annotation type for Decorator .
|
Default |
Specifies the default value of an optional parameter.
|
DefaultClientBuilderParams |
|
DefaultClientRequestContext |
|
DefaultHttpData |
|
DefaultHttpHeaders |
|
DefaultHttpParameters |
|
DefaultHttpRequest |
Deprecated.
|
DefaultHttpResponse |
Deprecated.
|
DefaultRequestLog |
|
DefaultRpcRequest |
|
DefaultRpcResponse |
|
DefaultServiceRequestContext |
|
DefaultStreamMessage<T> |
|
DeferredHttpResponse |
Deprecated.
|
DeferredStreamMessage<T> |
|
DeflateStreamDecoderFactory |
|
Delete |
|
Description |
An annotation used in annotated HTTP service.
|
DnsAddressEndpointGroup |
|
DnsAddressEndpointGroupBuilder |
|
DnsServiceEndpointGroup |
|
DnsServiceEndpointGroupBuilder |
|
DnsTextEndpointGroup |
|
DnsTextEndpointGroupBuilder |
|
DocService |
|
DocServiceBuilder |
|
DocServicePlugin |
|
DocStringExtractor |
A supporting base class for implementing the standard pattern of extracting docstrings
from arbitrary files in a particular classpath location.
|
DropwizardMeterRegistries |
|
DynamicEndpointGroup |
|
EmptyFixedStreamMessage<T> |
A FixedStreamMessage that publishes no objects, just a close event.
|
Endpoint |
A remote endpoint that refers to a single host or a group of multiple hosts.
|
EndpointGroup |
|
EndpointGroupException |
|
EndpointGroupRegistry |
An in-memory registry of server groups.
|
EndpointInfo |
Metadata about the endpoints exposed by a Service .
|
EndpointInfoBuilder |
|
EndpointSelectionStrategy |
|
EndpointSelector |
|
EnumInfo |
Metadata about an enum type.
|
EnumValueInfo |
Metadata about an enum value.
|
EventCount |
An immutable object that stores the count of events.
|
EventLoopGroups |
|
EventLoopStreamMessage<T> |
A StreamMessage optimized for when writes and reads all happen on the provided EventLoop ,
removing the need for most synchronization from the hot path.
|
ExceptionFilter |
A filter that decides whether circuit breaker should deal with a given error raised by remote service.
|
ExceptionHandler |
|
ExceptionHandlerFunction |
An interface for exception handler.
|
ExceptionHandlers |
|
ExceptionInfo |
Metadata about an exception type.
|
Exceptions |
Provides methods that are useful for handling exceptions.
|
ExceptionVerbosity |
The verbosity of exceptions logged by annotated HTTP services.
|
FailFastException |
An exception indicating that a request has been failed by circuit breaker.
|
FieldInfo |
Metadata about a field of a struct or an exception.
|
FieldInfoBuilder |
Creates a new FieldInfo using the builder pattern.
|
FieldLocation |
The location of a field.
|
FieldRequirement |
The requirement level of a field.
|
FilteredHttpResponse |
|
FilteredStreamMessage<T,U> |
|
Flags |
The system properties that affect Armeria's runtime behavior.
|
Functions |
Utility methods related with function composition.
|
Get |
|
GzipStreamDecoderFactory |
|
Head |
|
Header |
Annotation for mapping an HTTP request header onto the following elements.
|
HealthCheckedEndpointGroup |
|
HealthCheckedEndpointGroup.EndpointHealthChecker |
Returns whether an Endpoint is healthy or not.
|
HealthChecker |
Determines whether the Server is healthy.
|
HttpAuthService |
Decorates a Service to provide HTTP authorization functionality.
|
HttpAuthServiceBuilder |
|
HttpClient |
An HTTP client.
|
HttpClientBuilder |
Creates a new HTTP client that connects to the specified URI using the builder pattern.
|
HttpData |
HTTP/2 data.
|
HttpDecodingClient |
|
HttpEncodingService |
|
HttpFile |
|
HttpFileAttributes |
|
HttpFileBuilder |
|
HttpFileService |
An HttpService that serves static files from a file system.
|
HttpFileServiceBuilder |
|
HttpFileServiceConfig |
|
HttpHeaderNames |
Standard HTTP header names.
|
HttpHeaders |
HTTP/2 headers.
|
HttpHeadersJsonDeserializer |
|
HttpHeadersJsonSerializer |
|
HttpHealthCheckedEndpointGroup |
|
HttpHealthCheckedEndpointGroupBuilder |
|
HttpHealthCheckService |
An HttpService that responds with HTTP status "200 OK" if the server is healthy and can
accept requests and HTTP status "503 Service Not Available" if the server is unhealthy and cannot
accept requests.
|
HttpMethod |
HTTP request method.
|
HttpObject |
|
HttpParameters |
HTTP parameters map.
|
HttpRequest |
|
HttpRequestDuplicator |
Allows subscribing to a HttpRequest multiple times by duplicating the stream.
|
HttpRequestWriter |
|
HttpResponse |
|
HttpResponseDuplicator |
Allows subscribing to a HttpResponse multiple times by duplicating the stream.
|
HttpResponseException |
A RuntimeException that is raised to send an HTTP response with the content specified
by a user.
|
HttpResponseWriter |
|
HttpResult<T> |
An interface which helps a user specify an HttpStatus and HttpHeaders for a response
produced by an annotated HTTP service method.
|
HttpService |
|
HttpStatus |
HTTP response code and its description.
|
HttpStatusClass |
The class of HTTP status.
|
HttpStatusException |
|
HttpVfs |
A virtual file system that provides the files requested by HttpFileService .
|
InetAddressPredicates |
A utility class which provides factory methods in order to easily create a Predicate of an
InetAddress .
|
InvalidResponseException |
A RuntimeException raised when the client received a response with an unexpected status code.
|
JacksonRequestConverterFunction |
|
JacksonResponseConverterFunction |
A response converter implementation which creates an HttpResponse with
content-type: application/json; charset=utf-8 or content-type: application/json-seq .
|
JsonTextSequences |
|
KeyedCircuitBreakerMapping<K> |
|
KeyedCircuitBreakerMapping.KeySelector<K> |
Returns the mapping key of the given Request .
|
Listenable<T> |
An interface that accepts item change listeners.
|
LoggingClient<I extends Request,O extends Response> |
|
LoggingClientBuilder |
|
LoggingDecorator |
|
LoggingDecoratorBuilder<T extends LoggingDecoratorBuilder<T>> |
Builds a new logging decorator.
|
LoggingDecoratorFactoryFunction |
|
LoggingDecorators |
|
LoggingService<I extends Request,O extends Response> |
|
LoggingServiceBuilder |
|
LogLevel |
Log level.
|
LruMap<T,U> |
LRU (Least Recently Used) cache Map .
|
ManagedHttpHealthCheckService |
|
MediaType |
|
MediaTypeJsonDeserializer |
|
MediaTypeJsonSerializer |
|
MediaTypeSet |
An immutable Set of MediaType s which provides useful methods for content negotiation.
|
MeterIdPrefix |
|
MeterIdPrefixFunction |
|
MethodInfo |
Metadata about a function of a Service .
|
MetricCollectingCircuitBreakerListener |
|
MetricCollectingClient<I extends Request,O extends Response> |
|
MetricCollectingService<I extends Request,O extends Response> |
|
MoreMeters |
|
MoreNamingConventions |
|
NamedTypeInfo |
Metadata about a named type.
|
NativeLibraries |
Deprecated.
|
NonNullByDefault |
An annotation that signifies the return values, parameters and fields are non-nullable by default
leveraging the JSR-305 Nonnull annotation.
|
NonWrappingRequestContext |
|
NoopMeterRegistry |
|
NoopSubscriber<T> |
A Subscriber that discards all elements silently.
|
NullToNoContentResponseConverterFunction |
|
OAuth1aToken |
|
OAuth2Token |
|
OneElementFixedStreamMessage<T> |
A FixedStreamMessage that only publishes one object.
|
Options |
|
Order |
Specifies an order which is used to sort the annotated service methods.
|
Param |
Annotation for mapping a parameter of a request onto the following elements.
|
Patch |
|
Path |
Annotation for mapping dynamic web requests onto specific method.
|
PathMapped<T> |
|
PathMapping |
Matches the absolute path part of a URI and extracts path parameters from it.
|
PathMappingContext |
Holds the parameters which are required to find a service available to handle the request.
|
PathMappingResult |
|
PathMappingResultBuilder |
|
Post |
|
Produces |
Specifies a media type which would be produced by the service method or class.
|
ProducesBinary |
An alias for @Produces("application/binary") .
|
ProducesEventStream |
An alias for @Produces("text/event-stream") and
@ResponseConverter(ServerSentEventResponseConverterFunction.class) .
|
ProducesGroup |
The containing annotation type for Produces .
|
ProducesJson |
An alias for @Produces("application/json; charset=utf-8") .
|
ProducesJsonSequences |
An alias for @Produces("application/json-seq") .
|
ProducesOctetStream |
An alias for @Produces("application/octet-stream") .
|
ProducesText |
An alias for @Produces("text/plain; charset=utf-8") .
|
ProduceType |
Deprecated.
|
ProduceTypes |
Deprecated.
|
PrometheusExpositionService |
|
PrometheusMeterRegistries |
|
PropertiesEndpointGroup |
|
ProtocolViolationException |
|
ProxiedAddresses |
An interface to provide source and destination addresses delivered from a proxy server.
|
PublisherBasedStreamMessage<T> |
|
Put |
|
RateLimitingDecorator |
|
RateLimitingDecoratorFactoryFunction |
|
RateLimitingDecorators |
|
RateLimitingThrottlingStrategy<T extends Request> |
|
RedirectService |
|
RegularFixedStreamMessage<T> |
A FixedStreamMessage that publishes an arbitrary number of objects.
|
RejectedPathMappingHandler |
|
ReleasableHolder<T> |
|
Request |
A request.
|
RequestContext |
|
RequestContextWrapper<T extends RequestContext> |
|
RequestConverter |
|
RequestConverterFunction |
|
RequestConverters |
|
RequestLog |
A set of informational properties collected while processing a Request and its Response .
|
RequestLogAvailability |
Tells which properties are available in a RequestLog .
|
RequestLogAvailabilityException |
|
RequestLogBuilder |
Updates a RequestLog with newly available information.
|
RequestLogListener |
|
RequestLogListenerInvoker |
|
RequestObject |
|
RequestTimeoutChangeListener |
|
RequestTimeoutException |
A TimeoutException raised when a request has not been received from a client within timeout.
|
Response |
A response stream or a holder of the future result value.
|
ResponseConverter |
|
ResponseConverterFunction |
|
ResponseConverterFunctionProvider |
|
ResponseConverters |
|
ResponseTimeoutException |
A TimeoutException raised when a response has not been received from a server within timeout.
|
RetryingClient<I extends Request,O extends Response> |
A Client decorator that handles failures of remote invocation and retries requests.
|
RetryingClientBuilder<T extends RetryingClientBuilder<T,U,I,O>,U extends RetryingClient<I,O>,I extends Request,O extends Response> |
|
RetryingHttpClient |
A Client decorator that handles failures of an invocation and retries HTTP requests.
|
RetryingHttpClientBuilder |
|
RetryingRpcClient |
A Client decorator that handles failures of an invocation and retries RPC requests.
|
RetryingRpcClientBuilder |
|
RetryStrategy |
Determines whether a failed request should be retried.
|
RetryStrategyWithContent<T extends Response> |
Determines whether a failed request should be retried using the content of a Response .
|
Router<V> |
|
Routers |
A factory that creates a Router instance.
|
RpcRequest |
|
RpcResponse |
|
SafeCloseable |
|
Scheme |
|
SerializationFormat |
Serialization format of a remote procedure call and its reply.
|
SerializationFormatProvider |
|
SerializationFormatProvider.Entry |
|
Server |
|
ServerBuilder |
|
ServerCacheControl |
Directives for HTTP caching mechanisms in responses.
|
ServerCacheControlBuilder |
|
ServerConfig |
|
ServerListener |
Listens to life cycle events of a Server .
|
ServerListenerAdapter |
A skeletal ServerListener implementation in order for a user to implement only the methods
what he or she really needs.
|
ServerListenerBuilder |
|
ServerPort |
|
ServerSentEvent |
|
ServerSentEventBuilder |
|
ServerSentEventResponseConverterFunction |
A response converter implementation which creates an HttpResponse with
content-type: text/event-stream .
|
ServerSentEvents |
|
Service<I extends Request,O extends Response> |
|
ServiceCallbackInvoker |
A helper class that invokes the callback methods in Service .
|
ServiceConfig |
|
ServiceInfo |
|
ServiceRequestContext |
Provides information about an invocation and related utilities.
|
ServiceRequestContextBuilder |
|
ServiceRequestContextWrapper |
|
ServiceSpecification |
|
ServiceWithPathMappings<I extends Request,O extends Response> |
|
SessionProtocol |
Session-level protocol that provides facilities such as framing and flow control.
|
SessionProtocolNegotiationCache |
|
SessionProtocolNegotiationException |
An exception triggered when failed to negotiate the desired SessionProtocol with a server.
|
SettableHealthChecker |
|
SignalLengthGetter<T> |
A function that accepts one signal and produces the length of the signal.
|
SimpleCompositeService<I extends Request,O extends Response> |
|
SimpleCompositeServiceBuilder<I extends Request,O extends Response> |
|
SimpleDecoratingClient<I extends Request,O extends Response> |
|
SimpleDecoratingService<I extends Request,O extends Response> |
|
StartStopSupport<V,L> |
Provides asynchronous start-stop life cycle support.
|
StaticEndpointGroup |
|
StatusCode |
An annotation which specifies a default HTTP status code of a response produced by an annotated HTTP service.
|
StickyEndpointSelectionStrategy |
|
StreamDecoder |
An interface for objects that apply HTTP content decoding to incoming HttpData .
|
StreamDecoderFactory |
An interface that constructs a new StreamDecoder for a given Content-Encoding header value.
|
StreamingHttpFile<T extends Closeable> |
A skeletal HttpFile that simplifies the streaming of potentially large content.
|
StreamMessage<T> |
|
StreamMessageWrapper<T> |
Wraps a StreamMessage and forwards its method invocations to delegate .
|
StreamWriter<T> |
|
StringRequestConverterFunction |
|
StringResponseConverterFunction |
A response converter implementation which creates an HttpResponse with
content-type: text/plain .
|
StructInfo |
Metadata about a struct type.
|
StructuredLog |
Deprecated.
|
StructuredLogBuilder<L> |
Deprecated.
|
StructuredLoggingService<I extends Request,O extends Response,L> |
Deprecated.
|
TextFormatter |
A utility class to format things as a String with ease.
|
ThrottlingHttpService |
Decorates a HTTP Service to throttle incoming requests.
|
ThrottlingRpcService |
Decorates an RPC Service to throttle incoming requests.
|
ThrottlingService<I extends Request,O extends Response> |
Decorates a Service to throttle incoming requests.
|
ThrottlingStrategy<T extends Request> |
Determines whether a request should be throttled.
|
Ticker |
A time source; returns a time value representing the number of nanoseconds elapsed since some
fixed but arbitrary point in time.
|
TimeoutException |
A RuntimeException that is raised when a requested invocation did not complete before its deadline.
|
Trace |
|
TransientService<I extends Request,O extends Response> |
A Service that handles transient requests, for example, health check requests.
|
TwoElementFixedStreamMessage<T> |
A FixedStreamMessage that publishes two objects.
|
TypeSignature |
Type signature of a method parameter, a method return value or a struct/exception field.
|
TypeSignatureJsonSerializer |
|
UnprocessedRequestException |
A RuntimeException raised when it is certain that a request has not been handled by a server and
thus can be retried safely.
|
UserClient<I extends Request,O extends Response> |
A base class for implementing a user's entry point for sending a Request .
|
Version |
Retrieves the version information of available Armeria artifacts.
|
VirtualHost |
|
VirtualHostBuilder |
|
WriteTimeoutException |
A TimeoutException raised when a client failed to send a request to the wire within timeout.
|