Index
All Classes|All Packages
A
- AAC_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
-
Advanced Audio Coding.
- AAC_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"audio/aac".
- abort() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator
- abort() - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.EmptyFixedStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
- abort() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Closes this stream with
AbortedStreamException
and prevents further subscription. - abort() - Method in interface com.linecorp.armeria.common.stream.StreamMessageDuplicator
-
Closes this duplicator and aborts all stream messages returned by
StreamMessageDuplicator.duplicate()
. - abort() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
- abort() - Method in class com.linecorp.armeria.common.stream.ThreeElementFixedStreamMessage
- abort() - Method in class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.EmptyFixedStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
- abort(Throwable) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Closes this stream with the specified
Throwable
and prevents further subscription. - abort(Throwable) - Method in interface com.linecorp.armeria.common.stream.StreamMessageDuplicator
-
Closes this duplicator and aborts all stream messages returned by
StreamMessageDuplicator.duplicate()
with the specifiedThrowable
. - abort(Throwable) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.ThreeElementFixedStreamMessage
- abort(Throwable) - Method in class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
- aborted(Throwable) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Returns an aborted
StreamMessage
that terminates with the specifiedThrowable
viaSubscriber.onError(Throwable)
immediately after being subscribed to. - AbortedStreamException - Exception in com.linecorp.armeria.common.stream
-
A
RuntimeException
that is raised to signal aSubscriber
that theStreamMessage
it subscribed to has been aborted byStreamMessage.abort()
. - absolutePathRef() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
-
Returns the
String
that consists of path, query string and fragment. - absolutePathRef() - Method in class com.linecorp.armeria.client.UserClient
- AbstractAllOrEachExtension - Class in com.linecorp.armeria.testing.junit5.common
-
A base class for JUnit5 extensions that allows implementations to control whether the callbacks are run around the entire class, like
BeforeAll
orAfterAll
, or around each test method, likeBeforeEach
orAfterEach
. - AbstractAllOrEachExtension() - Constructor for class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
- AbstractArmeriaAutoConfiguration - Class in com.linecorp.armeria.spring
-
Abstract class for implementing ArmeriaAutoConfiguration of boot2-autoconfigure module and ArmeriaSpringBoot1AutoConfiguration of boot1-autoconfigure module.
- AbstractArmeriaAutoConfiguration() - Constructor for class com.linecorp.armeria.spring.AbstractArmeriaAutoConfiguration
- AbstractArmeriaBeanPostProcessor - Exception in com.linecorp.armeria.spring
-
Abstract class for implementing ArmeriaBeanPostProcessor of boot2-autoconfigure module and ArmeriaSpringBoot1BeanPostProcessor of boot1-autoconfigure module.
- AbstractAuthorizerWithHandlers<T> - Class in com.linecorp.armeria.server.auth
-
Provides base implementation for an
Authorizer
that defines customAuthSuccessHandler
/AuthFailureHandler
s. - AbstractAuthorizerWithHandlers() - Constructor for class com.linecorp.armeria.server.auth.AbstractAuthorizerWithHandlers
- AbstractBackoff - Class in com.linecorp.armeria.client.retry
-
A skeletal
Backoff
implementation. - AbstractBackoff() - Constructor for class com.linecorp.armeria.client.retry.AbstractBackoff
- AbstractBlockingHttpVfs - Class in com.linecorp.armeria.server.file
-
A skeletal
HttpVfs
implementation for accessing file system with blocking I/O. - AbstractBlockingHttpVfs(boolean) - Constructor for class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
-
Creates a new instance.
- AbstractCircuitBreakerClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.circuitbreaker
-
A
Client
decorator that handles failures of remote invocation based on circuit breaker pattern. - AbstractCircuitBreakerClientBuilder<O extends Response> - Class in com.linecorp.armeria.client.circuitbreaker
-
A skeletal builder implementation that builds a new
AbstractCircuitBreakerClient
or its decorator function. - AbstractClientOptionsBuilder - Class in com.linecorp.armeria.client
-
A skeletal builder implementation for
ClientOptions
. - AbstractClientOptionsBuilder() - Constructor for class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Creates a new instance.
- AbstractClientOptionsBuilder(ClientOptions) - Constructor for class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Creates a new instance with the specified base options.
- AbstractConcurrencyLimitingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.limit
-
An abstract
Client
decorator that limits the concurrent number of active requests. - AbstractConcurrencyLimitingClient(Client<I, O>, int) - Constructor for class com.linecorp.armeria.client.limit.AbstractConcurrencyLimitingClient
-
Creates a new instance that decorates the specified
delegate
to limit the concurrent number of active requests tomaxConcurrency
, with the default timeout of 10000L milliseconds. - AbstractConcurrencyLimitingClient(Client<I, O>, int, long, TimeUnit) - Constructor for class com.linecorp.armeria.client.limit.AbstractConcurrencyLimitingClient
-
Creates a new instance that decorates the specified
delegate
to limit the concurrent number of active requests tomaxConcurrency
. - AbstractCuratorFrameworkBuilder - Class in com.linecorp.armeria.common.zookeeper
-
A skeletal builder implementation for
CuratorFramework
. - AbstractCuratorFrameworkBuilder(String, String) - Constructor for class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
-
Creates a new instance with the specified
zkConnectionStr
. - AbstractCuratorFrameworkBuilder(CuratorFramework, String) - Constructor for class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
-
Creates a new instance with the specified
CuratorFramework
. - AbstractEndpointSelector - Class in com.linecorp.armeria.client.endpoint
-
A skeletal
EndpointSelector
implementation. - AbstractEndpointSelector(EndpointGroup) - Constructor for class com.linecorp.armeria.client.endpoint.AbstractEndpointSelector
-
Creates a new instance that selects an
Endpoint
from the specifiedEndpointGroup
. - AbstractHealthCheckedEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.healthcheck
-
A skeletal builder implementation for creating a new
HealthCheckedEndpointGroup
. - AbstractHealthCheckedEndpointGroupBuilder(EndpointGroup) - Constructor for class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
-
Creates a new
AbstractHealthCheckedEndpointGroupBuilder
. - AbstractHttpFile - Class in com.linecorp.armeria.server.file
-
A skeletal
HttpFile
implementation. - AbstractHttpFile(MediaType, Clock, boolean, boolean, BiFunction<String, HttpFileAttributes, String>, HttpHeaders) - Constructor for class com.linecorp.armeria.server.file.AbstractHttpFile
-
Creates a new instance.
- AbstractHttpFileBuilder - Class in com.linecorp.armeria.server.file
-
A skeletal builder class which helps easier implementation of
HttpFileBuilder
orAggregatedHttpFileBuilder
. - AbstractHttpFileBuilder() - Constructor for class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
- AbstractHttpRequestBuilder - Class in com.linecorp.armeria.common
-
Builds a new
HttpRequest
. - AbstractHttpRequestBuilder() - Constructor for class com.linecorp.armeria.common.AbstractHttpRequestBuilder
- AbstractHttpService - Class in com.linecorp.armeria.server
-
A skeletal
HttpService
for easier HTTP service implementation. - AbstractHttpService() - Constructor for class com.linecorp.armeria.server.AbstractHttpService
- AbstractHttpVfs - Class in com.linecorp.armeria.server.file
-
A skeletal
HttpVfs
implementation. - AbstractHttpVfs() - Constructor for class com.linecorp.armeria.server.file.AbstractHttpVfs
- AbstractListenable<T> - Class in com.linecorp.armeria.common.util
-
A skeletal
Listenable
implementation. - AbstractListenable() - Constructor for class com.linecorp.armeria.common.util.AbstractListenable
- AbstractMetricCollectingBuilder - Class in com.linecorp.armeria.common.metric
-
Builds an implementing class of
AbstractMetricCollectingBuilder
instance. - AbstractMetricCollectingBuilder(MeterIdPrefixFunction) - Constructor for class com.linecorp.armeria.common.metric.AbstractMetricCollectingBuilder
- AbstractOption<T extends AbstractOption<T,U,V>,U extends AbstractOptionValue<U,T,V>,V> - Class in com.linecorp.armeria.common.util
-
A configuration option.
- AbstractOption(String, V, Function<V, V>, BiFunction<U, U, U>) - Constructor for class com.linecorp.armeria.common.util.AbstractOption
-
Creates a new instance.
- AbstractOption.Factory<T extends AbstractOption<T,U,V>,U extends AbstractOptionValue<U,T,V>,V> - Interface in com.linecorp.armeria.common.util
-
Creates a new option instance.
- AbstractOptions<T extends AbstractOption<T,U,Object>,U extends AbstractOptionValue<U,T,Object>> - Class in com.linecorp.armeria.common.util
-
A set of configuration options and their respective values.
- AbstractOptions(AbstractOptions<T, U>, Iterable<? extends AbstractOptionValue<?, ?, ?>>) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
-
Creates a new instance.
- AbstractOptions(Iterable<? extends AbstractOptionValue<?, ?, ?>>) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
-
Creates a new instance.
- AbstractOptionValue<T extends AbstractOptionValue<T,U,V>,U extends AbstractOption<U,T,V>,V> - Class in com.linecorp.armeria.common.util
-
A holder of a value of an
AbstractOption
. - AbstractOptionValue(U, V) - Constructor for class com.linecorp.armeria.common.util.AbstractOptionValue
-
Creates a new instance with the specified
option
andvalue
. - AbstractRequestContextBuilder - Class in com.linecorp.armeria.common
-
Provides the information required for building a
RequestContext
. - AbstractRequestContextBuilder(boolean, HttpRequest) - Constructor for class com.linecorp.armeria.common.AbstractRequestContextBuilder
-
Creates a new builder with the specified
HttpRequest
. - AbstractRequestContextBuilder(boolean, RpcRequest, URI) - Constructor for class com.linecorp.armeria.common.AbstractRequestContextBuilder
-
Creates a new builder with the specified
RpcRequest
andURI
. - AbstractRetryingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.retry
-
A
Client
decorator that handles failures of remote invocation and retries requests. - AbstractRetryingClientBuilder<O extends Response> - Class in com.linecorp.armeria.client.retry
-
Builds a new
AbstractRetryingClient
or its decorator function. - AbstractRuleBuilder - Class in com.linecorp.armeria.client
-
A skeletal builder implementation for
RetryRule
,RetryRuleWithContent
,CircuitBreakerRule
andCircuitBreakerRuleWithContent
. - AbstractRuleBuilder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Constructor for class com.linecorp.armeria.client.AbstractRuleBuilder
-
Creates a new instance with the specified
requestHeadersFilter
. - AbstractRuleWithContentBuilder<T extends Response> - Class in com.linecorp.armeria.client
-
A skeletal builder implementation for
RetryRuleWithContent
andCircuitBreakerRuleWithContent
. - AbstractRuleWithContentBuilder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Constructor for class com.linecorp.armeria.client.AbstractRuleWithContentBuilder
-
Creates a new instance with the specified
requestHeadersFilter
. - AbstractThrottlingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.throttling
-
Decorates a
Service
to throttle incoming requests. - AbstractThrottlingService(Service<I, O>, ThrottlingStrategy<I>, Function<CompletionStage<? extends O>, O>, ThrottlingAcceptHandler<I, O>, ThrottlingRejectHandler<I, O>) - Constructor for class com.linecorp.armeria.server.throttling.AbstractThrottlingService
-
Creates a new instance that decorates the specified
Service
. - AbstractUnaryGrpcService - Class in com.linecorp.armeria.server.grpc.protocol
-
An
AbstractUnaryGrpcService
can be used to implement a gRPC service without depending on gRPC stubs. - AbstractUnaryGrpcService() - Constructor for class com.linecorp.armeria.server.grpc.protocol.AbstractUnaryGrpcService
- AbstractUnsafeUnaryGrpcService - Class in com.linecorp.armeria.server.grpc.protocol
-
An
AbstractUnsafeUnaryGrpcService
can be used to implement a gRPC service without depending on gRPC stubs. - AbstractUnsafeUnaryGrpcService() - Constructor for class com.linecorp.armeria.server.grpc.protocol.AbstractUnsafeUnaryGrpcService
- AbstractUnwrappable<T extends Unwrappable> - Class in com.linecorp.armeria.common.util
-
Skeletal
Unwrappable
implementation. - AbstractUnwrappable(T) - Constructor for class com.linecorp.armeria.common.util.AbstractUnwrappable
-
Creates a new decorator with the specified delegate.
- AbstractWebClientBuilder - Class in com.linecorp.armeria.client
-
A skeletal builder implementation for
WebClient
. - AbstractWebClientBuilder() - Constructor for class com.linecorp.armeria.client.AbstractWebClientBuilder
-
Creates a new instance.
- AbstractWebClientBuilder(SessionProtocol, EndpointGroup, String) - Constructor for class com.linecorp.armeria.client.AbstractWebClientBuilder
-
Creates a new instance.
- AbstractWebClientBuilder(URI) - Constructor for class com.linecorp.armeria.client.AbstractWebClientBuilder
-
Creates a new instance.
- accept(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategy
-
Registers a request with the bucket.
- accept(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
-
Returns whether a given request should be treated as failed before it is handled actually.
- accept(URI, Cookie) - Method in interface com.linecorp.armeria.client.cookie.CookiePolicy
- ACCEPT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Accept"
header field name. - ACCEPT_CHARSET - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Accept-Charset"
header field name. - ACCEPT_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Accept-Encoding"
header field name. - ACCEPT_LANGUAGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Accept-Language"
header field name. - ACCEPT_PATCH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Accept-Patch"
header field name. - ACCEPT_RANGES - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Accept-Ranges"
header field name. - acceptAll() - Static method in interface com.linecorp.armeria.client.cookie.CookiePolicy
-
Returns a
CookiePolicy
that accepts all cookies. - ACCEPTED - Static variable in class com.linecorp.armeria.common.HttpStatus
-
202 Accepted.
- acceptFile(String) - Method in class com.linecorp.armeria.server.docs.DocStringExtractor
-
Determine whether the file at
filename
should be processed by theDocStringExtractor
. - acceptLanguages() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
-
Returns a list of
Locale.LanguageRange
s that are specified inHttpHeaderNames.ACCEPT_LANGUAGE
in the order of client-side preferences. - acceptLanguages() - Method in interface com.linecorp.armeria.common.HttpRequest
-
Returns a list of
Locale.LanguageRange
s that are specified inHttpHeaderNames.ACCEPT_LANGUAGE
in the order of client-side preferences. - acceptLanguages() - Method in interface com.linecorp.armeria.common.RequestHeaders
-
Returns a list of
Locale.LanguageRange
s that are specified inHttpHeaderNames.ACCEPT_LANGUAGE
in the order of client preferences. - acceptLanguages(Iterable<Locale.LanguageRange>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the
"accept-language"
header. - acceptLanguages(Locale.LanguageRange...) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the
"accept-language"
header. - acceptNone() - Static method in interface com.linecorp.armeria.client.cookie.CookiePolicy
-
Returns a
CookiePolicy
that rejects all cookies. - acceptOriginOnly() - Static method in interface com.linecorp.armeria.client.cookie.CookiePolicy
-
Returns a
CookiePolicy
that only accepts cookies from the original server. - acceptTypes() - Method in interface com.linecorp.armeria.server.RoutingContext
-
Returns a list of
MediaType
s that are specified inHttpHeaderNames.ACCEPT
in the order of client-side preferences. - ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Allow-Credentials"
header field name. - ACCESS_CONTROL_ALLOW_HEADERS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Allow-Headers"
header field name. - ACCESS_CONTROL_ALLOW_METHODS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Allow-Methods"
header field name. - ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Allow-Origin"
header field name. - ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Expose-Headers"
header field name. - ACCESS_CONTROL_MAX_AGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Max-Age"
header field name. - ACCESS_CONTROL_REQUEST_HEADERS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Request-Headers"
header field name. - ACCESS_CONTROL_REQUEST_METHOD - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Access-Control-Request-Method"
header field name. - accessLogFormat(String) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
- accessLogFormat(String) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the format of this
Server
's access log. - accessLogFormat(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- accessLogFormat(String) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
- accessLogFormat(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- accessLogger() - Method in class com.linecorp.armeria.server.VirtualHost
-
Returns the
Logger
which is used for writing access logs of this virtual host. - accessLogger(String) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the default access logger name for all
VirtualHost
s. - accessLogger(String) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
- accessLogger(Function<? super VirtualHost, ? extends Logger>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the default access logger mapper for all
VirtualHost
s. - accessLogger(Function<? super VirtualHost, ? extends Logger>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Sets the access logger mapper of this
VirtualHost
. - accessLogger(Logger) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the default access
Logger
for allVirtualHost
s. - accessLogger(Logger) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Sets the
Logger
of thisVirtualHost
, which is used for writing access logs. - accessLogWriter() - Method in class com.linecorp.armeria.server.ServiceConfig
-
Returns the access log writer.
- accessLogWriter() - Method in class com.linecorp.armeria.server.VirtualHost
-
Returns the access log writer.
- accessLogWriter(AccessLogWriter, boolean) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
- accessLogWriter(AccessLogWriter, boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets an access log writer of this
Server
. - accessLogWriter(AccessLogWriter, boolean) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- accessLogWriter(AccessLogWriter, boolean) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
- accessLogWriter(AccessLogWriter, boolean) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Sets the access log writer of this
VirtualHost
. - accessLogWriter(AccessLogWriter, boolean) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- AccessLogWriter - Interface in com.linecorp.armeria.server.logging
-
Consumes the
RequestLog
s produced by aService
, usually for logging purpose. - accessToken() - Method in class com.linecorp.armeria.common.auth.oauth2.GrantedOAuth2AccessToken
-
"access_token" Access Token response field, REQUIRED.
- accessToken() - Method in class com.linecorp.armeria.common.auth.OAuth2Token
-
Returns the access token.
- accessTokenType() - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizer
-
Authorization type permitted by this authorizer.
- accessTokenType(String) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Access Token type permitted by this authorizer, as per [RFC6749], Section 7.1.
- acquire(SessionProtocol, EndpointGroup, Endpoint) - Method in interface com.linecorp.armeria.client.EventLoopScheduler
- acquireEventLoop(SessionProtocol, EndpointGroup, Endpoint) - Method in interface com.linecorp.armeria.client.ClientFactory
- acquireEventLoop(SessionProtocol, EndpointGroup, Endpoint) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
- acs() - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
-
Returns a
SamlAssertionConsumerConfigBuilder
to configure a new assertion consumer service of this service provider. - acsEndpoint() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
-
Returns a
SamlEndpoint
of the service provider that the assertion will be sent to in response to the authentication request. - acsEndpoint(SamlEndpoint) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
-
Sets an assertion consumer service URL of this service provider.
- activeLocalPort() - Method in class com.linecorp.armeria.server.Server
-
Returns the local
ServerPort
that thisServer
is listening to. - activeLocalPort(SessionProtocol) - Method in class com.linecorp.armeria.server.Server
-
Returns the local
ServerPort
which serves the givenSessionProtocol
. - activePort() - Method in class com.linecorp.armeria.server.Server
-
Returns the primary
ServerPort
that thisServer
is listening to. - activePort(SessionProtocol) - Method in class com.linecorp.armeria.server.Server
-
Returns the primary
ServerPort
which serves the givenSessionProtocol
that thisServer
is listening to. - activePorts() - Method in class com.linecorp.armeria.server.Server
-
Returns all
ServerPort
s that thisServer
is listening to. - activeRequestPrefix(MeterRegistry, RequestOnlyLog) - Method in class com.linecorp.armeria.client.retrofit2.RetrofitMeterIdPrefixFunction
- activeRequestPrefix(MeterRegistry, RequestOnlyLog) - Method in class com.linecorp.armeria.common.grpc.GrpcMeterIdPrefixFunction
- activeRequestPrefix(MeterRegistry, RequestOnlyLog) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
-
Creates a
MeterIdPrefix
for the active request counter gauges from the specifiedRequestOnlyLog
. - actual() - Method in exception com.linecorp.armeria.client.SessionProtocolNegotiationException
-
Returns the actual
SessionProtocol
. - add(ClientDecoration) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Adds the specified
ClientDecoration
. - add(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Adds the specified HTTP-level
decorator
. - add(Authorizer<HttpRequest>) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an
Authorizer
. - add(CharSequence, Iterable<String>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds new headers with the specified
name
andvalues
. - add(CharSequence, Iterable<String>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- add(CharSequence, Iterable<String>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- add(CharSequence, String) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header with the specified
name
andvalue
. - add(CharSequence, String) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- add(CharSequence, String) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- add(CharSequence, String...) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds new headers with the specified
name
andvalues
. - add(CharSequence, String...) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- add(CharSequence, String...) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- add(Iterable<? extends Authorizer<HttpRequest>>) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds multiple
Authorizer
s. - add(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds all header names and values of the specified
entries
. - add(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- add(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- add(Iterable<? extends Map.Entry<? extends String, String>>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds all parameter names and values of the specified
entries
. - add(String, Iterable<String>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds new parameters with the specified
name
andvalues
. - add(String, String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter with the specified
name
andvalue
. - add(String, String...) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds new parameters with the specified
name
andvalues
. - add(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Adds the specified HTTP-level
decorator
. - add(Map<? extends CharSequence, String>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds all header names and values of the specified
entries
. - add(Map<? extends CharSequence, String>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- add(Map<? extends CharSequence, String>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- add(Map<String, String>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds all parameter names and values of the specified
entries
. - add(T) - Method in interface com.linecorp.armeria.common.stream.HttpDecoderOutput
-
Adds the decoded item to this
HttpDecoderOutput
. - addAdditionalRequestHeader(CharSequence, Object) - Method in interface com.linecorp.armeria.client.ClientRequestContext
-
Adds a header with the specified
name
andvalue
. - addAdditionalRequestHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
- addAdditionalRequestHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- addAdditionalResponseHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- addAdditionalResponseHeader(CharSequence, Object) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Adds a header with the specified
name
andvalue
. - addAdditionalResponseHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- addAdditionalResponseTrailer(CharSequence, Object) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- addAdditionalResponseTrailer(CharSequence, Object) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Adds a trailer with the specified
name
andvalue
. - addAdditionalResponseTrailer(CharSequence, Object) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- addAllStackTrace(Iterable<? extends StackTraceElementProto>) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addAppender(Appender<ILoggingEvent>) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
- addAsBodyParameters(QueryParamsBuilder) - Method in class com.linecorp.armeria.common.auth.oauth2.ClientAuthorization
-
Fetches client credentials from the supplier and composes required body parameters, as per [RFC6749], Section 2.3:
- addAttribute(String, AttributeKey<?>) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
-
Adds the specified
AttributeKey
to the export list. - addAttribute(String, AttributeKey<?>, Function<?, String>) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
-
Adds the specified
AttributeKey
to the export list. - addBasicAuth(Authorizer<? super BasicToken>) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an HTTP basic
Authorizer
. - addBasicAuth(Authorizer<? super BasicToken>, CharSequence) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an HTTP basic
Authorizer
for the givenheader
. - addBuiltIn(BuiltInProperty) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
-
Adds the specified
BuiltInProperty
to the export list. - addCallAdapterFactory(CallAdapter.Factory) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
-
Adds the specified call adapter factory for supporting service method return types other than
Call
. - addChild(RequestLogAccess) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
-
Adds the specified
RequestLogAccess
so that the logs are propagated from thechild
. - addConverterFactory(Converter.Factory) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
-
Adds the specified converter factory for serialization and deserialization of objects.
- addDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header.
- addDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addDouble(String, double) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter.
- addEndpoint(Endpoint) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
- addExceptionMapping(Class<? extends Throwable>, Status) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
- addExceptionMapping(Class<T>, BiFunction<T, Metadata, Status>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
- addFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header.
- addFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addFloat(String, float) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter.
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Adds the specified HTTP header.
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.ClientBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.WebClientBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Adds the specified HTTP header.
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Adds the specified HTTP header.
- addHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Adds the specified HTTP headers.
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.ClientBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.WebClientBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Adds the specified HTTP headers.
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Adds the specified HTTP headers.
- addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- addInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header.
- addInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addInt(String, int) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter.
- additionalEndpoint(String, Endpoint) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
-
Adds the specified additional
Endpoint
with the specifiedname
. - additionalEndpoints() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
-
Returns the additional
Endpoint
s. - additionalEndpoints(Map<String, Endpoint>) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
-
Adds the specified additional
Endpoint
s. - AdditionalHeader - Annotation Type in com.linecorp.armeria.server.annotation
-
Annotation for an additional HTTP header.
- additionalHeaders() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
-
Returns the immutable additional
HttpHeaders
which will be set when building anHttpResponse
. - AdditionalHeaders - Annotation Type in com.linecorp.armeria.server.annotation
-
The containing annotation type for
AdditionalHeader
. - additionalRequestHeaders() - Method in interface com.linecorp.armeria.client.ClientRequestContext
- additionalRequestHeaders() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
- additionalRequestHeaders() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- additionalResponseHeaders() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- additionalResponseHeaders() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
- additionalResponseHeaders() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- additionalResponseTrailers() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- additionalResponseTrailers() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns the
HttpHeaders
which is included along with any other trailers when aService
completes anHttpResponse
. - additionalResponseTrailers() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- additionals() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
-
Returns additional (or user-defined) parameters.
- AdditionalTrailer - Annotation Type in com.linecorp.armeria.server.annotation
-
Annotation for an additional HTTP trailer.
- AdditionalTrailers - Annotation Type in com.linecorp.armeria.server.annotation
-
The containing annotation type for
AdditionalTrailer
. - addListener(ServerListener) - Method in class com.linecorp.armeria.server.Server
-
Adds the specified
ServerListener
to thisServer
, so that it is notified when the state of thisServer
changes. - addListener(Consumer<? super List<Endpoint>>) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
- addListener(Consumer<? super T>) - Method in class com.linecorp.armeria.common.util.AbstractListenable
- addListener(Consumer<? super T>) - Method in interface com.linecorp.armeria.common.util.Listenable
-
Adds a
Consumer
that will be invoked when aListenable
changes its value. - addListener(L) - Method in class com.linecorp.armeria.common.util.StartStopSupport
-
Adds the specified
listener
, so that it is notified when the state of thisStartStopSupport
changes. - addLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header.
- addLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addLong(String, long) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter.
- addOAuth1a(Authorizer<? super OAuth1aToken>) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an OAuth1a
Authorizer
. - addOAuth1a(Authorizer<? super OAuth1aToken>, CharSequence) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an OAuth1a
Authorizer
for the givenheader
. - addOAuth2(Authorizer<? super OAuth2Token>) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an OAuth2
Authorizer
. - addOAuth2(Authorizer<? super OAuth2Token>, CharSequence) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds an OAuth2
Authorizer
for the givenheader
. - addObject(CharSequence, Iterable<?>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header with the specified name and values.
- addObject(CharSequence, Iterable<?>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addObject(CharSequence, Iterable<?>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header.
- addObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addObject(CharSequence, Object...) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header with the specified name and values.
- addObject(CharSequence, Object...) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addObject(CharSequence, Object...) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addObject(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds all header names and values of the specified
entries
. - addObject(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addObject(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addObject(Iterable<? extends Map.Entry<? extends String, ?>>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds all parameter names and values of the specified
entries
. - addObject(String, Iterable<?>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter with the specified name and values.
- addObject(String, Object) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter.
- addObject(String, Object...) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter with the specified name and values.
- addPolicy(CorsPolicy) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Adds a
CorsPolicy
instance in the service. - addRepeatedField(Descriptors.FieldDescriptor, Object) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- addRepeatedField(Descriptors.FieldDescriptor, Object) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- addRequestHeader(CharSequence) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
-
Adds the specified HTTP request header name to the export list.
- addResponseHeader(CharSequence) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
-
Adds the specified HTTP response header name to the export list.
- ADDRESS_RESOLVER_GROUP_FACTORY - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
-
The factory that creates an
AddressResolverGroup
which resolves remote addresses intoInetSocketAddress
es. - addressResolverGroupFactory() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
-
Returns the factory that creates an
AddressResolverGroup
which resolves remote addresses intoInetSocketAddress
es. - addressResolverGroupFactory(Function<? super EventLoopGroup, ? extends AddressResolverGroup<? extends InetSocketAddress>>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
-
Sets the factory that creates a
AddressResolverGroup
which resolves remote addresses intoInetSocketAddress
es. - addRoute(Route) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
- addRoute(Route) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- addRoute(Route) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
- addRoute(Route) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- addRpc(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Adds the specified RPC-level
decorator
. - addRpc(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Adds the specified RPC-level
decorator
. - addService(BindableService) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds a gRPC
BindableService
to thisGrpcServiceBuilder
. - addService(ServerServiceDefinition) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds a gRPC
ServerServiceDefinition
to thisGrpcServiceBuilder
, such as what's returned byBindableService.bindService()
. - addService(Object) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
-
Adds a new service implementation to the builder.
- addService(String, BindableService) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds a gRPC
BindableService
to thisGrpcServiceBuilder
. - addService(String, BindableService, MethodDescriptor<?, ?>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
- addService(String, ServerServiceDefinition) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds a gRPC
ServerServiceDefinition
to thisGrpcServiceBuilder
, such as what's returned byBindableService.bindService()
. - addService(String, ServerServiceDefinition, MethodDescriptor<?, ?>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
- addService(String, Object) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
-
Adds a new
TMultiplexed
service to the builder. - addServiceDefinitions(ServerServiceDefinition...) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds gRPC
ServerServiceDefinition
s to thisGrpcServiceBuilder
. - addServiceDefinitions(Iterable<ServerServiceDefinition>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds gRPC
ServerServiceDefinition
s to thisGrpcServiceBuilder
. - addServices(BindableService...) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds gRPC
BindableService
s to thisGrpcServiceBuilder
. - addServices(Iterable<BindableService>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Adds gRPC
BindableService
s to thisGrpcServiceBuilder
. - addStackTrace(int, StackTraceElementProto) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addStackTrace(int, StackTraceElementProto.Builder) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addStackTrace(StackTraceElementProto) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addStackTrace(StackTraceElementProto.Builder) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addStackTraceBuilder() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addStackTraceBuilder(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- addTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Adds a new header.
- addTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- addTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- addTimeMillis(String, long) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Adds a new parameter.
- addTokenAuthorizer(Function<? super RequestHeaders, T>, Authorizer<? super T>) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Adds a token-based
Authorizer
. - after() - Method in class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
-
Shuts down all threads created by this
TestRule
asynchronously. - after() - Method in class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
-
Deletes the generated
SelfSignedCertificate
. - after() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
-
Calls
ServerRule.stop()
, without waiting until theServer
is stopped completely. - after(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
-
A method that should be run at the end of a test lifecycle.
- after(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
-
Shuts down all threads created by this
Extension
asynchronously. - after(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
-
Deletes the generated
SelfSignedCertificate
. - after(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
-
Calls
ServerExtension.stop()
, without waiting until theServer
is stopped completely. - afterAll(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
- afterEach(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
- AGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Age"
header field name. - aggregate() - Method in interface com.linecorp.armeria.common.HttpRequest
-
Aggregates this request.
- aggregate() - Method in interface com.linecorp.armeria.common.HttpResponse
-
Aggregates this response.
- aggregate() - Method in interface com.linecorp.armeria.common.multipart.Multipart
-
Aggregates this
Multipart
. - aggregate(EventExecutor) - Method in interface com.linecorp.armeria.common.HttpRequest
-
Aggregates this request.
- aggregate(EventExecutor) - Method in interface com.linecorp.armeria.common.HttpResponse
-
Aggregates this response.
- aggregate(EventExecutor) - Method in interface com.linecorp.armeria.common.multipart.Multipart
-
Aggregates this
Multipart
with the specifiedEventExecutor
. - aggregate(Executor) - Method in interface com.linecorp.armeria.server.file.HttpFile
-
Converts this file into an
AggregatedHttpFile
. - aggregate(Executor) - Method in class com.linecorp.armeria.server.file.StreamingHttpFile
- AggregatedBodyPart - Interface in com.linecorp.armeria.common.multipart
-
A complete body part whose headers and content are readily available.
- AggregatedHttpFile - Interface in com.linecorp.armeria.server.file
-
A complete HTTP file whose attributes and content are readily available.
- AggregatedHttpFileBuilder - Class in com.linecorp.armeria.server.file
-
Builds an
AggregatedHttpFile
from anHttpData
. - AggregatedHttpObject - Interface in com.linecorp.armeria.common
-
A complete HTTP headers and content that are readily available.
- AggregatedHttpRequest - Interface in com.linecorp.armeria.common
-
A complete HTTP request whose content is readily available as a single
HttpData
. - AggregatedHttpResponse - Interface in com.linecorp.armeria.common
-
A complete HTTP response whose content is readily available as a single
HttpData
. - AggregatedMultipart - Interface in com.linecorp.armeria.common.multipart
-
A complete multipart whose body parts are readily available.
- aggregateWithPooledObjects(ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpRequest
-
(Advanced users only) Aggregates this request.
- aggregateWithPooledObjects(ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpResponse
-
(Advanced users only) Aggregates this response.
- aggregateWithPooledObjects(ByteBufAllocator) - Method in interface com.linecorp.armeria.common.multipart.Multipart
-
(Advanced users only) Aggregates this
Multipart
. - aggregateWithPooledObjects(EventExecutor, ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpRequest
-
Aggregates this request.
- aggregateWithPooledObjects(EventExecutor, ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpResponse
-
Aggregates this response.
- aggregateWithPooledObjects(EventExecutor, ByteBufAllocator) - Method in interface com.linecorp.armeria.common.multipart.Multipart
-
(Advanced users only) Aggregates this
Multipart
. - aggregateWithPooledObjects(Executor, ByteBufAllocator) - Method in interface com.linecorp.armeria.server.file.HttpFile
-
(Advanced users only) Converts this file into an
AggregatedHttpFile
. - aggregateWithPooledObjects(Executor, ByteBufAllocator) - Method in class com.linecorp.armeria.server.file.StreamingHttpFile
- ALL - com.linecorp.armeria.server.annotation.ExceptionVerbosity
-
Log all exceptions.
- alloc() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- alloc() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
-
Returns the
ByteBufAllocator
. - alloc() - Method in interface com.linecorp.armeria.common.RequestContext
-
Returns the
ByteBufAllocator
for thisRequestContext
. - alloc() - Method in class com.linecorp.armeria.common.RequestContextWrapper
- alloc() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- alloc(ByteBufAllocator) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
- alloc(ByteBufAllocator) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
-
Sets the
ByteBufAllocator
. - alloc(ByteBufAllocator) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
- allOf() - Static method in enum com.linecorp.armeria.server.TransientServiceOption
-
Returns all
TransientServiceOption
s. - allOptions() - Static method in class com.linecorp.armeria.client.ClientFactoryOption
-
Returns the all available
ClientFactoryOption
s. - allOptions() - Static method in class com.linecorp.armeria.client.ClientOption
-
Returns the all available
ClientOption
s. - allOptions(Class<?>) - Static method in class com.linecorp.armeria.common.util.AbstractOption
-
Returns all available options of the specified option type.
- ALLOW - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Allow"
header field name. - allowCredentials() - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
- allowCredentials() - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
- allowCredentials() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Enables cookies to be added to CORS requests.
- allowedRequestHeaders() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
-
The headers that should be returned in the CORS
"Access-Control-Allow-Headers"
response header. - allowedRequestHeaders() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
-
Returns the allowed set of request headers.
- allowedRequestMethods() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
-
The allowed HTTP request methods that should be returned in the CORS
"Access-Control-Allow-Methods"
response header. - allowedRequestMethods() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
-
Returns the allowed set of request methods.
- allowNullOrigin() - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
- allowNullOrigin() - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
- allowNullOrigin() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Enables a successful CORS response with a
"null"
value for the CORS response header"Access-Control-Allow-Origin"
. - allowRequestHeaders(CharSequence...) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
- allowRequestHeaders(CharSequence...) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
- allowRequestHeaders(CharSequence...) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Specifies the headers that should be returned in the CORS
"Access-Control-Allow-Headers"
response header. - allowRequestHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
- allowRequestHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
- allowRequestHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Specifies the headers that should be returned in the CORS
"Access-Control-Allow-Headers"
response header. - allowRequestMethods(HttpMethod...) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
- allowRequestMethods(HttpMethod...) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
- allowRequestMethods(HttpMethod...) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Specifies the allowed set of HTTP request methods that should be returned in the CORS
"Access-Control-Allow-Methods"
response header. - allowRequestMethods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
- allowRequestMethods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
- allowRequestMethods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Specifies the allowed set of HTTP request methods that should be returned in the CORS
"Access-Control-Allow-Methods"
response header. - always() - Static method in interface com.linecorp.armeria.common.util.Sampler
-
Returns a sampler that will always return
true
. - always() - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
-
Returns a singleton
ThrottlingStrategy
that always accepts requests. - and() - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
-
Returns the parent
CorsServiceBuilder
. - and() - Method in class com.linecorp.armeria.server.saml.SamlAssertionConsumerConfigBuilder
-
Returns a
SamlServiceProvider
which is the parent of this builder. - and() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
-
Returns a
SamlServiceProvider
which is the parent of this builder. - and() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Returns the parent
ServerBuilder
. - and(DocServiceFilter) - Method in interface com.linecorp.armeria.server.docs.DocServiceFilter
-
Returns a composite
DocServiceFilter
that represents a short-circuiting logicalAND
of this filter andother
. - andForOrigin(String) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
-
Creates a new instance of
ChainedCorsPolicyBuilder
added to the parentCorsServiceBuilder
. - andForOrigin(String) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Creates a new builder instance for a new
CorsPolicy
. - andForOrigins(Iterable<String>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Creates a new builder instance for a new
CorsPolicy
. - andForOrigins(String...) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
-
Creates a new instance of
ChainedCorsPolicyBuilder
added to the parentCorsServiceBuilder
. - andForOrigins(String...) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Creates a new builder instance for a new
CorsPolicy
. - andThen(MeterIdPrefixFunctionCustomizer) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
-
Returns a
MeterIdPrefixFunction
that applies transformation on theMeterIdPrefix
returned by this function. - andThen(AccessLogWriter) - Method in interface com.linecorp.armeria.server.logging.AccessLogWriter
-
Returns a new
AccessLogWriter
which combines twoAccessLogWriter
s. - annotatedService() - Method in class com.linecorp.armeria.server.ServerBuilder
-
Returns an
AnnotatedServiceBindingBuilder
to build annotated service. - annotatedService() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Returns a new instance of
VirtualHostAnnotatedServiceBindingBuilder
to build an annotated service fluently. - annotatedService(Object) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the path prefix
"/"
. - annotatedService(Object) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the path prefix
"/"
. - annotatedService(Object, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the path prefix
"/"
. - annotatedService(Object, Object...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the path prefix
"/"
. - annotatedService(Object, Function<? super HttpService, ? extends HttpService>, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the path prefix
"/"
. - annotatedService(Object, Function<? super HttpService, ? extends HttpService>, Object...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the path prefix
"/"
. - annotatedService(String, Object) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Iterable<?>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Iterable<?>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Object...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Function<? super HttpService, ? extends HttpService>, Iterable<?>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Function<? super HttpService, ? extends HttpService>, Iterable<?>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Function<? super HttpService, ? extends HttpService>, Iterable<? extends ExceptionHandlerFunction>, Iterable<? extends RequestConverterFunction>, Iterable<? extends ResponseConverterFunction>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Function<? super HttpService, ? extends HttpService>, Iterable<? extends ExceptionHandlerFunction>, Iterable<? extends RequestConverterFunction>, Iterable<? extends ResponseConverterFunction>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Function<? super HttpService, ? extends HttpService>, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Binds the specified annotated service object under the specified path prefix.
- annotatedService(String, Object, Function<? super HttpService, ? extends HttpService>, Object...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Binds the specified annotated service object under the specified path prefix.
- AnnotatedServiceBindingBuilder - Class in com.linecorp.armeria.server
-
A builder class for binding an
HttpService
fluently. - annotatedServiceExceptionVerbosity() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the verbosity of exceptions logged by annotated HTTP services.
- annotatedServiceExtensions(Iterable<? extends RequestConverterFunction>, Iterable<? extends ResponseConverterFunction>, Iterable<? extends ExceptionHandlerFunction>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the
RequestConverterFunction
s,ResponseConverterFunction
andExceptionHandlerFunction
s for creating anAnnotatedServiceExtensions
. - annotatedServiceExtensions(Iterable<? extends RequestConverterFunction>, Iterable<? extends ResponseConverterFunction>, Iterable<? extends ExceptionHandlerFunction>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Sets the
RequestConverterFunction
s,ResponseConverterFunction
andExceptionHandlerFunction
s for creating anAnnotatedServiceExtensions
. - ANY_APPLICATION_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_APPLICATION_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/*".
- ANY_AUDIO_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_AUDIO_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"audio/*".
- ANY_IMAGE_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_IMAGE_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"image/*".
- ANY_MULTIPART_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_MULTIPART_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"multipart/*".
- ANY_TEXT_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_TEXT_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"text/*".
- ANY_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"*/*".
- ANY_VIDEO_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
- ANY_VIDEO_TYPE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"video/*".
- append(ILoggingEvent) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
- append(String) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
-
Returns a newly-created instance whose name is concatenated by the specified
suffix
. - appendElapsed(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Appends the human-readable representation of the duration given as
elapsed
to the specifiedStringBuilder
. - appendElapsed(StringBuilder, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Appends the human-readable representation of the duration between the specified
startTimeNanos
andendTimeNanos
to the specifiedStringBuilder
. - appendElapsedAndSize(StringBuilder, long, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
A shortcut method that calls
TextFormatter.appendElapsed(StringBuilder, long, long)
andTextFormatter.appendSize(StringBuilder, long)
, concatenated by", "
. - appendEpochMicros(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Formats the given epoch time in microseconds to typical human-readable format "yyyy-MM-dd'T'HH_mm:ss.SSSX" and appends it to the specified
StringBuilder
. - appendEpochMillis(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Formats the given epoch time in milliseconds to typical human-readable format "yyyy-MM-dd'T'HH_mm:ss.SSSX" and appends it to the specified
StringBuilder
. - appendInetAddress(StringBuilder, InetAddress) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Formats the given
InetAddress
. - appendQueryString(StringBuilder) - Method in interface com.linecorp.armeria.common.QueryParams
-
Encodes all parameter entries into a query string, as defined in 4.10.22.6, HTML5 W3C Recommendation, and appends it into the specified
StringBuilder
. - appendSize(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Appends the human-readable representation of the specified byte-unit
size
to the specifiedStringBuffer
. - appendSocketAddress(StringBuilder, SocketAddress) - Static method in class com.linecorp.armeria.common.util.TextFormatter
-
Formats the given
SocketAddress
. - appendWithTags(String, Iterable<Tag>) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
-
Returns a newly-created instance whose name is concatenated by the specified
suffix
andtags
. - appendWithTags(String, String...) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
-
Returns a newly-created instance whose name is concatenated by the specified
suffix
andtags
. - appGroupName(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
-
Sets the group name of the application.
- APPLE_MOBILE_CONFIG - Static variable in class com.linecorp.armeria.common.MediaType
- APPLE_MOBILE_CONFIG - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/x-apple-aspen-config".
- APPLE_PASSBOOK - Static variable in class com.linecorp.armeria.common.MediaType
- APPLE_PASSBOOK - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/vnd.apple.pkpass".
- APPLICATION_BINARY - Static variable in class com.linecorp.armeria.common.MediaType
-
This is a non-standard media type, but is commonly used in serving hosted binary files as it is known not to trigger content sniffing in current browsers.
- APPLICATION_BINARY - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/binary".
- APPLICATION_XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
-
As described in RFC 3023, this constant (
application/xml
) is used for XML documents that are "unreadable by casual users." - APPLICATION_XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/xml; charset=utf-8".
- apply(RequestContext, Object) - Method in class com.linecorp.armeria.common.logging.RegexBasedSanitizer
- apply(RoutingContext) - Method in interface com.linecorp.armeria.server.Route
-
Deprecated.
- apply(RoutingContext, boolean) - Method in interface com.linecorp.armeria.server.Route
-
Matches the specified
RoutingContext
and extracts the path parameters from it if exists. - apply(MeterRegistry, RequestOnlyLog, MeterIdPrefix) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunctionCustomizer
-
Returns a
MeterIdPrefix
. - apply(String, String, String) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerFactory
-
Given a combination of host, method and path, creates a
CircuitBreaker
. - apply(Throwable, Metadata) - Method in interface com.linecorp.armeria.common.grpc.GrpcStatusFunction
- appName(String) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
-
Sets the specified
appName
. - appName(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
-
Sets the name of the application.
- AppRootFinder - Class in com.linecorp.armeria.common.util
- args() - Method in class com.linecorp.armeria.common.thrift.ThriftCall
-
Returns the arguments of this call.
- ARMERIA_GRPC_THROWABLEPROTO_BIN - Static variable in class com.linecorp.armeria.common.grpc.protocol.GrpcHeaderNames
-
"armeria.grpc.ThrowableProto-bin"
. - ARMERIA_RETRY_COUNT - Static variable in class com.linecorp.armeria.client.retry.AbstractRetryingClient
-
The header which indicates the retry count of a
Request
. - ArmeriaAutoConfiguration - Class in com.linecorp.armeria.spring
-
Spring Boot
Configuration
that provides Armeria integration. - ArmeriaAutoConfiguration() - Constructor for class com.linecorp.armeria.spring.ArmeriaAutoConfiguration
- armeriaBeanPostProcessor(BeanFactory) - Method in class com.linecorp.armeria.spring.ArmeriaBeanPostProcessorConfiguration
-
Create an
ArmeriaBeanPostProcessor
bean. - ArmeriaBeanPostProcessor - Class in com.linecorp.armeria.spring
-
BeanPostProcessor
implementation that autowires annotated fields, setter methods, and arbitrary config methods. - ArmeriaBeanPostProcessor(BeanFactory) - Constructor for class com.linecorp.armeria.spring.ArmeriaBeanPostProcessor
-
Creates a new instance.
- ArmeriaBeanPostProcessorConfiguration - Class in com.linecorp.armeria.spring
-
Spring Boot
Configuration
that provides Armeria integration. - ArmeriaBeanPostProcessorConfiguration() - Constructor for class com.linecorp.armeria.spring.ArmeriaBeanPostProcessorConfiguration
- armeriaBufferFactory(Optional<DataBufferFactory>) - Method in class com.linecorp.armeria.spring.web.reactive.DataBufferFactoryWrapperConfiguration
-
Returns a new
DataBufferFactoryWrapper
forArmeriaWebServer
andArmeriaClientHttpConnector
. - ArmeriaBundle<C extends Configuration> - Class in com.linecorp.armeria.dropwizard
-
A Dropwizard
ConfiguredBundle
that routes requests through an ArmeriaServer
rather than the default Jetty server. - ArmeriaBundle() - Constructor for class com.linecorp.armeria.dropwizard.ArmeriaBundle
- ArmeriaClientAutoConfiguration - Class in com.linecorp.armeria.spring.web.reactive
-
An auto-configuration for Armeria-based
WebClient
. - ArmeriaClientAutoConfiguration() - Constructor for class com.linecorp.armeria.spring.web.reactive.ArmeriaClientAutoConfiguration
- ArmeriaClientConfigurator - Interface in com.linecorp.armeria.spring.web.reactive
-
A configurator to configure an
WebClientBuilder
for anArmeriaClientHttpConnector
. - ArmeriaJaxrsClientEngine - Class in com.linecorp.armeria.client.resteasy
-
An implementation of
AsyncClientHttpEngine
based on ArmeriaWebClient
. - ArmeriaJaxrsClientEngine(WebClient) - Constructor for class com.linecorp.armeria.client.resteasy.ArmeriaJaxrsClientEngine
-
Constructs
ArmeriaJaxrsClientEngine
based onWebClient
. - ArmeriaJaxrsClientEngine(WebClient, int, Duration) - Constructor for class com.linecorp.armeria.client.resteasy.ArmeriaJaxrsClientEngine
-
Constructs
ArmeriaJaxrsClientEngine
based onWebClient
and other parameters. - ArmeriaMessageDeframer - Class in com.linecorp.armeria.common.grpc.protocol
-
A deframer of messages transported in the gRPC wire format.
- ArmeriaMessageDeframer(int) - Constructor for class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
-
Construct an
ArmeriaMessageDeframer
for reading messages out of a gRPC request or response. - ArmeriaMessageFramer - Class in com.linecorp.armeria.common.grpc.protocol
-
A framer of messages for transport with the gRPC wire protocol.
- ArmeriaMessageFramer(ByteBufAllocator, int, boolean) - Constructor for class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
-
Constructs an
ArmeriaMessageFramer
to write messages to a gRPC request or response. - armeriaReactiveWebServerFactory(ConfigurableListableBeanFactory, Environment) - Method in class com.linecorp.armeria.spring.web.reactive.ArmeriaReactiveWebServerFactoryAutoConfiguration
-
Returns a new
ArmeriaReactiveWebServerFactory
bean instance. - ArmeriaReactiveWebServerFactory - Class in com.linecorp.armeria.spring.web.reactive
-
A
ReactiveWebServerFactory
which is used to create a newArmeriaWebServer
. - ArmeriaReactiveWebServerFactory(ConfigurableListableBeanFactory, Environment) - Constructor for class com.linecorp.armeria.spring.web.reactive.ArmeriaReactiveWebServerFactory
-
Creates a new factory instance with the specified
ConfigurableListableBeanFactory
. - ArmeriaReactiveWebServerFactoryAutoConfiguration - Class in com.linecorp.armeria.spring.web.reactive
-
An auto-configuration for a reactive web server.
- ArmeriaReactiveWebServerFactoryAutoConfiguration() - Constructor for class com.linecorp.armeria.spring.web.reactive.ArmeriaReactiveWebServerFactoryAutoConfiguration
- ArmeriaResteasyClientBuilder - Class in com.linecorp.armeria.client.resteasy
-
An optional helper class to build
ResteasyClient
usingResteasyClientBuilder
interface as below. - ArmeriaRetrofit - Class in com.linecorp.armeria.client.retrofit2
- ArmeriaRetrofitBuilder - Class in com.linecorp.armeria.client.retrofit2
- armeriaServer(ArmeriaSettings, Optional<MeterRegistry>, Optional<List<HealthChecker>>, Optional<List<HealthCheckServiceConfigurator>>, Optional<List<MetricCollectingServiceConfigurator>>, Optional<MeterIdPrefixFunction>, Optional<List<ArmeriaServerConfigurator>>, Optional<List<Consumer<ServerBuilder>>>, Optional<List<DocServiceConfigurator>>) - Method in class com.linecorp.armeria.spring.AbstractArmeriaAutoConfiguration
-
Create a started
Server
bean. - ArmeriaServerConfigurator - Exception in com.linecorp.armeria.spring
-
Interface used to configure a service on the default armeria server.
- ArmeriaServerConfigurator - Interface in com.linecorp.armeria.spring
-
Interface used to configure a service on the default armeria server.
- armeriaServerGracefulShutdownLifecycle(Server) - Method in class com.linecorp.armeria.spring.AbstractArmeriaAutoConfiguration
-
Wrap
Server
withSmartLifecycle
. - ArmeriaSettings - Class in com.linecorp.armeria.spring
-
Settings for armeria servers.
- ArmeriaSettings() - Constructor for class com.linecorp.armeria.spring.ArmeriaSettings
- ArmeriaSettings.Compression - Class in com.linecorp.armeria.spring
-
Configurations for the HTTP content encoding.
- ArmeriaSettings.Port - Class in com.linecorp.armeria.spring
-
Port and protocol settings.
- ArmeriaSpringActuatorAutoConfiguration - Class in com.linecorp.armeria.spring.actuate
-
A
Configuration
to enable actuator endpoints on an Armeria server. - ArmeriaSpringActuatorAutoConfiguration() - Constructor for class com.linecorp.armeria.spring.actuate.ArmeriaSpringActuatorAutoConfiguration
- ArmeriaStatusException - Exception in com.linecorp.armeria.common.grpc.protocol
-
An
Exception
that contains enough information to convert it to a gRPC status. - ArmeriaStatusException(int, String) - Constructor for exception com.linecorp.armeria.common.grpc.protocol.ArmeriaStatusException
-
Constructs an
ArmeriaStatusException
for the given gRPC status code and message. - ArmeriaStatusException(int, String, Throwable) - Constructor for exception com.linecorp.armeria.common.grpc.protocol.ArmeriaStatusException
-
Constructs an
ArmeriaStatusException
for the given gRPC status code, message and cause. - array() - Method in interface com.linecorp.armeria.common.HttpData
-
Returns the underlying byte array of this data.
- artifactId() - Method in class com.linecorp.armeria.common.util.Version
-
Returns the Maven artifact ID of the component, such as
"armeria-grpc"
. - artifactVersion() - Method in class com.linecorp.armeria.common.util.Version
-
Returns the Maven artifact version of the component, such as
"1.0.0"
. - as(Class<T>) - Method in interface com.linecorp.armeria.client.Client
-
Unwraps this
Client
into the object of the specifiedtype
. - as(Class<T>) - Method in interface com.linecorp.armeria.client.retry.Backoff
- as(Class<T>) - Method in interface com.linecorp.armeria.common.util.Unwrappable
-
Unwraps this object into the object of the specified
type
. - as(Class<T>) - Method in interface com.linecorp.armeria.server.Service
-
Unwraps this
Service
into the object of the specifiedtype
. - as(Class<U>) - Method in class com.linecorp.armeria.common.util.AbstractUnwrappable
- AS_IS - com.linecorp.armeria.server.healthcheck.HealthCheckUpdateResult
-
Tells
HealthCheckService
to leave theServer
healthiness unchanged. - asBodyParameters() - Method in class com.linecorp.armeria.common.auth.oauth2.ClientAuthorization
-
Fetches client credentials from the supplier and composes required body parameters, as per [RFC6749], Section 2.3:
- asDefault() - Method in class com.linecorp.armeria.server.saml.SamlAssertionConsumerConfigBuilder
-
Sets this assertion consumer service as a default.
- asDefault() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
-
Sets this idp as a default.
- asHeaderValue() - Method in class com.linecorp.armeria.common.auth.BasicToken
-
Returns the string that is sent as the value of the
HttpHeaderNames.AUTHORIZATION
header. - asHeaderValue() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
-
Returns the string that is sent as the value of the
HttpHeaderNames.AUTHORIZATION
header. - asHeaderValue() - Method in class com.linecorp.armeria.common.auth.oauth2.ClientAuthorization
-
Fetches client authorization token or client credentials from the supplier and composes client
Authorization
header value, as per [RFC6749], Section 2.3: - asHeaderValue() - Method in class com.linecorp.armeria.common.auth.OAuth2Token
-
Returns the string that is sent as the value of the
HttpHeaderNames.AUTHORIZATION
header. - asHeaderValue() - Method in class com.linecorp.armeria.common.CacheControl
-
Encodes the directives in this
CacheControl
into an HTTP"cache-control"
header value. - asHeaderValue() - Method in class com.linecorp.armeria.common.ClientCacheControl
- asHeaderValue() - Method in class com.linecorp.armeria.common.ContentDisposition
-
Returns the header value for this content disposition as defined in RFC 6266.
- asHeaderValue() - Method in class com.linecorp.armeria.common.ServerCacheControl
- asMap() - Method in class com.linecorp.armeria.common.util.AbstractOptions
-
Returns an immutable
Map
of user-specified options. - asService() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
- asService() - Method in interface com.linecorp.armeria.server.file.HttpFile
- AsyncCloseable - Interface in com.linecorp.armeria.common.util
-
An object that may hold resources until it is closed.
- AsyncCloseableSupport - Class in com.linecorp.armeria.common.util
-
Provides support for implementing
AsyncCloseable
orListenableAsyncCloseable
. - AsyncMethodCallbacks - Class in com.linecorp.armeria.common.thrift
-
A utility class that bridges the gap between
CompletionStage
andAsyncMethodCallback
. - ATOM_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
- ATOM_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/atom+xml; charset=utf-8".
- attr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
- attr(AttributeKey<V>) - Method in interface com.linecorp.armeria.common.RequestContext
-
Returns the value associated with the given
AttributeKey
ornull
if there's no value set byRequestContext.setAttr(AttributeKey, Object)
. - attr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
- attr(AttributeKey<V>) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- attr(AttributeKey<V>, V) - Method in class com.linecorp.armeria.client.RequestOptionsBuilder
- attr(AttributeKey<V>, V) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- attr(String, AttributeKey<?>) - Method in class com.linecorp.armeria.common.logging.ExportGroupBuilder
-
Adds the specified
AttributeKey
to the export list. - attr(String, AttributeKey<?>) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
-
Adds the specified
AttributeKey
to the export list. - attr(String, AttributeKey<?>, Function<?, String>) - Method in class com.linecorp.armeria.common.logging.ExportGroupBuilder
-
Adds the specified
AttributeKey
to the export list. - attr(String, AttributeKey<?>, Function<?, String>) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
-
Adds the specified
AttributeKey
to the export list. - attr(String, Object) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
-
Puts the specified attribute into the Jetty
Server
. - attributes() - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns all
AttributeKey
s in the export list. - attributes() - Method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
-
Returns the attributes of the file.
- attrs() - Method in interface com.linecorp.armeria.client.RequestOptions
-
Returns the
Map
of all attributes thisRequestOptions
contains. - attrs() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
- attrs() - Method in interface com.linecorp.armeria.common.RequestContext
- attrs() - Method in class com.linecorp.armeria.common.RequestContextWrapper
- attrs() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- audience() - Method in class com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptor
-
"aud" Token Introspection Response field, OPTIONAL.
- audience(String) - Method in class com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptorBuilder
-
aud
Token Introspection Response field, OPTIONAL. - auth(BasicToken) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Sets the HTTP basic access authentication header using
HttpHeaderNames.AUTHORIZATION
. - auth(BasicToken) - Method in class com.linecorp.armeria.client.ClientBuilder
- auth(BasicToken) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- auth(BasicToken) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- auth(BasicToken) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- auth(BasicToken) - Method in class com.linecorp.armeria.client.WebClientBuilder
- auth(BasicToken) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- auth(OAuth1aToken) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Sets the OAuth Core 1.0 Revision A header using
HttpHeaderNames.AUTHORIZATION
. - auth(OAuth1aToken) - Method in class com.linecorp.armeria.client.ClientBuilder
- auth(OAuth1aToken) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- auth(OAuth1aToken) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- auth(OAuth1aToken) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- auth(OAuth1aToken) - Method in class com.linecorp.armeria.client.WebClientBuilder
- auth(OAuth1aToken) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- auth(OAuth2Token) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Sets the OAuth 2.0 header using
HttpHeaderNames.AUTHORIZATION
. - auth(OAuth2Token) - Method in class com.linecorp.armeria.client.ClientBuilder
- auth(OAuth2Token) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- auth(OAuth2Token) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- auth(OAuth2Token) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- auth(OAuth2Token) - Method in class com.linecorp.armeria.client.WebClientBuilder
- auth(OAuth2Token) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- authFailed(HttpService, ServiceRequestContext, HttpRequest, Throwable) - Method in interface com.linecorp.armeria.server.auth.AuthFailureHandler
-
Invoked when the authorization of the specified
HttpRequest
has failed. - AuthFailureHandler - Interface in com.linecorp.armeria.server.auth
-
A callback which is invoked to handle an authorization failure indicated by
Authorizer
. - authority() - Method in class com.linecorp.armeria.client.Endpoint
-
Converts this endpoint into the authority part of a URI.
- authority() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
-
Returns the authority of the request.
- authority() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
-
Returns the authority of this request.
- authority() - Method in interface com.linecorp.armeria.common.HttpRequest
-
Returns the authority of this request.
- authority() - Method in interface com.linecorp.armeria.common.RequestHeaders
-
Returns the value of the
":authority"
for HTTP/2 request or"Host"
header for HTTP/1.1. - authority(Endpoint) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the
":authority"
header from the specifiedEndpoint
. - authority(String) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the
":authority"
header. - AUTHORITY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
":authority"
pseudo header field name. - authorization() - Method in class com.linecorp.armeria.common.auth.oauth2.GrantedOAuth2AccessToken
-
A value of the
HttpHeaderNames.AUTHORIZATION
header based on this access token. - AUTHORIZATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Authorization"
header field name. - AuthorizationStatus - Interface in com.linecorp.armeria.server.auth
-
Provides a status of the request authorization operation, optionally combined with
AuthSuccessHandler
andAuthFailureHandler
to facilitate custom status handling. - authorize(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.auth.AbstractAuthorizerWithHandlers
- authorize(ServiceRequestContext, T) - Method in interface com.linecorp.armeria.server.auth.Authorizer
-
Authorizes the given
data
. - authorizeAndSupplyHandlers(ServiceRequestContext, OAuth2Token) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizer
- authorizeAndSupplyHandlers(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.auth.AbstractAuthorizerWithHandlers
- authorizeAndSupplyHandlers(ServiceRequestContext, T) - Method in interface com.linecorp.armeria.server.auth.Authorizer
-
Authorizes the given
data
. - authorizer(Authorizer<HttpRequest>) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
-
Set an
Authorizer
which is used for this service provider's authentication. - Authorizer<T> - Interface in com.linecorp.armeria.server.auth
-
Determines whether a given
data
is authorized for the service registered in. - AuthService - Class in com.linecorp.armeria.server.auth
-
Decorates an
HttpService
to provide HTTP authorization functionality. - AuthServiceBuilder - Class in com.linecorp.armeria.server.auth
-
Builds a new
AuthService
. - authSucceeded(HttpService, ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.auth.AuthSuccessHandler
-
Invoked when the authorization of the specified
HttpRequest
has succeeded. - AuthSuccessHandler - Interface in com.linecorp.armeria.server.auth
-
A callback which is invoked to handle an authorization success indicated by
Authorizer
. - AuthTokenExtractors - Class in com.linecorp.armeria.server.auth
-
A utility class that provides singleton instances of authorization token extractor functions.
- autoDetectedContentType(boolean) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets whether to set the
"content-type"
header automatically based on the extension of the file. - autoDetectedContentType(boolean) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- autoDetectedContentType(boolean) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- autoFillAcceptEncoding(boolean) - Method in class com.linecorp.armeria.client.encoding.DecodingClientBuilder
-
Automatically fills possible
HttpHeaderNames.ACCEPT_ENCODING
s specified inDecodingClientBuilder.decoderFactories(StreamDecoderFactory...)
if anHttpHeaderNames.ACCEPT_ENCODING
is not set inRequestHeaders
. - autoIndex() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
-
Returns whether a directory listing for a directory without an
index.html
file will be auto-generated. - autoIndex(boolean) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Sets whether
FileService
auto-generates a directory listing for a directory without anindex.html
file. - availabilityStamp() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
-
Returns an
int
representation of the currently available properties of thisRequestLog
. - availableFormats(SerializationFormat...) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
-
Sets the available
SerializationFormat
s. - availableFormats(Iterable<SerializationFormat>) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
-
Sets the available
SerializationFormat
s. - availableMimeTypes() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
-
Returns the set of available MIME types of this endpoint.
- availableMimeTypes(MediaType...) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
-
Sets the available
MediaType
s. - availableMimeTypes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
-
Sets the available
MediaType
s.
B
- backoff(Backoff) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
- backoff(Backoff) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
- backoff(Backoff) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
- Backoff - Interface in com.linecorp.armeria.client.retry
-
Controls back off between attempts in a single retry operation.
- BackoffWrapper - Class in com.linecorp.armeria.client.retry
-
Wraps an existing
Backoff
. - BackoffWrapper(Backoff) - Constructor for class com.linecorp.armeria.client.retry.BackoffWrapper
- BAD_GATEWAY - Static variable in class com.linecorp.armeria.common.HttpStatus
-
502 Bad Gateway.
- BAD_REQUEST - Static variable in class com.linecorp.armeria.common.HttpStatus
-
400 Bad Request.
- BandwidthLimit - Class in com.linecorp.armeria.server.throttling.bucket4j
-
Stores configurations of a single Token-Bucket bandwidth limit.
- baseDir(String) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
-
Sets the base directory of an embedded Tomcat.
- baseDir(Path) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
-
Sets the base directory of an embedded Tomcat.
- basic() - Static method in class com.linecorp.armeria.server.auth.AuthTokenExtractors
-
Returns a
BasicToken
extractor function. - BASIC_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
-
Basic Audio, as defined by RFC 2046.
- BASIC_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"audio/basic".
- BasicToken - Class in com.linecorp.armeria.common.auth
-
The bearer token of HTTP basic access authentication.
- bean(Object) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
-
Adds the specified bean to the Jetty
Server
. - bean(Object, boolean) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
-
Adds the specified bean to the Jetty
Server
. - before() - Method in class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
- before() - Method in class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
-
Generates a
SelfSignedCertificate
. - before() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
-
Calls
ServerRule.start()
if auto-start is enabled. - before(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
-
A method that should be run at the beginning of a test lifecycle.
- before(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
- before(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
-
Generates a
SelfSignedCertificate
. - before(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
-
Calls
ServerExtension.start()
if auto-start is enabled. - beforeAll(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
- beforeComplete(Subscriber<? super U>) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
-
A callback executed just before calling
Subscriber.onComplete()
onsubscriber
. - beforeEach(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
- beforeError(Subscriber<? super U>, Throwable) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
-
A callback executed just before calling
Subscriber.onError(Throwable)
onsubscriber
. - beforeInitiatingSso(ServiceRequestContext, HttpRequest, MessageContext<AuthnRequest>, SamlIdentityProviderConfig) - Method in interface com.linecorp.armeria.server.saml.SamlSingleSignOnHandler
-
Invoked before the service provider sends an authentication request to an identity provider.
- beforeSubscribe(Subscriber<? super U>, Subscription) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
-
A callback executed just before calling
Subscriber.onSubscribe(Subscription)
onsubscriber
. - beforeTestExecution(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
- belongsTo(MediaType) - Method in class com.linecorp.armeria.common.MediaType
- binary(MediaType...) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Sets the specified
MediaType
s to produce the hex dump preview when the content type of theRequestHeaders
orResponseHeaders
is one of theMediaType
s. - binary(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Sets the specified
MediaType
s to produce the hex dump preview when the content type of theRequestHeaders
orResponseHeaders
is one of theMediaType
s. - binary(BiFunction<? super HttpHeaders, ? super ByteBuf, String>, MediaType...) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Sets the specified
MediaType
s to produce the preview using the specifiedBiFunction
when the content type of theRequestHeaders
orResponseHeaders
is one of theMediaType
s. - binary(BiFunction<? super HttpHeaders, ? super ByteBuf, String>, Iterable<MediaType>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Sets the specified
MediaType
s to produce the preview using the specifiedBiFunction
when the content type of theRequestHeaders
orResponseHeaders
is one of theMediaType
s. - binary(BiFunction<? super HttpHeaders, ? super ByteBuf, String>, BiPredicate<? super RequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Sets the specified
BiPredicate
to produce the preview using the specifiedBiFunction
when the predicate returnstrue
. - binary(BiPredicate<? super RequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
- BINARY - Static variable in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
-
TProtocolFactory
for Thrift TBinary protocol. - BINARY - Static variable in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
-
Thrift TBinary serialization format.
- bindingProtocol() - Method in class com.linecorp.armeria.server.saml.SamlEndpoint
-
Returns a
SamlBindingProtocol
of this endpoint. - Blocking - Annotation Type in com.linecorp.armeria.server.annotation
-
Specifies that the annotated service method must be invoked from the blocking task executor instead of an event loop thread.
- blockingCanList(Executor, String) - Method in class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
-
Returns whether the file at the specified
path
is a listable directory. - blockingGet(Executor, String, Clock, String, HttpHeaders) - Method in class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
-
Finds the file at the specified
path
. - blockingList(Executor, String) - Method in class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
-
Lists the files at the specified directory
path
non-recursively. - blockingTaskExecutor() - Static method in class com.linecorp.armeria.common.CommonPools
-
Returns the default common blocking task
ScheduledExecutorService
which is used for potentially long-running tasks which may block I/O threads. - blockingTaskExecutor() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- blockingTaskExecutor() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns the
ScheduledExecutorService
dedicated to the execution of blocking tasks or invocations. - blockingTaskExecutor() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns the
ContextAwareScheduledExecutorService
that could be used for executing a potentially long-running task. - blockingTaskExecutor() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- blockingTaskExecutor(int) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Uses a newly created
BlockingTaskExecutor
with the specified number of threads dedicated to the execution of blocking tasks or invocations. - blockingTaskExecutor(ScheduledExecutorService, boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the
ScheduledExecutorService
dedicated to the execution of blocking tasks or invocations. - BlockingTaskExecutor - Interface in com.linecorp.armeria.common.util
-
Provides an executor interface which is used for potentially long-running tasks which may block I/O threads.
- BlockingTaskExecutorBuilder - Class in com.linecorp.armeria.common.util
-
A builder that is useful for creating a
ScheduledExecutorService
. - blockUntilShutdown() - Method in class com.linecorp.armeria.server.Server
-
Waits until the result of
CompletableFuture
which is completed after theServer.close()
orServer.closeAsync()
operation is completed. - BMP - Static variable in class com.linecorp.armeria.common.MediaType
-
Bitmap file format (
bmp
files). - BMP - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"image/bmp".
- body() - Method in interface com.linecorp.armeria.common.SplitHttpResponse
-
Returns a
StreamMessage
publishes HTTP payloads as a stream ofHttpData
. - BODY - com.linecorp.armeria.server.docs.FieldLocation
-
The field is located in the request body.
- BodyPart - Interface in com.linecorp.armeria.common.multipart
-
A body part entity.
- BodyPartBuilder - Class in com.linecorp.armeria.common.multipart
-
A builder class for creating
BodyPart
instances. - bodyParts() - Method in interface com.linecorp.armeria.common.multipart.AggregatedMultipart
-
Returns all the nested body parts.
- bodyParts() - Method in interface com.linecorp.armeria.common.multipart.Multipart
-
Returns all the nested body parts.
- boundary() - Method in interface com.linecorp.armeria.common.multipart.AggregatedMultipart
-
Returns the boundary string.
- boundary() - Method in interface com.linecorp.armeria.common.multipart.Multipart
-
Returns the boundary string.
- BraveClient - Class in com.linecorp.armeria.client.brave
- BraveService - Class in com.linecorp.armeria.server.brave
- buf() - Method in class com.linecorp.armeria.common.grpc.protocol.DeframedMessage
-
Returns the
ByteBuf
. - BUFFERS - Static variable in class com.linecorp.armeria.unsafe.grpc.GrpcUnsafeBufferUtil
- build() - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrantBuilder
-
Builds a new instance of
OAuth2ClientCredentialsGrant
using configured parameters. - build() - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ResourceOwnerPasswordCredentialsGrantBuilder
-
Builds a new instance of
OAuth2ResourceOwnerPasswordCredentialsGrant
using configured parameters. - build() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Returns a newly-created
CircuitBreaker
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Returns a newly-created
ClientDecoration
based on the decorators added to this builder. - build() - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
-
Returns a newly-created
ClientFactory
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
-
Returns a newly-created
ClientOptions
based on theClientOptionValue
s of this builder. - build() - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
-
Returns a new
ClientRequestContext
created with the properties of this builder. - build() - Method in class com.linecorp.armeria.client.consul.ConsulEndpointGroupBuilder
-
Returns a newly-created
ConsulEndpointGroup
. - build() - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
-
Returns a newly created
DnsAddressEndpointGroup
. - build() - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
-
Returns a newly created
DnsServiceEndpointGroup
. - build() - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
-
Returns a newly created
DnsTextEndpointGroup
. - build() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
-
Returns a newly created
HealthCheckedEndpointGroup
based on the properties set so far. - build() - Method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroupBuilder
-
Returns a new
PropertiesEndpointGroup
built from the properties set so far. - build() - Method in class com.linecorp.armeria.client.endpoint.WeightRampingUpStrategyBuilder
-
Returns a newly-created weight ramping up
EndpointSelectionStrategy
which ramps the weight of newly addedEndpoint
s. - build() - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
-
Returns a newly-created
EurekaEndpointGroup
based on the properties set so far. - build() - Method in class com.linecorp.armeria.client.RequestOptionsBuilder
-
Returns a newly created
RequestOptions
with the properties specified so far. - build() - Method in class com.linecorp.armeria.client.resteasy.ArmeriaResteasyClientBuilder
- build() - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
-
Returns a newly-created
Retrofit
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.client.retry.RetryConfigBuilder
-
Returns a newly-created
RetryConfig
from thisRetryConfigBuilder
's values. - build() - Method in class com.linecorp.armeria.client.WebClientBuilder
-
Returns a newly-created web client based on the properties of this builder.
- build() - Method in class com.linecorp.armeria.client.zookeeper.CuratorDiscoverySpecBuilder
-
Returns a newly-created
ZooKeeperDiscoverySpec
based on the properties set so far. - build() - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
-
Returns a newly-created
ZooKeeperEndpointGroup
based on the properties set so far. - build() - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
-
Returns a newly-created
OAuth1aToken
based on the properties set so far. - build() - Method in class com.linecorp.armeria.common.auth.oauth2.GrantedOAuth2AccessTokenBuilder
-
Builds a new instance of
GrantedOAuth2AccessToken
based on the configured parameters. - build() - Method in class com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptorBuilder
-
Builds a new instance of
OAuth2TokenDescriptor
based on the configured parameters. - build() - Method in class com.linecorp.armeria.common.auth.oauth2.TokenRevocationBuilder
-
Builds a new instance of
TokenRevocation
using configured parameters. - build() - Method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContextBuilder
-
Returns a newly-created
RequestContextCurrentTraceContext
based on the configuration properties set so far. - build() - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
-
Returns a newly created
ClientCacheControl
with the directives enabled so far. - build() - Method in class com.linecorp.armeria.common.ContentDispositionBuilder
-
Returns a newly-created
ContentDisposition
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.common.ContentTooLargeExceptionBuilder
-
Returns a new instance of
ContentTooLargeException
. - build() - Method in class com.linecorp.armeria.common.CookieBuilder
-
Returns a newly created
Cookie
with the properties set so far. - build() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- build() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- build() - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Returns a newly created
HttpHeaders
with the entries in this builder. - build() - Method in class com.linecorp.armeria.common.HttpRequestBuilder
-
Builds the request.
- build() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimingsBuilder
-
Returns a newly-created
ClientConnectionTimings
instance. - build() - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Returns a newly-created
ContentPreviewerFactory
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.common.logging.ExportGroupBuilder
-
Builds a new
ExportGroup
. - build() - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
-
Returns a newly-created
RequestContextExporter
instance. - build() - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Returns a newly-created
BodyPart
. - build() - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Returns a newly created
QueryParams
with the entries in this builder. - build() - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Returns a newly created
RequestHeaders
with the entries in this builder. - build() - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
-
Returns a newly created
ResponseHeaders
with the entries in this builder. - build() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
-
Returns a newly created
ServerCacheControl
with the directives enabled so far. - build() - Method in class com.linecorp.armeria.common.sse.ServerSentEventBuilder
-
Creates a new
ServerSentEvent
instance. - build() - Method in class com.linecorp.armeria.common.util.BlockingTaskExecutorBuilder
-
Returns a newly-created
BlockingTaskExecutor
with the properties given so far. - build() - Method in class com.linecorp.armeria.common.util.ThreadFactoryBuilder
-
Returns a new
ThreadFactory
. - build() - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Builds a new instance of
OAuth2TokenIntrospectionAuthorizer
using configured parameters. - build() - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
-
Returns a newly-created
ConsulUpdatingListener
that registers theServer
to Consul when theServer
starts. - build() - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
-
Returns a newly-created
CorsPolicy
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
-
Returns a newly-created
DocService
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
-
Returns a newly-created
EndpointInfo
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.docs.FieldInfoBuilder
-
Returns a newly-created
FieldInfo
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
-
Returns a newly-created
EurekaUpdatingListener
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
-
Returns a newly created
AggregatedHttpFile
with the properties configured so far. - build() - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Returns a newly-created
FileService
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
-
Returns a newly created
HttpFile
with the properties configured so far. - build() - Method in class com.linecorp.armeria.server.graphql.GraphqlServiceBuilder
-
Creates a
GraphqlService
. - build() - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Constructs a new
GrpcService
that can be bound toServerBuilder
. - build() - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
-
Returns a newly created
HealthCheckService
built from the properties specified so far. - build() - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
-
Returns a newly-created
JettyService
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.metric.PrometheusExpositionServiceBuilder
-
Returns a newly-created
PrometheusExpositionService
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.resteasy.ResteasyServiceBuilder
-
Builds new
ResteasyService
. - build() - Method in class com.linecorp.armeria.server.RouteBuilder
-
Returns a newly-created
Route
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.RoutingResultBuilder
-
Returns a newly-created
RoutingResult
. - build() - Method in class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
-
Creates a new
KeyStoreCredentialResolver
. - build() - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
-
Builds a
SamlServiceProvider
which helps aServer
have a SAML-based authentication. - build() - Method in class com.linecorp.armeria.server.ServerBuilder
-
Returns a newly-created
Server
based on the configuration properties set so far. - build() - Method in class com.linecorp.armeria.server.ServerListenerBuilder
-
Returns a newly-created
ServerListener
based on theRunnable
s added to this builder. - build() - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
-
Returns a new
ServiceRequestContext
created with the properties of this builder. - build() - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
-
Builds a new instance of
THttpService
. - build() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder
-
Returns a newly-created
TokenBucket
based on the set of limits configured for this builder. - build() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder
-
Returns a newly-created
TokenBucketThrottlingStrategy
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
-
Returns a newly-created
TomcatService
based on the properties of this builder. - build() - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
-
Returns a newly-created
ZooKeeperRegistrationSpec
based on the properties set so far. - build() - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
-
Returns a newly-created
ZooKeeperRegistrationSpec
based on the properties set so far. - build() - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListenerBuilder
-
Returns a newly-created
ZooKeeperUpdatingListener
instance that registers the server to ZooKeeper when the server starts. - build(CircuitBreakerFactory) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMappingBuilder
-
Returns a newly-created
CircuitBreakerMapping
with the specifiedCircuitBreakerFactory
and properties set so far. - build(HttpClient) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClientBuilder
-
Returns a newly-created
CircuitBreakerClient
based on the properties of this builder. - build(HttpClient) - Method in class com.linecorp.armeria.client.encoding.DecodingClientBuilder
-
Returns a newly-created
DecodingClient
based on the properties of this builder. - build(HttpClient) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
-
Returns a newly-created
LoggingClient
decoratingdelegate
based on the properties of this builder. - build(HttpClient) - Method in class com.linecorp.armeria.client.metric.MetricCollectingClientBuilder
-
Returns a newly-created
MetricCollectingClient
decoratingHttpClient
based on the properties of this builder. - build(HttpClient) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
-
Returns a newly-created
RetryingClient
based on the properties of this builder. - build(RpcClient) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClientBuilder
-
Returns a newly-created
CircuitBreakerRpcClient
based on the properties of this builder. - build(RpcClient) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
-
Returns a newly-created
LoggingRpcClient
decoratingdelegate
based on the properties of this builder. - build(RpcClient) - Method in class com.linecorp.armeria.client.metric.MetricCollectingRpcClientBuilder
-
Returns a newly-created
MetricCollectingRpcClient
decoratingRpcClient
based on the properties of this builder. - build(RpcClient) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
-
Returns a newly-created
RetryingRpcClient
based on the properties of this builder. - build(DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
-
Sets the
DecoratingHttpServiceFunction
and returnsServerBuilder
that thisDecoratingServiceBindingBuilder
was created from. - build(DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
-
Sets the
DecoratingHttpServiceFunction
and returnsVirtualHostBuilder
that thisVirtualHostDecoratingServiceBindingBuilder
was created from. - build(HttpService) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
-
Returns a newly-created
AuthService
based on theAuthorizer
s added to this builder. - build(HttpService) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
-
Returns a newly-created
CorsService
based on the properties of this builder. - build(HttpService) - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
-
Returns a newly-created
EncodingService
based on the properties of this builder. - build(HttpService) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
-
Returns a newly-created
LoggingService
decoratingHttpService
based on the properties of this builder. - build(HttpService) - Method in class com.linecorp.armeria.server.metric.MetricCollectingServiceBuilder
-
Returns a newly-created
MetricCollectingService
decoratingHttpService
based on the properties of this builder. - build(HttpService) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
-
Sets the
HttpService
and returns theServerBuilder
that thisServiceBindingBuilder
was created from. - build(HttpService) - Method in class com.linecorp.armeria.server.throttling.ThrottlingServiceBuilder
-
Returns a newly-created
ThrottlingService
based on theThrottlingStrategy
s added to this builder. - build(HttpService) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
-
Sets the
HttpService
and returns theVirtualHostBuilder
that thisVirtualHostServiceBindingBuilder
was created from. - build(RpcService) - Method in class com.linecorp.armeria.server.throttling.ThrottlingRpcServiceBuilder
-
Returns a newly-created
ThrottlingRpcService
based on theThrottlingStrategy
s added to this builder. - build(ServiceDescriptor) - Method in class com.linecorp.armeria.common.grpc.GrpcJsonMarshallerBuilder
-
Returns a newly-created
GrpcJsonMarshaller
with the specifiedServiceDescriptor
. - build(Class<T>) - Method in class com.linecorp.armeria.client.ClientBuilder
-
Returns a newly-created client which implements the specified
clientType
, based on the properties of this builder. - build(Object) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
- build(Object) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
-
Registers the given service to the VirtualHostBuilder.
- build(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
-
Sets the
decorator
and returnsServerBuilder
that thisDecoratingServiceBindingBuilder
was created from. - build(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
-
Sets the
decorator
and returnsVirtualHostBuilder
that thisVirtualHostDecoratingServiceBindingBuilder
was created from. - buildCuratorFramework() - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
-
Returns a newly-created
CuratorFramework
based on the configuration properties added to this builder ifAbstractCuratorFrameworkBuilder.isUserSpecifiedCuratorFramework()
is true. - builder() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
-
Returns a new
CircuitBreakerBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
-
Returns a builder that builds a
CircuitBreakerMapping
by setting host, method and/or path. - builder() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
-
Returns a newly created
CircuitBreakerRuleBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
-
Returns a newly created
CircuitBreakerRuleWithContentBuilder
. - builder() - Static method in class com.linecorp.armeria.client.ClientDecoration
-
Returns a newly created
ClientDecorationBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.ClientFactory
-
Returns a newly created
ClientFactoryBuilder
. - builder() - Static method in class com.linecorp.armeria.client.ClientOptions
-
Returns a newly created
ClientOptionsBuilder
. - builder() - Static method in class com.linecorp.armeria.client.encoding.DecodingClient
-
Returns a new
DecodingClientBuilder
. - builder() - Static method in class com.linecorp.armeria.client.logging.LoggingClient
-
Returns a newly created
LoggingClientBuilder
. - builder() - Static method in class com.linecorp.armeria.client.logging.LoggingRpcClient
-
Returns a newly created
LoggingRpcClientBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.RequestOptions
-
Returns a newly created
RequestOptionsBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.retry.RetryRule
-
Returns a newly created
RetryRuleBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
-
Returns a newly created
RetryRuleWithContentBuilder
. - builder() - Static method in interface com.linecorp.armeria.client.WebClient
-
Returns a new
WebClientBuilder
created without a baseURI
. - builder() - Static method in class com.linecorp.armeria.common.auth.OAuth1aToken
-
Returns a new
OAuth1aTokenBuilder
. - builder() - Static method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContext
-
Use this when you need customizations such as log integration via CurrentTraceContext.Builder.addScopeDecorator(ScopeDecorator).
- builder() - Static method in class com.linecorp.armeria.common.ClientCacheControl
-
Returns a newly created
ClientCacheControlBuilder
with all directives disabled initially. - builder() - Static method in exception com.linecorp.armeria.common.ContentTooLargeException
-
Returns a
ContentTooLargeExceptionBuilder
which may return a singleton or a new instance in itsContentTooLargeExceptionBuilder.build()
method, depending onFlags.verboseExceptionSampler()
's decision. - builder() - Static method in interface com.linecorp.armeria.common.grpc.GrpcJsonMarshaller
-
Returns a new
GrpcJsonMarshallerBuilder
. - builder() - Static method in interface com.linecorp.armeria.common.HttpHeaders
-
Returns a new empty builder.
- builder() - Static method in interface com.linecorp.armeria.common.HttpRequest
-
Returns a new
HttpRequestBuilder
. - builder() - Static method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
-
Returns a newly created
ClientConnectionTimingsBuilder
. - builder() - Static method in interface com.linecorp.armeria.common.logging.ContentPreviewerFactory
-
Returns a newly created
ContentPreviewerFactoryBuilder
. - builder() - Static method in class com.linecorp.armeria.common.logging.ExportGroup
-
Returns a new
ExportGroupBuilder
. - builder() - Static method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns a newly created
RequestContextExporterBuilder
. - builder() - Static method in interface com.linecorp.armeria.common.multipart.BodyPart
-
Returns a new
BodyPartBuilder
. - builder() - Static method in interface com.linecorp.armeria.common.QueryParams
-
Returns a new empty builder.
- builder() - Static method in interface com.linecorp.armeria.common.RequestHeaders
-
Returns a new empty builder.
- builder() - Static method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns a new empty builder.
- builder() - Static method in class com.linecorp.armeria.common.ServerCacheControl
-
Returns a newly created
ServerCacheControlBuilder
with all directives disabled initially. - builder() - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
-
Returns a newly created
ServerSentEventBuilder
. - builder() - Static method in interface com.linecorp.armeria.common.util.BlockingTaskExecutor
-
Returns a new builder for
BlockingTaskExecutor
. - builder() - Static method in class com.linecorp.armeria.server.auth.AuthService
-
Returns a new
AuthServiceBuilder
. - builder() - Static method in class com.linecorp.armeria.server.cors.CorsPolicy
-
Returns a new
CorsPolicyBuilder
. - builder() - Static method in class com.linecorp.armeria.server.docs.DocService
-
Returns a new
DocServiceBuilder
. - builder() - Static method in class com.linecorp.armeria.server.encoding.EncodingService
-
Returns a new
EncodingServiceBuilder
. - builder() - Static method in interface com.linecorp.armeria.server.graphql.GraphqlService
-
Returns a new
GraphqlServiceBuilder
. - builder() - Static method in interface com.linecorp.armeria.server.grpc.GrpcService
-
Returns a new
GrpcServiceBuilder
. - builder() - Static method in class com.linecorp.armeria.server.healthcheck.HealthCheckService
-
Returns a new builder which builds a new
HealthCheckService
. - builder() - Static method in class com.linecorp.armeria.server.jetty.JettyService
-
Returns a new
JettyServiceBuilder
. - builder() - Static method in class com.linecorp.armeria.server.logging.LoggingService
-
Returns a newly created
LoggingServiceBuilder
. - builder() - Static method in interface com.linecorp.armeria.server.Route
-
Returns a new builder.
- builder() - Static method in class com.linecorp.armeria.server.RoutingResult
-
Returns a new builder.
- builder() - Static method in class com.linecorp.armeria.server.saml.SamlServiceProvider
-
Returns a new
SamlServiceProviderBuilder
. - builder() - Static method in class com.linecorp.armeria.server.Server
-
Creates a new
ServerBuilder
. - builder() - Static method in interface com.linecorp.armeria.server.ServerListener
-
Returns a new
ServerListenerBuilder
. - builder() - Static method in class com.linecorp.armeria.server.thrift.THttpService
-
Creates a new instance of
THttpServiceBuilder
which can build an instance ofTHttpService
fluently. - builder() - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket
-
Returns a newly created
TokenBucketBuilder
. - builder(boolean) - Static method in class com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptor
-
Creates a new
OAuth2TokenDescriptorBuilder
to build a newOAuth2TokenDescriptor
and supplied it with a value ofactive
Token Introspection Response field. - builder(int) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns a new builder with the specified
statusCode
. - builder(CircuitBreakerRule) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
-
Returns a new
CircuitBreakerClientBuilder
with the specifiedCircuitBreakerRule
. - builder(CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
-
Returns a new
CircuitBreakerClientBuilder
with the specifiedCircuitBreakerRuleWithContent
. - builder(CircuitBreakerRuleWithContent<HttpResponse>, int) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
-
Returns a new
CircuitBreakerClientBuilder
with the specifiedCircuitBreakerRuleWithContent
and the specifiedmaxContentLength
which is required to determine aResponse
as a success or failure. - builder(CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
-
Returns a new
CircuitBreakerRpcClientBuilder
with the specifiedCircuitBreakerRuleWithContent
. - builder(EndpointGroup, String) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
-
Returns a newly created
HealthCheckedEndpointGroupBuilder
that builds aHealthCheckedEndpointGroup
which sends HTTPHEAD
health check requests. - builder(RequestOptions) - Static method in interface com.linecorp.armeria.client.RequestOptions
-
Returns a newly created
RequestOptionsBuilder
with the specifiedRequestOptions
. - builder(RetryConfig<HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
-
Returns a new
RetryingClientBuilder
with the specifiedRetryConfig
. - builder(RetryConfig<RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
-
Returns a new
RetryingRpcClientBuilder
with the specifiedRetryConfig
. - builder(RetryConfigMapping<RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
-
Returns a new
RetryingRpcClientBuilder
with the specifiedRetryConfigMapping
. - builder(RetryRule) - Static method in class com.linecorp.armeria.client.retry.RetryConfig
-
Returns a new
RetryConfigBuilder
with the specifiedRetryRule
. - builder(RetryRule) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
-
Returns a new
RetryingClientBuilder
with the specifiedRetryRule
. - builder(RetryRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryConfig
-
Returns a new
RetryConfigBuilder
with the specifiedRetryRuleWithContent
. - builder(RetryRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
-
Returns a new
RetryingClientBuilder
with the specifiedRetryRuleWithContent
. - builder(RetryRuleWithContent<HttpResponse>, int) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
-
Returns a new
RetryingClientBuilder
with the specifiedRetryRuleWithContent
and the specifiedmaxContentLength
. - builder(RetryRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
-
Returns a new
RetryingRpcClientBuilder
with the specifiedRetryRuleWithContent
. - builder(WebClient) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
that builds a client that sends requests using the specifiedWebClient
. - builder(WebClient, String) - Static method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrant
-
Creates a new builder for
OAuth2ClientCredentialsGrant
. - builder(WebClient, String) - Static method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ResourceOwnerPasswordCredentialsGrant
-
Creates a new builder for
OAuth2ResourceOwnerPasswordCredentialsGrant
. - builder(WebClient, String) - Static method in class com.linecorp.armeria.common.auth.oauth2.TokenRevocation
-
Creates a new builder for
TokenRevocation
. - builder(WebClient, String) - Static method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizer
-
Returns a newly created
OAuth2TokenIntrospectionAuthorizerBuilder
. - builder(HttpData) - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
-
Returns a new
AggregatedHttpFileBuilder
that builds anAggregatedHttpFile
from the specifiedHttpData
. - builder(HttpData) - Static method in interface com.linecorp.armeria.server.file.HttpFile
- builder(HttpData, long) - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
-
Returns a new
AggregatedHttpFileBuilder
that builds anAggregatedHttpFile
from the specifiedHttpData
andlastModifiedMillis
. - builder(HttpData, long) - Static method in interface com.linecorp.armeria.server.file.HttpFile
-
Returns a new
HttpFileBuilder
that builds anHttpFile
from the specifiedHttpData
andlastModifiedMillis
. - builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
-
Returns a newly created
CircuitBreakerRuleBuilder
with the specifiedHttpMethod
s. - builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
-
Returns a newly created
CircuitBreakerRuleWithContentBuilder
with the specifiedHttpMethod
s. - builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
-
Returns a newly created
RetryRuleBuilder
with the specifiedHttpMethod
s. - builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
-
Returns a newly created
RetryRuleWithContentBuilder
with the specifiedHttpMethod
s. - builder(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
-
Returns a new builder with the specified
HttpMethod
andpath
. - builder(HttpRequest) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
-
Returns a new
ClientRequestContextBuilder
created from the specifiedHttpRequest
. - builder(HttpRequest) - Static method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns a new
ServiceRequestContextBuilder
created from the specifiedHttpRequest
. - builder(HttpStatus) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns a new builder with the specified
HttpStatus
. - builder(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.client.metric.MetricCollectingClient
-
Returns a new
MetricCollectingClientBuilder
instance. - builder(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.client.metric.MetricCollectingRpcClient
-
Returns a new
MetricCollectingRpcClientBuilder
instance. - builder(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.server.metric.MetricCollectingService
-
Returns a newly created
MetricCollectingServiceBuilder
. - builder(RequestContext) - Static method in interface com.linecorp.armeria.common.logging.RequestLog
-
Returns a newly created
RequestLogBuilder
. - builder(RpcRequest, String) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
- builder(RpcRequest, URI) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
- builder(Scheme, EndpointGroup) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedEndpointGroup
with the specifiedScheme
. - builder(Scheme, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedEndpointGroup
with the specifiedScheme
andpath
. - builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedEndpointGroup
with the specifiedSessionProtocol
. - builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
-
Returns a new
EurekaEndpointGroupBuilder
created with the specifiedSessionProtocol
andEndpointGroup
. - builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
that builds a client that sends requests to the specifiedEndpointGroup
using the specifiedSessionProtocol
. - builder(SessionProtocol, EndpointGroup) - Static method in interface com.linecorp.armeria.client.WebClient
- builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
-
Returns a new
EurekaUpdatingListenerBuilder
created with the specifiedSessionProtocol
andEndpointGroup
. - builder(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedEndpointGroup
with the specifiedSessionProtocol
andpath
. - builder(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
-
Returns a new
EurekaEndpointGroupBuilder
created with the specifiedSessionProtocol
,EndpointGroup
and path. - builder(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
that builds a client that sends requests to the specifiedEndpointGroup
using the specifiedSessionProtocol
andpath
. - builder(SessionProtocol, EndpointGroup, String) - Static method in interface com.linecorp.armeria.client.WebClient
-
Returns a new
WebClientBuilder
created with the specifiedSessionProtocol
, baseEndpointGroup
and path. - builder(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
-
Returns a new
EurekaUpdatingListenerBuilder
created with the specifiedSessionProtocol
,EndpointGroup
and path. - builder(HttpVfs) - Static method in class com.linecorp.armeria.server.file.FileService
-
Returns a new
FileServiceBuilder
with the specifiedHttpVfs
. - builder(TokenBucket) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategy
-
Returns a newly created
TokenBucketThrottlingStrategyBuilder
. - builder(ThrottlingStrategy<HttpRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingService
-
Returns a new
ThrottlingServiceBuilder
. - builder(ThrottlingStrategy<RpcRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingRpcService
-
Returns a new
ThrottlingRpcServiceBuilder
. - builder(CollectorRegistry) - Static method in class com.linecorp.armeria.server.metric.PrometheusExpositionService
-
Returns a new
PrometheusExpositionServiceBuilder
created with the specifiedCollectorRegistry
. - builder(File) - Static method in class com.linecorp.armeria.server.file.FileService
-
Returns a new
FileServiceBuilder
with the specifiedrootDir
in an O/S file system. - builder(File) - Static method in interface com.linecorp.armeria.server.file.HttpFile
- builder(File) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
-
Creates a new
TomcatServiceBuilder
with the web application at the specified document base, which can be a directory or a JAR/WAR file. - builder(File, String) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
-
Creates a new
TomcatServiceBuilder
with the web application at the specified document base, which can be a directory or a JAR/WAR file. - builder(ClassLoader, String) - Static method in class com.linecorp.armeria.server.file.FileService
-
Returns a new
FileServiceBuilder
with the specifiedrootDir
in the current class path. - builder(ClassLoader, String) - Static method in interface com.linecorp.armeria.server.file.HttpFile
-
Returns a new
HttpFileBuilder
that builds anHttpFile
from the classpath resource at the specifiedpath
using the specifiedClassLoader
. - builder(ClassLoader, String, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
-
Returns a new
PropertiesEndpointGroupBuilder
created from the specified classpath resource. - builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
-
Returns a newly created
CircuitBreakerRuleBuilder
with the specifiedHttpMethod
s. - builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
-
Returns a newly created
CircuitBreakerRuleWithContentBuilder
with the specifiedHttpMethod
s. - builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
-
Returns a newly created
RetryRuleBuilder
with the specifiedHttpMethod
s. - builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
-
Returns a newly created
RetryRuleWithContentBuilder
with the specifiedHttpMethod
s. - builder(Iterable<String>) - Static method in class com.linecorp.armeria.server.cors.CorsPolicy
-
Returns a new
CorsPolicyBuilder
with the specifiedorigins
. - builder(Iterable<String>) - Static method in class com.linecorp.armeria.server.cors.CorsService
-
Returns a new
CorsServiceBuilder
with the specifiedorigins
. - builder(String) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
-
Returns a new
CircuitBreakerBuilder
that has the specified name. - builder(String) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifieduri
. - builder(String) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroup
-
Returns a new
DnsAddressEndpointGroupBuilder
with the specified hostname. - builder(String) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroup
-
Returns a new
DnsServiceEndpointGroupBuilder
with the specified hostname. - builder(String) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
-
Returns a new
EurekaEndpointGroupBuilder
created with the specifiedeurekaUri
. - builder(String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
created with the specifiedbaseUrl
. - builder(String) - Static method in interface com.linecorp.armeria.client.WebClient
-
Returns a new
WebClientBuilder
created with the specified baseuri
. - builder(String) - Static method in class com.linecorp.armeria.common.auth.oauth2.GrantedOAuth2AccessToken
-
Creates a new
GrantedOAuth2AccessTokenBuilder
to build a newGrantedOAuth2AccessToken
and supplied it with a value ofaccess_token
Access Token response field. - builder(String) - Static method in class com.linecorp.armeria.common.ContentDisposition
-
Returns a new
ContentDispositionBuilder
with the specifiedtype
. - builder(String) - Static method in class com.linecorp.armeria.common.util.ThreadFactories
-
Returns a new builder which builds a new
ThreadFactory
. - builder(String) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
-
Returns a new
EurekaUpdatingListenerBuilder
created with the specifiedeurekaUri
. - builder(String...) - Static method in class com.linecorp.armeria.server.cors.CorsPolicy
-
Returns a new
CorsPolicyBuilder
with the specifiedorigins
. - builder(String...) - Static method in class com.linecorp.armeria.server.cors.CorsService
-
Returns a new
CorsServiceBuilder
with the specifiedorigins
. - builder(String, EndpointGroup) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedEndpointGroup
with the specifiedscheme
. - builder(String, EndpointGroup) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
that builds a client that sends requests to the specifiedEndpointGroup
using the specifiedprotocol
. - builder(String, EndpointGroup) - Static method in interface com.linecorp.armeria.client.WebClient
- builder(String, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedEndpointGroup
with the specifiedscheme
andpath
. - builder(String, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
that builds a client that sends requests to the specifiedEndpointGroup
using the specifiedSessionProtocol
andpath
. - builder(String, EndpointGroup, String) - Static method in interface com.linecorp.armeria.client.WebClient
-
Returns a new
WebClientBuilder
created with the specifiedprotocol
. - builder(String, TypeSignature) - Static method in class com.linecorp.armeria.server.docs.FieldInfo
-
Returns a newly created
FieldInfoBuilder
. - builder(String, TypeSignature, FieldInfo...) - Static method in class com.linecorp.armeria.server.docs.FieldInfo
-
Returns a newly created
FieldInfoBuilder
. - builder(String, TypeSignature, Iterable<FieldInfo>) - Static method in class com.linecorp.armeria.server.docs.FieldInfo
-
Returns a newly created
FieldInfoBuilder
. - builder(String, String) - Static method in interface com.linecorp.armeria.common.Cookie
-
Returns a newly created
CookieBuilder
which builds aCookie
. - builder(String, String) - Static method in class com.linecorp.armeria.server.docs.EndpointInfo
-
Returns a newly created
EndpointInfoBuilder
that builds theEndpointInfo
with the specifiedhostnamePattern
andpathMapping
. - builder(String, String, ZooKeeperDiscoverySpec) - Static method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup
-
Returns a new
ZooKeeperEndpointGroupBuilder
created with the specified ZooKeeper connection string and ZNode path. - builder(String, String, ZooKeeperRegistrationSpec) - Static method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
-
Returns a
ZooKeeperUpdatingListenerBuilder
with a ZooKeeper connection string and a znode path. - builder(String, Function<byte[], Endpoint>) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroup
-
Returns a new
DnsTextEndpointGroupBuilder
with the specified hostname andFunction
mapping. - builder(URI) - Static method in class com.linecorp.armeria.client.Clients
-
Returns a new
ClientBuilder
that builds the client that connects to the specifiedURI
. - builder(URI) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
-
Returns a new
EurekaEndpointGroupBuilder
created with the specifiedeurekaUri
. - builder(URI) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
-
Returns a new
ArmeriaRetrofitBuilder
created with the specifiedbaseUrl
. - builder(URI) - Static method in interface com.linecorp.armeria.client.WebClient
-
Returns a new
WebClientBuilder
created with the specified baseURI
. - builder(URI) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
-
Returns a new
EurekaUpdatingListenerBuilder
created with the specifiedeurekaUri
. - builder(URI, String) - Static method in class com.linecorp.armeria.client.consul.ConsulEndpointGroup
-
Returns a newly-created
ConsulEndpointGroupBuilder
with the specifiedconsulUri
andserviceName
to buildConsulEndpointGroupBuilder
. - builder(URI, String) - Static method in class com.linecorp.armeria.server.consul.ConsulUpdatingListener
-
Returns a newly-created
ConsulUpdatingListenerBuilder
with the specifiedconsulUri
andserviceName
to buildConsulUpdatingListener
. - builder(Path) - Static method in class com.linecorp.armeria.server.file.FileService
-
Returns a new
FileServiceBuilder
with the specifiedrootDir
in an O/S file system. - builder(Path) - Static method in interface com.linecorp.armeria.server.file.HttpFile
- builder(Path) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
-
Creates a new
TomcatServiceBuilder
with the web application at the specified document base, which can be a directory or a JAR/WAR file. - builder(Path, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
-
Returns a new
PropertiesEndpointGroupBuilder
created from the file at the specifiedPath
. - builder(Path, String) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
-
Creates a new
TomcatServiceBuilder
with the web application at the specified document base, which can be a directory or a JAR/WAR file. - builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
-
Returns a newly created
CircuitBreakerRuleBuilder
with the specifiedrequestHeadersFilter
. - builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
-
Returns a newly created
CircuitBreakerRuleWithContentBuilder
with the specifiedrequestHeadersFilter
. - builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
-
Returns a newly created
RetryRuleBuilder
with the specifiedrequestHeadersFilter
. - builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
-
Returns a newly created
RetryRuleWithContentBuilder
with the specifiedrequestHeadersFilter
. - builder(Properties, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
-
Returns a new
PropertiesEndpointGroupBuilder
created from the specifiedProperties
. - builder(CuratorFramework, String, ZooKeeperDiscoverySpec) - Static method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup
-
Returns a new
ZooKeeperEndpointGroupBuilder
created with the specifiedCuratorFramework
and ZNode path. - builder(CuratorFramework, String, ZooKeeperRegistrationSpec) - Static method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
-
Returns a
ZooKeeperUpdatingListenerBuilder
with aCuratorFramework
instance and a znode path. - builder(ResteasyDeployment) - Static method in class com.linecorp.armeria.server.resteasy.ResteasyService
-
Creates a builder for
ResteasyService
. - builderForAnyOrigin() - Static method in class com.linecorp.armeria.server.cors.CorsService
-
Returns a new
CorsServiceBuilder
with its origin set with"*"
(any origin). - builderForCurator(String) - Static method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
-
Returns a new
CuratorDiscoverySpecBuilder
. - builderForCurator(String) - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
-
Returns a new
CuratorRegistrationSpecBuilder
. - builderForRampingUp() - Static method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
-
Returns a new
WeightRampingUpStrategyBuilder
that builds a weight ramping upEndpointSelectionStrategy
which ramps the weight of newly addedEndpoint
s. - builderForRpc(RetryRule) - Static method in class com.linecorp.armeria.client.retry.RetryConfig
-
Returns a new
RetryConfigBuilder
with the specifiedRetryRule
. - builderForRpc(RetryRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryConfig
-
Returns a new
RetryConfigBuilder
with the specifiedRetryRuleWithContent
. - builderForServerSets() - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
-
Returns a new
ServerSetsRegistrationSpecBuilder
. - builderWithMapping(RetryConfigMapping<HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
-
Returns a new
RetryingClientBuilder
with the specifiedRetryConfigMapping
. - buildHeaders() - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Returns the immutable additional
HttpHeaders
which will be set when building anHttpResponse
. - buildObtainRequest(WebClient, String, ClientAuthorization) - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrantBuilder
- buildObtainRequest(WebClient, String, ClientAuthorization) - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ResourceOwnerPasswordCredentialsGrantBuilder
- buildOptions() - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Builds
ClientOptions
with the given options and the default options. - buildOptions(ClientOptions) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Builds
ClientOptions
with the specifiedbaseOptions
and the options which were set to this builder. - buildPartial() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- buildPartial() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- buildRequest() - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Creates a new
HttpRequest
. - buildWebClient() - Method in class com.linecorp.armeria.client.AbstractWebClientBuilder
-
Returns a newly-created web client based on the properties of this builder.
- builtIn(BuiltInProperty) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
-
Adds the specified
BuiltInProperty
to the export list. - builtIn(BuiltInProperty, String) - Method in class com.linecorp.armeria.common.logging.ExportGroupBuilder
-
Adds the specified
BuiltInProperty
to the export list. - builtIn(BuiltInProperty, String) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
-
Adds the specified
BuiltInProperty
to the export list. - BuiltInProperty - Enum in com.linecorp.armeria.common.logging
-
A built-in property exported by
RequestContextExporter
. - builtIns() - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns all
BuiltInProperty
s in the export list. - ByteArrayRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
-
A
RequestConverterFunction
which converts a binary body of theAggregatedHttpRequest
to one ofbyte[]
orHttpData
depending on theexpectedResultType
. - ByteArrayRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.ByteArrayRequestConverterFunction
- ByteArrayResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
-
A
ResponseConverterFunction
which creates anHttpResponse
when: theresult
is an instance ofHttpData
orbyte[]
theresult
is an instance ofPublisher
orStream
while the"content-type"
of theResponseHeaders
is"application/binary"
or"application/octet-stream"
Note that thisResponseConverterFunction
is applied to an annotated service by default, so you don't have to specify this converter explicitly. - ByteArrayResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.ByteArrayResponseConverterFunction
- byteBuf() - Method in interface com.linecorp.armeria.common.HttpData
-
(Advanced users only) Returns a new duplicate of the underlying
ByteBuf
of this data. - byteBuf(int, int, ByteBufAccessMode) - Method in interface com.linecorp.armeria.common.HttpData
-
(Advanced users only) Returns a new slice, retained slice or direct copy of the underlying
ByteBuf
of this data based on the specifiedByteBufAccessMode
. - byteBuf(ByteBufAccessMode) - Method in interface com.linecorp.armeria.common.HttpData
-
(Advanced users only) Returns a new duplicate, retained duplicate or direct copy of the underlying
ByteBuf
of this data based on the specifiedByteBufAccessMode
. - ByteBufAccessMode - Enum in com.linecorp.armeria.common
- BZIP2 - Static variable in class com.linecorp.armeria.common.MediaType
- BZIP2 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/x-bzip2".
C
- CACHE_CONTROL - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Cache-Control"
header field name. - CACHE_MANIFEST_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
- CACHE_MANIFEST_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"text/cache-manifest; charset=utf-8".
- cacheControl(CacheControl) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets the
"cache-control"
header. - cacheControl(CacheControl) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- cacheControl(CacheControl) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Sets the
"cache-control"
header. - cacheControl(CacheControl) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- cacheControl(CharSequence) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets the
"cache-control"
header. - cacheControl(CharSequence) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- cacheControl(CharSequence) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Sets the
"cache-control"
header. - cacheControl(CharSequence) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- CacheControl - Class in com.linecorp.armeria.common
-
Directives for HTTP caching mechanisms in requests or responses.
- cachedHeaders() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the list of HTTP header names whose corresponding values will be cached, as specified in
Flags.headerValueCacheSpec()
. - cachePrivate() - Method in class com.linecorp.armeria.common.ServerCacheControl
-
Returns whether the
"private"
directive is enabled. - cachePrivate() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
-
Enables the
"private"
directive. - cachePrivate(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
-
Enables or disables the
"private"
directive. - cachePublic() - Method in class com.linecorp.armeria.common.ServerCacheControl
-
Returns whether the
"public"
directive is enabled. - cachePublic() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
-
Enables the
"public"
directive. - cachePublic(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
-
Enables or disables the
"public"
directive. - cacheSpec(String) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
-
Sets the Caffeine specification string of the cache that stores the domain names and their resolved addresses.
- cacheSpec(String) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Provides caching facility for OAuth 2.0
OAuth2TokenDescriptor
in order to avoid continuous Token Introspection as per [RFC7662], Section 2.2. - callbackExecutor(Executor) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- cancel() - Method in interface com.linecorp.armeria.client.ClientRequestContext
-
Cancels the response.
- cancel() - Method in interface com.linecorp.armeria.common.RequestContext
-
Cancels the current
Request
. - cancel() - Method in class com.linecorp.armeria.common.RequestContextWrapper
- cancel() - Method in class com.linecorp.armeria.common.stream.EmptyFixedStreamMessage
- cancel() - Method in class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
- cancel() - Method in class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
- cancel() - Method in class com.linecorp.armeria.common.stream.ThreeElementFixedStreamMessage
- cancel() - Method in class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
- cancel() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Cancels the request.
- cancel(boolean) - Method in class com.linecorp.armeria.common.CompletableRpcResponse
- cancel(boolean) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
-
Does nothing but returning whether this future has been cancelled or not.
- cancel(Throwable) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- cancel(Throwable) - Method in interface com.linecorp.armeria.common.RequestContext
- cancel(Throwable) - Method in class com.linecorp.armeria.common.RequestContextWrapper
- cancel(Throwable) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- cancellationCause() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- cancellationCause() - Method in interface com.linecorp.armeria.common.RequestContext
-
Returns the cause of cancellation,
null
if the request has not been cancelled. - cancellationCause() - Method in class com.linecorp.armeria.common.RequestContextWrapper
- cancellationCause() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- CancellationException - Exception in com.linecorp.armeria.common
-
A
RuntimeException
raised when a requested invocation is forced to stop before its completion. - CancellationException() - Constructor for exception com.linecorp.armeria.common.CancellationException
-
Creates a new exception.
- CancellationException(String) - Constructor for exception com.linecorp.armeria.common.CancellationException
-
Creates a new instance with the specified
message
. - CancellationException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.CancellationException
-
Creates a new instance with the specified
message
andcause
. - CancellationException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.common.CancellationException
-
Creates a new instance with the specified
message
,cause
, suppression enabled or disabled, and writable stack trace enabled or disabled. - CancellationException(Throwable) - Constructor for exception com.linecorp.armeria.common.CancellationException
-
Creates a new instance with the specified
cause
. - CancelledSubscriptionException - Exception in com.linecorp.armeria.common.stream
-
A
RuntimeException
that is raised to notifyStreamMessage.whenComplete()
when aSubscriber
has cancelled itsSubscription
. - canList(Executor, String) - Method in class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
-
Returns whether the file at the specified
path
is a listable directory. - canList(Executor, String) - Method in class com.linecorp.armeria.server.file.AbstractHttpVfs
- canList(Executor, String) - Method in interface com.linecorp.armeria.server.file.HttpVfs
-
Returns whether the file at the specified
path
is a listable directory. - canRequest() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
-
Decides whether a request should be sent or failed depending on the current circuit state.
- catchAll() - Method in class com.linecorp.armeria.server.RouteBuilder
-
Sets the
Route
to match any path. - cause() - Method in class com.linecorp.armeria.common.CompletableRpcResponse
- cause() - Method in interface com.linecorp.armeria.common.RpcResponse
-
Returns the cause of the failure if this
RpcResponse
completed exceptionally. - CAUSE_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.ThrowableProto
- certificate() - Method in class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
-
Returns the generated
X509Certificate
. - certificate() - Method in class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
-
Returns the generated
X509Certificate
. - certificateFile() - Method in class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
-
Returns the self-signed certificate file.
- certificateFile() - Method in class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
-
Returns the self-signed certificate file.
- ChainedCorsPolicyBuilder - Class in com.linecorp.armeria.server.cors
-
Builds a new
CorsPolicy
. - channel() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- channel() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
- channel() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
-
Returns the
Channel
that is handling this request, ornull
if the connection is not established yet. - channel() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- CHANNEL_OPTIONS - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
-
The
ChannelOption
s of the sockets created by theClientFactory
. - channelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
-
Sets the options of sockets created by the
ClientFactory
. - channelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the
ChannelOption
of the server socket bound byServer
. - channelOptions() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
-
Returns the
ChannelOption
s of the sockets created by theClientFactory
. - channelOptions() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns the
ChannelOption
s and their values ofServer
's server sockets. - charset() - Method in class com.linecorp.armeria.common.ContentDisposition
-
Returns the charset defined in
filename*
parameter, ornull
if not defined. - charset() - Method in class com.linecorp.armeria.common.MediaType
-
Returns a
Charset
for the value of the charset parameter if it is specified. - charset(Charset) - Method in class com.linecorp.armeria.common.MediaType
-
Returns a
Charset
for the value of the charset parameter if it is specified. - checkers(HealthChecker...) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
-
Adds the specified
HealthChecker
s that determine the healthiness of theServer
. - checkers(Iterable<? extends HealthChecker>) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
-
Adds the specified
HealthChecker
s that determine the healthiness of theServer
. - checkInterval(Duration) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
-
Sets the specified
Duration
for checking health. - checkIntervalMillis(long) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
-
Sets the specified
checkIntervalMills
for checking health in milliseconds. - checkMethod(HttpMethod) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
-
Sets HTTP method for checking health by Consul agent.
- checkUri(String) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
-
Sets URI for checking health by Consul agent.
- checkUri(URI) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
-
Sets URI for checking health by Consul agent.
- childChannelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the
ChannelOption
of sockets accepted byServer
. - childChannelOptions() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns the
ChannelOption
s and their values of sockets accepted byServer
. - childFieldInfos() - Method in class com.linecorp.armeria.server.docs.FieldInfo
-
Returns the child field infos of the field.
- children() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
-
Returns the list of
RequestLogAccess
es that provide access to the childRequestLog
s, ordered by the time they were added. - CircuitBreaker - Interface in com.linecorp.armeria.client.circuitbreaker
-
A circuit breaker, which tracks the number of success/failure requests and detects a remote service failure.
- CircuitBreakerBuilder - Class in com.linecorp.armeria.client.circuitbreaker
-
Builds a
CircuitBreaker
instance using builder pattern. - CircuitBreakerClient - Class in com.linecorp.armeria.client.circuitbreaker
-
An
HttpClient
decorator that handles failures of HTTP requests based on circuit breaker pattern. - CircuitBreakerClientBuilder - Class in com.linecorp.armeria.client.circuitbreaker
-
Builds a new
CircuitBreakerClient
or its decorator function. - CircuitBreakerDecision - Class in com.linecorp.armeria.client.circuitbreaker
-
A
CircuitBreakerDecision
that determines aResponse
as aCircuitBreakerDecision.success()
orCircuitBreakerDecision.failure()
, orCircuitBreakerDecision.ignore()
s aResponse
. - CircuitBreakerFactory - Interface in com.linecorp.armeria.client.circuitbreaker
-
A functional interface that represents a mapper factory, mapping a combination of host, method and path to a
CircuitBreaker
. - CircuitBreakerListener - Interface in com.linecorp.armeria.client.circuitbreaker
-
The listener interface for receiving
CircuitBreaker
events. - CircuitBreakerListenerAdapter - Class in com.linecorp.armeria.client.circuitbreaker
-
A skeletal
CircuitBreakerListener
implementation in order for a user to implement only the methods what he or she really needs. - CircuitBreakerListenerAdapter() - Constructor for class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListenerAdapter
- CircuitBreakerMapping - Interface in com.linecorp.armeria.client.circuitbreaker
-
Returns a
CircuitBreaker
instance from remote invocation parameters. - CircuitBreakerMappingBuilder - Class in com.linecorp.armeria.client.circuitbreaker
-
Builder class for building a
CircuitBreakerMapping
based on a combination of host, method and path. - CircuitBreakerRpcClient - Class in com.linecorp.armeria.client.circuitbreaker
-
An
RpcClient
decorator that handles failures of RPC remote invocation based on circuit breaker pattern. - CircuitBreakerRpcClientBuilder - Class in com.linecorp.armeria.client.circuitbreaker
-
Builds a new
CircuitBreakerRpcClient
or its decorator function. - CircuitBreakerRule - Interface in com.linecorp.armeria.client.circuitbreaker
-
Determines whether a
Response
should be reported as a success or failure to aCircuitBreaker
. - CircuitBreakerRuleBuilder - Class in com.linecorp.armeria.client.circuitbreaker
-
A builder for creating a new
CircuitBreakerRule
. - CircuitBreakerRuleWithContent<T extends Response> - Interface in com.linecorp.armeria.client.circuitbreaker
-
Determines whether a
Response
should be reported as a success or failure to aCircuitBreaker
using the content of theResponse
. - CircuitBreakerRuleWithContentBuilder<T extends Response> - Class in com.linecorp.armeria.client.circuitbreaker
-
A builder for creating a new
CircuitBreakerRuleWithContent
. - circuitOpenWindow(Duration) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Sets the duration of OPEN state.
- circuitOpenWindowMillis(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Sets the duration of OPEN state in milliseconds.
- CircuitState - Enum in com.linecorp.armeria.client.circuitbreaker
-
Defines the states of circuit breaker.
- CLASS_NAME_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.StackTraceElementProto
- clear() - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
-
Clears all HTTP-level and RPC-level decorators set so far.
- clear() - Static method in class com.linecorp.armeria.client.SessionProtocolNegotiationCache
-
Clears the cache.
- clear() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- clear() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- clear() - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Removes all headers.
- clear() - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
-
Removes all parameters.
- clear() - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- clear() - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- clear(RequestContext) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
-
Unbinds all request-scoped
MDC
properties from the specifiedRequestContext
. - clearCause() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The cause of this Throwable.
- clearClassName() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
-
The fully qualified name of the class containing the execution point represented by the stack trace element.
- clearDecorators() - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Clears all HTTP-level and RPC-level decorators set so far.
- clearDecorators() - Method in class com.linecorp.armeria.client.ClientBuilder
- clearDecorators() - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- clearDecorators() - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- clearDecorators() - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- clearDecorators() - Method in class com.linecorp.armeria.client.WebClientBuilder
- clearDecorators() - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- clearField(Descriptors.FieldDescriptor) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- clearField(Descriptors.FieldDescriptor) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- clearFileName() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
-
The name of the file containing the execution point represented by the stack trace element, or null if this information is unavailable.
- clearLineNumber() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
-
The line number of the source line containing the execution point represented by this stack trace element, or a negative number if this information is unavailable.
- clearMethodName() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
-
The name of the method containing the execution point represented by the stack trace element
- clearOneof(Descriptors.OneofDescriptor) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- clearOneof(Descriptors.OneofDescriptor) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- clearOriginalClassName() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The name of the class of the exception that was actually thrown.
- clearOriginalMessage() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The message of this throwable.
- clearRequestTimeout() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- clearRequestTimeout() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Clears the previously scheduled request timeout, if any.
- clearRequestTimeout() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- clearResponseTimeout() - Method in interface com.linecorp.armeria.client.ClientRequestContext
-
Clears the previously scheduled response timeout, if any.
- clearResponseTimeout() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
- clearResponseTimeout() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
- clearStackTrace() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
-
The stack trace of this Throwable.
- clearTrace(T) - Static method in class com.linecorp.armeria.common.util.Exceptions
-
Empties the stack trace of the specified
exception
. - Client<I extends Request,O extends Response> - Interface in com.linecorp.armeria.client
- CLIENT_CLOSED_REQUEST - Static variable in class com.linecorp.armeria.common.HttpStatus
-
499 Client Closed Request.
- CLIENT_ERROR - com.linecorp.armeria.common.HttpStatusClass
-
The client error class (4xx).
- CLIENT_IP - com.linecorp.armeria.common.logging.BuiltInProperty
-
"client.ip"
- the IP address who initiated a request. - clientAddress() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- clientAddress() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns the address of the client who initiated this request.
- clientAddress() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- clientAddressFilter() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns a filter which evaluates whether an
InetAddress
can be used as a client address. - clientAddressFilter(Predicate<? super InetAddress>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets a filter which evaluates whether an
InetAddress
can be used as a client address. - clientAddressMapper() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns a
Function
to use when determining the client address fromProxiedAddresses
. - clientAddressMapper(Function<? super ProxiedAddresses, ? extends InetSocketAddress>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets a
Function
to use when determining the client address fromProxiedAddresses
. - ClientAddressSource - Class in com.linecorp.armeria.server
-
A source which is used to get a client address.
- clientAddressSources() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns a list of
ClientAddressSource
s which are used to determine where to look for the client address, in the order of preference. - clientAddressSources(ClientAddressSource...) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets a list of
ClientAddressSource
s which are used to determine where to look for the client address, in the order of preference. - clientAddressSources(Iterable<ClientAddressSource>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets a list of
ClientAddressSource
s which are used to determine where to look for the client address, in the order of preference. - clientAddressTrustedProxyFilter() - Method in class com.linecorp.armeria.server.ServerConfig
-
Returns a filter which evaluates whether an
InetAddress
of a remote endpoint is trusted. - clientAddressTrustedProxyFilter(Predicate<? super InetAddress>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets a filter which evaluates whether an
InetAddress
of a remote endpoint is trusted. - clientAuthorization(Supplier<String>, String) - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrantBuilder
-
Provides client authorization for the OAuth 2.0 requests based on encoded authorization token and authorization type, as per [RFC6749], Section 2.3.
- clientAuthorization(Supplier<String>, String) - Method in class com.linecorp.armeria.common.auth.oauth2.TokenRevocationBuilder
-
Provides client authorization for the OAuth 2.0 requests based on encoded authorization token and authorization type, as per [RFC6749], Section 2.3.
- clientAuthorization(Supplier<String>, String) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Provides client authorization for the OAuth 2.0 Introspection requests based on encoded authorization token and authorization type, as per [RFC6749], Section 2.3.
- ClientAuthorization - Class in com.linecorp.armeria.common.auth.oauth2
-
Provides client authorization for the OAuth 2.0 requests, as per [RFC6749], Section 2.3.
- clientBasicAuthorization(Supplier<String>) - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrantBuilder
-
Provides client authorization for the OAuth 2.0 requests based on encoded authorization token and
Basic
authorization type, as per [RFC6749], Section 2.3. - clientBasicAuthorization(Supplier<String>) - Method in class com.linecorp.armeria.common.auth.oauth2.TokenRevocationBuilder
-
Provides client authorization for the OAuth 2.0 requests based on encoded authorization token and
Basic
authorization type, as per [RFC6749], Section 2.3. - clientBasicAuthorization(Supplier<String>) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Provides client authorization for the OAuth 2.0 Introspection requests based on encoded authorization token and
Basic
authorization type, as per [RFC6749], Section 2.3. - ClientBuilder - Class in com.linecorp.armeria.client
-
Creates a new client that connects to the specified
URI
using the builder pattern. - clientBuilderParams(ClientOptions) - Method in class com.linecorp.armeria.client.AbstractWebClientBuilder
-
Returns a newly-created
ClientBuilderParams
with the specifiedClientOptions
. - clientBuilderParams(T) - Method in interface com.linecorp.armeria.client.ClientFactory
-
Returns the
ClientBuilderParams
held inclient
. - clientBuilderParams(T) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
- ClientBuilderParams - Interface in com.linecorp.armeria.client
-
Provides the construction parameters of a client.
- ClientCacheControl - Class in com.linecorp.armeria.common
-
Directives for HTTP caching mechanisms in requests.
- ClientCacheControlBuilder - Class in com.linecorp.armeria.common
-
Creates a new
ClientCacheControl
using the builder pattern. - ClientConnectionTimings - Class in com.linecorp.armeria.common.logging
-
A holder class which has the timing information about a connection attempt before a client sends a
Request
. - ClientConnectionTimingsBuilder - Class in com.linecorp.armeria.common.logging
-
Builds a new
ClientConnectionTimings
. - clientCredentials(Supplier<? extends Map.Entry<String, String>>) - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrantBuilder
-
Provides client authorization for the OAuth 2.0 requests based on client credentials and
Basic
authorization type, as per [RFC6749], Section 2.3. - clientCredentials(Supplier<? extends Map.Entry<String, String>>) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Provides client authorization for the OAuth 2.0 Introspection requests based on client credentials and
Basic
authorization type, as per [RFC6749], Section 2.3. - clientCredentials(Supplier<? extends Map.Entry<String, String>>, String) - Method in class com.linecorp.armeria.client.auth.oauth2.OAuth2ClientCredentialsGrantBuilder
-
Provides client authorization for the OAuth 2.0 requests based on client credentials and authorization type, as per [RFC6749], Section 2.3.
- clientCredentials(Supplier<? extends Map.Entry<String, String>>, String) - Method in class com.linecorp.armeria.common.auth.oauth2.TokenRevocationBuilder
-
Provides client authorization for the OAuth 2.0 requests based on client credentials and authorization type, as per [RFC6749], Section 2.3.
- clientCredentials(Supplier<? extends Map.Entry<String, String>>, String) - Method in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
-
Provides client authorization for the OAuth 2.0 Introspection requests based on client credentials and authorization type, as per [RFC6749], Section 2.3.
- ClientDecoration - Class in com.linecorp.armeria.client
- ClientDecorationBuilder - Class in com.linecorp.armeria.client
-
Creates a new
ClientDecoration
using the builder pattern. - clientFactory(ClientFactory) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
-
Sets the
ClientFactory
to use when making health check requests. - clientFactory(ClientFactory) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
- ClientFactory - Interface in com.linecorp.armeria.client
-
Creates and manages clients.
- ClientFactoryBuilder - Class in com.linecorp.armeria.client
-
Builds a new
ClientFactory
. - ClientFactoryOption<T> - Class in com.linecorp.armeria.client
-
A
ClientFactory
option. - ClientFactoryOptions - Class in com.linecorp.armeria.client
-
A set of
ClientFactoryOption
s and their respective values. - ClientFactoryOptionValue<T> - Class in com.linecorp.armeria.client
-
A value of a
ClientFactoryOption
. - ClientFactoryProvider - Interface in com.linecorp.armeria.client
-
Creates a new
ClientFactory
dynamically via Java SPI (Service Provider Interface). - clientHttpConnector(List<ArmeriaClientConfigurator>, DataBufferFactoryWrapper<?>) - Method in class com.linecorp.armeria.spring.web.reactive.ArmeriaClientAutoConfiguration
-
Returns a
ClientHttpConnector
which is configured by a list ofArmeriaClientConfigurator
s. - clientId() - Method in class com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptor
-
"client_id" Token Introspection Response field, OPTIONAL.
- clientId(String) - Method in class com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptorBuilder
-
client_id
Token Introspection Response field, OPTIONAL. - ClientOption<T> - Class in com.linecorp.armeria.client
-
A client option.
- clientOptions() - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckerContext
-
Returns the
ClientOptions
of theClient
that sends health check requests. - clientOptions(ClientOptions) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
-
Sets the
ClientOptions
of theClient
that sends health check requests. - clientOptions(ClientOptions) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
- ClientOptions - Class in com.linecorp.armeria.client
-
A set of
ClientOption
s and their respective values. - ClientOptionsBuilder - Class in com.linecorp.armeria.client
-
Creates a new
ClientOptions
using the builder pattern. - ClientOptionValue<T> - Class in com.linecorp.armeria.client
-
A value of a
ClientOption
. - ClientRequestContext - Interface in com.linecorp.armeria.client
- ClientRequestContextBuilder - Class in com.linecorp.armeria.client
-
Builds a new
ClientRequestContext
. - ClientRequestContextCaptor - Interface in com.linecorp.armeria.client
-
Captures the
ClientRequestContext
s created by the current thread. - ClientRequestContextWrapper - Class in com.linecorp.armeria.client
-
Wraps an existing
ClientRequestContext
. - ClientRequestContextWrapper(ClientRequestContext) - Constructor for class com.linecorp.armeria.client.ClientRequestContextWrapper
-
Creates a new instance.
- Clients - Class in com.linecorp.armeria.client
-
Creates a new client that connects to a specified
URI
. - clientType() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
-
Returns the type of the client.
- clientType() - Method in class com.linecorp.armeria.client.UserClient
- clock() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
-
Returns the
Clock
which provides the current date and time. - clock() - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Returns the
Clock
that provides the current date and time. - clock() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
-
Returns the
Clock
the provides the current date and time to anFileService
. - clock(Clock) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets the
Clock
that provides the current date and time. - clock(Clock) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- clock(Clock) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
-
Sets the
Clock
that provides the current date and time. - clock(Clock) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- clone() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
- clone() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
- close() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
- close() - Method in class com.linecorp.armeria.client.Endpoint
-
This method does nothing.
- close() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
- close() - Method in class com.linecorp.armeria.client.resteasy.ArmeriaJaxrsClientEngine
- close() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
- close() - Method in interface com.linecorp.armeria.common.HttpData
-
Releases the underlying
ByteBuf
if this data was created viaHttpData.wrap(ByteBuf)
. - close() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
- close() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator
- close() - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
-
Closes the deferred stream without setting a delegate.
- close() - Method in interface com.linecorp.armeria.common.stream.StreamMessageDuplicator
-
Closes this duplicator and prevents it from further duplication.
- close() - Method in interface com.linecorp.armeria.common.stream.StreamWriter
-
Closes the
StreamMessage
successfully. - close() - Method in interface com.linecorp.armeria.common.util.AsyncCloseable
-
Releases any underlying resources held by this object synchronously.
- close() - Method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
- close() - Method in interface com.linecorp.armeria.common.util.SafeCloseable
- close() - Method in class com.linecorp.armeria.common.util.StartStopSupport
-
A synchronous version of
StartStopSupport.stop(Object)
. - close() - Method in class com.linecorp.armeria.server.Server
- close(AggregatedHttpResponse) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
-
Writes the specified HTTP response and closes the stream.
- close(Object) - Static method in class com.linecorp.armeria.unsafe.PooledObjects
-
Closes the given pooled
HttpData
. - close(Throwable) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
- close(Throwable) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
-
Closes the deferred stream without setting a delegate.
- close(Throwable) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
-
Closes the
StreamMessage
exceptionally. - closeAsync() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
- closeAsync() - Method in class com.linecorp.armeria.client.Endpoint
-
This method does nothing but returning an immediately complete future.
- closeAsync() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
- closeAsync() - Method in interface com.linecorp.armeria.common.util.AsyncCloseable
-
Releases any underlying resources held by this object asynchronously.
- closeAsync() - Method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
- closeAsync() - Method in class com.linecorp.armeria.common.util.StartStopSupport
- closeAsync() - Method in class com.linecorp.armeria.server.Server
- closed() - Static method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
-
Returns the
AsyncCloseableSupport
which has been closed already. - CLOSED - com.linecorp.armeria.client.circuitbreaker.CircuitState
-
Initial state.
- closeDefault() - Static method in interface com.linecorp.armeria.client.ClientFactory
-
Closes the default
ClientFactory
. - ClosedSessionException - Exception in com.linecorp.armeria.common
-
A
RuntimeException
raised when the connection to the remote peer has been closed unexpectedly. - ClosedSessionException(String) - Constructor for exception com.linecorp.armeria.common.ClosedSessionException
-
Creates a new instance with the specified
message
. - ClosedSessionException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.ClosedSessionException
-
Creates a new instance with the specified
message
andcause
. - ClosedSessionException(Throwable) - Constructor for exception com.linecorp.armeria.common.ClosedSessionException
-
Creates a new instance with the specified
cause
. - ClosedStreamException - Exception in com.linecorp.armeria.common.stream
-
A
RuntimeException
that is raised when aStreamMessage
has been closed unexpectedly. - ClosedStreamException(String) - Constructor for exception com.linecorp.armeria.common.stream.ClosedStreamException
-
Creates a new instance with the specified
message
. - ClosedStreamException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.stream.ClosedStreamException
-
Creates a new instance with the specified
message
andcause
. - ClosedStreamException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.common.stream.ClosedStreamException
-
Creates a new instance with the specified
message
,cause
, suppression enabled or disabled, and writable stack trace enabled or disabled. - ClosedStreamException(Throwable) - Constructor for exception com.linecorp.armeria.common.stream.ClosedStreamException
-
Creates a new instance with the specified
cause
. - closeFailed(Throwable) - Method in class com.linecorp.armeria.common.util.StartStopSupport
-
Invoked when failed to stop in
StartStopSupport.close()
. - code() - Method in class com.linecorp.armeria.common.HttpStatus
-
Returns the code of this
HttpStatus
. - codeAsText() - Method in class com.linecorp.armeria.common.HttpStatus
-
Returns the status code as
String
. - codeClass() - Method in class com.linecorp.armeria.common.HttpStatus
-
Returns the class of this
HttpStatus
. - collect() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Collects the elements published by this
StreamMessage
. - collect(SubscriptionOption...) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Collects the elements published by this
StreamMessage
with the specifiedSubscriptionOption
s. - collect(EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
- collect(EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
- collect(EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
- collect(EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
- collect(EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
- collect(EventExecutor, SubscriptionOption...) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Collects the elements published by this
StreamMessage
with the specifiedEventExecutor
andSubscriptionOption
s. - collect(EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
- com.linecorp.armeria.client - package com.linecorp.armeria.client
-
Client core.
- com.linecorp.armeria.client.auth.oauth2 - package com.linecorp.armeria.client.auth.oauth2
-
Client-side OAuth 2.0 implementation artifacts.
- com.linecorp.armeria.client.brave - package com.linecorp.armeria.client.brave
- com.linecorp.armeria.client.circuitbreaker - package com.linecorp.armeria.client.circuitbreaker
-
Failure detection and fallback mechanism based on circuit breaker pattern.
- com.linecorp.armeria.client.consul - package com.linecorp.armeria.client.consul
-
Consul-based
EndpointGroup
implementation. - com.linecorp.armeria.client.cookie - package com.linecorp.armeria.client.cookie
-
Cookie aware client.
- com.linecorp.armeria.client.encoding - package com.linecorp.armeria.client.encoding
-
HTTP content decoding client.
- com.linecorp.armeria.client.endpoint - package com.linecorp.armeria.client.endpoint
-
Endpoint
groups and their registry. - com.linecorp.armeria.client.endpoint.dns - package com.linecorp.armeria.client.endpoint.dns
-
DNS-based
EndpointGroup
implementation. - com.linecorp.armeria.client.endpoint.healthcheck - package com.linecorp.armeria.client.endpoint.healthcheck
-
Filters out unhealthy
Endpoint
s from an existingEndpointGroup
by sending health check requests. - com.linecorp.armeria.client.eureka - package com.linecorp.armeria.client.eureka
-
Eureka-based
EndpointGroup
for automatic service discovery. - com.linecorp.armeria.client.grpc - package com.linecorp.armeria.client.grpc
-
An armeria client that uses the gRPC wire protocol.
- com.linecorp.armeria.client.grpc.protocol - package com.linecorp.armeria.client.grpc.protocol
-
Unary gRPC client without support for gRPC generated code stubs.
- com.linecorp.armeria.client.limit - package com.linecorp.armeria.client.limit
-
Limits the number of executed
Request
s. - com.linecorp.armeria.client.logging - package com.linecorp.armeria.client.logging
-
Logging client decorators.
- com.linecorp.armeria.client.metric - package com.linecorp.armeria.client.metric
-
Metric-collecting client decorators.
- com.linecorp.armeria.client.proxy - package com.linecorp.armeria.client.proxy
-
Proxy configuration.
- com.linecorp.armeria.client.resteasy - package com.linecorp.armeria.client.resteasy
-
Integration with RESTEasy client.
- com.linecorp.armeria.client.retrofit2 - package com.linecorp.armeria.client.retrofit2
-
Retrofit2 adapter for Armeria.
- com.linecorp.armeria.client.retry - package com.linecorp.armeria.client.retry
-
A
Client
decorator that handles failures and retries requests. - com.linecorp.armeria.client.thrift - package com.linecorp.armeria.client.thrift
-
Thrift client.
- com.linecorp.armeria.client.zookeeper - package com.linecorp.armeria.client.zookeeper
-
ZooKeeper-based
EndpointGroup
for automatic service discovery. - com.linecorp.armeria.common - package com.linecorp.armeria.common
-
Common types.
- com.linecorp.armeria.common.annotation - package com.linecorp.armeria.common.annotation
-
Common annotations.
- com.linecorp.armeria.common.auth - package com.linecorp.armeria.common.auth
-
HTTP authorization common.
- com.linecorp.armeria.common.auth.oauth2 - package com.linecorp.armeria.common.auth.oauth2
-
Common artifacts used by OAuth 2.0 implementation.
- com.linecorp.armeria.common.brave - package com.linecorp.armeria.common.brave
- com.linecorp.armeria.common.consul - package com.linecorp.armeria.common.consul
-
Various classes used internally.
- com.linecorp.armeria.common.encoding - package com.linecorp.armeria.common.encoding
-
Provides the common classes for HTTP content encoding.
- com.linecorp.armeria.common.grpc - package com.linecorp.armeria.common.grpc
-
gRPC-related common classes.
- com.linecorp.armeria.common.grpc.protocol - package 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 - package com.linecorp.armeria.common.kotlin
-
Kotlin-related common classes.
- com.linecorp.armeria.common.logback - package com.linecorp.armeria.common.logback
-
Logback integration.
- com.linecorp.armeria.common.logging - package com.linecorp.armeria.common.logging
- com.linecorp.armeria.common.metric - package com.linecorp.armeria.common.metric
-
Common metric collection utilities.
- com.linecorp.armeria.common.multipart - package com.linecorp.armeria.common.multipart
-
Multiple part messages support.
- com.linecorp.armeria.common.reactor3 - package com.linecorp.armeria.common.reactor3
-
Reactor plugins to help keep
RequestContext
during Reactor operations. - com.linecorp.armeria.common.rxjava2 - package com.linecorp.armeria.common.rxjava2
-
RxJava2 plugins to help keep
RequestContext
during RxJava2 Operations. - com.linecorp.armeria.common.rxjava3 - package com.linecorp.armeria.common.rxjava3
-
RxJava3 plugins to help keep
RequestContext
during RxJava3 Operations. - com.linecorp.armeria.common.sse - package com.linecorp.armeria.common.sse
-
Server-Sent Events support.
- com.linecorp.armeria.common.stream - package com.linecorp.armeria.common.stream
-
Streamed message types.
- com.linecorp.armeria.common.thrift - package com.linecorp.armeria.common.thrift
-
Thrift-related common classes.
- com.linecorp.armeria.common.thrift.text - package com.linecorp.armeria.common.thrift.text
-
A Thrift JSON protocol that supports field names as defined in the IDL.
- com.linecorp.armeria.common.throttling - package com.linecorp.armeria.common.throttling
-
Common throttling artifacts used by throttling implementation.
- com.linecorp.armeria.common.util - package com.linecorp.armeria.common.util
-
Generic utility classes.
- com.linecorp.armeria.common.zookeeper - package com.linecorp.armeria.common.zookeeper
-
ZooKeeper-related common classes.
- com.linecorp.armeria.dropwizard - package com.linecorp.armeria.dropwizard
-
Provides a Dropwizard Bundle for Armeria.
- com.linecorp.armeria.server - package com.linecorp.armeria.server
-
Server core.
- com.linecorp.armeria.server.annotation - package com.linecorp.armeria.server.annotation
-
Annotations for building a RESTful service.
- com.linecorp.armeria.server.annotation.decorator - package com.linecorp.armeria.server.annotation.decorator
-
Decorators for the annotated HTTP service.
- com.linecorp.armeria.server.annotation.processor - package com.linecorp.armeria.server.annotation.processor
-
Annotation processors for annotated services.
- com.linecorp.armeria.server.auth - package com.linecorp.armeria.server.auth
-
HTTP authorization service.
- com.linecorp.armeria.server.auth.oauth2 - package com.linecorp.armeria.server.auth.oauth2
-
Server-side OAuth 2.0 implementation artifacts.
- com.linecorp.armeria.server.brave - package com.linecorp.armeria.server.brave
- com.linecorp.armeria.server.consul - package com.linecorp.armeria.server.consul
-
Automatic service registration and discovery with Consul.
- com.linecorp.armeria.server.cors - package com.linecorp.armeria.server.cors
-
Cross-Origin Resource Sharing (CORS) support.
- com.linecorp.armeria.server.docs - package com.linecorp.armeria.server.docs
-
Documentation service.
- com.linecorp.armeria.server.encoding - package com.linecorp.armeria.server.encoding
-
HTTP content encoding service.
- com.linecorp.armeria.server.eureka - package com.linecorp.armeria.server.eureka
-
Eureka-based automatic service registration.
- com.linecorp.armeria.server.file - package com.linecorp.armeria.server.file
-
HTTP static file service.
- com.linecorp.armeria.server.graphql - package com.linecorp.armeria.server.graphql
-
GraphQL-related server classes.
- com.linecorp.armeria.server.grpc - package 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 - package 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 - package com.linecorp.armeria.server.healthcheck
-
HTTP health check service for load balancers.
- com.linecorp.armeria.server.jetty - package com.linecorp.armeria.server.jetty
-
Embedded Jetty service.
- com.linecorp.armeria.server.kotlin - package com.linecorp.armeria.server.kotlin
-
Decorators for Kotlin coroutines.
- com.linecorp.armeria.server.logging - package com.linecorp.armeria.server.logging
-
Logging and metric-collecting service decorators.
- com.linecorp.armeria.server.logging.kafka - package com.linecorp.armeria.server.logging.kafka
-
Kafka backend integration support for request/response logging.
- com.linecorp.armeria.server.management - package com.linecorp.armeria.server.management
-
Supports monitoring and management features.
- com.linecorp.armeria.server.metric - package com.linecorp.armeria.server.metric
-
Metric-collecting service decorators and exporters.
- com.linecorp.armeria.server.protobuf - package com.linecorp.armeria.server.protobuf
-
Provides the default
ResponseConverterFunction
which automatically converts aMessage
into anHttpResponse
and the defaultRequestConverterFunction
which automatically converts anAggregatedHttpRequest
into aMessage
. - com.linecorp.armeria.server.resteasy - package com.linecorp.armeria.server.resteasy
-
Integration with RESTEasy server.
- com.linecorp.armeria.server.rxjava2 - package com.linecorp.armeria.server.rxjava2
-
Provides a default
ResponseConverterFunction
which automatically converts anObservableSource
into anHttpResponse
when theObservableSource
is returned by an annotated HTTP service. - com.linecorp.armeria.server.rxjava3 - package com.linecorp.armeria.server.rxjava3
-
Provides a default
ResponseConverterFunction
which automatically converts anObservableSource
into anHttpResponse
when theObservableSource
is returned by an annotated HTTP service. - com.linecorp.armeria.server.saml - package com.linecorp.armeria.server.saml
-
SAML-based single sign-on service.
- com.linecorp.armeria.server.streaming - package com.linecorp.armeria.server.streaming
-
Supports streaming responses from
Publisher
orStream
. - com.linecorp.armeria.server.thrift - package com.linecorp.armeria.server.thrift
-
Thrift service.
- com.linecorp.armeria.server.throttling - package com.linecorp.armeria.server.throttling
-
Request throttling service decorators and strategies.
- com.linecorp.armeria.server.throttling.bucket4j - package com.linecorp.armeria.server.throttling.bucket4j
-
Rate-limiting throttling implementation based on Token-Bucket algorithm and Bucket4j library.
- com.linecorp.armeria.server.tomcat - package com.linecorp.armeria.server.tomcat
-
Embedded Tomcat service.
- com.linecorp.armeria.server.zookeeper - package com.linecorp.armeria.server.zookeeper
-
ZooKeeper-based automatic service registration.
- com.linecorp.armeria.spring - package com.linecorp.armeria.spring
-
Spring Boot integration.
- com.linecorp.armeria.spring.actuate - package com.linecorp.armeria.spring.actuate
-
Spring Boot actuator integration.
- com.linecorp.armeria.spring.web.reactive - package com.linecorp.armeria.spring.web.reactive
-
Spring Boot integration based on reactive server stack.
- com.linecorp.armeria.testing.junit4.common - package com.linecorp.armeria.testing.junit4.common
-
Common testing utilities.
- com.linecorp.armeria.testing.junit4.server - package com.linecorp.armeria.testing.junit4.server
-
Server-side testing utilities.
- com.linecorp.armeria.testing.junit5.common - package com.linecorp.armeria.testing.junit5.common
-
Common testing utilities.
- com.linecorp.armeria.testing.junit5.server - package com.linecorp.armeria.testing.junit5.server
-
Server-side testing utilities.
- com.linecorp.armeria.testing.junit5.server.mock - package com.linecorp.armeria.testing.junit5.server.mock
-
A mock server for use when testing clients.
- com.linecorp.armeria.unsafe - package com.linecorp.armeria.unsafe
- com.linecorp.armeria.unsafe.grpc - package com.linecorp.armeria.unsafe.grpc
-
Utilities for working with
ByteBuf
in an unsafe way. - combined() - Static method in interface com.linecorp.armeria.server.logging.AccessLogWriter
-
Returns an access log writer with a combined format.
- comment() - Method in interface com.linecorp.armeria.common.sse.ServerSentEvent
-
Returns a comment of this event, if it exists.
- comment(String) - Method in class com.linecorp.armeria.common.sse.ServerSentEventBuilder
-
Sets the specified
comment
. - commitTimeMillis() - Method in class com.linecorp.armeria.common.util.Version
-
Returns when the release commit was created.
- common() - Static method in interface com.linecorp.armeria.server.logging.AccessLogWriter
-
Returns an access log writer with a common format.
- CommonPools - Class in com.linecorp.armeria.common
-
Provides the common shared thread pools and
EventLoopGroup
s which is used when not overridden. - COMPACT - Static variable in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
-
TProtocolFactory
for Thrift TCompact protocol. - COMPACT - Static variable in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
-
Thrift TCompact serialization format.
- compareTo(Endpoint) - Method in class com.linecorp.armeria.client.Endpoint
- compareTo(Cookie) - Method in interface com.linecorp.armeria.common.Cookie
- compareTo(HttpStatus) - Method in class com.linecorp.armeria.common.HttpStatus
-
Compares this status to the specified status.
- compareTo(Scheme) - Method in class com.linecorp.armeria.common.Scheme
- compareTo(SerializationFormat) - Method in class com.linecorp.armeria.common.SerializationFormat
- compareTo(SerializationFormatProvider.Entry) - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
- compareTo(AbstractOption<?, ?, ?>) - Method in class com.linecorp.armeria.common.util.AbstractOption
- compareTo(ServerPort) - Method in class com.linecorp.armeria.server.ServerPort
- CompletableRpcResponse - Class in com.linecorp.armeria.common
-
An
RpcResponse
implementation which is initially incomplete and can be completed later. - CompletableRpcResponse() - Constructor for class com.linecorp.armeria.common.CompletableRpcResponse
- complete(T) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
-
Throws an
UnsupportedOperationException
. - completedFuture(T) - Static method in class com.linecorp.armeria.common.thrift.ThriftFuture
-
Returns a new
ThriftFuture
instance that has its value set immediately. - completedFuture(T) - Static method in class com.linecorp.armeria.common.thrift.ThriftListenableFuture
-
Returns a new
ThriftListenableFuture
instance that has its value set immediately. - completedFuture(U) - Static method in class com.linecorp.armeria.common.util.EventLoopCheckingFuture
-
Returns an
EventLoopCheckingFuture
which has been completed with the specifiedvalue
. - completedFuture(U) - Static method in class com.linecorp.armeria.common.util.UnmodifiableFuture
-
Returns an
UnmodifiableFuture
which has been completed with the specifiedvalue
. - completeExceptionally(Throwable) - Method in class com.linecorp.armeria.common.CompletableRpcResponse
- completeExceptionally(Throwable) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
-
Throws an
UnsupportedOperationException
. - completeRequestPrefix(MeterRegistry, RequestLog) - Method in class com.linecorp.armeria.client.retrofit2.RetrofitMeterIdPrefixFunction
- completeRequestPrefix(MeterRegistry, RequestLog) - Method in class com.linecorp.armeria.common.grpc.GrpcMeterIdPrefixFunction
- completeRequestPrefix(MeterRegistry, RequestLog) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
-
Creates a
MeterIdPrefix
from the specified completeRequestLog
. - CompletionActions - Class in com.linecorp.armeria.common.util
-
Provides the common actions that are useful when handling a
CompletionStage
. - complexity() - Method in interface com.linecorp.armeria.server.Route
-
Returns the complexity of this
Route
. - compose(Function<A, B>, Function<B, C>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>, Function<E, F>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>, Function<E, F>, Function<F, G>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>, Function<E, F>, Function<F, G>, Function<G, H>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>, Function<E, F>, Function<F, G>, Function<G, H>, Function<H, I>) - Static method in class com.linecorp.armeria.common.util.Functions
- compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>, Function<E, F>, Function<F, G>, Function<G, H>, Function<H, I>, Function<I, J>) - Static method in class com.linecorp.armeria.common.util.Functions
- CompositeException - Exception in com.linecorp.armeria.common.util
-
Represents an exception that is a composite of one or more other exceptions.
- CompositeException(Iterable<? extends Throwable>) - Constructor for exception com.linecorp.armeria.common.util.CompositeException
-
Constructs a CompositeException with the given array of Throwables as the list of suppressed exceptions.
- CompositeException(Throwable...) - Constructor for exception com.linecorp.armeria.common.util.CompositeException
-
Constructs a CompositeException with the given array of Throwables as the list of suppressed exceptions.
- compress(OutputStream) - Method in interface com.linecorp.armeria.common.grpc.protocol.Compressor
-
Wraps an existing output stream with a compressing output stream.
- Compression() - Constructor for class com.linecorp.armeria.spring.ArmeriaSettings.Compression
- Compressor - Interface in com.linecorp.armeria.common.grpc.protocol
-
Represents a message compressor.
- compressorRegistry(CompressorRegistry) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Sets the
CompressorRegistry
to use when compressing messages. - compute(Endpoint, int, int) - Method in interface com.linecorp.armeria.client.endpoint.EndpointWeightTransition
- concat(Iterable<? extends Publisher<? extends T>>) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Returns a concatenated
StreamMessage
which relays items of the specifiedPublisher
s in order, non-overlappingly, one after the other finishes. - concat(Publisher<? extends Publisher<? extends T>>) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Returns a concatenated
StreamMessage
which relays items of the specifiedPublisher
ofPublisher
s in order, non-overlappingly, one after the other finishes. - concat(Publisher<? extends T>...) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
-
Returns a concatenated
StreamMessage
which relays items of the specified array ofPublisher
s in order, non-overlappingly, one after the other finishes. - ConcurrencyLimitingClient - Class in com.linecorp.armeria.client.limit
-
An
HttpClient
decorator that limits the concurrent number of active HTTP requests. - config() - Method in class com.linecorp.armeria.server.cors.CorsService
-
Returns the
CorsConfig
. - config() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- config() - Method in class com.linecorp.armeria.server.file.FileService
-
Returns the configuration.
- config() - Method in class com.linecorp.armeria.server.Server
-
Returns the configuration of this
Server
. - config() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
- config() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- configurator(Consumer<? super StandardServer>) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
-
Adds a
Consumer
that performs additional configuration operations against the TomcatStandardServer
created by aTomcatService
. - configurator(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
-
Adds a
Consumer
that performs additional configuration operations against the JettyServer
created by aJettyService
. - configure(WebClientBuilder) - Method in interface com.linecorp.armeria.spring.web.reactive.ArmeriaClientConfigurator
-
Configures the client using the specified
WebClientBuilder
. - configure(DocServiceBuilder) - Method in interface com.linecorp.armeria.spring.DocServiceConfigurator
-
Configures the specified
DocServiceBuilder
. - configure(HealthCheckServiceBuilder) - Method in interface com.linecorp.armeria.spring.HealthCheckServiceConfigurator
-
Configures the
HealthCheckService
using the specifiedHealthCheckServiceBuilder
. - configure(MetricCollectingServiceBuilder) - Method in interface com.linecorp.armeria.spring.MetricCollectingServiceConfigurator
-
Configures the
MetricCollectingService
using the specifiedMetricCollectingServiceBuilder
. - configure(ServerBuilder) - Method in class com.linecorp.armeria.dropwizard.ArmeriaBundle
- configure(ServerBuilder) - Method in interface com.linecorp.armeria.spring.ArmeriaServerConfigurator
-
Configures the server using the specified
ServerBuilder
. - configure(ServerBuilder) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
-
Configures the
Server
with the givenServerBuilder
. - configure(ServerBuilder) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
- configure(ServerBuilder) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
-
Configures the
Server
with the givenServerBuilder
. - configure(GraphQL.Builder) - Method in interface com.linecorp.armeria.server.graphql.GraphqlConfigurator
-
Configures the
GraphQL
using the specifiedGraphQL.Builder
. - configure(RuntimeWiring.Builder) - Method in interface com.linecorp.armeria.server.graphql.RuntimeWiringConfigurator
-
Configures the service using the specified
RuntimeWiring.Builder
. - configureDataLoaderRegistry(Iterable<? extends Consumer<? super DataLoaderRegistry>>) - Method in class com.linecorp.armeria.server.graphql.GraphqlServiceBuilder
-
Adds the
DataLoaderRegistry
consumers. - configureDataLoaderRegistry(Consumer<DataLoaderRegistry>...) - Method in class com.linecorp.armeria.server.graphql.GraphqlServiceBuilder
-
Adds the
DataLoaderRegistry
consumers. - configureGraphql(GraphqlConfigurator...) - Method in class com.linecorp.armeria.server.graphql.GraphqlServiceBuilder
-
Adds the
GraphqlConfigurator
consumers. - configureGraphql(Iterable<? extends GraphqlConfigurator>) - Method in class com.linecorp.armeria.server.graphql.GraphqlServiceBuilder
-
Adds the
GraphqlConfigurator
consumers. - configureRegistry(T) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
-
Configures the
DropwizardMeterRegistry
with Armeria's defaults. - configureRegistry(T) - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
-
Configures the
PrometheusMeterRegistry
with Armeria's defaults. - configureServer(ServerBuilder) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
-
Configures the
ServerBuilder
beyond the defaults of enabling HTTPs and registering a service for handling enqueued responses. - CONFLICT - Static variable in class com.linecorp.armeria.common.HttpStatus
-
409 Conflict.
- connect(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
- connect(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- connect(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
- connect(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- connect(InetSocketAddress) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
-
Creates a
ProxyConfig
configuration for CONNECT protocol. - connect(InetSocketAddress, boolean) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
-
Creates a
ProxyConfig
configuration for CONNECT protocol. - connect(InetSocketAddress, String, String, boolean) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
-
Creates a
ProxyConfig
configuration for CONNECT protocol. - CONNECT - com.linecorp.armeria.client.proxy.ProxyType
-
CONNECT proxy protocol.
- CONNECT - com.linecorp.armeria.common.HttpMethod
-
The CONNECT method which is used for a proxy that can dynamically switch to being a tunnel or for bootstrapping WebSockets with HTTP/2.
- connectFailed(SessionProtocol, Endpoint, SocketAddress, Throwable) - Method in interface com.linecorp.armeria.client.proxy.ProxyConfigSelector
-
Called to indicate a connection attempt to the specified
SessionProtocol
andEndpoint
has failed. - CONNECTION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Connection"
header field name. - CONNECTION_POOL_LISTENER - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
-
The listener which is notified on a connection pool event.
- connectionAcquisitionDurationNanos() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
-
Returns the duration which was taken to get a connection, in nanoseconds.
- connectionAcquisitionStartTimeMicros() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
-
Returns the time when the client started to acquire a connection, in microseconds since the epoch.
- connectionAcquisitionStartTimeMillis() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
-
Returns the time when the client started to acquire a connection, in milliseconds since the epoch.
- connectionCheckoutTimeout(long, TimeUnit) - Method in class com.linecorp.armeria.client.resteasy.ArmeriaResteasyClientBuilder
- connectionClosed(SessionProtocol, InetSocketAddress, InetSocketAddress, AttributeMap) - Method in interface com.linecorp.armeria.client.ConnectionPoolListener
-
Invoked when a connection in the connection pool has been closed.
- connectionClosed(SessionProtocol, InetSocketAddress, InetSocketAddress, AttributeMap) - Method in class com.linecorp.armeria.client.ConnectionPoolListenerAdapter
- connectionClosed(SessionProtocol, InetSocketAddress, InetSocketAddress, AttributeMap) - Method in class com.linecorp.armeria.client.ConnectionPoolListenerWrapper
- connectionOpen(SessionProtocol, InetSocketAddress, InetSocketAddress, AttributeMap) - Method in interface com.linecorp.armeria.client.ConnectionPoolListener
-
Invoked when a new connection is open and ready to send a request.
- connectionOpen(SessionProtocol, InetSocketAddress, InetSocketAddress, AttributeMap) - Method in class com.linecorp.armeria.client.ConnectionPoolListenerAdapter
- connectionOpen(SessionProtocol, InetSocketAddress, InetSocketAddress, AttributeMap) - Method in class com.linecorp.armeria.client.ConnectionPoolListenerWrapper
- connectionPoolListener() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
-
Returns the listener which is notified on a connection pool event.
- connectionPoolListener(ConnectionPoolListener) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
-
Sets the listener which is notified on a connection pool event.
- ConnectionPoolListener - Interface in com.linecorp.armeria.client
-
Listens to the client connection pool events.
- ConnectionPoolListenerAdapter - Class in com.linecorp.armeria.client
-
A skeletal
ConnectionPoolListener
implementation in order for a user to implement only the methods what he or she really needs. - ConnectionPoolListenerAdapter() - Constructor for class com.linecorp.armeria.client.ConnectionPoolListenerAdapter
-
Creates a new instance.
- ConnectionPoolListenerWrapper - Class in com.linecorp.armeria.client
-
A
ConnectionPoolListener
that wraps an existingConnectionPoolListener
. - ConnectionPoolListenerWrapper(ConnectionPoolListener) - Constructor for class com.linecorp.armeria.client.ConnectionPoolListenerWrapper
-
Creates a new instance with the specified
delegate
. - connectionPoolSize(int) - Method in class com.linecorp.armeria.client.resteasy.ArmeriaResteasyClientBuilder
- connectionTimings() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
-
Returns the
ClientConnectionTimings
of theRequest
. - connectionTimings(ClientConnectionTimings) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
-
Sets the
ClientConnectionTimings
of the request. - connectionTTL(long, TimeUnit) - Method in class com.linecorp.armeria.client.resteasy.ArmeriaResteasyClientBuilder
- connector() - Method in class com.linecorp.armeria.server.tomcat.TomcatService
-
Returns Tomcat
Connector
. - ConnectProxyConfig - Class in com.linecorp.armeria.client.proxy
-
CONNECT proxy configuration.
- connectTimeout(long, TimeUnit) - Method in class com.linecorp.armeria.client.resteasy.ArmeriaResteasyClientBuilder
- connectTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
-
Sets the timeout of a socket connection attempt.
- connectTimeout(Duration) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
- connectTimeout(Duration) - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
-
Sets the specified connect timeout.
- connectTimeout(Duration) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListenerBuilder
- connectTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
-
Sets the timeout of a socket connection attempt in milliseconds.
- connectTimeoutMillis(long) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
- connectTimeoutMillis(long) - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
-
Sets the specified connect timeout in milliseconds.
- connectTimeoutMillis(long) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListenerBuilder
- consulApiVersion(String) - Method in class com.linecorp.armeria.client.consul.ConsulEndpointGroupBuilder
- consulApiVersion(String) - Method in interface com.linecorp.armeria.common.consul.ConsulConfigSetters
-
Sets the specified Consul's API version.
- consulApiVersion(String) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
- ConsulConfigSetters - Interface in com.linecorp.armeria.common.consul
-
Sets properties for building a Consul client.
- ConsulEndpointGroup - Class in com.linecorp.armeria.client.consul
-
A Consul-based
EndpointGroup
implementation that retrieves the list ofEndpoint
s from Consul using Consul's HTTP API and updates theEndpoint
s periodically. - ConsulEndpointGroupBuilder - Class in com.linecorp.armeria.client.consul
-
A builder class for
ConsulEndpointGroup
. - consulToken(String) - Method in class com.linecorp.armeria.client.consul.ConsulEndpointGroupBuilder
- consulToken(String) - Method in interface com.linecorp.armeria.common.consul.ConsulConfigSetters
-
Sets the specified token for Consul's API.
- consulToken(String) - Method in class com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
- ConsulUpdatingListener - Class in com.linecorp.armeria.server.consul
- ConsulUpdatingListenerBuilder - Class in com.linecorp.armeria.server.consul
-
Builds a new
ConsulUpdatingListener
, which registers the server to Consul cluster. - consumerKey() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
-
Returns the value of the "oauth_consumer_key" property.
- consumerKey(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
-
Sets the value of the oath_consumer_key property.
- consumes() - Method in interface com.linecorp.armeria.server.Route
- consumes(MediaType...) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
- consumes(MediaType...) - Method in class com.linecorp.armeria.server.RouteBuilder
- consumes(MediaType...) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- consumes(MediaType...) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
- consumes(MediaType...) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- consumes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
- consumes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.RouteBuilder
- consumes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- consumes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
- consumes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- Consumes - Annotation Type in com.linecorp.armeria.server.annotation
-
Specifies a media type which would be consumed by the service method or class.
- ConsumesBinary - Annotation Type in com.linecorp.armeria.server.annotation
-
An alias for
@Consumes(MediaTypeNames.APPLICATION_BINARY)
. - ConsumesGroup - Annotation Type in com.linecorp.armeria.server.annotation
-
The containing annotation type for
Consumes
. - ConsumesJson - Annotation Type in com.linecorp.armeria.server.annotation
-
An alias for
@Consumes(MediaTypeNames.JSON)
. - ConsumesOctetStream - Annotation Type in com.linecorp.armeria.server.annotation
-
An alias for
@Consumes(MediaTypeNames.OCTET_STREAM)
. - ConsumesProtobuf - Annotation Type in com.linecorp.armeria.server.annotation
-
An alias for
@Consumes(MediaTypeNames.PROTOBUF)
. - ConsumesText - Annotation Type in com.linecorp.armeria.server.annotation
-
An alias for
@Consumes(MediaTypeNames.PLAIN_TEXT_UTF_8)
. - contains(int) - Method in enum com.linecorp.armeria.common.HttpStatusClass
-
Returns
true
if and only if the specified HTTP status code falls into this class. - contains(HttpStatus) - Method in enum com.linecorp.armeria.common.HttpStatusClass
-
Returns
true
if and only if the specifiedHttpStatus
falls into this class. - contains(CharSequence) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
exists,false
otherwise. - contains(CharSequence, String) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - contains(Object) - Method in class com.linecorp.armeria.common.MediaTypeSet
- contains(String) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
exists,false
otherwise. - contains(String, String) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsAttribute(AttributeKey<?>) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns
true
if the specifiedAttributeKey
is in the export list. - containsBoolean(CharSequence, boolean) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsBoolean(String, boolean) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsBuiltIn(BuiltInProperty) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns
true
if the specifiedBuiltInProperty
is in the export list. - containsDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsDouble(String, double) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsFloat(String, float) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsInt(String, int) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsLong(String, long) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsObject(String, Object) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - containsRequestHeader(CharSequence) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns
true
if the specified HTTP request header name is in the export list. - containsResponseHeader(CharSequence) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
-
Returns
true
if the specified HTTP response header name is in the export list. - containsTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns
true
if a header with thename
andvalue
exists. - containsTimeMillis(String, long) - Method in interface com.linecorp.armeria.common.QueryParams
-
Returns
true
if a parameter with thename
andvalue
exists. - content() - Method in interface com.linecorp.armeria.common.AggregatedHttpObject
-
Returns the content of this message.
- content() - Method in interface com.linecorp.armeria.common.multipart.BodyPart
-
Returns the reactive representation of the part content.
- content() - Method in interface com.linecorp.armeria.server.annotation.HttpResult
-
Returns an object which would be converted into response body.
- content() - Method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
-
Returns the content of the file.
- content(byte[]) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
bytes
as a body part content. - content(HttpData) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
HttpData
as a body part content. - content(MediaType, byte[]) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- content(MediaType, byte[]) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets the content for this request.
- content(MediaType, byte[]) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- content(MediaType, HttpData) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- content(MediaType, HttpData) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets the content for this request.
- content(MediaType, HttpData) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- content(MediaType, CharSequence) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- content(MediaType, CharSequence) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets the content for this request.
- content(MediaType, CharSequence) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- content(MediaType, String) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- content(MediaType, String) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets the content for this request.
- content(MediaType, String) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- content(MediaType, String, Object...) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- content(MediaType, String, Object...) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets the content for this request.
- content(MediaType, String, Object...) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- content(MediaType, Publisher<? extends HttpData>) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- content(MediaType, Publisher<? extends HttpData>) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets the
Publisher
for this request. - content(MediaType, Publisher<? extends HttpData>) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- content(File) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
File
as a body part content. - content(File, int) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
File
as a body part content. - content(CharSequence) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
CharSequence
as a UTF-8-encoded body part content. - content(Charset) - Method in interface com.linecorp.armeria.common.AggregatedHttpObject
-
Returns the content of this message as a string encoded in the specified
Charset
. - content(Path) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
Path
as a body part content. - content(Path, int) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds the specified
Path
as a body part content. - content(Publisher<? extends HttpData>) - Method in class com.linecorp.armeria.common.multipart.BodyPartBuilder
-
Adds a new body part backed by the specified
Publisher
. - CONTENT_BASE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Base"
header field name. - CONTENT_DESCRIPTION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP/MIME
"Content-Description"
header field name. - CONTENT_DISPOSITION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP/MIME
"Content-Disposition"
header field name. - CONTENT_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Encoding"
header field name. - CONTENT_ID - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP/MIME
"Content-ID"
header field name. - CONTENT_LANGUAGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Language"
header field name. - CONTENT_LENGTH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Length"
header field name. - CONTENT_LOCATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Location"
header field name. - CONTENT_MD5 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-MD5"
header field name. - CONTENT_RANGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Range"
header field name. - CONTENT_SECURITY_POLICY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
Content-Security-Policy
header field name. - CONTENT_SECURITY_POLICY_REPORT_ONLY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Security-Policy-Report-Only"
header field name. - CONTENT_TRANSFER_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP/MIME
"Content-Transfer-Encoding"
header field name. - CONTENT_TYPE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Content-Type"
header field name. - contentAscii() - Method in interface com.linecorp.armeria.common.AggregatedHttpObject
-
Returns the content of this message as an ASCII string.
- contentDisposition() - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns the parsed
"content-disposition"
header. - contentDisposition(ContentDisposition) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Sets the
"content-disposition"
header. - contentDisposition(ContentDisposition) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- contentDisposition(ContentDisposition) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- ContentDisposition - Class in com.linecorp.armeria.common
-
Representation of the Content-Disposition type and parameters as defined in RFC 6266.
- ContentDispositionBuilder - Class in com.linecorp.armeria.common
-
A builder class for creating
ContentDisposition
. - contentLength() - Method in exception com.linecorp.armeria.common.ContentTooLargeException
-
Returns the actual content length in bytes, as specified in the
content-length
header, or-1
if this value is not known. - contentLength(long) - Method in class com.linecorp.armeria.common.ContentTooLargeExceptionBuilder
-
Sets the actual content length in bytes, as specified in the
content-length
header. - contentLength(HttpHeaders) - Method in class com.linecorp.armeria.common.ContentTooLargeExceptionBuilder
-
Sets the actual content length in bytes, as specified in the
content-length
header, from the specifiedHttpHeaders
. - ContentPreviewer - Interface in com.linecorp.armeria.common.logging
-
Produces the preview of
RequestLog
. - ContentPreviewerFactory - Interface in com.linecorp.armeria.common.logging
-
A factory creating a
ContentPreviewer
. - ContentPreviewerFactoryBuilder - Class in com.linecorp.armeria.common.logging
-
A builder which builds a
ContentPreviewerFactory
. - ContentPreviewingClient - Class in com.linecorp.armeria.client.logging
- ContentPreviewingService - Class in com.linecorp.armeria.server.logging
- contentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
- contentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
- contentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
-
Sets the
BiFunction
to use to sanitize request and response content before logging. - contentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
- ContentTooLargeException - Exception in com.linecorp.armeria.common
-
A
RuntimeException
raised when the length of request or response content exceeds its limit. - ContentTooLargeExceptionBuilder - Class in com.linecorp.armeria.common
-
Builds a new
ContentTooLargeException
. - contentType() - Method in interface com.linecorp.armeria.common.AggregatedHttpObject
-
Returns the value of the
'content-type'
header. - contentType() - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns the parsed
"content-type"
header. - contentType() - Method in interface com.linecorp.armeria.common.HttpRequest
-
Returns the value of the
'content-type'
header. - contentType() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
-
Returns the
MediaType
of the file, which will be used for setting the"content-type"
header. - contentType() - Method in interface com.linecorp.armeria.server.RoutingContext
-
Returns
MediaType
specified by 'Content-Type' header of the request. - contentType(MediaType) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
-
Sets the
"content-type"
header. - contentType(MediaType) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
- contentType(MediaType) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
- contentType(MediaType) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets the
"content-type"
header. - contentType(MediaType) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- contentType(MediaType) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- contentType(CharSequence) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets the
"content-type"
header. - contentType(CharSequence) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- contentType(CharSequence) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- contentUtf8() - Method in interface com.linecorp.armeria.common.AggregatedHttpObject
-
Returns the content of this message as a UTF-8 string.
- context() - Method in interface com.linecorp.armeria.common.ContextAwareEventLoop
-
Returns the
RequestContext
that is specified when creating thisContextAwareEventLoop
. - context() - Method in interface com.linecorp.armeria.common.ContextAwareScheduledExecutorService
-
Returns the
RequestContext
that is specified when creating thisContextAwareScheduledExecutorService
. - context() - Method in interface com.linecorp.armeria.common.ContextHolder
-
Returns the
RequestContext
. - context() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
-
Returns the
RequestContext
associated with theRequest
being handled. - context() - Method in class com.linecorp.armeria.testing.junit5.server.mock.RecordedRequest
-
The
ServiceRequestContext
created when handling the request. - ContextAwareEventLoop - Interface in com.linecorp.armeria.common
-
A delegating
EventLoop
that sets theRequestContext
before executing any submitted tasks. - ContextAwareScheduledExecutorService - Interface in com.linecorp.armeria.common
-
A delegating
ScheduledExecutorService
that sets theRequestContext
before executing any submitted tasks. - ContextHolder - Interface in com.linecorp.armeria.common
-
A holder of
RequestContext
. - CONTINUE - Static variable in class com.linecorp.armeria.common.HttpStatus
-
100 Continue.
- convert(ServiceRequestContext, Throwable) - Method in interface com.linecorp.armeria.server.ExceptionHandler
-
Converts the given
Throwable
to anAggregatedHttpResponse
. - convert(AsciiString) - Method in interface com.linecorp.armeria.common.Http1HeaderNaming
-
Converts the specified HTTP/2 headerName into another HTTP/1 header name.
- converter(Function<? super ServiceInstance<?>, Endpoint>) - Method in class com.linecorp.armeria.client.zookeeper.CuratorDiscoverySpecBuilder
-
Sets the specified converter to convert a
ServiceInstance
into anEndpoint
. - convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in class com.linecorp.armeria.server.annotation.ByteArrayRequestConverterFunction
- convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in class com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction
-
Converts the specified
AggregatedHttpRequest
to an object ofexpectedResultType
. - convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in interface com.linecorp.armeria.server.annotation.RequestConverterFunction
-
Converts the specified
request
to an object ofexpectedResultType
. - convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in class com.linecorp.armeria.server.annotation.StringRequestConverterFunction
-
Converts the specified
AggregatedHttpRequest
to aString
. - convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in class com.linecorp.armeria.server.protobuf.ProtobufRequestConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.annotation.ByteArrayResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.annotation.HttpFileResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.annotation.JacksonResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.annotation.NullToNoContentResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in interface com.linecorp.armeria.server.annotation.ResponseConverterFunction
-
Returns
HttpResponse
instance corresponds to the givenresult
. - convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.annotation.ServerSentEventResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.annotation.StringResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.protobuf.ProtobufResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.rxjava2.ObservableResponseConverterFunction
- convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.rxjava3.ObservableResponseConverterFunction
- cookie(Cookie) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- cookie(Cookie) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets a cookie for this request.
- cookie(Cookie) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- cookie(Cookie) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the cookie header.
- cookie(Cookie) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
-
Sets the set-cookie header.
- Cookie - Interface in com.linecorp.armeria.common
-
An interface defining an HTTP cookie.
- COOKIE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Cookie"
header field name. - CookieBuilder - Class in com.linecorp.armeria.common
-
Builds a
Cookie
. - CookieClient - Class in com.linecorp.armeria.client.cookie
-
Decorates an
HttpClient
to set cookies toCookie
header of outgoingHttpRequest
and store cookies fromSet-Cookie
headers of incomingHttpResponse
. - CookieJar - Interface in com.linecorp.armeria.client.cookie
-
A
Cookie
container for a client. - CookiePolicy - Interface in com.linecorp.armeria.client.cookie
- cookies() - Method in interface com.linecorp.armeria.common.RequestHeaders
-
Returns the parsed cookie header.
- cookies() - Method in interface com.linecorp.armeria.common.ResponseHeaders
-
Returns the parsed set-cookie header.
- cookies(Cookie...) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the cookie header.
- cookies(Cookie...) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
-
Sets the set-cookie header.
- cookies(Iterable<? extends Cookie>) - Method in class com.linecorp.armeria.client.WebClientRequestPreparation
- cookies(Iterable<? extends Cookie>) - Method in class com.linecorp.armeria.common.AbstractHttpRequestBuilder
-
Sets multiple cookies for this request.
- cookies(Iterable<? extends Cookie>) - Method in class com.linecorp.armeria.common.HttpRequestBuilder
- cookies(Iterable<? extends Cookie>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
-
Sets the cookie header.
- cookies(Iterable<? extends Cookie>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
-
Sets the set-cookie header.
- Cookies - Interface in com.linecorp.armeria.common
- CookieState - Enum in com.linecorp.armeria.client.cookie
- copy(RequestContext, String) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
-
Copies the specified thread-local
MDC
property to the specifiedRequestContext
. - copyAll(RequestContext) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
-
Copies all thread-local
MDC
properties to the specifiedRequestContext
. - copyAndClose(T) - Static method in class com.linecorp.armeria.unsafe.PooledObjects
- copyOf(byte[]) - Static method in interface com.linecorp.armeria.common.HttpData
-
Creates a new instance from the specified byte array by first copying it.
- copyOf(byte[], int, int) - Static method in interface com.linecorp.armeria.common.HttpData
-
Creates a new instance from the specified byte array,
offset
andlength
by first copying it. - copyOf(ByteBuf) - Static method in interface com.linecorp.armeria.common.HttpData
-
Creates a new instance from the specified
ByteBuf
by first copying its content. - CoroutineContextProvider - Interface in com.linecorp.armeria.common.kotlin
-
Returns a
CoroutineContext
from a givenServiceRequestContext
. - CoroutineContexts - Class in com.linecorp.armeria.common.kotlin
-
Configures a coroutine context for annotated services and Kotlin suspending functions.
- CoroutineContextService - Class in com.linecorp.armeria.server.kotlin
-
Decorates an
HttpService
to configure the coroutine context which is used as an initial context of annotated services' suspending functions. - CORS_PREFLIGHT - com.linecorp.armeria.server.RoutingResultType
- CorsConfig - Class in com.linecorp.armeria.server.cors
-
Cross-Origin Resource Sharing (CORS) configuration.
- CorsDecorator - Annotation Type in com.linecorp.armeria.server.annotation.decorator
-
A
CorsService
decorator for annotated HTTP services. - CorsDecoratorFactoryFunction - Class in com.linecorp.armeria.server.cors
-
A factory which creates a
CorsService
decorator when only oneCorsDecorator
is added. - CorsDecoratorFactoryFunction() - Constructor for class com.linecorp.armeria.server.cors.CorsDecoratorFactoryFunction
- CorsDecorators - Annotation Type in com.linecorp.armeria.server.annotation.decorator
-
The containing annotation type for
CorsDecorator
. - CorsDecoratorsFactoryFunction - Class in com.linecorp.armeria.server.cors
-
A factory which creates a
CorsService
decorator when two or moreCorsDecorator
s are added. - CorsDecoratorsFactoryFunction() - Constructor for class com.linecorp.armeria.server.cors.CorsDecoratorsFactoryFunction
- CorsPolicy - Class in com.linecorp.armeria.server.cors
-
Contains information of the CORS policy with the specified origins.
- CorsPolicyBuilder - Class in com.linecorp.armeria.server.cors
-
Builds a new
CorsPolicy
. - CorsService - Class in com.linecorp.armeria.server.cors
-
Decorates an
HttpService
to add the Cross-Origin Resource Sharing (CORS) support. - CorsServiceBuilder - Class in com.linecorp.armeria.server.cors
-
Builds a new
CorsService
or its decorator function. - counterSlidingWindow(Duration) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Sets the time length of sliding window to accumulate the count of events.
- counterSlidingWindowMillis(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Sets the time length of sliding window to accumulate the count of events, in milliseconds.
- counterUpdateInterval(Duration) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Sets the interval that a circuit breaker can see the latest accumulated count of events.
- counterUpdateIntervalMillis(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
-
Sets the interval that a circuit breaker can see the latest accumulated count of events, in milliseconds.
- create(String, String) - Static method in class com.linecorp.armeria.common.MediaType
-
Creates a new media type with the given type and subtype.
- CREATED - Static variable in class com.linecorp.armeria.common.HttpStatus
-
201 Created.
- createRequestConverterFunction(Type, RequestConverterFunction) - Method in interface com.linecorp.armeria.server.annotation.RequestConverterFunctionProvider
-
Returns a
RequestConverterFunction
instance if there is a function which can convert therequestType
, otherwise returnnull
. - createRequestConverterFunction(Type, RequestConverterFunction) - Method in class com.linecorp.armeria.server.protobuf.ProtobufRequestConverterFunctionProvider
- createResponseConverterFunction(Type, ResponseConverterFunction, ExceptionHandlerFunction) - Method in interface com.linecorp.armeria.server.annotation.ResponseConverterFunctionProvider
-
Returns a
ResponseConverterFunction
instance if there is a function which can convert theresponseType
, otherwise returnnull
. - createResponseConverterFunction(Type, ResponseConverterFunction, ExceptionHandlerFunction) - Method in class com.linecorp.armeria.server.protobuf.ProtobufResponseConverterFunctionProvider
- credentialResolver(CredentialResolver) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
-
Sets a
CredentialResolver
for this service provider. - credentialsAllowed() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
-
Determines if cookies are allowed to be added to CORS requests.
- CRW - Static variable in class com.linecorp.armeria.common.MediaType
-
The Canon Image File Format (
crw
files), a widely-used "raw image" format for cameras. - CRW - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"image/x-canon-crw".
- CSS_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
- CSS_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"text/css; charset=utf-8".
- CSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
- CSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"text/csv; charset=utf-8".
- curator(String) - Static method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
-
Returns a
ZooKeeperDiscoverySpec
that is compatible with Curator Service Discovery. - curator(String) - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
-
Returns the
ZooKeeperRegistrationSpec
that registers theServer
using the format of Curator Service Discovery. - CuratorDiscoverySpecBuilder - Class in com.linecorp.armeria.client.zookeeper
-
Builds a
ZooKeeperDiscoverySpec
for Curator Service Discovery. - CuratorRegistrationSpecBuilder - Class in com.linecorp.armeria.server.zookeeper
-
Builds a
ZooKeeperRegistrationSpec
for Curator Service Discovery. - current() - Static method in interface com.linecorp.armeria.client.ClientRequestContext
-
Returns the client-side context of the
Request
that is being handled in the current thread. - current() - Static method in interface com.linecorp.armeria.common.RequestContext
-
Returns the context of the
Request
that is being handled in the current thread. - current() - Static method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns the server-side context of the
Request
that is being handled in the current thread. - currentOrNull() - Static method in interface com.linecorp.armeria.client.ClientRequestContext
-
Returns the client-side context of the
Request
that is being handled in the current thread. - currentOrNull() - Static method in interface com.linecorp.armeria.common.RequestContext
-
Returns the context of the
Request
that is being handled in the current thread. - currentOrNull() - Method in interface com.linecorp.armeria.common.RequestContextStorage
-
Returns the
RequestContext
in the storage. - currentOrNull() - Method in class com.linecorp.armeria.common.RequestContextStorageWrapper
- currentOrNull() - Static method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns the server-side context of the
Request
that is being handled in the current thread. - currentTimeMicros() - Static method in class com.linecorp.armeria.common.util.SystemInfo
-
Returns the number of microseconds since the epoch (00:00:00, 01-Jan-1970, GMT).
- custom(String) - Static method in interface com.linecorp.armeria.server.logging.AccessLogWriter
-
Returns an access log writer with the specified
formatStr
. - customizer(Consumer<? super CuratorFrameworkFactory.Builder>) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
- customizer(Consumer<? super CuratorFrameworkFactory.Builder>) - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
-
Specifies the
Consumer
that customizes theCuratorFramework
. - customizer(Consumer<? super CuratorFrameworkFactory.Builder>) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListenerBuilder
D
- daemon(boolean) - Method in class com.linecorp.armeria.common.util.BlockingTaskExecutorBuilder
-
Sets the flag of daemon for new threads.
- daemon(boolean) - Method in class com.linecorp.armeria.common.util.ThreadFactoryBuilder
-
Sets daemon for new threads.
- DART_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
-
Files in the dart.
- DART_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
-
"application/dart; charset=utf-8".
- data() - Method in interface com.linecorp.armeria.common.sse.ServerSentEvent
-
Returns a data of this event, if it exists.
- data(String) - Method in class com.linecorp.armeria.common.sse.ServerSentEventBuilder
-
Sets the specified
data
. - DataBufferFactoryWrapperConfiguration - Class in com.linecorp.armeria.spring.web.reactive
-
A configuration class which creates an
DataBufferFactoryWrapper
. - DataBufferFactoryWrapperConfiguration() - Constructor for class com.linecorp.armeria.spring.web.reactive.DataBufferFactoryWrapperConfiguration
- datacenter(String) - Method in class com.linecorp.armeria.client.consul.ConsulEndpointGroupBuilder
-
Sets which datacenter to query.
- dataCenterMetadata(Map<String, String>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
-
Sets the metadata of the data center.
- dataCenterName(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
-
Sets the name of the data center.
- datagramChannelType() - Method in enum com.linecorp.armeria.common.util.TransportType
-
Returns the
DatagramChannel
class that is available for this transport type. - datagramChannelType(EventLoopGroup) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
-
Deprecated.
- datagramChannelType(EventLoopGroup) - Static method in enum com.linecorp.armeria.common.util.TransportType
-
Returns the available
DatagramChannel
class foreventLoopGroup
. - date(boolean) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
-
Sets whether to set the
"date"
header automatically. - date(boolean) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
- date(boolean) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
- DATE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
-
The HTTP
"Date"
header field name. - DEBUG - com.linecorp.armeria.common.logging.LogLevel
-
DEBUG log level.
- decode(byte[]) - Method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
-
Decodes a znode value to an
Endpoint
. - decode(HttpData) - Method in interface com.linecorp.armeria.client.encoding.StreamDecoder
-
Deprecated.
- decode(HttpData) - Method in interface com.linecorp.armeria.common.encoding.StreamDecoder
- decode(HttpDecoder<T>) - Method in interface com.linecorp.armeria.common.HttpMessage
-
Creates a decoded
StreamMessage
which is decoded from a stream ofHttpObject
s using the specifiedHttpDecoder
. - decode(HttpDecoder<T>, ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpMessage
-
Creates a decoded
StreamMessage
which is decoded from a stream ofHttpObject
s using the specifiedHttpDecoder
andByteBufAllocator
. - decode(HttpDecoder<T>, ByteBufAllocator, Function<? super HttpData, ? extends ByteBuf>) - Method in interface com.linecorp.armeria.common.HttpMessage
-
Creates a decoded
StreamMessage
which is decoded from a stream ofHttpObject
s using the specifiedHttpDecoder
andByteBufAllocator
andbyteBufConverter
. - decode(HttpDecoder<T>, ByteBufAllocator, Function<? super HttpData, ? extends ByteBuf>) - Method in interface com.linecorp.armeria.common.HttpRequest
- decode(HttpDecoder<T>, ByteBufAllocator, Function<? super HttpData, ? extends ByteBuf>) - Method in interface com.linecorp.armeria.common.HttpResponse
- decodedMappedPath() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
- decodedMappedPath() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
-
Returns the
RequestContext.decodedPath()
with its context path removed. - decodedMappedPath() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
- decodedParam(String, String) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
-
Adds a decoded path parameter.
- decodedPath() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
- decodedPath() - Method in interface com.linecorp.armeria.common.RequestContext
-
Returns the absolute path part of the current
Request
URI, excluding the query part, decoded in UTF-8. - decodedPath() - Method in class com.linecorp.armeria.common.RequestContextWrapper
- decodedPath() - Method in class com.linecorp.armeria.server.RoutingResult
-
Returns the path mapped by the
Route
, decoded in UTF-8. - decodeIdn(boolean) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
-
Sets if the domain and host names should be decoded to unicode when received.
- decoderFactories(StreamDecoderFactory...) - Method in class com.linecorp.armeria.client.encoding.DecodingClientBuilder
-
Sets the specified
StreamDecoderFactory
s. - decoderFactories(Iterable<? extends StreamDecoderFactory>) - Method in class com.linecorp.armeria.client.encoding.DecodingClientBuilder
-
Sets the specified
StreamDecoderFactory
s. - DecodingClient - Class in com.linecorp.armeria.client.encoding
-
A
DecoratingClient
that requests and decodes HTTP encoding (e.g., gzip) that has been applied to the content of anHttpResponse
. - DecodingClientBuilder - Class in com.linecorp.armeria.client.encoding
-
A builder class for
DecodingClient
. - DecodingService - Class in com.linecorp.armeria.server.encoding
-
A
DecoratingService
that requests and decodes HTTP encoding (e.g., gzip) that has been applied to the content of anHttpRequest
. - decompress(InputStream) - Method in interface com.linecorp.armeria.common.grpc.protocol.Decompressor
-
Wraps an existing input stream with a decompressing input stream.
- decompressor(Decompressor) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
-
Sets the
Decompressor
for this deframer. - Decompressor - Interface in com.linecorp.armeria.common.grpc.protocol
-
Represents a message decompressor.
- decompressorRegistry(DecompressorRegistry) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
-
Sets the
DecompressorRegistry
to use when decompressing messages. - decorate(HttpClient) - Method in class com.linecorp.armeria.client.ClientDecoration
-
Decorates the specified
HttpClient
using the decorator. - decorate(DecoratingHttpServiceFunction) - Method in interface com.linecorp.armeria.server.HttpService
-
Creates a new
HttpService
that decorates thisHttpService
with the specifiedDecoratingHttpServiceFunction
. - decorate(DecoratingRpcServiceFunction) - Method in interface com.linecorp.armeria.server.RpcService
-
Creates a new
RpcService
that decorates thisRpcService
with the specifiedDecoratingRpcServiceFunction
. - decorate(Function<? super HttpService, R>) - Method in interface com.linecorp.armeria.server.HttpService
- decorate(Function<? super RpcService, ? extends RpcService>) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
-
A
Function<? super RpcService, ? extends RpcService>
to decorate theRpcService
. - decorate(Function<? super RpcService, R>) - Method in interface com.linecorp.armeria.server.RpcService
- DecoratingClient<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response> - Class in com.linecorp.armeria.client
-
Decorates a
Client
. - DecoratingClient(Client<T_I, T_O>) - Constructor for class com.linecorp.armeria.client.DecoratingClient
-
Creates a new instance that decorates the specified
Client
. - DecoratingClientFactory - Class in com.linecorp.armeria.client
- DecoratingClientFactory(ClientFactory) - Constructor for class com.linecorp.armeria.client.DecoratingClientFactory
-
Creates a new instance.
- DecoratingHttpClientFunction - Interface in com.linecorp.armeria.client
-
A functional interface that enables building a
SimpleDecoratingHttpClient
withClientBuilder.decorator(DecoratingHttpClientFunction)
. - DecoratingHttpServiceFunction - Interface in com.linecorp.armeria.server
-
A functional interface that enables building a
SimpleDecoratingHttpService
withHttpService.decorate(DecoratingHttpServiceFunction)
. - DecoratingRpcClientFunction - Interface in com.linecorp.armeria.client
-
A functional interface that enables building a
SimpleDecoratingRpcClient
withClientBuilder.rpcDecorator(DecoratingRpcClientFunction)
. - DecoratingRpcServiceFunction - Interface in com.linecorp.armeria.server
-
A functional interface that enables building a
SimpleDecoratingRpcService
withRpcService.decorate(DecoratingRpcServiceFunction)
. - DecoratingService<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response> - Class in com.linecorp.armeria.server
- DecoratingService(Service<T_I, T_O>) - Constructor for class com.linecorp.armeria.server.DecoratingService
-
Creates a new instance that decorates the specified
Service
. - DecoratingServiceBindingBuilder - Class in com.linecorp.armeria.server
-
A builder class for binding a
decorator
withRoute
fluently. - decoration() - Method in class com.linecorp.armeria.client.ClientOptions
-
Returns the
Function
s that decorate the components of a client. - DECORATION - Static variable in class com.linecorp.armeria.client.ClientOptions
-
The
Function
that decorates the client components. - decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Adds the specified HTTP-level
decorator
. - decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.ClientBuilder
- decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.client.WebClientBuilder
- decorator(DecoratingHttpClientFunction) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- decorator(DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Decorates all
HttpService
s with the specifiedDecoratingHttpServiceFunction
. - decorator(DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Decorates all
HttpService
s with the specifiedDecoratingHttpServiceFunction
. - decorator(Route, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Decorates
HttpService
s with the specifiedRoute
. - decorator(Route, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
- decorator(Route, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Decorates
HttpService
s with the specifiedRoute
. - decorator(Route, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
- decorator(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.ServerBuilder
- decorator(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
- decorator(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
- decorator(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
- decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
-
Adds the specified HTTP-level
decorator
. - decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.ClientBuilder
- decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
- decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
- decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
- decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.WebClientBuilder
- decorator(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
- decorator(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
- decorator(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Decorates all
HttpService
s with the specifieddecorator
. - decorator(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- decorator(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
- decorator(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Decorates all
HttpService
s with the specifieddecorator
. - decorator(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- Decorator - Annotation Type in com.linecorp.armeria.server.annotation
-
Specifies a
DecoratingHttpServiceFunction
class which handles anHttpRequest
before invoking an annotated service method. - DecoratorFactory - Annotation Type in com.linecorp.armeria.server.annotation
-
Specifies a
DecoratorFactoryFunction
class which is a factory to create a decorator. - DecoratorFactoryFunction<T extends Annotation> - Interface in com.linecorp.armeria.server.annotation
-
A decorator factory which is used for a user-defined decorator annotation.
- decorators() - Method in class com.linecorp.armeria.client.ClientDecoration
-
Returns the HTTP-level decorators.
- decorators(Iterable<? extends Function<? super HttpService, ? extends HttpService>>) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
- decorators(Iterable<? extends Function<? super HttpService, ? extends HttpService>>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- decorators(Iterable<? extends Function<? super HttpService, ? extends HttpService>>) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
- decorators(Iterable<? extends Function<? super HttpService, ? extends HttpService>>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- decorators(Function<? super HttpService, ? extends HttpService>...) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
- decorators(Function<? super HttpService, ? extends HttpService>...) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
- decorators(Function<? super HttpService, ? extends HttpService>...) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
- decorators(Function<? super HttpService, ? extends HttpService>...) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
- Decorators - Annotation Type in com.linecorp.armeria.server.annotation
-
The containing annotation type for
Decorator
. - decoratorUnder(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Decorates
HttpService
s under the specified directory. - decoratorUnder(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Decorates
HttpService
s under the specified directory. - decoratorUnder(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Decorates
HttpService
s under the specified directory. - decoratorUnder(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Decorates
HttpService
s under the specified directory. - Default - Annotation Type in com.linecorp.armeria.server.annotation
-
Specifies the default value of an optional parameter.
- DEFAULT_CACHE_SPEC - Static variable in class com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizerBuilder
- defaultBackoffSpec() - Static method in class com.linecorp.armeria.common.Flags
- defaultCharset(Charset) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
-
Sets the default
Charset
used to produce the text preview when a charset is not specified in the"content-type"
header. - defaultClientIdleTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default client-side idle timeout of a connection for keep-alive in milliseconds.
- DefaultClientRequestContext - Class in com.linecorp.armeria.client
-
Default
ClientRequestContext
implementation. - DefaultClientRequestContext(MeterRegistry, SessionProtocol, RequestId, HttpMethod, String, String, String, ClientOptions, HttpRequest, RpcRequest, RequestOptions, long, long) - Constructor for class com.linecorp.armeria.client.DefaultClientRequestContext
-
Creates a new instance.
- defaultConnectTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default client-side timeout of a socket connection attempt in milliseconds.
- defaultFormat(SerializationFormat) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
-
Sets the default
SerializationFormat
. - defaultHistogramConfig() - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
- defaultHostname() - Method in class com.linecorp.armeria.server.Server
-
Returns the hostname of the default
VirtualHost
, which is the hostname of the machine. - defaultHostname() - Method in class com.linecorp.armeria.server.VirtualHost
-
Returns the default hostname of this virtual host.
- defaultHostname(String) - Method in class com.linecorp.armeria.server.ServerBuilder
-
Sets the default hostname of the default
VirtualHostBuilder
. - defaultHostname(String) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
-
Sets the default hostname of this
VirtualHost
. - defaultHttp1MaxChunkSize() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default maximum length of each chunk in an HTTP/1 request or response content.
- defaultHttp1MaxHeaderSize() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default maximum length of all HTTP/1 headers in a request or response.
- defaultHttp1MaxInitialLineLength() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default maximum length of an HTTP/1 initial line.
- defaultHttp2InitialConnectionWindowSize() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default value of the
ServerBuilder.http2InitialConnectionWindowSize(int)
andClientFactoryBuilder.http2InitialConnectionWindowSize(int)
option. - defaultHttp2InitialStreamWindowSize() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default value of the
ServerBuilder.http2InitialStreamWindowSize(int)
andClientFactoryBuilder.http2InitialStreamWindowSize(int)
option. - defaultHttp2MaxFrameSize() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default value of the
ServerBuilder.http2MaxFrameSize(int)
andClientFactoryBuilder.http2MaxFrameSize(int)
option. - defaultHttp2MaxHeaderListSize() - Static method in class com.linecorp.armeria.common.Flags
-
Returns the default value of the
ServerBuilder.http2MaxHeaderListSize(long)
and
Route.apply(RoutingContext, boolean)
.