Armeria 1.29.3 API reference
Package
Description
Client core.
Client-side OAuth 2.0 implementation artifacts.
Failure detection and fallback mechanism based on
circuit breaker pattern.
Consul-based
EndpointGroup implementation.Cookie aware client.
HTTP content decoding client.
Endpoint groups and their registry.DNS-based
EndpointGroup implementation.Filters out unhealthy
Endpoints from an existing
EndpointGroup by sending health check requests.Eureka-based
EndpointGroup for automatic service discovery.An armeria client that uses the gRPC wire protocol.
Unary gRPC client without support for gRPC generated code stubs.
Fabric8 Kubernetes client based on Armeria.
EndpointGroup for Kubernetes services.Limits the number of executed
Requests.Logging client decorators.
Metric-collecting client decorators.
Observation basing on Micrometer Observation.
Proxy configuration.
Integration with RESTEasy client.
Retrofit2 adapter for Armeria.
A
Client decorator that handles failures and retries requests.Thrift client.
Client-side classes for the WebSocket Protocol.
ZooKeeper-based
EndpointGroup for automatic service discovery.Common types.
Common annotations.
HTTP authorization common.
Common artifacts used by OAuth 2.0
implementation.
Provides the common classes for
CircuitBreaker.Various classes used internally.
Provides the common classes for HTTP content encoding.
Common classes for handling the GraphQL protocol.
GraphQL-related extended scalar classes.
gRPC-related common classes.
Common classes for handling the gRPC wire protocol without support for gRPC generated code stubs.
Kotlin-related common classes.
Logback integration.
Common metric collection utilities.
Multiple part messages support.
Prometheus version 1 metrics.
Reactor plugins to help keep
RequestContext during Reactor operations.RxJava2 plugins to help keep
RequestContext during RxJava2 Operations.RxJava3 plugins to help keep
RequestContext during RxJava3 Operations.Server-Sent Events support.
Streamed message types.
Thrift-related common classes.
A Thrift JSON protocol that supports field names as defined in the IDL.
Common throttling artifacts used by throttling implementation.
Generic utility classes.
Common classes for the WebSocket Protocol.
ZooKeeper-related common classes.
Provides a Dropwizard Bundle for Armeria.
Resilience4j's CircuitBreaker
integration with Armeria.Resilience4j's CircuitBreaker
integration with Armeria clients.Server core.
Annotations for building a RESTful service.
Decorators for the annotated HTTP service.
Annotation processors for annotated services.
HTTP authorization service.
Server-side OAuth 2.0 implementation artifacts.
Automatic service registration and discovery with Consul.
Cross-Origin Resource Sharing
(CORS) support.
Documentation service.
HTTP content encoding service.
Eureka-based automatic service registration.
HTTP static file service.
GraphQL-related server classes.
HttpService implementations for supporting the GraphQL protocol.Allows an Armeria server to host a gRPC API using the gRPC wire protocol.
HttpService implementations for handling the gRPC wire protocol
without support for gRPC generated code stubs.HTTP health check service for load balancers.
Embedded Jetty service.
Decorators for Kotlin coroutines.
Logging and metric-collecting service decorators.
Kafka backend integration support for request/response logging.
Supports monitoring and management features.
Metric-collecting service decorators and exporters.
Observation basing on Micrometer Observation.
Prometheus version 1 metrics.
Provides the default
ResponseConverterFunction
which automatically converts a Message into
an HttpResponse and
the default RequestConverterFunction which automatically
converts an AggregatedHttpRequest into
a Message.Integration with RESTEasy server.
Provides a default
ResponseConverterFunction
which automatically converts an ObservableSource into an
HttpResponse when the ObservableSource
is returned by an annotated HTTP service.Provides a default
ResponseConverterFunction
which automatically converts an ObservableSource into an
HttpResponse when the ObservableSource
is returned by an annotated HTTP service.SAML-based single sign-on
service.
Supports streaming responses from
Publisher or Stream.Thrift service.
Request throttling service decorators and strategies.
Rate-limiting throttling implementation based on
Token-Bucket algorithm
and Bucket4j library.
Embedded Tomcat service.
Server-side classes for the WebSocket Protocol.
ZooKeeper-based automatic service registration.
Spring Boot integration.
Spring Boot actuator integration.
Spring 6 HTTP interface integration.
Spring Boot integration based on reactive server stack.
Common testing utilities.
Server-side testing utilities.
Common testing utilities.
Server-side testing utilities.
A mock server for use when testing clients.
Testing utilities.
Utilities for working with
ByteBuf in an unsafe way.Provides integrations with the
v3 gRPC-xDS protocol.
Provides client-side
Endpoint related integrations with xDS.