Armeria 1.9.0 API reference

Package Description
com.linecorp.armeria.client
Client core.
com.linecorp.armeria.client.auth.oauth2
Client-side OAuth 2.0 implementation artifacts.
com.linecorp.armeria.client.brave
Distributed tracing clients based on Brave, a Java tracing library compatible with Zipkin.
com.linecorp.armeria.client.circuitbreaker
Failure detection and fallback mechanism based on circuit breaker pattern.
com.linecorp.armeria.client.consul
Consul-based EndpointGroup implementation.
com.linecorp.armeria.client.cookie
Cookie aware client.
com.linecorp.armeria.client.encoding
HTTP content decoding client.
com.linecorp.armeria.client.endpoint
Endpoint groups and their registry.
com.linecorp.armeria.client.endpoint.dns
DNS-based EndpointGroup implementation.
com.linecorp.armeria.client.endpoint.healthcheck
Filters out unhealthy Endpoints from an existing EndpointGroup by sending health check requests.
com.linecorp.armeria.client.eureka
Eureka-based EndpointGroup for automatic service discovery.
com.linecorp.armeria.client.grpc
An armeria client that uses the gRPC wire protocol.
com.linecorp.armeria.client.grpc.protocol
Unary gRPC client without support for gRPC generated code stubs.
com.linecorp.armeria.client.limit
Limits the number of executed Requests.
com.linecorp.armeria.client.logging
Logging client decorators.
com.linecorp.armeria.client.metric
Metric-collecting client decorators.
com.linecorp.armeria.client.proxy
Proxy configuration.
com.linecorp.armeria.client.resteasy
Integration with RESTEasy client.
com.linecorp.armeria.client.retrofit2
Retrofit2 adapter for Armeria.
com.linecorp.armeria.client.retry
A Client decorator that handles failures and retries requests.
com.linecorp.armeria.client.thrift
Thrift client.
com.linecorp.armeria.client.zookeeper
ZooKeeper-based EndpointGroup for automatic service discovery.
com.linecorp.armeria.common
Common types.
com.linecorp.armeria.common.annotation
Common annotations.
com.linecorp.armeria.common.auth
HTTP authorization common.
com.linecorp.armeria.common.auth.oauth2
Common artifacts used by OAuth 2.0 implementation.
com.linecorp.armeria.common.brave
Common classes for distributed tracing support based on Brave, a Java tracing library compatible with Zipkin.
com.linecorp.armeria.common.consul
Various classes used internally.
com.linecorp.armeria.common.encoding
Provides the common classes for HTTP content encoding.
com.linecorp.armeria.common.grpc
gRPC-related common classes.
com.linecorp.armeria.common.grpc.protocol
Common classes for handling the gRPC wire protocol without support for gRPC generated code stubs.
com.linecorp.armeria.common.kotlin
Kotlin-related common classes.
com.linecorp.armeria.common.logback
Logback integration.
com.linecorp.armeria.common.logging
Common types used for collecting the information about Requests and Responses.
com.linecorp.armeria.common.metric
Common metric collection utilities.
com.linecorp.armeria.common.multipart
com.linecorp.armeria.common.reactor3
Reactor plugins to help keep RequestContext during Reactor operations.
com.linecorp.armeria.common.rxjava2
RxJava2 plugins to help keep RequestContext during RxJava2 Operations.
com.linecorp.armeria.common.rxjava3
RxJava3 plugins to help keep RequestContext during RxJava3 Operations.
com.linecorp.armeria.common.sse
com.linecorp.armeria.common.stream
Streamed message types.
com.linecorp.armeria.common.thrift
Thrift-related common classes.
com.linecorp.armeria.common.thrift.text
A Thrift JSON protocol that supports field names as defined in the IDL.
com.linecorp.armeria.common.throttling
Common throttling artifacts used by throttling implementation.
com.linecorp.armeria.common.util
Generic utility classes.
com.linecorp.armeria.common.zookeeper
ZooKeeper-related common classes.
com.linecorp.armeria.dropwizard
Provides a Dropwizard Bundle for Armeria.
com.linecorp.armeria.server
Server core.
com.linecorp.armeria.server.annotation
Annotations for building a RESTful service.
com.linecorp.armeria.server.annotation.decorator
Decorators for the annotated HTTP service.
com.linecorp.armeria.server.annotation.processor
Annotation processors for annotated services.
com.linecorp.armeria.server.auth
HTTP authorization service.
com.linecorp.armeria.server.auth.oauth2
Server-side OAuth 2.0 implementation artifacts.
com.linecorp.armeria.server.brave
Distributed tracing services based on Brave, a Java tracing library compatible with Zipkin.
com.linecorp.armeria.server.consul
Automatic service registration and discovery with Consul.
com.linecorp.armeria.server.cors
com.linecorp.armeria.server.docs
Documentation service.
com.linecorp.armeria.server.encoding
HTTP content encoding service.
com.linecorp.armeria.server.eureka
Eureka-based automatic service registration.
com.linecorp.armeria.server.file
HTTP static file service.
com.linecorp.armeria.server.graphql
GraphQL-related server classes.
com.linecorp.armeria.server.grpc
Allows an Armeria server to host a gRPC API using the gRPC wire protocol.
com.linecorp.armeria.server.grpc.protocol
HttpService implementations for handling the gRPC wire protocol without support for gRPC generated code stubs.
com.linecorp.armeria.server.healthcheck
HTTP health check service for load balancers.
com.linecorp.armeria.server.jetty
Embedded Jetty service.
com.linecorp.armeria.server.kotlin
Decorators for Kotlin coroutines.
com.linecorp.armeria.server.logging
Logging and metric-collecting service decorators.
com.linecorp.armeria.server.logging.kafka
Kafka backend integration support for request/response logging.
com.linecorp.armeria.server.management
Supports monitoring and management features.
com.linecorp.armeria.server.metric
Metric-collecting service decorators and exporters.
com.linecorp.armeria.server.protobuf
Provides the default ResponseConverterFunction which automatically converts a Message into an HttpResponse and the default RequestConverterFunction which automatically converts an AggregatedHttpRequest into a Message.
com.linecorp.armeria.server.resteasy
Integration with RESTEasy server.
com.linecorp.armeria.server.rxjava2
Provides a default ResponseConverterFunction which automatically converts an ObservableSource into an HttpResponse when the ObservableSource is returned by an annotated HTTP service.
com.linecorp.armeria.server.rxjava3
Provides a default ResponseConverterFunction which automatically converts an ObservableSource into an HttpResponse when the ObservableSource is returned by an annotated HTTP service.
com.linecorp.armeria.server.saml
SAML-based single sign-on service.
com.linecorp.armeria.server.streaming
Supports streaming responses from Publisher or Stream.
com.linecorp.armeria.server.thrift
Thrift service.
com.linecorp.armeria.server.throttling
Request throttling service decorators and strategies.
com.linecorp.armeria.server.throttling.bucket4j
Rate-limiting throttling implementation based on Token-Bucket algorithm and Bucket4j library.
com.linecorp.armeria.server.tomcat
Embedded Tomcat service.
com.linecorp.armeria.server.zookeeper
ZooKeeper-based automatic service registration.
com.linecorp.armeria.spring
Spring Boot integration.
com.linecorp.armeria.spring.actuate
Spring Boot actuator integration.
com.linecorp.armeria.spring.web.reactive
Spring Boot integration based on reactive server stack.
com.linecorp.armeria.testing.junit4.common
Common testing utilities.
com.linecorp.armeria.testing.junit4.server
Server-side testing utilities.
com.linecorp.armeria.testing.junit5.common
Common testing utilities.
com.linecorp.armeria.testing.junit5.server
Server-side testing utilities.
com.linecorp.armeria.testing.junit5.server.mock
A mock server for use when testing clients.
com.linecorp.armeria.unsafe
Utilities for working with an HttpData backed by a pooled ByteBuf.
com.linecorp.armeria.unsafe.grpc
Utilities for working with ByteBuf in an unsafe way.