Index

A B C D E F G H I J K L M N O P Q R S T U V W X Z 
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.PublisherBasedStreamMessage
 
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(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.PublisherBasedStreamMessage
 
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 specified Throwable.
abort(Throwable) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
AbortedStreamException - Exception in com.linecorp.armeria.common.stream
A RuntimeException that is raised to signal a Subscriber that the StreamMessage it subscribed to has been aborted by StreamMessage.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 or AfterAll, or around each test method, like BeforeEach or AfterEach.
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.
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 to maxConcurrency, 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 to maxConcurrency.
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 specified EndpointGroup.
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
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 or AggregatedHttpFileBuilder.
AbstractHttpFileBuilder() - Constructor for class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
 
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
 
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 and value.
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 and URI.
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
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 and CircuitBreakerRuleWithContent.
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 - 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.
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 the DocStringExtractor.
acceptTypes() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns a list of MediaTypes that are specified in HttpHeaderNames.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 VirtualHosts.
accessLogger(String) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the Logger named loggerName of this VirtualHost, which is used for writing access logs.
accessLogger(Function<? super VirtualHost, ? extends Logger>) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the default access logger mapper for all VirtualHosts.
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 all VirtualHosts.
accessLogger(Logger) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the Logger of this VirtualHost, 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 RequestLogs produced by a Service, usually for logging purpose.
accessToken() - Method in class com.linecorp.armeria.common.auth.OAuth2Token
Returns the access token.
acquire(SessionProtocol, EndpointGroup, Endpoint) - Method in interface com.linecorp.armeria.client.EventLoopScheduler
Acquires an EventLoop that is expected to handle a connection to the specified Endpoint.
acquireEventLoop(SessionProtocol, EndpointGroup, Endpoint) - Method in interface com.linecorp.armeria.client.ClientFactory
Acquires an EventLoop that is expected to handle a connection to the specified Endpoint.
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 this Server is listening to.
activeLocalPort(SessionProtocol) - Method in class com.linecorp.armeria.server.Server
Returns the local ServerPort which serves the given SessionProtocol.
activePort() - Method in class com.linecorp.armeria.server.Server
Returns the primary ServerPort that this Server is listening to.
activePort(SessionProtocol) - Method in class com.linecorp.armeria.server.Server
Returns the primary ServerPort which serves the given SessionProtocol that this Server is listening to.
activePorts() - Method in class com.linecorp.armeria.server.Server
Returns all ServerPorts that this Server 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 specified RequestOnlyLog.
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 and values.
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 and value.
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 and values.
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 Authorizers.
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 and values.
add(String, String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Adds a new parameter with the specified name and value.
add(String, String...) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Adds new parameters with the specified name and values.
add(Function<? super HttpClient, ? extends HttpClient>) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
Adds the specified HTTP-level decorator.
addAdditionalRequestHeader(CharSequence, Object) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Adds a header with the specified name and value.
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 and value.
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 and value.
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
 
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 given header.
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 the child.
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
Adds the specified Endpoint to current Endpoint list.
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 specified name.
additionalEndpoints() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
Returns the additional Endpoints.
additionalEndpoints(Map<String, Endpoint>) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
Adds the specified additional Endpoints.
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 an HttpResponse.
AdditionalHeaders - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for AdditionalHeader.
additionalRequestHeaders() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns an HttpHeaders which will be included when a Client sends an HttpRequest.
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
Returns the HttpHeaders which will be included when a Service sends an HttpResponse.
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 a Service completes an HttpResponse.
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 this Server, so that it is notified when the state of this Server 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 a Listenable 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 this StartStopSupport 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 given header.
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 given header.
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 into InetSocketAddresses.
addressResolverGroupFactory() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the factory that creates an AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
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 into InetSocketAddresses.
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 this GrpcServiceBuilder.
addService(ServerServiceDefinition) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Adds a gRPC ServerServiceDefinition to this GrpcServiceBuilder, such as what's returned by BindableService.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 this GrpcServiceBuilder.
addService(String, BindableService, MethodDescriptor<?, ?>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Adds a method of gRPC BindableService to this GrpcServiceBuilder.
addService(String, ServerServiceDefinition) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Adds a gRPC ServerServiceDefinition to this GrpcServiceBuilder, such as what's returned by BindableService.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.
addServices(BindableService...) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
addServices(Iterable<BindableService>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
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.server.SelfSignedCertificateRule
Deletes the generated SelfSignedCertificate.
after() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Calls ServerRule.stop(), without waiting until the Server 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.server.SelfSignedCertificateExtension
Deletes the generated SelfSignedCertificate.
after(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Calls ServerExtension.stop(), without waiting until the Server 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(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(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
 
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 an HttpData.
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.
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(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(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 this RequestContext.
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
alloc(ByteBufAllocator) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
allOptions() - Static method in class com.linecorp.armeria.client.ClientFactoryOption
Returns the all available ClientFactoryOptions.
allOptions() - Static method in class com.linecorp.armeria.client.ClientOption
Returns the all available ClientOptions.
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 logical AND of this filter and other.
andForOrigin(String) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
Creates a new instance of ChainedCorsPolicyBuilder added to the parent CorsServiceBuilder.
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 parent CorsServiceBuilder.
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 the MeterIdPrefix returned by this function.
andThen(AccessLogWriter) - Method in interface com.linecorp.armeria.server.logging.AccessLogWriter
Returns a new AccessLogWriter which combines two AccessLogWriters.
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 RequestConverterFunctions, ResponseConverterFunction and ExceptionHandlerFunctions for creating an AnnotatedServiceExtensions.
annotatedServiceExtensions(Iterable<? extends RequestConverterFunction>, Iterable<? extends ResponseConverterFunction>, Iterable<? extends ExceptionHandlerFunction>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the RequestConverterFunctions, ResponseConverterFunction and ExceptionHandlerFunctions for creating an AnnotatedServiceExtensions.
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_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 specified StringBuilder.
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 and endTimeNanos to the specified StringBuilder.
appendElapsedAndSize(StringBuilder, long, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
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.
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 specified StringBuffer.
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 and tags.
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 and tags.
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
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.
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
A utility that looks for the Path to the JAR, WAR or directory where a Class is located at.
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 for ArmeriaWebServer and ArmeriaClientHttpConnector.
ArmeriaBundle<C extends Configuration> - Class in com.linecorp.armeria.dropwizard
A Dropwizard ConfiguredBundle that routes requests through an Armeria Server 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 an ArmeriaClientHttpConnector.
ArmeriaMessageDeframer - Class in com.linecorp.armeria.common.grpc.protocol
A deframer of messages transported in the gRPC wire format.
ArmeriaMessageDeframer(ArmeriaMessageDeframer.Listener, int, ByteBufAllocator, boolean) - Constructor for class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Construct an ArmeriaMessageDeframer for reading messages out of a gRPC request or response.
ArmeriaMessageDeframer.DeframedMessage - Class in com.linecorp.armeria.common.grpc.protocol
A deframed message.
ArmeriaMessageDeframer.Listener - Interface in com.linecorp.armeria.common.grpc.protocol
A listener of deframing events.
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 new ArmeriaWebServer.
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
 
ArmeriaRetrofit - Class in com.linecorp.armeria.client.retrofit2
Provides various ways to create a Retrofit which uses WebClient for sending requests.
ArmeriaRetrofitBuilder - Class in com.linecorp.armeria.client.retrofit2
A builder that creates a Retrofit which uses WebClient for sending requests.
armeriaServer(ArmeriaSettings, Optional<MeterRegistry>, Optional<List<HealthChecker>>, 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.
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 specified type.
as(Class<T>) - Method in interface com.linecorp.armeria.client.retry.Backoff
Undecorates this Backoff to find the Backoff which is an instance of the specified type.
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 specified type.
as(Class<U>) - Method in class com.linecorp.armeria.common.util.AbstractUnwrappable
 
AS_IS - com.linecorp.armeria.server.healthcheck.HealthCheckUpdateResult
Tells HealthCheckService to leave the Server healthiness unchanged.
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.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.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
Returns an HttpService which serves the file for HEAD and GET requests.
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 or ListenableAsyncCloseable.
AsyncMethodCallbacks - Class in com.linecorp.armeria.common.thrift
A utility class that bridges the gap between CompletionStage and AsyncMethodCallback.
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 or null if there's no value set by RequestContext.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(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.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 AttributeKeys in the export list.
attributes() - Method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Returns the attributes of the file.
attrs() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
attrs() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the Iterator of all Map.Entrys this context contains.
attrs() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
attrs() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
auth(BasicToken) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
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
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
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, in the form of "hostname:port".
authority() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the authority of this request.
authority(Endpoint) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
Sets the ":authority" header from the specified Endpoint.
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 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Authorization" header field name.
authorize(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
 
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 an index.html file.
availabilityStamp() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns an int representation of the currently available properties of this RequestLog.
availableFormats(SerializationFormat...) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
Sets the available SerializationFormats.
availableFormats(Iterable<SerializationFormat>) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
Sets the available SerializationFormats.
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 MediaTypes.
availableMimeTypes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
Sets the available MediaTypes.

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
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.server.SelfSignedCertificateRule
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.server.SelfSignedCertificateExtension
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() on subscriber.
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) on subscriber.
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) on subscriber.
beforeTestExecution(ExtensionContext) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
 
belongsTo(MediaType) - Method in class com.linecorp.armeria.common.MediaType
Returns true if this MediaType belongs to the given MediaType.
binary(MediaType...) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes to produce the hex dump preview when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
binary(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes to produce the hex dump preview when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
binary(BiFunction<? super HttpHeaders, ? super ByteBuf, String>, MediaType...) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes to produce the preview using the specified BiFunction when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
binary(BiFunction<? super HttpHeaders, ? super ByteBuf, String>, Iterable<MediaType>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes to produce the preview using the specified BiFunction when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
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 specified BiFunction when the predicate returns true.
binary(BiPredicate<? super RequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified BiPredicate to produce the hex dump preview when the predicate returns true.
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(ScheduledExecutorService, boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the ScheduledExecutorService dedicated to the execution of blocking tasks or invocations.
blockUntilShutdown() - Method in class com.linecorp.armeria.server.Server
Waits until the result of CompletableFuture which is completed after the Server.close() or Server.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 - com.linecorp.armeria.server.docs.FieldLocation
The field is located in the request body.
BraveClient - Class in com.linecorp.armeria.client.brave
Decorates an HttpClient to trace outbound HttpRequests using Brave.
BraveService - Class in com.linecorp.armeria.server.brave
Decorates an HttpService to trace inbound HttpRequests using Brave.
buf() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
Returns the ByteBuf.
BUFFERS - Static variable in class com.linecorp.armeria.unsafe.grpc.GrpcUnsafeBufferUtil
An AttributeKey for storing the ByteBufs backing Messages.
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 the ClientOptionValues 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.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.eureka.EurekaEndpointGroupBuilder
Returns a newly-created EurekaEndpointGroup based on the properties set so far.
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.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.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.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.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.RequestContextExporterBuilder
Returns a newly-created RequestContextExporter instance.
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.ThreadFactoryBuilder
Returns a new ThreadFactory.
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.grpc.GrpcServiceBuilder
Constructs a new GrpcService that can be bound to ServerBuilder.
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.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 a Server 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 the Runnables 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(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.logging.LoggingClientBuilder
Returns a newly-created LoggingClient decorating delegate 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 decorating delegate 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 returns ServerBuilder that this DecoratingServiceBindingBuilder was created from.
build(DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
build(HttpService) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
Returns a newly-created AuthService based on the Authorizers 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 decorating HttpService based on the properties of this builder.
build(HttpService) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
Sets the HttpService and returns the ServerBuilder that this ServiceBindingBuilder was created from.
build(HttpService) - Method in class com.linecorp.armeria.server.throttling.ThrottlingServiceBuilder
Returns a newly-created ThrottlingService based on the ThrottlingStrategys added to this builder.
build(HttpService) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
Sets the HttpService and returns the VirtualHostBuilder that this VirtualHostServiceBindingBuilder was created from.
build(RpcService) - Method in class com.linecorp.armeria.server.throttling.ThrottlingRpcServiceBuilder
Returns a newly-created ThrottlingRpcService based on the ThrottlingStrategys added to this builder.
build(ServiceDescriptor) - Method in class com.linecorp.armeria.common.grpc.GrpcJsonMarshallerBuilder
Returns a newly-created GrpcJsonMarshaller with the specified ServiceDescriptor.
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
Registers the given service to ServerBuilder and return ServerBuilder to continue building Server.
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 returns ServerBuilder that this DecoratingServiceBindingBuilder was created from.
build(Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
Sets the decorator and returns VirtualHostBuilder that this VirtualHostDecoratingServiceBindingBuilder 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 if AbstractCuratorFrameworkBuilder.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.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.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.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 base URI.
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 directived disabled initially.
builder() - Static method in interface com.linecorp.armeria.common.grpc.GrpcJsonMarshaller
builder() - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new empty builder.
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.RequestContextExporter
Returns a newly created RequestContextExporterBuilder.
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 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.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
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 of THttpService fluently.
builder() - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket
Returns a newly created TokenBucketBuilder.
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 specified CircuitBreakerRule.
builder(CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
builder(CircuitBreakerRuleWithContent<HttpResponse>, int) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRuleWithContent and the specified maxContentLength which is required to determine a Response as a success or failure.
builder(CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
builder(EndpointGroup, String) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns a newly created HealthCheckedEndpointGroupBuilder that builds a HealthCheckedEndpointGroup which sends HTTP HEAD health check requests.
builder(RetryRule) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Returns a new RetryingClientBuilder with the specified RetryRule.
builder(RetryRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Returns a new RetryingClientBuilder with the specified RetryRuleWithContent.
builder(RetryRuleWithContent<HttpResponse>, int) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Returns a new RetryingClientBuilder with the specified RetryRuleWithContent and the specified maxContentLength.
builder(RetryRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Returns a new RetryingRpcClientBuilder with the specified RetryRuleWithContent.
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 specified WebClient.
builder(HttpData) - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Returns a new AggregatedHttpFileBuilder that builds an AggregatedHttpFile from the specified HttpData.
builder(HttpData) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns a new HttpFileBuilder that builds an HttpFile from the specified HttpData.
builder(HttpData, long) - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Returns a new AggregatedHttpFileBuilder that builds an AggregatedHttpFile from the specified HttpData and lastModifiedMillis.
builder(HttpData, long) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns a new HttpFileBuilder that builds an HttpFile from the specified HttpData and lastModifiedMillis.
builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRuleBuilder with the specified HttpMethods.
builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified HttpMethods.
builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRuleBuilder with the specified HttpMethods.
builder(HttpMethod...) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a newly created RetryRuleWithContentBuilder with the specified HttpMethods.
builder(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new builder with the specified HttpMethod and path.
builder(HttpRequest) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a new ClientRequestContextBuilder created from the specified HttpRequest.
builder(HttpRequest) - Static method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns a new ServiceRequestContextBuilder created from the specified HttpRequest.
builder(HttpStatus) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new builder with the specified HttpStatus.
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
Returns a new ClientRequestContextBuilder created from the specified RpcRequest and uri.
builder(RpcRequest, URI) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a new ClientRequestContextBuilder created from the specified RpcRequest and URI.
builder(Scheme, EndpointGroup) - Static method in class com.linecorp.armeria.client.Clients
Returns a new ClientBuilder that builds the client that connects to the specified EndpointGroup with the specified Scheme.
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 specified EndpointGroup with the specified Scheme and path.
builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.Clients
Returns a new ClientBuilder that builds the client that connects to the specified EndpointGroup with the specified SessionProtocol.
builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroupBuilder created with the specified SessionProtocol and EndpointGroup.
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 specified EndpointGroup using the specified SessionProtocol.
builder(SessionProtocol, EndpointGroup) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClientBuilder created with the specified SessionProtocol and base EndpointGroup.
builder(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListenerBuilder created with the specified SessionProtocol and EndpointGroup.
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 specified EndpointGroup with the specified SessionProtocol and path.
builder(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroupBuilder created with the specified SessionProtocol, 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 specified EndpointGroup using the specified SessionProtocol and path.
builder(SessionProtocol, EndpointGroup, String) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClientBuilder created with the specified SessionProtocol, base EndpointGroup and path.
builder(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListenerBuilder created with the specified SessionProtocol, EndpointGroup and path.
builder(HttpVfs) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileServiceBuilder with the specified HttpVfs.
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
builder(ThrottlingStrategy<RpcRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingRpcService
builder(File) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileServiceBuilder with the specified rootDir in an O/S file system.
builder(File) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified File.
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 specified rootDir in the current class path.
builder(ClassLoader, String) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns a new HttpFileBuilder that builds an HttpFile from the classpath resource at the specified path using the specified ClassLoader.
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 specified HttpMethods.
builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified HttpMethods.
builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRuleBuilder with the specified HttpMethods.
builder(Iterable<HttpMethod>) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a newly created RetryRuleWithContentBuilder with the specified HttpMethods.
builder(Iterable<String>) - Static method in class com.linecorp.armeria.server.cors.CorsPolicy
Returns a new CorsPolicyBuilder with the specified origins.
builder(Iterable<String>) - Static method in class com.linecorp.armeria.server.cors.CorsService
Returns a new CorsServiceBuilder with the specified origins.
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 specified uri.
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 specified eurekaUri.
builder(String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new ArmeriaRetrofitBuilder created with the specified baseUrl.
builder(String) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClientBuilder created with the specified base uri.
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 specified eurekaUri.
builder(String...) - Static method in class com.linecorp.armeria.server.cors.CorsPolicy
Returns a new CorsPolicyBuilder with the specified origins.
builder(String...) - Static method in class com.linecorp.armeria.server.cors.CorsService
Returns a new CorsServiceBuilder with the specified origins.
builder(String, EndpointGroup) - Static method in class com.linecorp.armeria.client.Clients
Returns a new ClientBuilder that builds the client that connects to the specified EndpointGroup with the specified scheme.
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 specified EndpointGroup using the specified protocol.
builder(String, EndpointGroup) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClientBuilder created with the specified protocol and base EndpointGroup.
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 specified EndpointGroup with the specified scheme and path.
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 specified EndpointGroup using the specified SessionProtocol and path.
builder(String, EndpointGroup, String) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClientBuilder created with the specified protocol.
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 a Cookie.
builder(String, String) - Static method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns a newly created EndpointInfoBuilder that builds the EndpointInfo with the specified hostnamePattern and pathMapping.
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 and Function mapping.
builder(URI) - Static method in class com.linecorp.armeria.client.Clients
Returns a new ClientBuilder that builds the client that connects to the specified URI.
builder(URI) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroupBuilder created with the specified eurekaUri.
builder(URI) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new ArmeriaRetrofitBuilder created with the specified baseUrl.
builder(URI) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClientBuilder created with the specified base URI.
builder(URI) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListenerBuilder created with the specified eurekaUri.
builder(Path) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileServiceBuilder with the specified rootDir in an O/S file system.
builder(Path) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified Path.
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 specified Path.
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 specified requestHeadersFilter.
builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified requestHeadersFilter.
builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRuleBuilder with the specified requestHeadersFilter.
builder(BiPredicate<? super ClientRequestContext, ? super RequestHeaders>) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a newly created RetryRuleWithContentBuilder with the specified requestHeadersFilter.
builder(Properties, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Returns a new PropertiesEndpointGroupBuilder created from the specified Properties.
builder(CuratorFramework, String, ZooKeeperDiscoverySpec) - Static method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup
Returns a new ZooKeeperEndpointGroupBuilder created with the specified CuratorFramework and ZNode path.
builder(CuratorFramework, String, ZooKeeperRegistrationSpec) - Static method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
Returns a ZooKeeperUpdatingListenerBuilder with a CuratorFramework instance and a znode path.
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
builderForCurator(String) - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
builderForServerSets() - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
buildHeaders() - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Returns the immutable additional HttpHeaders which will be set when building an HttpResponse.
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 specified baseOptions 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
 
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.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 BuiltInPropertys in the export list.
ByteArrayRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
A RequestConverterFunction which converts a binary body of the AggregatedHttpRequest to one of byte[] or HttpData depending on the expectedResultType.
ByteArrayRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.ByteArrayRequestConverterFunction
 
ByteArrayResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A ResponseConverterFunction which creates an HttpResponse when: the result is an instance of HttpData or byte[] the result is an instance of Publisher or Stream while the "content-type" of the ResponseHeaders is "application/binary" or "application/octet-stream" Note that this ResponseConverterFunction is applied to the annotated service by default, so you don't have to set 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 specified ByteBufAccessMode.
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 specified ByteBufAccessMode.
ByteBufAccessMode - Enum in com.linecorp.armeria.common
Specifies the way a ByteBuf is retrieved from an HttpData.
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 value of the cachedHeaders parameter which contains a comma-separated list of headers whose values are cached using headerValueCache.
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.
callbackExecutor(Executor) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
Sets the Executor on which Callback methods are invoked when returning Call from your service method.
cancel() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Cancels the response.
cancel() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
cancel() - Method in interface com.linecorp.armeria.common.RequestContext
Cancels the current Request.
cancel() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Cancels the request.
cancel() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
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.ClientRequestContextWrapper
 
cancel(Throwable) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
cancel(Throwable) - Method in interface com.linecorp.armeria.common.RequestContext
Cancels the current Request with a Throwable.
cancel(Throwable) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
cancel(Throwable) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
cancellationCause() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
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.server.DefaultServiceRequestContext
 
cancellationCause() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
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 and cause.
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 notify StreamMessage.whenComplete() when a Subscriber has cancelled its Subscription.
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
Returns the Netty Channel which handled the Request.
channel() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
Returns the Channel that is handling this request, or null 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 ChannelOptions of the sockets created by the ClientFactory.
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 by Server.
channelOptions() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the ChannelOptions of the sockets created by the ClientFactory.
channelOptions() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ChannelOptions and their values of Server's server sockets.
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 HealthCheckers that determine the healthiness of the Server.
checkers(Iterable<? extends HealthChecker>) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Adds the specified HealthCheckers that determine the healthiness of the Server.
childChannelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the ChannelOption of sockets accepted by Server.
childChannelOptions() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ChannelOptions and their values of sockets accepted by Server.
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 RequestLogAccesses that provide access to the child RequestLogs, 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
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.
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 a CircuitBreaker.
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 a CircuitBreaker using the content of the Response.
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 specified RequestContext.
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
Sends a Request to a remote Endpoint.
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 from ProxiedAddresses.
clientAddressMapper(Function<? super ProxiedAddresses, ? extends InetSocketAddress>) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets a Function to use when determining the client address from ProxiedAddresses.
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 ClientAddressSources 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 ClientAddressSources 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 ClientAddressSources 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.
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 specified ClientOptions.
clientBuilderParams(T) - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the ClientBuilderParams held in client.
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
ClientDecoration - Class in com.linecorp.armeria.client
A set of Functions that transforms a Client into another.
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 ClientFactoryOptions 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 of ArmeriaClientConfigurators.
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 the Client that sends health check requests.
clientOptions(ClientOptions) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the ClientOptions of the Client 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 ClientOptions 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
Provides information about a Request, its Response and its related utilities.
ClientRequestContextBuilder - Class in com.linecorp.armeria.client
Builds a new ClientRequestContext.
ClientRequestContextCaptor - Interface in com.linecorp.armeria.client
Captures the ClientRequestContexts 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 an FileService.
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.common.grpc.protocol.ArmeriaMessageDeframer
Closes this deframer and frees any resources.
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 via HttpData.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 and cause.
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 a StreamMessage 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 and cause.
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().
closeWhenComplete() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Requests closing this deframer when any messages currently queued have been requested and delivered.
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.
com.linecorp.armeria.client - package com.linecorp.armeria.client
Client core.
com.linecorp.armeria.client.brave - package com.linecorp.armeria.client.brave
Distributed tracing clients based on Brave, a Java tracing library compatible with Zipkin.
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.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 Endpoints from an existing EndpointGroup 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 Requests.
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.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.brave - package com.linecorp.armeria.common.brave
Common classes for distributed tracing support based on Brave, a Java tracing library compatible with Zipkin.
com.linecorp.armeria.common.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
Common types used for collecting the information about Requests and Responses.
com.linecorp.armeria.common.metric - package com.linecorp.armeria.common.metric
Common metric collection utilities.
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
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.brave - package com.linecorp.armeria.server.brave
Distributed tracing services based on Brave, a Java tracing library compatible with Zipkin.
com.linecorp.armeria.server.cors - package com.linecorp.armeria.server.cors
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.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.metric - package com.linecorp.armeria.server.metric
Metric-collecting service decorators and exporters.
com.linecorp.armeria.server.rxjava2 - package com.linecorp.armeria.server.rxjava2
Provides a default ResponseConverterFunction which automatically converts an ObservableSource into an HttpResponse when the ObservableSource is returned by an annotated HTTP service.
com.linecorp.armeria.server.rxjava3 - package com.linecorp.armeria.server.rxjava3
Provides a default ResponseConverterFunction which automatically converts an ObservableSource into an HttpResponse when the ObservableSource is returned by an annotated HTTP service.
com.linecorp.armeria.server.saml - 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 or Stream.
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
Utilities for working with an HttpData backed by a pooled ByteBuf.
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 EventLoopGroups 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
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 specified value.
completedFuture(U) - Static method in class com.linecorp.armeria.common.util.UnmodifiableFuture
Returns an UnmodifiableFuture which has been completed with the specified value.
completeExceptionally(Throwable) - Method in class com.linecorp.armeria.common.CompletableRpcResponse
 
completeExceptionally(Throwable) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
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 complete RequestLog.
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
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
compose(Function<A, B>, Function<B, C>, Function<C, D>) - Static method in class com.linecorp.armeria.common.util.Functions
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
compose(Function<A, B>, Function<B, C>, Function<C, D>, Function<D, E>) - Static method in class com.linecorp.armeria.common.util.Functions
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
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
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
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
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
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
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
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
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
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
Returns a Function that composes the specified Functions with chained Function.andThen(Function).
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.
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
Returns the ServiceConfig of the Service that is handling the current Request.
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 Tomcat StandardServer created by a TomcatService.
configurator(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Adds a Consumer that performs additional configuration operations against the Jetty Server created by a JettyService.
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(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 given ServerBuilder.
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 given ServerBuilder.
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.
connectFailed(SessionProtocol, Endpoint, SocketAddress, Throwable) - Method in interface com.linecorp.armeria.client.proxy.ProxyConfigSelector
Called to indicate a connection attempt to the specified SessionProtocol and Endpoint 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.
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
ConnectionPoolListenerWrapper(ConnectionPoolListener) - Constructor for class com.linecorp.armeria.client.ConnectionPoolListenerWrapper
Creates a new instance with the specified delegate.
connectionTimings() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the ClientConnectionTimings of the Request.
connectionTimings(ClientConnectionTimings) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
Sets the ClientConnectionTimings of the request.
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(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
 
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
Returns the Set of MediaTypes that this Route consumes.
consumes(MediaType...) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
consumes(MediaType...) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to consume the specified MediaTypes.
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
Sets the Route to consume the specified MediaTypes.
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).
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 specified HttpStatus falls into this class.
contains(Object) - Method in class com.linecorp.armeria.common.MediaTypeSet
 
containsAttribute(AttributeKey<?>) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
Returns true if the specified AttributeKey is in the export list.
containsBuiltIn(BuiltInProperty) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
Returns true if the specified BuiltInProperty is in the export list.
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.
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_BASE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Content-Base" header field name.
CONTENT_DISPOSITION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Content-Disposition" header field name.
CONTENT_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Content-Encoding" 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_TYPE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Content-Type" header field name.
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
Decorates an HttpClient to preview the content of Requests and Responses.
ContentPreviewingService - Class in com.linecorp.armeria.server.logging
Decorates an HttpService to preview the content of Requests and Responses.
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.
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
 
context() - Method in interface com.linecorp.armeria.common.ContextAwareEventLoop
Returns the RequestContext that is specified when creating this ContextAwareEventLoop.
context() - Method in interface com.linecorp.armeria.common.ContextAwareScheduledExecutorService
Returns the RequestContext that is specified when creating this ContextAwareScheduledExecutorService.
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 the Request 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 the RequestContext before executing any submitted tasks.
ContextAwareScheduledExecutorService - Interface in com.linecorp.armeria.common
A delegating ScheduledExecutorService that sets the RequestContext 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.
converter(Function<? super ServiceInstance<?>, Endpoint>) - Method in class com.linecorp.armeria.client.zookeeper.CuratorDiscoverySpecBuilder
Sets the specified converter to convert a ServiceInstance into an Endpoint.
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 of expectedResultType.
convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in interface com.linecorp.armeria.server.annotation.RequestConverterFunction
Converts the specified request to an object of expectedResultType.
convertRequest(ServiceRequestContext, AggregatedHttpRequest, Class<?>, ParameterizedType) - Method in class com.linecorp.armeria.server.annotation.StringRequestConverterFunction
Converts the specified AggregatedHttpRequest to a String.
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.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 given result.
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.rxjava2.ObservableResponseConverterFunction
 
convertResponse(ServiceRequestContext, ResponseHeaders, Object, HttpHeaders) - Method in class com.linecorp.armeria.server.rxjava3.ObservableResponseConverterFunction
 
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.
Cookies - Interface in com.linecorp.armeria.common
An immutable Set of Cookies.
copy(RequestContext, String) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Copies the specified thread-local MDC property to the specified RequestContext.
copyAll(RequestContext) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Copies all thread-local MDC properties to the specified RequestContext.
copyAndClose(T) - Static method in class com.linecorp.armeria.unsafe.PooledObjects
Creates an unpooled copy of the given HttpData and closes the given HttpData.
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 and length 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 given ServiceRequestContext.
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
A Route did not match a RoutingContext, but a CORS preflight request must be handled for the Route.
CorsConfig - Class in com.linecorp.armeria.server.cors
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 one CorsDecorator 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 more CorsDecorators 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.
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 the responseType, otherwise return null.
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 the Server using the format of Curator Service Discovery.
CuratorDiscoverySpecBuilder - Class in com.linecorp.armeria.client.zookeeper
CuratorRegistrationSpecBuilder - Class in com.linecorp.armeria.server.zookeeper
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 the CuratorFramework.
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.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
 
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(EventLoopGroup) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns the available DatagramChannel class for eventLoopGroup, for use in configuring a custom Bootstrap.
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.
Decodes an HttpData and returns the decoded HttpData.
decode(HttpData) - Method in interface com.linecorp.armeria.common.encoding.StreamDecoder
Decodes an HttpData and returns the decoded HttpData.
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.
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 an HttpResponse.
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 an HttpRequest.
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 this HttpService with the specified DecoratingHttpServiceFunction.
decorate(DecoratingRpcServiceFunction) - Method in interface com.linecorp.armeria.server.RpcService
Creates a new RpcService that decorates this RpcService with the specified DecoratingRpcServiceFunction.
decorate(Function<? super HttpService, R>) - Method in interface com.linecorp.armeria.server.HttpService
Creates a new Service that decorates this HttpService with the specified decorator.
decorate(Function<? super RpcService, ? extends RpcService>) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
A Function<? super RpcService, ? extends RpcService> to decorate the RpcService.
decorate(Function<? super RpcService, R>) - Method in interface com.linecorp.armeria.server.RpcService
Creates a new Service that decorates this RpcService with the specified decorator.
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
A ClientFactory that delegates the creation of Clients to another ClientFactory.
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 with ClientBuilder.decorator(DecoratingHttpClientFunction).
DecoratingHttpServiceFunction - Interface in com.linecorp.armeria.server
A functional interface that enables building a SimpleDecoratingHttpService with HttpService.decorate(DecoratingHttpServiceFunction).
DecoratingRpcClientFunction - Interface in com.linecorp.armeria.client
A functional interface that enables building a SimpleDecoratingRpcClient with ClientBuilder.rpcDecorator(DecoratingRpcClientFunction).
DecoratingRpcServiceFunction - Interface in com.linecorp.armeria.server
A functional interface that enables building a SimpleDecoratingRpcService with RpcService.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
A Service that decorates another Service.
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 with Route fluently.
decoration() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the Functions 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 HttpServices with the specified DecoratingHttpServiceFunction.
decorator(DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates all HttpServices with the specified DecoratingHttpServiceFunction.
decorator(Route, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates HttpServices with the specified Route.
decorator(Route, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates HttpServices whose Route matches the specified Route.
decorator(Route, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates HttpServices with the specified Route.
decorator(Route, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates HttpServices whose Route matches the specified Route.
decorator(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates HttpServices whose Route matches the specified pathPattern.
decorator(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates HttpServices whose Route matches the specified pathPattern.
decorator(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates HttpServices whose Route matches the specified pathPattern.
decorator(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates HttpServices whose Route matches the specified pathPattern.
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 HttpServices with the specified decorator.
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 HttpServices with the specified decorator.
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 an HttpRequest 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 HttpServices under the specified directory.
decoratorUnder(String, DecoratingHttpServiceFunction) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates HttpServices under the specified directory.
decoratorUnder(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates HttpServices under the specified directory.
decoratorUnder(String, Function<? super HttpService, ? extends HttpService>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates HttpServices under the specified directory.
Default - Annotation Type in com.linecorp.armeria.server.annotation
Specifies the default value of an optional parameter.
defaultBackoffSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the backoffSpec parameter when instantiating a Backoff using Backoff.of(String).
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, 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
defaultHttp2InitialStreamWindowSize() - Static method in class com.linecorp.armeria.common.Flags
defaultHttp2MaxFrameSize() - Static method in class com.linecorp.armeria.common.Flags
defaultHttp2MaxHeaderListSize() - Static method in class com.linecorp.armeria.common.Flags
defaultHttp2MaxStreamsPerConnection() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the ServerBuilder.http2MaxStreamsPerConnection(long) option.
defaultLogName() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).
defaultLogName(String) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
 
defaultLogName(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
defaultLogName(String) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Sets the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).
defaultLogName(String) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
 
defaultLogName(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
defaultMaxRequestLength() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side maximum length of a request.
defaultMaxResponseLength() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side maximum length of a response.
defaultMaxServerConnectionAgeMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side max age of a connection for keep-alive in milliseconds.
defaultMaxTotalAttempts() - Static method in class com.linecorp.armeria.common.Flags
Returns the default maximum number of total attempts.
defaultMimeType() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the default MIME type of this endpoint.
defaultMimeType(MediaType) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
Sets the default MediaType.
defaultNonLoopbackIpV4Address() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Returns the non-loopback Inet4Address whose NetworkInterface.getIndex() is the lowest.
defaultPingIntervalMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value for the PING interval.
defaultPort() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns the default INET port number of this protocol.
defaultPort(int) - Method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroupBuilder
Sets the default port number which is used when parsing an Endpoint without a port number.
defaultRegistry() - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
defaultRequestTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side timeout of a request in milliseconds.
defaultResponseTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side timeout of a response in milliseconds.
defaultSerializationFormat() - Method in class com.linecorp.armeria.server.thrift.THttpService
Returns the default SerializationFormat of this service.
defaultSerializationFormat(SerializationFormat) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
Adds the default serialization format which will be used when the client does not specify one in request.
defaultServerIdleTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side idle timeout of a connection for keep-alive in milliseconds.
defaultServiceName() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the default value of the RequestOnlyLog.serviceName() property which is used when no service name was set via RequestLogBuilder.name(String, String).
defaultServiceName(String) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
 
defaultServiceName(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
defaultServiceName(String) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Sets the default value of the RequestOnlyLog.serviceName() property which is used when no service name was set via RequestLogBuilder.name(String, String).
defaultServiceName(String) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
 
defaultServiceName(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
DefaultServiceRequestContext - Class in com.linecorp.armeria.server
Default ServiceRequestContext implementation.
DefaultServiceRequestContext(ServiceConfig, Channel, MeterRegistry, SessionProtocol, RequestId, RoutingContext, RoutingResult, HttpRequest, SSLSession, ProxiedAddresses, InetAddress, long, long) - Constructor for class com.linecorp.armeria.server.DefaultServiceRequestContext
Creates a new instance.
DefaultStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A StreamMessage which buffers the elements to be signaled into a Queue.
DefaultStreamMessage() - Constructor for class com.linecorp.armeria.common.stream.DefaultStreamMessage
Creates a new instance.
DefaultStreamMessageDuplicator<T> - Class in com.linecorp.armeria.common.stream
A default duplicator.
DefaultStreamMessageDuplicator(StreamMessage<T>, SignalLengthGetter<? super T>, EventExecutor, long) - Constructor for class com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator
Creates a new instance.
defaultSubscriberExecutor() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
defaultSubscriberExecutor() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns the default EventExecutor which will be used when a user subscribes using StreamMessage.subscribe(Subscriber), StreamMessage.subscribe(Subscriber, SubscriptionOption...).
defaultSubscriberExecutor() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
defaultUseHttp1Pipelining() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the ClientFactoryBuilder.useHttp1Pipelining(boolean) option.
defaultUseHttp2Preface() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the ClientFactoryBuilder.useHttp2Preface(boolean) option.
defaultValue() - Method in class com.linecorp.armeria.common.util.AbstractOption
Returns the default value of this option.
defaultVirtualHost() - Method in class com.linecorp.armeria.server.ServerBuilder
Returns the VirtualHostBuilder for building the default name-based virtual host.
defaultVirtualHost() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default VirtualHost, which is used when no other VirtualHosts match the host name of a client request. e.g. the "Host" header in HTTP or host name in TLS SNI extension
defaultWriteTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side timeout of a socket write attempt in milliseconds.
defer(RequestLogProperty) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
defer(RequestLogProperty...) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
defer(Iterable<RequestLogProperty>) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
deferredStatusException() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns a deferred HttpStatusException which was previously set via RoutingContext.deferStatusException(HttpStatusException).
DeferredStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A StreamMessage whose stream is published later by another StreamMessage.
DeferredStreamMessage() - Constructor for class com.linecorp.armeria.common.stream.DeferredStreamMessage
 
deferStatusException(HttpStatusException) - Method in interface com.linecorp.armeria.server.RoutingContext
Defers throwing an HttpStatusException until reaching the end of the service list.
define(Class<?>, String, V, AbstractOption.Factory<T, U, V>, Function<V, V>, BiFunction<U, U, U>) - Static method in class com.linecorp.armeria.common.util.AbstractOption
Defines a new option.
define(String, T) - Static method in class com.linecorp.armeria.client.ClientFactoryOption
Defines a new ClientFactoryOption of the specified name and default value.
define(String, T) - Static method in class com.linecorp.armeria.client.ClientOption
Defines a new ClientOption of the specified name and default value.
define(String, T, Function<T, T>, BiFunction<ClientFactoryOptionValue<T>, ClientFactoryOptionValue<T>, ClientFactoryOptionValue<T>>) - Static method in class com.linecorp.armeria.client.ClientFactoryOption
Defines a new ClientFactoryOption of the specified name, default value and merge function.
define(String, T, Function<T, T>, BiFunction<ClientOptionValue<T>, ClientOptionValue<T>, ClientOptionValue<T>>) - Static method in class com.linecorp.armeria.client.ClientOption
Defines a new ClientOption of the specified name, default value and merge function.
deflate() - Static method in interface com.linecorp.armeria.client.encoding.StreamDecoderFactory
Deprecated.
Returns the StreamDecoderFactory for "deflate" content encoding.
deflate() - Static method in interface com.linecorp.armeria.common.encoding.StreamDecoderFactory
Returns the StreamDecoderFactory for "deflate" content encoding.
deframe(HttpData, boolean) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Adds the given data to this deframer and attempts delivery to the listener.
DeframedMessage(ByteBuf, int) - Constructor for class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
Creates a new instance with the specified ByteBuf and type.
DeframedMessage(InputStream, int) - Constructor for class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
Creates a new instance with the specified InputStream and type.
delayed(AggregatedHttpResponse, Duration) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the provided AggregatedHttpResponse, beginning publishing after delay has passed from a random ScheduledExecutorService.
delayed(AggregatedHttpResponse, Duration, ScheduledExecutorService) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the provided AggregatedHttpResponse, beginning publishing after delay has passed from the provided ScheduledExecutorService.
delayed(HttpResponse, Duration) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the provided HttpResponse, beginning publishing after delay has passed from a random ScheduledExecutorService.
delayed(HttpResponse, Duration, ScheduledExecutorService) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the provided HttpResponse, beginning publishing after delay has passed from the provided ScheduledExecutorService.
delegate() - Method in class com.linecorp.armeria.common.RequestContextWrapper
Returns the delegate context.
delegate() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
Returns the delegate Publisher.
delegate() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
Returns the StreamMessage being decorated.
delegate(StreamMessage<T>) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
Sets the upstream StreamMessage which will actually publish the stream.
delete(String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP DELETE request.
delete(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
delete(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
delete(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
delete(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
Delete - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.DELETE onto specific method.
DELETE - com.linecorp.armeria.common.HttpMethod
The DELETE method which requests that the origin server delete the resource identified by the Request-URI.
Description - Annotation Type in com.linecorp.armeria.server.annotation
An annotation used in annotated HTTP service.
deserializeMessage(MethodDescriptor.Marshaller<T>, InputStream) - Method in interface com.linecorp.armeria.common.grpc.GrpcJsonMarshaller
Deserializes a gRPC message from JSON.
destinationAddresses() - Method in class com.linecorp.armeria.server.ProxiedAddresses
Returns the destination addresses of the proxied request.
detachAndStopAllAppenders() - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
detachAppender(Appender<ILoggingEvent>) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
detachAppender(String) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
direct() - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Returns a ProxyConfig which signifies that a proxy is absent.
DIRECT - com.linecorp.armeria.client.proxy.ProxyType
Proxy is absent.
directEventLoop() - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a special EventLoop which executes submitted tasks in the caller thread.
DirectProxyConfig - Class in com.linecorp.armeria.client.proxy
Represents a direct connection without a proxy.
disable() - Static method in class com.linecorp.armeria.common.reactor3.RequestContextHooks
Disables RequestContext during Reactor operations.
disable() - Static method in class com.linecorp.armeria.common.rxjava2.RequestContextAssembly
Disable RequestContext during operators.
disable() - Static method in class com.linecorp.armeria.common.rxjava3.RequestContextAssembly
Disable RequestContext during operators.
disable(MediaType...) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes NOT to produce the preview when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
disable(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes NOT to produce the preview when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
disable(BiPredicate<? super RequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified BiPredicate NOT to produce the preview when the predicate returns true.
disabled() - Static method in interface com.linecorp.armeria.common.logging.ContentPreviewer
Returns a dummy ContentPreviewer which produces null.
disabled() - Static method in interface com.linecorp.armeria.server.logging.AccessLogWriter
Returns disabled access log writer.
DISABLED - Static variable in class com.linecorp.armeria.common.ServerCacheControl
"no-cache, no-store, must-revalidate".
DISABLED - Static variable in interface com.linecorp.armeria.server.RejectedRouteHandler
A RejectedRouteHandler that does nothing for a problematic Route.
disableDateHeader() - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the response header not to include default "Date" header.
disablePreflightResponseHeaders() - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
disablePreflightResponseHeaders() - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
disablePreflightResponseHeaders() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Specifies that no preflight response headers should be added to a preflight response.
disableServerHeader() - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the response header not to include default "Server" header.
disableShutdownHook() - Static method in interface com.linecorp.armeria.client.ClientFactory
Disables the shutdown hook which closes the default ClientFactory.
distributionStatisticConfig() - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns the DistributionStatisticConfig to use when the factory methods in MoreMeters create a Timer or a DistributionSummary.
DnsAddressEndpointGroup - Class in com.linecorp.armeria.client.endpoint.dns
DynamicEndpointGroup which resolves targets using DNS address queries (A and AAAA).
DnsAddressEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.dns
Builds a new DnsAddressEndpointGroup that sources its Endpoint list from the A or AAAA DNS records of a certain hostname.
dnsQueryLifecycleObserverFactory(DnsQueryLifecycleObserverFactory) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets DnsQueryLifecycleObserverFactory that is used to generate objects which can observe individual DNS queries.
dnsResolutionDurationNanos() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the duration which was taken to resolve a domain name, in nanoseconds.
dnsResolutionEnd() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimingsBuilder
Sets the time when the client ended to resolve a domain name.
dnsResolutionStartTimeMicros() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the time when the client started to resolve a domain name, in microseconds since the epoch.
dnsResolutionStartTimeMillis() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the time when the client started to resolve a domain name, in milliseconds since the epoch.
DnsResolverGroupBuilder - Class in com.linecorp.armeria.client
Builds an AddressResolverGroup which builds AddressResolvers that update DNS caches automatically.
dnsServerAddressStreamProvider(DnsServerAddressStreamProvider) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets DnsServerAddressStreamProvider which is used to determine which DNS server is used to resolve each hostname.
DnsServiceEndpointGroup - Class in com.linecorp.armeria.client.endpoint.dns
DynamicEndpointGroup which resolves targets using DNS SRV records.
DnsServiceEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.dns
Builds a new DnsServiceEndpointGroup that sources its Endpoint list from the SRV DNS records of a certain hostname.
DnsTextEndpointGroup - Class in com.linecorp.armeria.client.endpoint.dns
DynamicEndpointGroup which resolves targets using DNS TXT records.
DnsTextEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.dns
Builds a new DnsTextEndpointGroup that sources its Endpoint list from the TXT DNS records of a certain hostname.
DnsTimeoutException - Exception in com.linecorp.armeria.client
A TimeoutException raised when a response has not been received from a DNS server within timeout.
DnsTimeoutException(String) - Constructor for exception com.linecorp.armeria.client.DnsTimeoutException
Creates a new instance.
DNT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "DNT" header field name.
doCancel() - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
Completes this CompletableFuture with a CancellationException, unless already completed.
doCloseAsync(CompletableFuture<?>) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.
doCloseAsync(CompletableFuture<?>) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
 
doCloseAsync(CompletableFuture<?>) - Method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
 
doCloseAsync(CompletableFuture<?>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
 
doCloseAsync(CompletableFuture<?>) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup
 
doComplete(T) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
Completes with a non-exceptional @{code value}, unless already completed.
doCompleteExceptionally(Throwable) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
Completes with the specified Throwable, unless already completed.
DocService - Class in com.linecorp.armeria.server.docs
An HttpService that provides information about the Services running in a Server.
DocService() - Constructor for class com.linecorp.armeria.server.docs.DocService
Creates a new instance.
DocServiceBuilder - Class in com.linecorp.armeria.server.docs
Builds a new DocService.
DocServiceConfigurator - Exception in com.linecorp.armeria.spring
Configures a DocService built by Armeria auto configuration.
DocServiceConfigurator - Interface in com.linecorp.armeria.spring
Configures a DocService built by Armeria auto configuration.
DocServiceFilter - Interface in com.linecorp.armeria.server.docs
A filter which includes or excludes service methods when building a DocService.
DocServicePlugin - Interface in com.linecorp.armeria.server.docs
Generates the ServiceSpecifications of the supported Services.
docString() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
docString() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
Returns the documentation string that describes the enum value.
docString() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
docString() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the documentation string of the field.
docString() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the documentation string of the function.
docString() - Method in interface com.linecorp.armeria.server.docs.NamedTypeInfo
Returns the documentation string.
docString() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the documentation string.
docString() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
docString(String) - Method in class com.linecorp.armeria.server.docs.FieldInfoBuilder
Sets the documentation string of the field.
DocStringExtractor - Class in com.linecorp.armeria.server.docs
A supporting base class for implementing the standard pattern of extracting docstrings from arbitrary files in a particular classpath location.
DocStringExtractor(String, String) - Constructor for class com.linecorp.armeria.server.docs.DocStringExtractor
 
DocumentationProcessor - Class in com.linecorp.armeria.server.annotation.processor
Processor that creates a properties file based on the JavaDoc/KDoc description of parameters for interfaces.
DocumentationProcessor() - Constructor for class com.linecorp.armeria.server.annotation.processor.DocumentationProcessor
 
doDelete(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a DELETE request.
doExecute(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.retry.RetryingClient
 
doExecute(ClientRequestContext, HttpRequest, CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
 
doExecute(ClientRequestContext, RpcRequest) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClient
 
doExecute(ClientRequestContext, RpcRequest, CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
 
doExecute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Invoked by AbstractRetryingClient.execute(ClientRequestContext, Request) after the deadline for response timeout is set.
doExecute(ClientRequestContext, I, CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClient
Invoked when the CircuitBreaker is in closed state.
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a GET request.
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.file.FileService
 
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.metric.PrometheusExpositionService
 
doHead(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a HEAD request.
domain() - Method in interface com.linecorp.armeria.common.Cookie
Returns the domain of this Cookie.
domain(String) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the domain of the Cookie.
domainNameResolverCustomizer(Consumer<? super DnsResolverGroupBuilder>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Adds the specified Consumer which customizes the given DnsNameResolverBuilder.
doNewValue(T) - Method in class com.linecorp.armeria.client.ClientFactoryOption
 
doNewValue(T) - Method in class com.linecorp.armeria.client.ClientOption
 
doNewValue(V) - Method in class com.linecorp.armeria.common.util.AbstractOption
Implement this method to return a new option value.
doNextDelayMillis(int) - Method in class com.linecorp.armeria.client.retry.AbstractBackoff
Invoked by AbstractBackoff.nextDelayMillis(int) after numAttemptsSoFar is validated.
doOptions(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles an OPTIONS request.
doPatch(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a PATCH request.
doPost(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a POST request.
doPost(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.grpc.protocol.AbstractUnsafeUnaryGrpcService
 
doPost(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.metric.PrometheusExpositionService
 
doPut(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a PUT request.
doRead(ResponseHeaders, long, Executor, ByteBufAllocator) - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
Returns a new HttpResponse which streams the content of the file which follows the specified ResponseHeaders.
doRead(ResponseHeaders, long, Executor, ByteBufAllocator) - Method in class com.linecorp.armeria.server.file.StreamingHttpFile
 
doStart(T) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked by StartStopSupport.start(Object, boolean) to perform the actual startup.
doStop(U) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked by StartStopSupport.stop(Object) to perform the actual startup, or indirectly by StartStopSupport.start(Object, boolean) when startup failed.
doTrace(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a TRACE request.
DropwizardMeterRegistries - Class in com.linecorp.armeria.common.metric
Provides the convenient factory methods for DropwizardMeterRegistry with more sensible defaults for NamingConvention and HierarchicalNameMapper.
dump(OutputStream) - Method in interface com.linecorp.armeria.server.Router
Dumps the content of this Router.
dumpAfterStart(boolean) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets whether the Jetty Server needs to dump its configuration after it started up.
dumpBeforeStop(boolean) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets whether the Jetty Server needs to dump its configuration before it shuts down.
dumpOpenSslInfo() - Static method in class com.linecorp.armeria.common.Flags
Returns whether information about the OpenSSL environment should be dumped when first starting the application, including supported ciphers.
duplicate() - Method in interface com.linecorp.armeria.common.HttpRequestDuplicator
Returns a new HttpRequest that publishes the same HttpDatas and trailers as the HttpRequest that this duplicator is created from.
duplicate() - Method in interface com.linecorp.armeria.common.HttpResponseDuplicator
Returns a new HttpResponse that publishes the same ResponseHeaders, HttpDatas and trailers as the HttpResponse that this duplicator is created from.
duplicate() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator
 
duplicate() - Method in interface com.linecorp.armeria.common.stream.StreamMessageDuplicator
Returns a new StreamMessage that publishes the same elements as the StreamMessage that this duplicator is created from.
duplicate(RequestHeaders) - Method in interface com.linecorp.armeria.common.HttpRequestDuplicator
Returns a new HttpRequest with the specified RequestHeaders that publishes the same HttpDatas and trailers as the HttpRequest that this duplicator is created from.
DUPLICATE - com.linecorp.armeria.common.ByteBufAccessMode
Gets the duplicate (or slice) of the underlying ByteBuf.
duplicatorExecutor() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator
Returns the default EventExecutor which will be used when a user subscribes to a child stream using StreamMessage.subscribe(Subscriber, SubscriptionOption...).
DynamicEndpointGroup - Class in com.linecorp.armeria.client.endpoint
A dynamic EndpointGroup.
DynamicEndpointGroup() - Constructor for class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
DynamicEndpointGroup(EndpointSelectionStrategy) - Constructor for class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Creates a new empty DynamicEndpointGroup that uses the specified EndpointSelectionStrategy.

E

EARLY_DATA - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Early-Data" header field name.
elapsed(long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Creates a new StringBuilder whose content is the human-readable representation of the duration given as elapsed.
elapsed(long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Creates a new StringBuilder whose content is the human-readable representation of the duration between the specified startTimeNanos and endTimeNanos.
ELAPSED_NANOS - com.linecorp.armeria.common.logging.BuiltInProperty
"elapsed_nanos" - the amount of time in nanoseconds taken to handle the request.
elapsedAndSize(long, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
EMAIL - com.linecorp.armeria.server.saml.SamlNameIdFormat
Email name format.
empty() - Static method in interface com.linecorp.armeria.common.HttpData
Returns an empty HttpData.
empty() - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Returns a singleton empty ServerSentEvent.
empty() - Static method in class com.linecorp.armeria.server.Routed
Returns a singleton instance of a Routed that represents a non-existent value.
empty() - Static method in class com.linecorp.armeria.server.RoutingResult
EMPTY - Static variable in class com.linecorp.armeria.common.ClientCacheControl
An empty instance with all directives disabled.
EMPTY - Static variable in class com.linecorp.armeria.common.ServerCacheControl
An empty instance with all directives disabled.
EmptyEndpointGroupException - Exception in com.linecorp.armeria.client.endpoint
An EndpointGroupException raised when the resolution of an EndpointGroup fails because there are no Endpoints in the EndpointGroup.
EmptyFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that publishes no objects, just a close event.
EmptyFixedStreamMessage() - Constructor for class com.linecorp.armeria.common.stream.EmptyFixedStreamMessage
 
enable() - Static method in class com.linecorp.armeria.common.reactor3.RequestContextHooks
Enables RequestContext during Reactor operations.
enable() - Static method in class com.linecorp.armeria.common.rxjava2.RequestContextAssembly
Enable RequestContext during operators.
enable() - Static method in class com.linecorp.armeria.common.rxjava3.RequestContextAssembly
Enable RequestContext during operators.
enableUnframedRequests(boolean) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets whether the service handles requests not framed using the gRPC wire protocol.
encodableContentTypes(MediaType...) - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
Sets the specified MediaTypes to evaluate whether the content type of the HttpResponse is encodable or not.
encodableContentTypes(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
Sets the specified MediaTypes to evaluate whether the content type of the HttpResponse is encodable or not.
encodableContentTypes(Predicate<MediaType>) - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
Sets the specified Predicate to evaluate whether the content type of the HttpResponse is encodable or not.
encodableRequestHeaders(Predicate<? super RequestHeaders>) - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
Sets the specified Predicate to evaluate whether the corresponding HttpResponse of the HttpRequest whose RequestHeaders is the input of the Predicate is encodable or not.
encodedInstance() - Method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
Returns the byte array representation of the Server.
encodingHeaderValue() - Method in interface com.linecorp.armeria.client.encoding.StreamDecoderFactory
Deprecated.
Returns the value of the Content-Encoding header which this factory applies to.
encodingHeaderValue() - Method in interface com.linecorp.armeria.common.encoding.StreamDecoderFactory
Returns the value of the Content-Encoding header which this factory applies to.
EncodingService - Class in com.linecorp.armeria.server.encoding
Decorates an HttpService to apply HTTP encoding (e.g., gzip) to an HttpService.
EncodingServiceBuilder - Class in com.linecorp.armeria.server.encoding
Builds a new EncodingService or its decorator function.
ENCRYPTED - com.linecorp.armeria.server.saml.SamlNameIdFormat
Used by NameIDPolicy to indicate a NameID should be encrypted.
encryptionCredential() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns a Credential of the identity provider for encryption.
encryptionKey(String) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets an encryption key name for an identity provider.
encryptionKey(String) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets an encryption key name for this service provider.
endOfStream() - Method in interface com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.Listener
Called when the stream is complete and all messages have been successfully delivered.
endOfStream(boolean) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets whether the headers will be the last frame in an HTTP/2 stream.
endOfStream(boolean) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
endOfStream(boolean) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
endpoint() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the remote Endpoint of the current Request.
endpoint() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
endpoint() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
endpoint() - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckerContext
Returns the Endpoint to send health check requests to.
endpoint() - Method in class com.linecorp.armeria.server.saml.SamlAssertionConsumerConfig
Returns a SamlEndpoint that an assertion consumer service is to be bound to.
endpoint(Endpoint) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
Sets the Endpoint of the request.
endpoint(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the Endpoint of the specified SessionProtocol for the Server.
endpoint(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the Endpoint of the specified SessionProtocol for the Server.
endpoint(SamlEndpoint) - Method in class com.linecorp.armeria.server.saml.SamlAssertionConsumerConfigBuilder
Sets an endpoint of this assertion consumer service.
Endpoint - Class in com.linecorp.armeria.client
A remote endpoint that refers to a single host.
ENDPOINT_REMAPPER - Static variable in class com.linecorp.armeria.client.ClientOptions
A Function that remaps a target Endpoint into an EndpointGroup.
endpointGroup() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the EndpointGroup of the client.
endpointGroup() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the EndpointGroup used for the current Request.
endpointGroup() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
endpointGroup() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
endpointGroup() - Method in class com.linecorp.armeria.client.UserClient
 
EndpointGroup - Interface in com.linecorp.armeria.client.endpoint
A list of Endpoints.
EndpointGroupException - Exception in com.linecorp.armeria.client.endpoint
A RuntimeException raised when the resolution of an EndpointGroup fails.
EndpointGroupException() - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance.
EndpointGroupException(String) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified message.
EndpointGroupException(String, Throwable) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified message and cause.
EndpointGroupException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
EndpointGroupException(Throwable) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified cause.
EndpointInfo - Class in com.linecorp.armeria.server.docs
Metadata about the endpoints exposed by a Service.
EndpointInfoBuilder - Class in com.linecorp.armeria.server.docs
Creates a new EndpointInfo using the builder pattern.
endpointRemapper() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the Function that remaps a target Endpoint into an EndpointGroup.
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets a Function that remaps an Endpoint into an EndpointGroup.
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.client.ClientBuilder
 
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
endpointRemapper(Function<? super Endpoint, ? extends EndpointGroup>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
endpoints() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
endpoints() - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns the endpoints held by this EndpointGroup.
endpoints() - Method in class com.linecorp.armeria.client.Endpoint
 
endpoints() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the endpoints for accessing this method.
EndpointSelectionStrategy - Interface in com.linecorp.armeria.client.endpoint
Endpoint selection strategy that creates a EndpointSelector.
EndpointSelector - Interface in com.linecorp.armeria.client.endpoint
Selects an Endpoint from an EndpointGroup.
endRequest() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Request information.
endRequest(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Request information.
endRequest(Throwable) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Request information.
endRequest(Throwable, long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Request information.
endResponse() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Response information.
endResponse(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Response information.
endResponse(Throwable) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Response information.
endResponse(Throwable, long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Finishes the collection of the Response information.
endResponseWithLastChild() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Fills the response-side logs from the last added child.
engineName(String) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
Sets the name of the StandardEngine of an embedded Tomcat.
enqueue(AggregatedHttpResponse) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
Enqueues the AggregatedHttpResponse to return to a client of this MockWebServerExtension.
enqueue(HttpResponse) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
Enqueues the HttpResponse to return to a client of this MockWebServerExtension.
ensureAvailable(RequestLogProperty) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLog that is guaranteed to have the specified RequestLogProperty.
ensureAvailable(RequestLogProperty...) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLog that is guaranteed to have all the specified RequestLogPropertys.
ensureAvailable(Iterable<RequestLogProperty>) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLog that is guaranteed to have all the specified RequestLogPropertys.
ensureComplete() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLog that is guaranteed to have all properties, for both request and response side.
ensureRequestComplete() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLog that is guaranteed to have all request-side properties.
ENTITY - com.linecorp.armeria.server.saml.SamlNameIdFormat
SAML entity name format.
entityId() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns an entity ID of the identity provider.
entityId(String) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets an entity ID for an identity provider.
entityId(String) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets an entity ID for this service provider.
entityTag(boolean) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Sets whether to set the "etag" header automatically based on the path and attributes of the file.
entityTag(boolean) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
 
entityTag(boolean) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
 
entityTag(BiFunction<String, HttpFileAttributes, String>) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Sets the function which generates the entity tag that's used for setting the "etag" header automatically.
entityTag(BiFunction<String, HttpFileAttributes, String>) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
 
entityTag(BiFunction<String, HttpFileAttributes, String>) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
 
entityTagFunction() - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Returns the function which generates the entity tag that's used for setting the "etag" header automatically.
entries() - Method in class com.linecorp.armeria.common.SerializationFormatProvider
entries() - Method in class com.linecorp.armeria.server.thrift.ThriftCallService
Returns the information about the Thrift services being served.
entries() - Method in class com.linecorp.armeria.server.thrift.THttpService
Returns the information about the Thrift services being served.
Entry(String, MediaType, MediaType...) - Constructor for class com.linecorp.armeria.common.SerializationFormatProvider.Entry
Creates a new instance.
entryCacheSpec() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
Returns the cache spec of the file entry cache, as defined in CaffeineSpec.
entryCacheSpec(String) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
Sets the cache spec for caching file entries.
EnumInfo - Class in com.linecorp.armeria.server.docs
Metadata about an enum type.
EnumInfo(Class<? extends Enum<?>>) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(Class<? extends Enum<?>>, String) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Class<? extends Enum<?>>) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Class<? extends Enum<?>>, String) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Iterable<EnumValueInfo>) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Iterable<EnumValueInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
enums() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the enums related with the services in this specification.
EnumValueInfo - Class in com.linecorp.armeria.server.docs
Metadata about an enum value.
EnumValueInfo(String) - Constructor for class com.linecorp.armeria.server.docs.EnumValueInfo
Creates a new instance.
EnumValueInfo(String, Integer) - Constructor for class com.linecorp.armeria.server.docs.EnumValueInfo
Creates a new instance.
EnumValueInfo(String, Integer, String) - Constructor for class com.linecorp.armeria.server.docs.EnumValueInfo
Creates a new instance.
EOT - Static variable in class com.linecorp.armeria.common.MediaType
EOT - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.ms-fontobject".
epochMicros(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".
epochMillis(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".
EPUB - Static variable in class com.linecorp.armeria.common.MediaType
As described in the International Digital Publishing Forum EPUB is the distribution and interchange format standard for digital publications and documents.
EPUB - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/epub+zip".
equals(Object) - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
 
equals(Object) - Method in class com.linecorp.armeria.client.Endpoint
 
equals(Object) - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
 
equals(Object) - Method in class com.linecorp.armeria.client.proxy.HAProxyConfig
 
equals(Object) - Method in class com.linecorp.armeria.client.proxy.Socks4ProxyConfig
 
equals(Object) - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
 
equals(Object) - Method in class com.linecorp.armeria.common.auth.BasicToken
 
equals(Object) - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
 
equals(Object) - Method in class com.linecorp.armeria.common.auth.OAuth2Token
 
equals(Object) - Method in class com.linecorp.armeria.common.CacheControl
 
equals(Object) - Method in class com.linecorp.armeria.common.ClientCacheControl
 
equals(Object) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
 
equals(Object) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
equals(Object) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
equals(Object) - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the specified object is "equal to" this status.
equals(Object) - Method in class com.linecorp.armeria.common.MediaType
 
equals(Object) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
 
equals(Object) - Method in class com.linecorp.armeria.common.Scheme
 
equals(Object) - Method in class com.linecorp.armeria.common.SerializationFormat
 
equals(Object) - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
equals(Object) - Method in class com.linecorp.armeria.common.ServerCacheControl
 
equals(Object) - Method in class com.linecorp.armeria.common.thrift.ThriftCall
 
equals(Object) - Method in class com.linecorp.armeria.common.thrift.ThriftMessage
 
equals(Object) - Method in class com.linecorp.armeria.common.thrift.ThriftReply
 
equals(Object) - Method in class com.linecorp.armeria.common.util.AbstractOption
 
equals(Object) - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
 
equals(Object) - Method in class com.linecorp.armeria.server.ClientAddressSource
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.EndpointInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.MethodInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.StructInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.TypeSignature
 
equals(Object) - Method in class com.linecorp.armeria.server.file.HttpFileAttributes
 
equals(Object) - Method in class com.linecorp.armeria.server.ProxiedAddresses
 
equals(Object) - Method in class com.linecorp.armeria.server.RouteBuilder
 
equals(Object) - Method in class com.linecorp.armeria.server.saml.SamlEndpoint
 
equals(Object) - Method in class com.linecorp.armeria.server.ServerPort
 
equals(Object) - Method in class com.linecorp.armeria.testing.junit5.server.mock.RecordedRequest
 
ERROR - com.linecorp.armeria.common.logging.LogLevel
ERROR log level.
escape(String) - Static method in class com.linecorp.armeria.common.grpc.protocol.StatusMessageEscaper
Escape the provided unicode String into ascii.
ETAG - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "ETag" header field name.
EurekaEndpointGroup - Class in com.linecorp.armeria.client.eureka
A Eureka-based EndpointGroup implementation.
EurekaEndpointGroupBuilder - Class in com.linecorp.armeria.client.eureka
EurekaUpdatingListener - Class in com.linecorp.armeria.server.eureka
A ServerListener which registers the current Server to Eureka.
EurekaUpdatingListenerBuilder - Class in com.linecorp.armeria.server.eureka
Builds a EurekaUpdatingListener, which registers the server to Eureka.
event() - Method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Returns an event name of this event, if it exists.
event(String) - Method in class com.linecorp.armeria.common.sse.ServerSentEventBuilder
Sets the specified event.
EVENT_LOOP_SCHEDULER_FACTORY - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
EVENT_STREAM - Static variable in class com.linecorp.armeria.common.MediaType
As described in Server-Sent Events, this constant (text/event-stream) is used when sending notifications in the form of DOM events from a server.
EVENT_STREAM - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/event-stream".
EventCount - Class in com.linecorp.armeria.client.circuitbreaker
An immutable object that stores the count of events.
eventListener(Container.Listener) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Adds the specified event listener to the Jetty Server.
eventLoop() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
eventLoop() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the EventLoop that handles the request.
eventLoop() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the ContextAwareEventLoop that is handling the current Request.
eventLoop() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
eventLoop() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
eventLoop(boolean) - Method in class com.linecorp.armeria.common.util.ThreadFactoryBuilder
Sets event loop for new threads.
eventLoop(EventLoop) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
eventLoop(EventLoop) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
eventLoop(EventLoop) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
eventLoop(EventLoop) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
eventLoop(EventLoop) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the EventLoop that handles the request.
eventLoop(EventLoop) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
EventLoopCheckingFuture<T> - Class in com.linecorp.armeria.common.util
A CompletableFuture that warns the user if they call a method that blocks the event loop.
EventLoopCheckingFuture() - Constructor for class com.linecorp.armeria.common.util.EventLoopCheckingFuture
 
EventLoopExtension - Class in com.linecorp.armeria.testing.junit5.common
An Extension that provides an EventLoopGroup.
EventLoopExtension() - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
Creates a new Extension that provides an EventLoop.
EventLoopExtension(boolean) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
Creates a new Extension that provides an EventLoop.
EventLoopExtension(String) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
Creates a new Extension that provides an EventLoop.
EventLoopExtension(String, boolean) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
Creates a new Extension that provides an EventLoop.
eventLoopGroup() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the EventLoopGroup being used by this ClientFactory.
eventLoopGroup() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
EventLoopGroupExtension - Class in com.linecorp.armeria.testing.junit5.common
An Extension that provides an EventLoopGroup.
EventLoopGroupExtension(int) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopGroupExtension
Creates a new Extension that provides an EventLoopGroup.
EventLoopGroupExtension(int, boolean) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopGroupExtension
Creates a new Extension that provides an EventLoopGroup.
EventLoopGroupExtension(int, String) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopGroupExtension
Creates a new Extension that provides an EventLoopGroup.
EventLoopGroupExtension(int, String, boolean) - Constructor for class com.linecorp.armeria.testing.junit5.common.EventLoopGroupExtension
Creates a new Extension that provides an EventLoopGroup.
EventLoopGroupRule - Class in com.linecorp.armeria.testing.junit4.common
A TestRule that provides an EventLoopGroup.
EventLoopGroupRule(int) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
Creates a new TestRule that provides an EventLoopGroup.
EventLoopGroupRule(int, boolean) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
Creates a new TestRule that provides an EventLoopGroup.
EventLoopGroupRule(int, String) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
Creates a new TestRule that provides an EventLoopGroup.
EventLoopGroupRule(int, String, boolean) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
Creates a new TestRule that provides an EventLoopGroup.
EventLoopGroups - Class in com.linecorp.armeria.common.util
Provides methods that are useful for creating an EventLoopGroup.
EventLoopRule - Class in com.linecorp.armeria.testing.junit4.common
A TestRule that provides an EventLoopGroup.
EventLoopRule() - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopRule
Creates a new TestRule that provides an EventLoop.
EventLoopRule(boolean) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopRule
Creates a new TestRule that provides an EventLoop.
EventLoopRule(String) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopRule
Creates a new TestRule that provides an EventLoop.
EventLoopRule(String, boolean) - Constructor for class com.linecorp.armeria.testing.junit4.common.EventLoopRule
Creates a new TestRule that provides an EventLoop.
EventLoopScheduler - Interface in com.linecorp.armeria.client
A scheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
eventLoopSchedulerFactory() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
eventLoopSchedulerFactory(Function<? super EventLoopGroup, ? extends EventLoopScheduler>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
eventLoopSupplier() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns a Supplier that provides one of the EventLoops being used by this ClientFactory.
eventLoopSupplier() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
exact(String) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match the specified exact path.
EXACT - com.linecorp.armeria.server.RoutePathType
The exact path type. e.g, "/foo"
exampleHeaders() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the example HTTP headers of the method.
exampleHeaders() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the example HTTP headers of the service.
exampleHeaders() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the example HTTP headers of the services in this specification.
exampleHeaders(HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders which are applicable to any services.
exampleHeaders(Class<?>, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified type.
exampleHeaders(Class<?>, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified type.
exampleHeaders(Class<?>, String, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified type and method name.
exampleHeaders(Class<?>, String, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified type and method name.
exampleHeaders(Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders which are applicable to any services.
exampleHeaders(String, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified name.
exampleHeaders(String, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified name.
exampleHeaders(String, String, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified service and method name.
exampleHeaders(String, String, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified service and method name.
examplePaths() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the example paths of the method.
examplePaths(Class<?>, String, Iterable<String>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example paths for the method with the specified service and method name.
examplePaths(Class<?>, String, String...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example paths for the method with the specified service and method name.
examplePaths(String, String, Iterable<String>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example paths for the method with the specified service and method name.
examplePaths(String, String, String...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example paths for the method with the specified service and method name.
exampleQueries() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the example queries of the method.
exampleQueries(Class<?>, String, Iterable<String>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example query strings for the method with the specified service and method name.
exampleQueries(Class<?>, String, String...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example query strings for the method with the specified service and method name.
exampleQueries(String, String, Iterable<String>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example query strings for the method with the specified service and method name.
exampleQueries(String, String, String...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the specified example query strings for the method with the specified service and method name.
exampleRequests() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the list of the example request serialized in a string.
exampleRequests(Class<?>, String, Iterable<?>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service type and method name.
exampleRequests(Class<?>, String, Object...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service type and method name.
exampleRequests(Iterable<?>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests which are applicable to the method denoted by the specified example requests.
exampleRequests(String, String, Iterable<?>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service and method name.
exampleRequests(String, String, Object...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service and method name.
exception() - Method in class com.linecorp.armeria.common.thrift.ThriftReply
Returns the exception of this reply.
exceptionallyCompletedFuture(Throwable) - Static method in class com.linecorp.armeria.common.thrift.ThriftFuture
Returns a new ThriftFuture instance that has an exception set immediately.
exceptionallyCompletedFuture(Throwable) - Static method in class com.linecorp.armeria.common.thrift.ThriftListenableFuture
Returns a new ThriftListenableFuture instance that has an exception set immediately.
exceptionallyCompletedFuture(Throwable) - Static method in class com.linecorp.armeria.common.util.EventLoopCheckingFuture
Returns an EventLoopCheckingFuture which has been completed exceptionally with the specified Throwable.
exceptionallyCompletedFuture(Throwable) - Static method in class com.linecorp.armeria.common.util.UnmodifiableFuture
Returns an UnmodifiableFuture which has been completed exceptionally with the specified Throwable.
exceptionFilter() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Returns the Predicate of an Exception.
ExceptionHandler - Annotation Type in com.linecorp.armeria.server.annotation
Specifies an ExceptionHandlerFunction class which handles exceptions throwing from an annotated service method.
ExceptionHandlerFunction - Interface in com.linecorp.armeria.server.annotation
An interface for exception handler.
exceptionHandlers(ExceptionHandlerFunction...) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
exceptionHandlers(ExceptionHandlerFunction...) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
exceptionHandlers(Iterable<? extends ExceptionHandlerFunction>) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
exceptionHandlers(Iterable<? extends ExceptionHandlerFunction>) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
ExceptionHandlers - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for ExceptionHandler.
ExceptionInfo - Class in com.linecorp.armeria.server.docs
Metadata about an exception type.
ExceptionInfo(String, Iterable<FieldInfo>) - Constructor for class com.linecorp.armeria.server.docs.ExceptionInfo
Creates a new instance.
ExceptionInfo(String, Iterable<FieldInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.ExceptionInfo
Creates a new instance.
exceptions() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the exceptions related with the services in this specification.
Exceptions - Class in com.linecorp.armeria.common.util
Provides methods that are useful for handling exceptions.
exceptionTypeSignatures() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the metadata about the exceptions declared by the function.
ExceptionVerbosity - Enum in com.linecorp.armeria.server.annotation
The verbosity of exceptions logged by annotated HTTP services.
exclude(DocServiceFilter) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the DocServiceFilter that checks whether a method will be excluded while building DocService.
execute(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.brave.BraveClient
 
execute(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.encoding.DecodingClient
 
execute(ClientRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.client.HttpClient
 
execute(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.logging.ContentPreviewingClient
 
execute(ClientRequestContext, RpcRequest) - Method in interface com.linecorp.armeria.client.RpcClient
 
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClient
 
execute(ClientRequestContext, I) - Method in interface com.linecorp.armeria.client.Client
Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.limit.AbstractConcurrencyLimitingClient
 
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
 
execute(HttpClient, ClientRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.client.DecoratingHttpClientFunction
Sends an HttpRequest to a remote Endpoint, as specified in ClientRequestContext.endpoint().
execute(RpcClient, ClientRequestContext, RpcRequest) - Method in interface com.linecorp.armeria.client.DecoratingRpcClientFunction
Sends an RpcRequest to a remote Endpoint, as specified in ClientRequestContext.endpoint().
execute(AggregatedHttpRequest) - Method in interface com.linecorp.armeria.client.WebClient
Sends the specified HTTP request.
execute(HttpRequest) - Method in interface com.linecorp.armeria.client.WebClient
Sends the specified HTTP request.
execute(RequestHeaders) - Method in interface com.linecorp.armeria.client.WebClient
Sends an empty HTTP request with the specified headers.
execute(RequestHeaders, byte[]) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP request with the specified headers and content.
execute(RequestHeaders, HttpData) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP request with the specified headers and content.
execute(RequestHeaders, String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP request with the specified headers and content.
execute(RequestHeaders, String, Charset) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP request with the specified headers and content.
execute(SessionProtocol, EndpointGroup, HttpMethod, String, String, String, I) - Method in class com.linecorp.armeria.client.UserClient
Executes the specified Request via the delegate.
execute(SessionProtocol, HttpMethod, String, String, String, I) - Method in class com.linecorp.armeria.client.UserClient
Executes the specified Request via the delegate.
execute(String, byte[]) - Method in class com.linecorp.armeria.client.grpc.protocol.UnaryGrpcClient
Executes a unary gRPC client request.
execute(String, Class<?>, String, Object...) - Method in interface com.linecorp.armeria.client.thrift.THttpClient
Executes the specified Thrift call.
executeMultiplexed(String, Class<?>, String, String, Object...) - Method in interface com.linecorp.armeria.client.thrift.THttpClient
Executes the specified multiplexed Thrift call.
executor() - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckerContext
Returns the ScheduledExecutorService which is used for scheduling the tasks related with sending health check requests.
EXPECT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Expect" header field name.
EXPECTATION_FAILED - Static variable in class com.linecorp.armeria.common.HttpStatus
417 Expectation Failed.
expected() - Method in exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Returns the expected SessionProtocol.
EXPIRES - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Expires" header field name.
exponential(long, long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that waits an exponentially-increasing amount of time between attempts.
exponential(long, long, double) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that waits an exponentially-increasing amount of time between attempts.
export() - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
Returns a Map whose key is an export key set through add*() in RequestContextExporterBuilder and value is extracted from RequestContext.
export(RequestContext) - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
Returns a Map whose key is an export key set through add*() in RequestContextExporterBuilder and value is extracted from the specified RequestContext.
exposedHeaders() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
The headers to be exposed to calling clients.
exposedHeaders() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Returns a set of headers to be exposed to calling clients.
exposeHeaders(CharSequence...) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
exposeHeaders(CharSequence...) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
exposeHeaders(CharSequence...) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Specifies the headers to be exposed to calling clients.
exposeHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
exposeHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
exposeHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Specifies the headers to be exposed to calling clients.
EXTEND - com.linecorp.armeria.common.util.TimeoutMode
Extends the previously scheduled timeout.

F

factory() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the ClientFactory used for creating a client.
factory(ClientFactory) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the ClientFactory used for creating a client.
factory(ClientFactory) - Method in class com.linecorp.armeria.client.ClientBuilder
 
factory(ClientFactory) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
factory(ClientFactory) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
factory(ClientFactory) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
factory(ClientFactory) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
factory(ClientFactory) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
FACTORY - Static variable in class com.linecorp.armeria.client.ClientOptions
The ClientFactory used for creating a client.
FAIL - Static variable in interface com.linecorp.armeria.server.RejectedRouteHandler
A RejectedRouteHandler that raises an IllegalStateException for a problematic Route.
FAILED_DEPENDENCY - Static variable in class com.linecorp.armeria.common.HttpStatus
424 Failed Dependency (WebDAV, RFC4918).
FailFastException - Exception in com.linecorp.armeria.client.circuitbreaker
An exception indicating that a request has been failed by circuit breaker.
FailFastException(CircuitBreaker) - Constructor for exception com.linecorp.armeria.client.circuitbreaker.FailFastException
Creates a new instance with the specified CircuitBreaker.
failsafe() - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if the request HTTP method is idempotent and an Exception is raised or the class of the response status is HttpStatusClass.SERVER_ERROR.
failure() - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerDecision
Returns a CircuitBreakerDecision that reports a Response as a failure.
failure() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the number of failure events.
failureRate() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the failure rate (failure/total), or throws an ArithmeticException if total is 0.
failureRateThreshold(double) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the threshold of failure rate to detect a remote service fault.
failureResponseLogLevel() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.LoggingDecorator
The LogLevel to use when logging failure responses (e.g., failed with an exception).
failureResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
failureResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
failureResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
failureResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
fakeChannel() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns a fake Channel which is required internally when creating a context.
fallthrough() - Static method in interface com.linecorp.armeria.server.annotation.ExceptionHandlerFunction
Throws a FallthroughException in order to try to handle the Throwable by the next handler.
fallthrough() - Static method in interface com.linecorp.armeria.server.annotation.RequestConverterFunction
Throws a FallthroughException in order to try to convert the request to an object by the next converter.
fallthrough() - Static method in interface com.linecorp.armeria.server.annotation.ResponseConverterFunction
Throws a FallthroughException in order to try to convert result to HttpResponse by the next converter.
FallthroughException - Exception in com.linecorp.armeria.server.annotation
A RuntimeException raised for falling through to the next something.
fibonacci(long, long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff for which the backoff delay increases in line with the Fibonacci sequence f(n) = f(n-1) + f(n-2) where f(0) = f(1) = initialDelayMillis.
FieldInfo - Class in com.linecorp.armeria.server.docs
Metadata about a field of a struct or an exception.
FieldInfoBuilder - Class in com.linecorp.armeria.server.docs
Creates a new FieldInfo using the builder pattern.
FieldLocation - Enum in com.linecorp.armeria.server.docs
The location of a field.
FieldRequirement - Enum in com.linecorp.armeria.server.docs
The requirement level of a field.
fields() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
Returns the metadata about the fields of the type.
fields() - Method in class com.linecorp.armeria.server.docs.StructInfo
Returns the metadata about the fields of the type.
FILE_NAME_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
FileService - Class in com.linecorp.armeria.server.file
An HttpService that serves static files from a file system.
FileServiceBuilder - Class in com.linecorp.armeria.server.file
Builds a new FileService and its FileServiceConfig.
fileServiceCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the fileServiceCache parameter.
FileServiceConfig - Class in com.linecorp.armeria.server.file
FileService configuration.
fillInStackTrace() - Method in exception com.linecorp.armeria.client.circuitbreaker.FailFastException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.client.DnsTimeoutException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.client.SessionProtocolNegotiationException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.client.UnprocessedRequestException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.common.grpc.StatusCauseException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.common.ProtocolViolationException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.server.annotation.FallthroughException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.server.HttpResponseException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.server.saml.SamlException
 
filter(T) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
The filter to apply to published objects.
FilteredHttpRequest - Class in com.linecorp.armeria.common
An HttpRequest that filters objects as they are published.
FilteredHttpRequest(HttpRequest) - Constructor for class com.linecorp.armeria.common.FilteredHttpRequest
Creates a new FilteredHttpRequest that filters objects published by delegate before passing to a subscriber.
FilteredHttpRequest(HttpRequest, boolean) - Constructor for class com.linecorp.armeria.common.FilteredHttpRequest
(Advanced users only) Creates a new FilteredHttpRequest that filters objects published by delegate before passing to a subscriber.
FilteredHttpResponse - Class in com.linecorp.armeria.common
An HttpResponse that filters objects as they are published.
FilteredHttpResponse(HttpResponse) - Constructor for class com.linecorp.armeria.common.FilteredHttpResponse
Creates a new FilteredHttpResponse that filters objects published by delegate before passing to a subscriber.
FilteredHttpResponse(HttpResponse, boolean) - Constructor for class com.linecorp.armeria.common.FilteredHttpResponse
(Advanced users only) Creates a new FilteredHttpResponse that filters objects published by delegate before passing to a subscriber.
FilteredStreamMessage<T,​U> - Class in com.linecorp.armeria.common.stream
A StreamMessage that filters objects as they are published.
FilteredStreamMessage(StreamMessage<T>) - Constructor for class com.linecorp.armeria.common.stream.FilteredStreamMessage
Creates a new FilteredStreamMessage that filters objects published by delegate before passing to a subscriber.
FilteredStreamMessage(StreamMessage<T>, boolean) - Constructor for class com.linecorp.armeria.common.stream.FilteredStreamMessage
(Advanced users only) Creates a new FilteredStreamMessage that filters objects published by delegate before passing to a subscriber.
find(MediaType...) - Static method in class com.linecorp.armeria.common.SerializationFormat
Finds the SerializationFormat which is accepted by any of the specified media ranges.
find(RoutingContext) - Method in interface com.linecorp.armeria.server.Router
Finds the value of mapping that matches the specified RoutingContext.
find(Class<?>) - Static method in class com.linecorp.armeria.common.util.AppRootFinder
Returns the Path to the JAR, WAR or directory where the specified Class is located at.
find(String) - Static method in class com.linecorp.armeria.common.SerializationFormat
find(String) - Static method in enum com.linecorp.armeria.common.SessionProtocol
Finds the SessionProtocol with the specified SessionProtocol.uriText().
findAll(RoutingContext) - Method in interface com.linecorp.armeria.server.Router
Finds all values of mapping that match the specified RoutingContext.
findCurrent() - Static method in class com.linecorp.armeria.common.util.AppRootFinder
Returns the Path to the JAR, WAR or directory where the caller class of this method is located at.
findCurrent(int) - Static method in class com.linecorp.armeria.common.util.AppRootFinder
Returns the Path to the JAR, WAR or directory where the caller class of this method is located at.
findNamedTypes() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
findNamedTypes() - Method in interface com.linecorp.armeria.server.docs.NamedTypeInfo
Returns all enum, struct and exception types referred by this type.
findNamedTypes() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns all enum, struct and exception TypeSignatures referred to by this service.
findNamedTypes() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
findServiceConfig(RoutingContext) - Method in class com.linecorp.armeria.server.VirtualHost
Finds the HttpService whose Router matches the RoutingContext.
findServiceConfig(RoutingContext, boolean) - Method in class com.linecorp.armeria.server.VirtualHost
Finds the HttpService whose Router matches the RoutingContext.
findVirtualHost(String) - Method in class com.linecorp.armeria.server.ServerConfig
Finds the VirtualHost that matches the specified hostname.
findVirtualHosts(HttpService) - Method in class com.linecorp.armeria.server.ServerConfig
Finds the List of VirtualHosts that contains the specified HttpService.
finish() - Method in interface com.linecorp.armeria.client.encoding.StreamDecoder
Deprecated.
Closes the decoder and returns any decoded data that may be left over.
finish() - Method in interface com.linecorp.armeria.common.encoding.StreamDecoder
Closes the decoder and returns any decoded data that may be left over.
first() - Static method in class com.linecorp.armeria.common.util.Functions
Returns a BiFunction that returns the first argument.
fixed(long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that waits a fixed delay between attempts.
Flags - Class in com.linecorp.armeria.common
The system properties that affect Armeria's runtime behavior.
FLV_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
Flash video.
FLV_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/x-flv".
FOLLOW_ONLY_WHEN_PRERENDER_SHOWN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Follow-Only-When-Prerender-Shown" header field name.
FOR_IO - com.linecorp.armeria.common.ByteBufAccessMode
Converts the underlying ByteBuf into a direct ByteBuf if necessary.
FORBIDDEN - Static variable in class com.linecorp.armeria.common.HttpStatus
403 Forbidden.
FORCE_CACHE - Static variable in class com.linecorp.armeria.common.ClientCacheControl
"only-if-cached, max-stale=2147483647".
FORCE_NETWORK - Static variable in class com.linecorp.armeria.common.ClientCacheControl
"no-cache".
FORM_DATA - Static variable in class com.linecorp.armeria.common.MediaType
 
FORM_DATA - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/x-www-form-urlencoded".
format() - Method in class com.linecorp.armeria.server.saml.SamlNameIdPolicy
FORWARDED - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Forwarded" header field name.
FOUND - Static variable in class com.linecorp.armeria.common.HttpStatus
302 Found.
fragment() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
fragment() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
fragment() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
fragment() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the URI fragment of this endpoint.
fragment(String) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
Sets the fragment of the pathMapping.
from(CompletionStage<?>) - Static method in interface com.linecorp.armeria.common.RpcResponse
Creates a new RpcResponse that is completed successfully or exceptionally based on the completion of the specified CompletionStage.
from(CompletionStage<? extends HttpResponse>) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage.
from(CompletionStage<? extends HttpResponse>, EventExecutor) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage.
from(CompletionStage<? extends HttpFile>) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns an HttpFile that becomes readable when the specified CompletionStage is complete.
FROM - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "From" header field name.
fromCookieHeader(boolean, String) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Cookie" header value into a set of Cookies.
fromCookieHeader(String) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Cookie" header value into a set of Cookies.
fromEvent(ResponseHeaders, ServerSentEvent) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream of the specified content.
fromEvent(ResponseHeaders, ServerSentEvent, HttpHeaders) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream of the specified content.
fromEvent(ServerSentEvent) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream of the specified content.
fromObject(ResponseHeaders, Object) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences of the specified content.
fromObject(ResponseHeaders, Object, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences of the specified content.
fromObject(ResponseHeaders, Object, HttpHeaders, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences of the specified content.
fromObject(Object) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences of the specified content.
fromPublisher(ResponseHeaders, Publisher<?>) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Publisher.
fromPublisher(ResponseHeaders, Publisher<?>, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Publisher.
fromPublisher(ResponseHeaders, Publisher<?>, HttpHeaders, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Publisher.
fromPublisher(ResponseHeaders, Publisher<? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Publisher.
fromPublisher(ResponseHeaders, Publisher<? extends ServerSentEvent>, HttpHeaders) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Publisher.
fromPublisher(ResponseHeaders, Publisher<T>, HttpHeaders, Function<? super T, ? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Publisher and converter.
fromPublisher(ResponseHeaders, Publisher<T>, Function<? super T, ? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Publisher and converter.
fromPublisher(Publisher<?>) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Publisher.
fromPublisher(Publisher<?>, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Publisher.
fromPublisher(Publisher<? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Publisher.
fromPublisher(Publisher<T>, Function<? super T, ? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Publisher and converter.
fromQueryString(String) - Static method in interface com.linecorp.armeria.common.QueryParams
Decodes the specified query string into a QueryParams, as defined in 4.10.22.6, HTML5 W3C Recommendation.
fromQueryString(String, boolean) - Static method in interface com.linecorp.armeria.common.QueryParams
Decodes the specified query string into a QueryParams, as defined in 4.10.22.6, HTML5 W3C Recommendation.
fromQueryString(String, int) - Static method in interface com.linecorp.armeria.common.QueryParams
Decodes the specified query string into a QueryParams, as defined in 4.10.22.6, HTML5 W3C Recommendation.
fromQueryString(String, int, boolean) - Static method in interface com.linecorp.armeria.common.QueryParams
Decodes the specified query string into a QueryParams, as defined in 4.10.22.6, HTML5 W3C Recommendation.
fromSetCookieHeader(boolean, String) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header value into a Cookie.
fromSetCookieHeader(String) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header value into a Cookie.
fromSetCookieHeaders(boolean, Iterable<String>) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header values into Cookies.
fromSetCookieHeaders(boolean, String...) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header values into Cookies.
fromSetCookieHeaders(boolean, Collection<String>) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header values into Cookies.
fromSetCookieHeaders(Iterable<String>) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header values into Cookies.
fromSetCookieHeaders(String...) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header values into Cookies.
fromSetCookieHeaders(Collection<String>) - Static method in interface com.linecorp.armeria.common.Cookie
Decodes the specified "Set-Cookie" header values into Cookies.
fromStream(ResponseHeaders, Stream<?>, HttpHeaders, Executor, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Stream.
fromStream(ResponseHeaders, Stream<?>, Executor) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Stream.
fromStream(ResponseHeaders, Stream<?>, Executor, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Stream.
fromStream(ResponseHeaders, Stream<? extends ServerSentEvent>, HttpHeaders, Executor) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Stream.
fromStream(ResponseHeaders, Stream<? extends ServerSentEvent>, Executor) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Stream.
fromStream(ResponseHeaders, Stream<T>, HttpHeaders, Executor, Function<? super T, ? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Stream and converter.
fromStream(ResponseHeaders, Stream<T>, Executor, Function<? super T, ? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Stream and converter.
fromStream(Stream<?>, Executor) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Stream.
fromStream(Stream<?>, Executor, ObjectMapper) - Static method in class com.linecorp.armeria.server.streaming.JsonTextSequences
Creates a new JSON Text Sequences from the specified Stream.
fromStream(Stream<? extends ServerSentEvent>, Executor) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Stream.
fromStream(Stream<T>, Executor, Function<? super T, ? extends ServerSentEvent>) - Static method in class com.linecorp.armeria.server.streaming.ServerSentEvents
Creates a new Server-Sent Events stream from the specified Stream and converter.
fullName() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the human-readable full name, which is the concatenation of RequestOnlyLog.serviceName() and RequestOnlyLog.name() using '/', of the Request.
Functions - Class in com.linecorp.armeria.common.util
Utility methods related with function composition.

G

GATEWAY_TIMEOUT - Static variable in class com.linecorp.armeria.common.HttpStatus
504 Gateway Timeout.
generate(Iterable<ServiceInfo>, Function<TypeSignature, ? extends NamedTypeInfo>) - Static method in class com.linecorp.armeria.server.docs.ServiceSpecification
Generates a new ServiceSpecification from the specified ServiceInfos and the factory Function that creates NamedTypeInfos for the enum, struct or exception types referred by the specified ServiceInfos.
generateEntityTag(HttpFileAttributes) - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
Generates an entity tag of the file with the given attributes using the entityTagFunction which was specified with the constructor.
generatePreflightResponseHeaders() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Generates immutable HTTP response headers that should be added to a CORS preflight response.
generateSpecification(Set<ServiceConfig>, DocServiceFilter) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Generates a new ServiceSpecification that provides the information about the supported Services.
GEO_JSON - Static variable in class com.linecorp.armeria.common.MediaType
GeoJSON Format, a geospatial data interchange format based on JSON.
GEO_JSON - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/geo+json".
get() - Method in interface com.linecorp.armeria.client.ClientRequestContextCaptor
Returns the ClientRequestContext captured first.
get() - Static method in exception com.linecorp.armeria.client.endpoint.EmptyEndpointGroupException
Returns an EmptyEndpointGroupException which may be a singleton or a new instance, depending on Flags.verboseExceptionSampler()'s decision.
get() - Static method in exception com.linecorp.armeria.client.GoAwayReceivedException
Returns a singleton GoAwayReceivedException.
get() - Static method in exception com.linecorp.armeria.client.RefusedStreamException
Returns a singleton RefusedStreamException.
get() - Static method in exception com.linecorp.armeria.client.ResponseCancellationException
Returns a singleton ResponseCancellationException.
get() - Static method in exception com.linecorp.armeria.client.ResponseTimeoutException
Returns a singleton ResponseTimeoutException.
get() - Static method in exception com.linecorp.armeria.client.WriteTimeoutException
Returns a singleton WriteTimeoutException.
get() - Method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContext
 
get() - Static method in exception com.linecorp.armeria.common.ClosedSessionException
Returns a ClosedSessionException which may be a singleton or a new instance, depending on Flags.verboseExceptionSampler()'s decision.
get() - Static method in exception com.linecorp.armeria.common.ContentTooLargeException
Returns a ContentTooLargeException which may be a singleton or a new instance, depending on Flags.verboseExceptionSampler()'s decision.
get() - Static method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
Returns the singleton instance.
get() - Static method in exception com.linecorp.armeria.common.stream.AbortedStreamException
Returns a AbortedStreamException which may be a singleton or a new instance, depending on Flags.verboseExceptionSampler()'s decision.
get() - Static method in exception com.linecorp.armeria.common.stream.CancelledSubscriptionException
Returns a CancelledSubscriptionException which may be a singleton or a new instance, depending on Flags.verboseExceptionSampler()'s decision.
get() - Static method in exception com.linecorp.armeria.common.stream.ClosedStreamException
Returns a ClosedStreamException which may be a singleton or a new instance, depending on Flags.verboseExceptionSampler()'s decision.
get() - Static method in class com.linecorp.armeria.common.stream.NoopSubscriber
Returns a singleton NoopSubscriber.
get() - Static method in class com.linecorp.armeria.common.thrift.text.TTextProtocolFactory
Returns the singleton TTextProtocolFactory instance.
get() - Method in class com.linecorp.armeria.common.util.EventLoopCheckingFuture
 
get() - Method in interface com.linecorp.armeria.common.util.ReleasableHolder
Returns the resource.
get() - Static method in exception com.linecorp.armeria.server.RequestCancellationException
Returns a singleton RequestCancellationException.
get() - Static method in exception com.linecorp.armeria.server.RequestTimeoutException
Returns a singleton RequestTimeoutException.
get() - Method in class com.linecorp.armeria.testing.junit4.common.EventLoopGroupRule
Returns the EventLoopGroup.
get() - Method in class com.linecorp.armeria.testing.junit4.common.EventLoopRule
Returns the EventLoop.
get() - Method in class com.linecorp.armeria.testing.junit5.common.EventLoopExtension
Returns the EventLoop.
get() - Method in class com.linecorp.armeria.testing.junit5.common.EventLoopGroupExtension
Returns the EventLoopGroup.
get(boolean) - Static method in class com.linecorp.armeria.common.thrift.text.TTextProtocolFactory
Returns the singleton TTextProtocolFactory instance, with optional serialization of named enums.
get(long, TimeUnit) - Method in class com.linecorp.armeria.common.util.EventLoopCheckingFuture
 
get(ClientRequestContext, Request) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
Returns the CircuitBreaker mapped to the given parameters.
get(RequestContext) - Static method in class com.linecorp.armeria.common.grpc.GrpcWebTrailers
Returns the gRPC-Web trailers which was set to the specified RequestContext using GrpcWebTrailers.set(RequestContext, HttpHeaders).
get(RequestContext) - Static method in class com.linecorp.armeria.common.kotlin.CoroutineContexts
Returns the coroutine context mapped to COROUTINE_CONTEXT_KEY in the context.
get(RequestContext, String) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Returns the value of the specified request-scoped MDC property bound to the specified RequestContext.
get(SerializationFormat) - Static method in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
Returns the TProtocolFactory for the specified SerializationFormat.
get(AbstractOption<?, ?, V>) - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns the value of the specified option.
get(String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP GET request.
get(String) - Static method in class com.linecorp.armeria.common.util.Version
Returns the version information for the Armeria artifact named artifactId.
get(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
get(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
get(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
get(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
get(String, ClassLoader) - Static method in class com.linecorp.armeria.common.util.Version
Returns the version information for the Armeria artifact named artifactId using the specified ClassLoader.
get(String, V, Function<V, V>, BiFunction<U, U, U>) - Method in interface com.linecorp.armeria.common.util.AbstractOption.Factory
Returns a newly created option with the specified properties.
get(Executor, String, Clock, String, HttpHeaders) - Method in class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
Finds the file at the specified path.
get(Executor, String, Clock, String, HttpHeaders) - Method in interface com.linecorp.armeria.server.file.HttpVfs
Finds the file at the specified path.
Get - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.GET onto specific method.
GET - com.linecorp.armeria.common.HttpMethod
The GET method which means retrieve whatever information (in the form of an entity) is identified by the Request-URI.
getAll() - Method in interface com.linecorp.armeria.client.ClientRequestContextCaptor
Returns all ClientRequestContexts captured so far.
getAll() - Static method in class com.linecorp.armeria.common.util.Version
Retrieves the version information of Armeria artifacts.
getAll(RequestContext) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Returns the Map of all request-scoped MDC properties bound to the specified RequestContext.
getAll(ClassLoader) - Static method in class com.linecorp.armeria.common.util.Version
Retrieves the version information of Armeria artifacts using the specified ClassLoader.
getAllAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the removed header values.
getAllAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the removed parameter values.
getAllDocStrings(ClassLoader) - Method in class com.linecorp.armeria.server.docs.DocStringExtractor
Extract all docstrings from files at the configured path, delegating to DocStringExtractor.getDocStringsFromFiles(Map) for actual processing.
getAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getAndRemove(CharSequence, String) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getAndRemove(String, String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getAppender(String) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
getBaseTimeUnit() - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
getCause() - Method in exception com.linecorp.armeria.client.UnprocessedRequestException
 
getCause() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
getCause() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The cause of this Throwable.
getCause() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The cause of this Throwable.
getCause() - Method in exception com.linecorp.armeria.common.util.CompositeException
 
getCauseBuilder() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
getCauseOrBuilder() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
getCauseOrBuilder() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The cause of this Throwable.
getCauseOrBuilder() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The cause of this Throwable.
getCiphers() - Method in class com.linecorp.armeria.spring.Ssl
Returns the supported SSL ciphers.
getCircuitBreaker() - Method in exception com.linecorp.armeria.client.circuitbreaker.FailFastException
Returns the CircuitBreaker that has detected the failure.
getClassName() - 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.
getClassName() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
The fully qualified name of the class containing the execution point represented by the stack trace element.
getClassName() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
The fully qualified name of the class containing the execution point represented by the stack trace element.
getClassNameBytes() - 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.
getClassNameBytes() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
The fully qualified name of the class containing the execution point represented by the stack trace element.
getClassNameBytes() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
The fully qualified name of the class containing the execution point represented by the stack trace element.
getClientAuth() - Method in class com.linecorp.armeria.spring.Ssl
Returns whether client authentication is not wanted ("none"), wanted ("want") or needed ("need").
getCode() - Method in exception com.linecorp.armeria.common.grpc.protocol.ArmeriaStatusException
Returns the gRPC status code for this ArmeriaStatusException.
getCompression() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the HTTP content encoding configuration that the Server uses.
getDefaultInstance() - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
getDefaultInstance() - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
getDefaultInstanceForType() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
getDefaultInstanceForType() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
getDefaultInstanceForType() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
getDefaultInstanceForType() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
getDescriptor() - Static method in class com.linecorp.armeria.common.grpc.InternalExceptionMessages
 
getDescriptor() - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
getDescriptor() - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
getDescriptor() - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
getDescriptor() - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
getDescriptorForType() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
getDescriptorForType() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
getDocsPath() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the path of the DocService.
getDocStringsFromFiles(Map<String, byte[]>) - Method in class com.linecorp.armeria.server.docs.DocStringExtractor
Extracts a Map of docstrings from the given Map of path to file contents.
getDoubleAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getDoubleAndRemove(CharSequence, double) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getDoubleAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getDoubleAndRemove(String, double) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getEnabledProtocols() - Method in class com.linecorp.armeria.spring.Ssl
Returns the enabled SSL protocols.
getExceptions() - Method in exception com.linecorp.armeria.common.util.CompositeException
Retrieves the list of exceptions that make up the CompositeException.
getExcludedUserAgents() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Returns the "user-agent" header values which are not applicable for the HTTP content encoding.
getFileName() - 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.
getFileName() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
The name of the file containing the execution point represented by the stack trace element, or null if this information is unavailable.
getFileName() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
The name of the file containing the execution point represented by the stack trace element, or null if this information is unavailable.
getFileNameBytes() - 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.
getFileNameBytes() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
The name of the file containing the execution point represented by the stack trace element, or null if this information is unavailable.
getFileNameBytes() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
The name of the file containing the execution point represented by the stack trace element, or null if this information is unavailable.
getFloatAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getFloatAndRemove(CharSequence, float) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getFloatAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getFloatAndRemove(String, float) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getGracefulShutdownQuietPeriodMillis() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the number of milliseconds to wait for active requests to go end before shutting down.
getGracefulShutdownTimeoutMillis() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the number of milliseconds to wait before shutting down the server regardless of active requests.
getHealthCheckPath() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the path of the HealthCheckService.
getIface() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Returns the network interface that the Server uses.
getIntAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getIntAndRemove(CharSequence, int) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getIntAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getIntAndRemove(String, int) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getInvocation(RequestLogAccess) - Static method in class com.linecorp.armeria.client.retrofit2.InvocationUtil
Retrieves a Retrofit Invocation associated with a RequestLog.
getIp() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Returns the IP address that the Server uses.
getKeyAlias() - Method in class com.linecorp.armeria.spring.Ssl
Returns the alias that identifies the key in the key store.
getKeyPassword() - Method in class com.linecorp.armeria.spring.Ssl
Returns the password used to access the key in the key store.
getKeyStore() - Method in class com.linecorp.armeria.spring.Ssl
Returns the path to the key store that holds the SSL certificate (typically a jks file).
getKeyStorePassword() - Method in class com.linecorp.armeria.spring.Ssl
Returns the password used to access the key store.
getKeyStoreProvider() - Method in class com.linecorp.armeria.spring.Ssl
Returns the provider for the key store.
getKeyStoreType() - Method in class com.linecorp.armeria.spring.Ssl
Returns the type of the key store.
getLineNumber() - 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.
getLineNumber() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
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.
getLineNumber() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
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.
getLongAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getLongAndRemove(CharSequence, long) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getLongAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getLongAndRemove(String, long) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getMessage() - Method in exception com.linecorp.armeria.common.util.CompositeException
 
getMessageEncoding() - Method in interface com.linecorp.armeria.common.grpc.protocol.Compressor
Returns the message encoding that this compressor uses.
getMessageEncoding() - Method in interface com.linecorp.armeria.common.grpc.protocol.Decompressor
Returns the message encoding that this compressor uses.
getMethodName() - 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
getMethodName() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
The name of the method containing the execution point represented by the stack trace element
getMethodName() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
The name of the method containing the execution point represented by the stack trace element
getMethodNameBytes() - 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
getMethodNameBytes() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
The name of the method containing the execution point represented by the stack trace element
getMethodNameBytes() - Method in interface com.linecorp.armeria.common.grpc.StackTraceElementProtoOrBuilder
The name of the method containing the execution point represented by the stack trace element
getMetricsPath() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the path of the metrics exposition service.
getMimeTypes() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Returns the MIME Types of an HTTP response which are applicable for the HTTP content encoding.
getMinResponseSize() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Returns the minimum bytes for encoding the content of an HTTP response.
getModuleName() - Method in class com.linecorp.armeria.common.thrift.ThriftJacksonModule
 
getNameId(Response, SamlNameIdFormat) - Static method in class com.linecorp.armeria.server.saml.SamlUtil
Returns a NameID that its name format equals to the specified expectedFormat, from the Response.
getNameId(Response, Predicate<NameID>) - Static method in class com.linecorp.armeria.server.saml.SamlUtil
Returns a NameID which is matched to the specified filter from the Response.
getNextDelay(ClientRequestContext, Backoff) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Returns the next delay which retry will be made after.
getNextDelay(ClientRequestContext, Backoff, long) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Returns the next delay which retry will be made after.
getNow(Object) - Method in interface com.linecorp.armeria.common.RpcResponse
Returns the specified valueIfAbsent when not complete, or returns the result value or throws an exception when complete.
getOrder() - Method in interface com.linecorp.armeria.spring.ArmeriaServerConfigurator
Returns the evaluation order of this configurator.
getOrder() - Method in interface com.linecorp.armeria.spring.DocServiceConfigurator
Returns the evaluation order of this configurator.
getOrder() - Method in interface com.linecorp.armeria.spring.web.reactive.ArmeriaClientConfigurator
Returns the evaluation order of this configurator.
getOriginalClassName() - Method in exception com.linecorp.armeria.common.grpc.StatusCauseException
Returns the class name of the original exception in the server.
getOriginalClassName() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The name of the class of the exception that was actually thrown.
getOriginalClassName() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The name of the class of the exception that was actually thrown.
getOriginalClassName() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The name of the class of the exception that was actually thrown.
getOriginalClassNameBytes() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The name of the class of the exception that was actually thrown.
getOriginalClassNameBytes() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The name of the class of the exception that was actually thrown.
getOriginalClassNameBytes() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The name of the class of the exception that was actually thrown.
getOriginalMessage() - Method in exception com.linecorp.armeria.common.grpc.StatusCauseException
Returns the message attached to the original exception in the server.
getOriginalMessage() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The message of this throwable.
getOriginalMessage() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The message of this throwable.
getOriginalMessage() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The message of this throwable.
getOriginalMessageBytes() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The message of this throwable.
getOriginalMessageBytes() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The message of this throwable.
getOriginalMessageBytes() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The message of this throwable.
getOrNull() - Method in interface com.linecorp.armeria.client.ClientRequestContextCaptor
Returns the ClientRequestContext captured first, or null if unavailable.
getParserForType() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
getParserForType() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
getPolicy(String, RoutingContext) - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns the policy for the specified origin.
getPort() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Returns the port that the Server uses.
getPorts() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the ArmeriaSettings.Ports of the Server.
getProtocol(TTransport) - Method in class com.linecorp.armeria.common.thrift.text.TTextProtocolFactory
 
getProtocols() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Returns the list of SessionProtocols that the Server uses.
getProvider() - Method in class com.linecorp.armeria.spring.Ssl
Returns Netty SSL Provider.
getSerializedSize() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
getSerializedSize() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
getSsl() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns the Ssl configuration that the Server uses.
getStackTrace(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTrace(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The stack trace of this Throwable.
getStackTrace(int) - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The stack trace of this Throwable.
getStackTraceBuilder(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTraceBuilderList() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTraceCount() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTraceCount() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The stack trace of this Throwable.
getStackTraceCount() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The stack trace of this Throwable.
getStackTraceList() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTraceList() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The stack trace of this Throwable.
getStackTraceList() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The stack trace of this Throwable.
getStackTraceOrBuilder(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTraceOrBuilder(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The stack trace of this Throwable.
getStackTraceOrBuilder(int) - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The stack trace of this Throwable.
getStackTraceOrBuilderList() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
getStackTraceOrBuilderList() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The stack trace of this Throwable.
getStackTraceOrBuilderList() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The stack trace of this Throwable.
getTimeMillisAndRemove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getTimeMillisAndRemove(CharSequence, long) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all the headers with the specified name and returns the header value which was added first.
getTimeMillisAndRemove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getTimeMillisAndRemove(String, long) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all the parameters with the specified name and returns the parameter value which was added first.
getTotalAttempts(ClientRequestContext) - Static method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Returns the total number of attempts of the current request represented by the specified ClientRequestContext.
getTrustStore() - Method in class com.linecorp.armeria.spring.Ssl
Returns the trust store that holds SSL certificates.
getTrustStorePassword() - Method in class com.linecorp.armeria.spring.Ssl
Returns the password used to access the trust store.
getTrustStoreProvider() - Method in class com.linecorp.armeria.spring.Ssl
Returns the provider for the trust store.
getTrustStoreType() - Method in class com.linecorp.armeria.spring.Ssl
Returns the type of the trust store.
getUnknownFields() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
getUnknownFields() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
getWebServer(HttpHandler) - Method in class com.linecorp.armeria.spring.web.reactive.ArmeriaReactiveWebServerFactory
 
GIF - Static variable in class com.linecorp.armeria.common.MediaType
 
GIF - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/gif".
glob(String) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match the specified glob.
GoAwayReceivedException - Exception in com.linecorp.armeria.client
A RuntimeException raised when a server sent an HTTP/2 GOAWAY frame with the lastStreamId less then the stream ID of the request.
GONE - Static variable in class com.linecorp.armeria.common.HttpStatus
410 Gone.
gracefulShutdownQuietPeriod() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the number of milliseconds to wait for active requests to go end before shutting down.
gracefulShutdownServerConfigurator(String, Duration) - Method in class com.linecorp.armeria.spring.AbstractArmeriaAutoConfiguration
A user can configure a Server by providing an ArmeriaServerConfigurator bean.
gracefulShutdownTimeout() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the number of milliseconds to wait before shutting down the server regardless of active requests.
gracefulShutdownTimeout(Duration, Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the amount of time to wait after calling Server.stop() for requests to go away before actually shutting down.
gracefulShutdownTimeoutMillis(long, long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the amount of time to wait after calling Server.stop() for requests to go away before actually shutting down.
group() - Method in class com.linecorp.armeria.client.endpoint.AbstractEndpointSelector
Returns the EndpointGroup being selected by this EndpointSelector.
GRPC_ACCEPT_ENCODING - Static variable in class com.linecorp.armeria.common.grpc.protocol.GrpcHeaderNames
"grpc-accept-encoding".
GRPC_ENCODING - Static variable in class com.linecorp.armeria.common.grpc.protocol.GrpcHeaderNames
"grpc-encoding".
GRPC_JSON_MARSHALLER_FACTORY - Static variable in class com.linecorp.armeria.client.grpc.GrpcClientOptions
Sets the factory that creates a GrpcJsonMarshaller that serializes and deserializes request or response messages to and from JSON depending on the SerializationFormat.
GRPC_MESSAGE - Static variable in class com.linecorp.armeria.common.grpc.protocol.GrpcHeaderNames
"grpc-message".
GRPC_STATUS - Static variable in class com.linecorp.armeria.common.grpc.protocol.GrpcHeaderNames
"grpc-status".
GRPC_TIMEOUT - Static variable in class com.linecorp.armeria.common.grpc.protocol.GrpcHeaderNames
"grpc-timeout".
GrpcClientOptions - Class in com.linecorp.armeria.client.grpc
ClientOptions to control gRPC-specific behavior.
GrpcHeaderNames - Class in com.linecorp.armeria.common.grpc.protocol
gRPC-related HTTP header names.
GrpcJsonMarshaller - Interface in com.linecorp.armeria.common.grpc
A JSON marshaller for gRPC method request or response messages to and from JSON.
GrpcJsonMarshallerBuilder - Class in com.linecorp.armeria.common.grpc
A builder for creating a new GrpcJsonMarshaller that serializes and deserializes a Message to and from JSON.
GrpcMeterIdPrefixFunction - Class in com.linecorp.armeria.common.grpc
Creates a MeterIdPrefix from a RequestLog.
GrpcSerializationFormats - Class in com.linecorp.armeria.common.grpc
gRPC-related SerializationFormat instances.
GrpcService - Interface in com.linecorp.armeria.server.grpc
An HttpService that implements the gRPC wire protocol.
GrpcServiceBuilder - Class in com.linecorp.armeria.server.grpc
Constructs a GrpcService to serve gRPC services from within Armeria.
GrpcUnsafeBufferUtil - Class in com.linecorp.armeria.unsafe.grpc
Provides utility methods useful for storing and releasing the ByteBuf backing a Message.
GrpcWebTrailers - Class in com.linecorp.armeria.common.grpc
Retrieves gRPC-Web trailers.
guessServiceMethodName(Object) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Guesses the name of the service method who handles the specified example request.
guessServiceName(Object) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Guesses the name of the service who handles the specified example request.
gzip() - Static method in interface com.linecorp.armeria.client.encoding.StreamDecoderFactory
Deprecated.
Returns the StreamDecoderFactory for "gzip" content encoding.
gzip() - Static method in interface com.linecorp.armeria.common.encoding.StreamDecoderFactory
Returns the StreamDecoderFactory for "gzip" content encoding.
GZIP - Static variable in class com.linecorp.armeria.common.MediaType
 
GZIP - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/x-gzip".

H

H1 - com.linecorp.armeria.common.SessionProtocol
HTTP/1 - over TLS.
H1C - com.linecorp.armeria.common.SessionProtocol
HTTP/1 - cleartext.
H2 - com.linecorp.armeria.common.SessionProtocol
HTTP/2 - over TLS.
H2C - com.linecorp.armeria.common.SessionProtocol
HTTP/2 - cleartext.
HAL_JSON - Static variable in class com.linecorp.armeria.common.MediaType
HAL_JSON - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/hal+json".
HALF_OPEN - com.linecorp.armeria.client.circuitbreaker.CircuitState
Only one trial request is sent at a time until at least one request succeeds or fails.
handle(ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.healthcheck.HealthCheckUpdateHandler
Determines if the healthiness of the Server needs to be changed or not from the given HttpRequest.
handleAccepted(Service<I, O>, ServiceRequestContext, I) - Method in interface com.linecorp.armeria.server.throttling.ThrottlingAcceptHandler
Invoked when the ThrottlingStrategy accepts the specified Request.
handleDuplicateRoute(VirtualHost, Route, Route) - Method in interface com.linecorp.armeria.server.RejectedRouteHandler
Invoked when a user attempts to bind an HttpService at the Route that conflicts with an existing Route.
handleException(ServiceRequestContext, HttpRequest, Throwable) - Method in interface com.linecorp.armeria.server.annotation.ExceptionHandlerFunction
Returns an HttpResponse which would be sent back to the client who sent the req.
handleMessage(byte[]) - Method in class com.linecorp.armeria.server.grpc.protocol.AbstractUnaryGrpcService
Returns an unframed response message to return to the client, given an unframed request message.
handleMessage(ByteBuf) - Method in class com.linecorp.armeria.server.grpc.protocol.AbstractUnaryGrpcService
 
handleMessage(ByteBuf) - Method in class com.linecorp.armeria.server.grpc.protocol.AbstractUnsafeUnaryGrpcService
Returns an unframed response message to return to the client, given an unframed request message.
handler(Handler) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets the Handler of the Jetty Server.
handleRejected(Service<I, O>, ServiceRequestContext, I, Throwable) - Method in interface com.linecorp.armeria.server.throttling.ThrottlingRejectHandler
Invoked when the ThrottlingStrategy rejects the specified Request.
handlerWrapper(HandlerWrapper) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Adds the specified HandlerWrapper to the Jetty Server.
haproxy(InetSocketAddress) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Creates a ProxyConfig configuration for HAProxy protocol.
haproxy(InetSocketAddress, InetSocketAddress) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Creates a ProxyConfig configuration for HAProxy protocol.
HAPROXY - com.linecorp.armeria.client.proxy.ProxyType
HAPROXY protocol.
HAProxyConfig - Class in com.linecorp.armeria.client.proxy
hasAttr(AttributeKey<?>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns true if and only if the value associated with the specified AttributeKey is not null.
hasAttr(AttributeKey<?>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
hasCause() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
hasCause() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
The cause of this Throwable.
hasCause() - Method in interface com.linecorp.armeria.common.grpc.ThrowableProtoOrBuilder
The cause of this Throwable.
hashCode() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
 
hashCode() - Method in class com.linecorp.armeria.client.Endpoint
 
hashCode() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
 
hashCode() - Method in class com.linecorp.armeria.client.proxy.HAProxyConfig
 
hashCode() - Method in class com.linecorp.armeria.client.proxy.Socks4ProxyConfig
 
hashCode() - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
 
hashCode() - Method in class com.linecorp.armeria.common.auth.BasicToken
 
hashCode() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
 
hashCode() - Method in class com.linecorp.armeria.common.auth.OAuth2Token
 
hashCode() - Method in class com.linecorp.armeria.common.CacheControl
 
hashCode() - Method in class com.linecorp.armeria.common.ClientCacheControl
 
hashCode() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
 
hashCode() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
hashCode() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
hashCode() - Method in class com.linecorp.armeria.common.HttpStatus
 
hashCode() - Method in class com.linecorp.armeria.common.MediaType
 
hashCode() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
 
hashCode() - Method in class com.linecorp.armeria.common.Scheme
 
hashCode() - Method in class com.linecorp.armeria.common.SerializationFormat
 
hashCode() - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
hashCode() - Method in class com.linecorp.armeria.common.ServerCacheControl
 
hashCode() - Method in class com.linecorp.armeria.common.thrift.ThriftCall
 
hashCode() - Method in class com.linecorp.armeria.common.thrift.ThriftMessage
 
hashCode() - Method in class com.linecorp.armeria.common.thrift.ThriftReply
 
hashCode() - Method in class com.linecorp.armeria.common.util.AbstractOption
 
hashCode() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
 
hashCode() - Method in class com.linecorp.armeria.server.ClientAddressSource
 
hashCode() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.MethodInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.TypeSignature
 
hashCode() - Method in class com.linecorp.armeria.server.file.HttpFileAttributes
 
hashCode() - Method in class com.linecorp.armeria.server.ProxiedAddresses
 
hashCode() - Method in class com.linecorp.armeria.server.RouteBuilder
 
hashCode() - Method in class com.linecorp.armeria.server.saml.SamlEndpoint
 
hashCode() - Method in class com.linecorp.armeria.server.ServerPort
 
hashCode() - Method in class com.linecorp.armeria.testing.junit5.server.mock.RecordedRequest
 
hasHighestScore() - Method in class com.linecorp.armeria.server.RoutingResult
Returns whether the score of this result is the highest or not.
hasHttp() - Method in class com.linecorp.armeria.server.ServerPort
hasHttp() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns true if the Server is started and it has an HTTP port open.
hasHttp() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns true if the Server is started and it has an HTTP port open.
hasHttps() - Method in class com.linecorp.armeria.server.ServerPort
hasHttps() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns true if the Server is started and it has an HTTPS port open.
hasHttps() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns true if the Server is started and it has an HTTPS port open.
hasIpAddr() - Method in class com.linecorp.armeria.client.Endpoint
Returns whether this endpoint has an IP address resolved.
hasLowestScore() - Method in class com.linecorp.armeria.server.RoutingResult
Returns whether the score of this result is the lowest or not.
hasMaxStale() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns whether the "max-stale" directive is enabled.
hasOwnAttr(AttributeKey<?>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns true if and only if the value associated with the specified AttributeKey is not null.
hasOwnAttr(AttributeKey<?>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
hasPort() - Method in class com.linecorp.armeria.client.Endpoint
Returns whether this endpoint has a port number specified.
hasProtocol(SessionProtocol) - Method in class com.linecorp.armeria.server.ServerPort
Returns whether the specified protocol is in the list of SessionProtocols.
hasProxyProtocol() - Method in class com.linecorp.armeria.server.ServerPort
Returns whether the SessionProtocol.PROXY is in the list of SessionProtocols.
hasTls() - Method in class com.linecorp.armeria.server.ServerPort
Returns whether there is a SessionProtocol which is over TLS.
hasTriePath() - Method in enum com.linecorp.armeria.server.RoutePathType
Tells whether this RoutePathType has a trie path or not.
hasWildcard() - Method in class com.linecorp.armeria.common.MediaType
Returns true if either the type or subtype is the wildcard.
head(String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP HEAD request.
head(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
head(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
head(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
head(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
Head - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.HEAD onto specific method.
HEAD - com.linecorp.armeria.common.HttpMethod
The HEAD method which is identical to GET except that the server MUST NOT return a message-body in the response.
header() - Method in class com.linecorp.armeria.common.thrift.ThriftMessage
Returns the header part of the message.
Header - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping an HTTP request header onto the following elements.
HEADER - com.linecorp.armeria.server.docs.FieldLocation
The field is located in the header.
headers() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the additional HTTP headers to send with requests.
headers() - Method in exception com.linecorp.armeria.client.InvalidResponseHeadersException
Returns the ResponseHeaders which triggered this exception.
headers() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Returns the RequestHeaders.
headers() - Method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Returns the ResponseHeaders.
headers() - Method in class com.linecorp.armeria.common.FilteredHttpRequest
 
headers() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the initial HTTP/2 headers of this request.
headers() - Method in interface com.linecorp.armeria.server.annotation.HttpResult
Returns the response HttpHeaders which may not contain the ":status" header.
headers() - Method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Returns the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.
headers() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
Returns the additional HttpHeaders to send in a response.
headers() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns the RequestHeaders retrieved from the request.
HEADERS - Static variable in class com.linecorp.armeria.client.ClientOptions
The additional HTTP headers to send with requests.
headersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
headersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
headersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize request, response and trailers before logging.
headersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
headersScheme(ThrottlingHeaders) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder
Optional ThrottlingHeaders to define specific RateLimit Header Scheme for HTTP.
headersScheme(ThrottlingHeaders, boolean) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder
Optional ThrottlingHeaders to define specific RateLimit Header Scheme for HTTP.
headerValueCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the headerValueCache parameter.
HealthCheckedEndpointGroup - Class in com.linecorp.armeria.client.endpoint.healthcheck
An EndpointGroup that filters out unhealthy Endpoints from an existing EndpointGroup, by sending periodic health check requests.
HealthCheckedEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.healthcheck
A builder for creating a new HealthCheckedEndpointGroup that sends HTTP health check requests.
HealthChecker - Interface in com.linecorp.armeria.server.healthcheck
Determines whether the Server is healthy.
HealthCheckerContext - Interface in com.linecorp.armeria.client.endpoint.healthcheck
Provides the properties and operations required for sending health check requests.
HealthCheckService - Class in com.linecorp.armeria.server.healthcheck
An HttpService that responds with HTTP status "200 OK" if the server is healthy and can accept requests and HTTP status "503 Service Not Available" if the server is unhealthy and cannot accept requests.
HealthCheckServiceBuilder - Class in com.linecorp.armeria.server.healthcheck
HealthCheckUpdateHandler - Interface in com.linecorp.armeria.server.healthcheck
Handles PUT, POST or PATCH requests sent to HealthCheckService.
HealthCheckUpdateResult - Enum in com.linecorp.armeria.server.healthcheck
The result of a request handled by HealthCheckUpdateHandler.
healthCheckUrl(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the health check URL.
HEALTHY - com.linecorp.armeria.server.healthcheck.HealthCheckUpdateResult
Tells HealthCheckService to mark the Server as 'healthy'.
healthyResponse(AggregatedHttpResponse) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Sets the AggregatedHttpResponse to send when the Service is healthy.
homePageUrl(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the home page URL.
hook(Function<? super RequestContextStorage, ? extends RequestContextStorage>) - Static method in interface com.linecorp.armeria.common.RequestContextStorage
Customizes the current RequestContextStorage by applying the specified Function to it.
host() - Method in class com.linecorp.armeria.client.Endpoint
Returns the host name of this endpoint.
HOST - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Host" header field name.
hostname() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Returns the local hostname.
hostname() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns the virtual host name of the request.
hostname(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the hostname.
hostname(String) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets the default hostname of the Jetty Server.
hostname(String) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a hostname of this service provider.
hostname(String) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
Sets the hostname of an embedded Tomcat.
hostnamePattern() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the hostname pattern of this endpoint.
hostnamePattern() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the hostname pattern of this virtual host, as defined in the section 3.1 of RFC2818.
hostnamePattern(String) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the hostname pattern of this VirtualHost.
hostsFileEntriesResolver(HostsFileEntriesResolver) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets HostsFileEntriesResolver which is used to first check if the hostname is locally aliased.
HTML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
HTML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/html; charset=utf-8".
http(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTP port that listens on all available network interfaces.
http(InetSocketAddress) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTP port that listens to the specified localAddress.
HTTP - com.linecorp.armeria.common.SessionProtocol
HTTP - cleartext, HTTP/2 preferred.
HTTP_POST - com.linecorp.armeria.server.saml.SamlBindingProtocol
HTTP POST binding protocol.
HTTP_REDIRECT - com.linecorp.armeria.server.saml.SamlBindingProtocol
HTTP Redirect binding protocol.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class com.linecorp.armeria.common.HttpStatus
505 HTTP Version Not Supported.
HTTP1_MAX_CHUNK_SIZE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The maximum length of each chunk in an HTTP/1 response content.
HTTP1_MAX_HEADER_SIZE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The maximum length of all headers in an HTTP/1 response.
HTTP1_MAX_INITIAL_LINE_LENGTH - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The maximum length of an HTTP/1 response initial line.
http1MaxChunkSize() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the maximum length of each chunk in an HTTP/1 response content.
http1MaxChunkSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum length of each chunk in an HTTP/1 response content.
http1MaxChunkSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum length of each chunk in an HTTP/1 response content.
http1MaxChunkSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum length of each chunk in an HTTP/1 response content.
http1MaxHeaderSize() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the maximum length of all headers in an HTTP/1 response.
http1MaxHeaderSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum length of all headers in an HTTP/1 response.
http1MaxHeaderSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum length of all headers in an HTTP/1 response.
http1MaxHeaderSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum length of all headers in an HTTP/1 response.
http1MaxInitialLineLength() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the maximum length of an HTTP/1 response initial line.
http1MaxInitialLineLength() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum length of an HTTP/1 response initial line.
http1MaxInitialLineLength(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum length of an HTTP/1 response initial line.
http1MaxInitialLineLength(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum length of an HTTP/1 response initial line.
HTTP2_INITIAL_CONNECTION_WINDOW_SIZE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
HTTP2_INITIAL_STREAM_WINDOW_SIZE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
HTTP2_MAX_FRAME_SIZE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
HTTP2_MAX_HEADER_LIST_SIZE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
HTTP2_SETTINGS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "HTTP2-Settings" header field name.
http2InitialConnectionWindowSize() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
http2InitialConnectionWindowSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the initial connection-level HTTP/2 flow control window size.
http2InitialConnectionWindowSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
http2InitialConnectionWindowSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the initial connection-level HTTP/2 flow control window size.
http2InitialStreamWindowSize() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
http2InitialStreamWindowSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the initial stream-level HTTP/2 flow control window size.
http2InitialStreamWindowSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
http2InitialStreamWindowSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the initial stream-level HTTP/2 flow control window size.
http2MaxFrameSize() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
http2MaxFrameSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum size of HTTP/2 frames that can be received.
http2MaxFrameSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
http2MaxFrameSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum size of HTTP/2 frame that can be received.
http2MaxHeaderListSize() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
http2MaxHeaderListSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum size of headers that can be received.
http2MaxHeaderListSize(long) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
http2MaxHeaderListSize(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum size of headers that can be received.
http2MaxStreamsPerConnection() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum number of concurrent streams per HTTP/2 connection.
http2MaxStreamsPerConnection(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum number of concurrent streams per HTTP/2 connection.
HttpClient - Interface in com.linecorp.armeria.client
Sends an HttpRequest to a remote Endpoint.
HttpData - Interface in com.linecorp.armeria.common
HTTP/2 data that contains a chunk of bytes.
httpEndpoint() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTP Endpoint for the Server.
httpEndpoint() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTP Endpoint for the Server.
HttpFile - Interface in com.linecorp.armeria.server.file
A file-like HTTP resource which yields an HttpResponse.
HttpFileAttributes - Class in com.linecorp.armeria.server.file
The attributes of an HttpFile.
HttpFileAttributes(long, long) - Constructor for class com.linecorp.armeria.server.file.HttpFileAttributes
Creates a new instance.
HttpFileBuilder - Class in com.linecorp.armeria.server.file
Builds an HttpFile from a file, a classpath resource or an HttpData.
HttpHeaderNames - Class in com.linecorp.armeria.common
Contains constant definitions for the HTTP header field names.
HttpHeaders - Interface in com.linecorp.armeria.common
Immutable HTTP/2 headers.
HttpHeadersBuilder - Interface in com.linecorp.armeria.common
Builds an HttpHeaders.
httpMethod() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the HTTP method of this method.
HttpMethod - Enum in com.linecorp.armeria.common
HTTP request method.
HttpObject - Interface in com.linecorp.armeria.common
The common interface for HTTP/2 message objects, HttpHeaders and HttpData.
httpOnly(boolean) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets whether the Cookie is HTTP only.
httpPort() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTP port number of the Server.
httpPort() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTP port number of the Server.
HttpRequest - Interface in com.linecorp.armeria.common
A streamed HTTP/2 Request.
HttpRequestDuplicator - Interface in com.linecorp.armeria.common
A duplicator that duplicates a HttpRequest into one or more HttpRequests, which publish the same elements.
HttpRequestWriter - Interface in com.linecorp.armeria.common
An HttpRequest that can have HttpObjects written to it.
httpResponse() - Method in exception com.linecorp.armeria.server.HttpResponseException
Returns the HttpResponse which would be sent back to the client who sent the corresponding request.
HttpResponse - Interface in com.linecorp.armeria.common
A streamed HTTP/2 Response.
HttpResponseDuplicator - Interface in com.linecorp.armeria.common
A duplicator that duplicates a HttpResponse into one or more HttpResponses, which publish the same elements.
HttpResponseException - Exception in com.linecorp.armeria.server
A RuntimeException that is raised to send an HTTP response with the content specified by a user.
HttpResponseWriter - Interface in com.linecorp.armeria.common
An HttpResponse that can have HttpObjects written to it.
HttpResult<T> - Interface in com.linecorp.armeria.server.annotation
An interface which helps a user specify an HttpStatus or ResponseHeaders for a response produced by an annotated HTTP service method.
https(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTPS port that listens on all available network interfaces.
https(InetSocketAddress) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTPS port that listens to the specified localAddress.
HTTPS - com.linecorp.armeria.common.SessionProtocol
HTTP - over TLS, HTTP/2 preferred.
httpsEndpoint() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTPS Endpoint for the Server.
httpsEndpoint() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTPS Endpoint for the Server.
HttpService - Interface in com.linecorp.armeria.server
An HTTP/2 Service.
HttpServiceWithRoutes - Interface in com.linecorp.armeria.server
An interface that enables getting all the Routes where an HttpService should be bound.
httpSocketAddress() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTP InetSocketAddress of the Server.
httpSocketAddress() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTP InetSocketAddress of the Server.
httpsPort() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTPS port number of the Server.
httpsPort() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTPS port number of the Server.
httpsSocketAddress() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTPS InetSocketAddress of the Server.
httpsSocketAddress() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTPS InetSocketAddress of the Server.
httpStatus() - Method in exception com.linecorp.armeria.server.HttpStatusException
Returns the HttpStatus which would be sent back to the client who sent the corresponding request.
HttpStatus - Class in com.linecorp.armeria.common
HTTP response code and its description.
HttpStatus(int, String) - Constructor for class com.linecorp.armeria.common.HttpStatus
Creates a new instance with the specified status code and its reason phrase.
HttpStatusClass - Enum in com.linecorp.armeria.common
The class of HTTP status.
HttpStatusException - Exception in com.linecorp.armeria.server
A RuntimeException that is raised to send a simplistic HTTP response with minimal content by a Service.
httpsUri() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTPS URI for the Server.
httpsUri() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTPS URI for the Server.
httpsUri(SerializationFormat) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTPS URI for the Server.
httpsUri(SerializationFormat) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTPS URI for the Server.
httpsValues() - Static method in enum com.linecorp.armeria.common.SessionProtocol
Returns an immutable Set that contains SessionProtocol.HTTPS, SessionProtocol.H1 and SessionProtocol.H2.
httpUri() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTP URI for the Server.
httpUri() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTP URI for the Server.
httpUri(SerializationFormat) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the HTTP URI for the Server.
httpUri(SerializationFormat) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the HTTP URI for the Server.
httpValues() - Static method in enum com.linecorp.armeria.common.SessionProtocol
Returns an immutable Set that contains SessionProtocol.HTTP, SessionProtocol.H1C and SessionProtocol.H2C.
HttpVfs - Interface in com.linecorp.armeria.server.file
A virtual file system that provides the files requested by FileService.

I

I_CALENDAR_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
I_CALENDAR_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/calendar; charset=utf-8".
ICO - Static variable in class com.linecorp.armeria.common.MediaType
 
ICO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/vnd.microsoft.icon".
id() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the RequestId.
id() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
id() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the RequestId of the current Request and Response pair.
id() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
id() - Method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Returns an ID of this event, if it exists.
id(RequestId) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
id(RequestId) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the RequestId.
id(RequestId) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
id(String) - Method in class com.linecorp.armeria.common.sse.ServerSentEventBuilder
Sets the specified id.
idempotentMethods() - Static method in enum com.linecorp.armeria.common.HttpMethod
IDLE_TIMEOUT_MILLIS - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The idle timeout of a socket connection in milliseconds.
idleTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the idle timeout of a socket connection.
idleTimeout(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the idle timeout of a connection for keep-alive.
idleTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the idle timeout of a socket connection in milliseconds.
idleTimeoutMillis() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the idle timeout of a connection in milliseconds for keep-alive.
idleTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the idle timeout of a socket connection in milliseconds.
idleTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the idle timeout of a connection in milliseconds for keep-alive.
idp() - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Returns a SamlIdentityProviderConfigBuilder to configure a new idp for authentication.
idpConfigSelector(SamlIdentityProviderConfigSelector) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a SamlIdentityProviderConfigSelector which determines a suitable idp for a request.
IF_MATCH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "If-Match" header field name.
IF_MODIFIED_SINCE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "If-Modified-Since" header field name.
IF_NONE_MATCH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "If-None-Match" header field name.
IF_RANGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "If-Range" header field name.
IF_UNMODIFIED_SINCE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "If-Unmodified-Since" header field name.
ignore() - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerDecision
Returns a CircuitBreakerDecision that ignores a Response and does not count as a success nor failure.
immutable() - Method in class com.linecorp.armeria.common.ServerCacheControl
Returns whether the "immutable" directive is enabled.
immutable() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables the "immutable" directive.
immutable(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables or disables the "immutable" directive.
IMMUTABLE - Static variable in class com.linecorp.armeria.common.ServerCacheControl
"max-age=31536000, public, immutable".
implementations() - Method in class com.linecorp.armeria.server.thrift.ThriftServiceEntry
Returns the list of *.AsyncIface or *.Iface implementations.
include(DocServiceFilter) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the DocServiceFilter that checks whether a method will be included while building DocService.
increaseRequestLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Increases the RequestOnlyLog.requestLength() by deltaBytes.
increaseRequestLength(HttpData) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Increases the RequestOnlyLog.requestLength() by data.length() and passes data to the previewer.
increaseResponseLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Increases the RequestLog.responseLength() by deltaBytes.
increaseResponseLength(HttpData) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Increases the RequestLog.responseLength() by data.length() and passes data to the previewer.
inetAddress(InetAddress) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Formats the given InetAddress.
InetAddressPredicates - Class in com.linecorp.armeria.common.util
A utility class which provides factory methods in order to easily create a Predicate of an InetAddress.
INFO - com.linecorp.armeria.common.logging.LogLevel
INFO log level.
INFORMATIONAL - com.linecorp.armeria.common.HttpStatusClass
The informational class (1xx).
informationals() - Method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Returns the informational class (1xx) HTTP headers.
init(EndpointGroup) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
Initializes this context with the specified EndpointGroup.
initialize(Bootstrap<?>) - Method in class com.linecorp.armeria.dropwizard.ArmeriaBundle
 
initialSize() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns the number of initial available tokens available to this bandwidth limit.
injectedScripts(Iterable<String>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds Javascript scripts to inject into the <head /> of the debug page HTML.
injectedScripts(String...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds Javascript scripts to inject into the <head /> of the debug page HTML.
injectedScriptSupplier(BiFunction<ServiceRequestContext, HttpRequest, String>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds a supplier for Javascript scripts to inject into the <head /> of the debug page HTML.
insecure() - Static method in interface com.linecorp.armeria.client.ClientFactory
Returns the insecure default ClientFactory implementation which does not verify server's TLS certificate chain.
instanceId(String) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the specified instanceId.
instanceId(String) - Method in class com.linecorp.armeria.client.zookeeper.CuratorDiscoverySpecBuilder
Sets the specified instance ID.
instanceId(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the ID of this instance.
INSUFFICIENT_STORAGE - Static variable in class com.linecorp.armeria.common.HttpStatus
507 Insufficient Storage (WebDAV, RFC4918).
interfaces() - Method in class com.linecorp.armeria.server.thrift.ThriftServiceEntry
Returns the *.AsyncIface or *.Iface classes implemented by the implementations.
INTERNAL_SERVER_ERROR - Static variable in class com.linecorp.armeria.common.HttpStatus
500 Internal Server Error.
InternalExceptionMessages - Class in com.linecorp.armeria.common.grpc
 
internalGetFieldAccessorTable() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
internalGetFieldAccessorTable() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
internalGetFieldAccessorTable() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
internalGetFieldAccessorTable() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
intValue() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
Returns the integer value of the enum value.
InvalidResponseException - Exception in com.linecorp.armeria.client
A RuntimeException raised when a client received an invalid response.
InvalidResponseException() - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance.
InvalidResponseException(String) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified message.
InvalidResponseException(String, Throwable) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified message and cause.
InvalidResponseException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
InvalidResponseException(Throwable) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified cause.
InvalidResponseHeadersException - Exception in com.linecorp.armeria.client
An InvalidResponseException raised when a client received a response with invalid headers.
InvalidResponseHeadersException(ResponseHeaders) - Constructor for exception com.linecorp.armeria.client.InvalidResponseHeadersException
Creates a new instance with the specified ResponseHeaders.
InvalidResponseHeadersException(ResponseHeaders, Throwable) - Constructor for exception com.linecorp.armeria.client.InvalidResponseHeadersException
Creates a new instance with the specified ResponseHeaders and cause.
InvalidSamlRequestException - Exception in com.linecorp.armeria.server.saml
Indicates that a SAML request is not valid.
InvalidSamlRequestException() - Constructor for exception com.linecorp.armeria.server.saml.InvalidSamlRequestException
Creates a new exception.
InvalidSamlRequestException(String) - Constructor for exception com.linecorp.armeria.server.saml.InvalidSamlRequestException
Creates a new instance with the specified message.
InvalidSamlRequestException(String, Throwable) - Constructor for exception com.linecorp.armeria.server.saml.InvalidSamlRequestException
Creates a new instance with the specified message and cause.
InvalidSamlRequestException(Throwable) - Constructor for exception com.linecorp.armeria.server.saml.InvalidSamlRequestException
Creates a new instance with the specified cause.
InvocationUtil - Class in com.linecorp.armeria.client.retrofit2
Retrieves a Retrofit Invocation associated with a RequestLog.
invokeOnError(AsyncMethodCallback<?>, Throwable) - Static method in class com.linecorp.armeria.common.thrift.AsyncMethodCallbacks
invokeServiceAdded(ServiceConfig, Service<?, ?>) - Static method in class com.linecorp.armeria.server.ServiceCallbackInvoker
ipAddr() - Method in class com.linecorp.armeria.client.Endpoint
Returns the IP address of this endpoint.
ipAddr(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the IP address.
ipFamily() - Method in class com.linecorp.armeria.client.Endpoint
Returns the StandardProtocolFamily of this endpoint's IP address.
is(MediaType) - Method in class com.linecorp.armeria.common.MediaType
Returns true if this instance falls within the range (as defined by the HTTP Accept header) given by the argument according to three criteria: The type of the argument is the wildcard or equal to the type of this instance.
isAccepted(MediaType) - Method in class com.linecorp.armeria.common.SerializationFormat
Returns whether the specified media range is accepted by any of the SerializationFormat.mediaTypes() defined by this format.
isAccepted(MediaType, MediaType...) - Method in class com.linecorp.armeria.common.SerializationFormat
Returns whether any of the specified media ranges is accepted by any of the SerializationFormat.mediaTypes() defined by this format.
isAccepted(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.SerializationFormat
Returns whether any of the specified media ranges is accepted by any of the SerializationFormat.mediaTypes() defined by this format.
isAnyOriginSupported() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Determines whether a wildcard origin, '*', is supported.
isAttached(Appender<ILoggingEvent>) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
isAvailable(RequestLogProperty) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns true if the specified RequestLogProperty is available.
isAvailable(RequestLogProperty...) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns true if all of the specified RequestLogPropertys are available.
isAvailable(Iterable<RequestLogProperty>) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns true if all of the specified RequestLogPropertys are available.
isBase() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns true if this type signature represents a base type.
isCancelled() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
isCancelled() - Method in interface com.linecorp.armeria.common.RequestContext
Returns whether this RequestContext has been cancelled.
isCancelled() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
isClientError() - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the HttpStatus is a client error, with a status code of 4XX.
isClosed() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
isClosed() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
isClosed() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Indicates whether or not this deframer has been closed.
isClosed() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
Indicates whether or not this framer has been closed via a call to either ArmeriaMessageFramer.close().
isClosed() - Method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
 
isClosed() - Method in interface com.linecorp.armeria.common.util.ListenableAsyncCloseable
Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.
isClosed() - Method in class com.linecorp.armeria.common.util.StartStopSupport
 
isClosed() - Method in class com.linecorp.armeria.server.Server
 
isClosing() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
isClosing() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
isClosing() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Indicates whether or not this deframer is closing.
isClosing() - Method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
 
isClosing() - Method in interface com.linecorp.armeria.common.util.ListenableAsyncCloseable
Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.
isClosing() - Method in class com.linecorp.armeria.common.util.StartStopSupport
 
isClosing() - Method in class com.linecorp.armeria.server.Server
 
isComplete() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns true if the Request has been processed completely and thus all properties of the RequestLog have been collected.
isComplete() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream is complete, either successfully or exceptionally, including cancellation and abortion.
isCompletedExceptionally() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns true if this RpcResponse completed exceptionally.
isContainer() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns true if this type signature represents a container type.
isContentAlwaysEmpty() - Method in class com.linecorp.armeria.common.HttpStatus
Returns true if the content of the response for this HttpStatus is expected to be always empty (204, 205 and 304 responses.)
isContentAlwaysEmpty(int) - Static method in class com.linecorp.armeria.common.HttpStatus
Returns true if the content of the response for the specified status code is expected to be always empty (204, 205 and 304 responses.)
isContentTypeAutoDetectionEnabled() - 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.
isCorsPreflight() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns true if this context is for a CORS preflight request.
isCreatable() - Method in class com.linecorp.armeria.server.saml.SamlNameIdPolicy
Returns whether this SamlNameIdPolicy allows to create a new name ID.
isCredentialsAllowed() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Determines if cookies are supported for CORS requests.
isDateEnabled() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
Returns whether to add the "date" header automatically.
isDateEnabled() - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Returns whether to set the "date" header automatically.
isDateHeaderEnabled() - Method in class com.linecorp.armeria.server.ServerConfig
Returns whether the response header will include default "Date" header.
isDefault() - Method in class com.linecorp.armeria.server.saml.SamlAssertionConsumerConfig
Returns whether this configuration is a default.
isDeferred(RequestLogProperty) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Returns true if the specified RequestLogProperty has been deferred with RequestLogBuilder.defer(RequestLogProperty).
isDeferred(RequestLogProperty...) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Returns true if all of the specified RequestLogPropertys have been deferred with RequestLogBuilder.defer(RequestLogProperty).
isDeferred(Iterable<RequestLogProperty>) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Returns true if all of the specified RequestLogPropertys have been deferred with RequestLogBuilder.defer(RequestLogProperty).
isDisabled() - Method in interface com.linecorp.armeria.common.logging.ContentPreviewer
Returns whether this ContentPreviewer is ContentPreviewer.disabled() or not.
isEmpty() - Method in interface com.linecorp.armeria.client.ClientRequestContextCaptor
Returns whether a ClientRequestContext was captured so far.
isEmpty() - Method in class com.linecorp.armeria.common.CacheControl
Returns true if all directives are disabled.
isEmpty() - Method in class com.linecorp.armeria.common.ClientCacheControl
 
isEmpty() - Method in interface com.linecorp.armeria.common.HttpData
Returns whether the HttpData.length() of this data is 0.
isEmpty() - Method in class com.linecorp.armeria.common.ServerCacheControl
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.EmptyFixedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
 
isEmpty() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream has been closed and did not publish any elements.
isEmpty() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
 
isEnabled() - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Returns true if the HTTP content encoding is enabled.
isEnabled() - Method in class com.linecorp.armeria.spring.Ssl
Returns whether to enable SSL support.
isEnabled(Logger) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Returns true if this level is enabled.
isEnableMetrics() - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Returns whether to enable metrics exposition service at the path specified via ArmeriaSettings.setMetricsPath(String).
isEndOfStream() - Method in interface com.linecorp.armeria.common.HttpObject
Tells whether the stream should be ended when writing this object.
isError() - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the HttpStatus is an error.
isException() - Method in class com.linecorp.armeria.common.thrift.ThriftReply
Returns true if the type of this reply is TMessageType.EXCEPTION.
isExpected(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Returns true if the specified exception is expected to occur in well-known circumstances.
isFramed() - Method in interface com.linecorp.armeria.server.grpc.GrpcService
Returns whether this service handles framed requests.
isGrpc(SerializationFormat) - Static method in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
Returns whether the specified SerializationFormat is gRPC.
isGrpcWeb(SerializationFormat) - Static method in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
Returns whether the specified SerializationFormat is gRPC-Web, the subset of gRPC that supports browsers.
isGrpcWebText(SerializationFormat) - Static method in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
Returns whether the specified SerializationFormat is gRPC-web-text which encodes messages using base64.
isHealthy() - Method in interface com.linecorp.armeria.server.healthcheck.HealthChecker
Returns true if and only if the Server is healthy.
isHealthy() - Method in class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
 
isHttpOnly() - Method in interface com.linecorp.armeria.common.Cookie
Returns whether this Cookie can only be accessed via HTTP.
isInformational() - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the HttpStatus is an information, with a status code of 1XX.
isInitialized() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
isInitialized() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
isInitialized() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
isInitialized() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
isIpAddrOnly() - Method in class com.linecorp.armeria.client.Endpoint
Returns whether this endpoint's host name is an IP address.
isJson(SerializationFormat) - Static method in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
Is a json-based gRPC serialization format.
isLastModifiedEnabled() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
Returns whether to add the "last-modified" header automatically.
isLastModifiedEnabled() - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Returns whether to set the "last-modified" header automatically.
isLinux() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Returns true if the operating system is Linux.
isMultiplex() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns true if and only if this protocol can multiplex a single transport-layer connection into more than one stream.
isNamed() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns true if this type signature represents a named type.
isNullOriginAllowed() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Determines if the policy allows a "null" origin.
isOpen() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
isOpen() - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
 
isOpen() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
isOpen() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
isOpen() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream is not closed yet.
isOpen() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
isOpen() - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Returns true if the StreamMessage is open.
isPooled() - Method in interface com.linecorp.armeria.common.HttpData
(Advanced users only) Returns whether this data is pooled.
isPresent() - Method in class com.linecorp.armeria.server.Routed
Returns true if Router found a matching value.
isPresent() - Method in class com.linecorp.armeria.server.RoutingResult
Returns true if this result is not RoutingResult.empty().
isProto(SerializationFormat) - Static method in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
Is a proto-based gRPC serialization format.
isRedirection() - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the HttpStatus is a redirection, with a status code of 3XX.
isRepositoryClean() - Method in class com.linecorp.armeria.common.util.Version
Returns whether the repository was clean when performing the release process.
isRequestComplete() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns true if the Request has been consumed completely and thus all properties of the RequestOnlyLog have been collected.
isRequestStartTimeSet() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns whether the request start time has been specified.
isSampled(T) - Method in interface com.linecorp.armeria.common.util.Sampler
Returns true if a request should be recorded.
isSecure() - Method in interface com.linecorp.armeria.common.Cookie
Returns whether this Cookie is secure.
isSequential() - Method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
Tells whether to create the ZooKeeper node using CreateMode.EPHEMERAL_SEQUENTIAL or not.
isServerError() - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the HttpStatus is a server error, with a status code of 5XX.
isServerHeaderEnabled() - Method in class com.linecorp.armeria.server.ServerConfig
Returns whether the response header will include default "Server" header.
isShortCircuit() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Determines whether a CORS request should be rejected if it's invalid before being further processing.
isStalled() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Indicates whether delivery is currently stalled, pending receipt of more data.
isStreamCancelling(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Returns true if the specified exception will cancel the current request or response stream.
isSuccess() - Method in class com.linecorp.armeria.common.HttpStatus
Returns whether the HttpStatus is a success, with a status code of 2XX.
isSupported(String) - Static method in enum com.linecorp.armeria.common.HttpMethod
Returns whether the specified String is one of the supported method names.
isThrift(SerializationFormat) - Static method in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
Returns whether the specified SerializationFormat is Thrift.
isTimedOut() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
isTimedOut() - Method in interface com.linecorp.armeria.common.RequestContext
Returns whether this RequestContext has been timed-out, that is the cancellation cause is an instance of TimeoutException.
isTimedOut() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
isTls() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns true if and only if this protocol uses TLS as its transport-level security layer.
isUndefinedUri(URI) - Static method in class com.linecorp.armeria.client.Clients
Returns true if the specified uri is an undefined URI, which signifies that a Client, was created without a URI or EndpointGroup.
isUnresolved() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns true if this type signature represents an unresolved type.
isUnsupported(Endpoint, SessionProtocol) - Static method in class com.linecorp.armeria.client.SessionProtocolNegotiationCache
Returns true if the specified Endpoint is known to have no support for the specified SessionProtocol.
isUnsupported(SocketAddress, SessionProtocol) - Static method in class com.linecorp.armeria.client.SessionProtocolNegotiationCache
Returns true if the specified remoteAddress is known to have no support for the specified SessionProtocol.
isUserSpecifiedCuratorFramework() - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
Returns true if this builder is created with AbstractCuratorFrameworkBuilder(CuratorFramework, String).
isValueQuoted() - Method in interface com.linecorp.armeria.common.Cookie
Returns whether the raw value of this Cookie was wrapped with double quotes in the original "Set-Cookie" header.
iterator() - Method in class com.linecorp.armeria.common.MediaTypeSet
 
iterator() - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns an immutable Iterator of user-specified options.
iteratorForAppenders() - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 

J

JacksonRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
A RequestConverterFunction which converts a JSON body of the AggregatedHttpRequest to an object using the default ObjectMapper.
JacksonRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction
Creates an instance with the default ObjectMapper.
JacksonRequestConverterFunction(ObjectMapper) - Constructor for class com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction
Creates an instance with the specified ObjectMapper.
JacksonResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A response converter implementation which creates an HttpResponse with content-type: application/json; charset=utf-8 or content-type: application/json-seq.
JacksonResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.JacksonResponseConverterFunction
Creates an instance with the default ObjectMapper.
JacksonResponseConverterFunction(ObjectMapper) - Constructor for class com.linecorp.armeria.server.annotation.JacksonResponseConverterFunction
Creates an instance with the specified ObjectMapper.
JAVASCRIPT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
RFC 4329 declares this to be the correct media type for JavaScript, but text/javascript may be necessary in certain situations for compatibility.
JAVASCRIPT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/javascript; charset=utf-8".
javaVersion() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Returns the major version of the current Java Virtual Machine.
jettyAlpnOptionalOrAvailable() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Whether the environment either supports ALPN natively or includes Jetty ALPN.
JettyService - Class in com.linecorp.armeria.server.jetty
An HttpService that dispatches its requests to a web application running in an embedded Jetty.
JettyServiceBuilder - Class in com.linecorp.armeria.server.jetty
Builds a JettyService.
join() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns the result value if completed successfully or throws an unchecked exception if completed exceptionally.
join() - Method in class com.linecorp.armeria.common.util.EventLoopCheckingFuture
 
JOSE - Static variable in class com.linecorp.armeria.common.MediaType
JOSE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/jose".
JOSE_JSON - Static variable in class com.linecorp.armeria.common.MediaType
JOSE_JSON - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/jose+json".
JPEG - Static variable in class com.linecorp.armeria.common.MediaType
 
JPEG - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/jpeg".
JSON - Static variable in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
gRPC JSON serialization format.
JSON - Static variable in class com.linecorp.armeria.common.MediaType
 
JSON - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/json".
JSON - Static variable in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
TProtocolFactory for the Thrift TJSON protocol.
JSON - Static variable in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
Thrift TJSON serialization format.
JSON_PATCH - Static variable in class com.linecorp.armeria.common.MediaType
As described in RFC 6902, this constant (application/json-patch+json) is used for expressing a sequence of operations to apply to a JavaScript Object Notation(JSON) document.
JSON_PATCH - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/json-patch+json".
JSON_SEQ - Static variable in class com.linecorp.armeria.common.MediaType
As described in RFC 7464, this constant (application/json-seq) is used for expressing JSON text sequences.
JSON_SEQ - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/json-seq".
JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/json; charset=utf-8".
JSON_WEB - Static variable in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
gRPC-Web JSON serialization format.
jsonMarshallerCustomizer(Consumer<? super MessageMarshaller.Builder>) - Method in class com.linecorp.armeria.common.grpc.GrpcJsonMarshallerBuilder
Sets a Consumer that can customize the JSON marshaller for Message used when handling JSON payloads in the service.
jsonMarshallerFactory(Function<? super ServiceDescriptor, ? extends GrpcJsonMarshaller>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets the factory that creates a GrpcJsonMarshaller that serializes and deserializes request or response messages to and from JSON depending on the SerializationFormat.
JsonTextSequences - Class in com.linecorp.armeria.server.streaming
A utility class which helps to create a JavaScript Object Notation (JSON) Text Sequences from a content Publisher or Stream.

K

KafkaAccessLogWriter<K,​V> - Class in com.linecorp.armeria.server.logging.kafka
An AccessLogWriter that sends access logs to a Kafka backend.
KafkaAccessLogWriter(Producer<K, V>, String, Function<? super RequestLog, ? extends K>, Function<? super RequestLog, ? extends V>) - Constructor for class com.linecorp.armeria.server.logging.kafka.KafkaAccessLogWriter
Creates a new instance.
KafkaAccessLogWriter(Producer<K, V>, String, Function<? super RequestLog, ? extends V>) - Constructor for class com.linecorp.armeria.server.logging.kafka.KafkaAccessLogWriter
Creates a new instance.
KERBEROS - com.linecorp.armeria.server.saml.SamlNameIdFormat
Kerberos name format.
KEY_ARCHIVE - Static variable in class com.linecorp.armeria.common.MediaType
As described in PKCS #12: Personal Information Exchange Syntax Standard, PKCS #12 defines an archive file format for storing many cryptography objects as a single file.
KEY_ARCHIVE - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/pkcs12".
keyPassword(String, String) - Method in class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Adds a key name and its password to the KeyStoreCredentialResolverBuilder.
keyPasswords(Map<String, String>) - Method in class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Adds all key names and their passwords which are specified by the keyPasswords.
keyPattern(String) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
Adds the property represented by the specified key pattern to the export list.
KeyStoreCredentialResolverBuilder - Class in com.linecorp.armeria.server.saml
A builder class which creates a new KeyStoreCredentialResolver instance.
KeyStoreCredentialResolverBuilder(File) - Constructor for class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Creates a builder with the specified File.
KeyStoreCredentialResolverBuilder(ClassLoader, String) - Constructor for class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Creates a builder with the specified ClassLoader and resourcePath.
KeyStoreCredentialResolverBuilder(Path) - Constructor for class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Creates a builder with the file at the specified Path.
KML - Static variable in class com.linecorp.armeria.common.MediaType
KML - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.google-earth.kml+xml".
KMZ - Static variable in class com.linecorp.armeria.common.MediaType
OGC KML (Keyhole Markup Language), compressed using the ZIP format into KMZ archives.
KMZ - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.google-earth.kmz".
knownMethods() - Static method in enum com.linecorp.armeria.common.HttpMethod
Returns all HttpMethods except HttpMethod.UNKNOWN.

L

L16_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
L16 audio, as defined by RFC 2586.
L16_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/l16".
L24_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
L24 audio, as defined by RFC 3190.
L24_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/l24".
LAST_EVENT_ID - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Last-Event-ID" header field name.
LAST_MODIFIED - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Last-Modified" header field name.
lastModified(boolean) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Sets whether to set the "last-modified" header automatically.
lastModified(boolean) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
 
lastModified(boolean) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
 
lastModifiedMillis() - Method in class com.linecorp.armeria.server.file.HttpFileAttributes
Returns the last modified time represented as the number of milliseconds since the epoch.
leaseDuration(Duration) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the lease duration.
leaseDurationMillis(long) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the lease duration in milliseconds.
leaseDurationSeconds(int) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
legacy() - Static method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
Returns the legacy ZooKeeperDiscoverySpec implementation which assumes a znode value is a comma-separated string.
legacy() - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
Returns the ZooKeeperRegistrationSpec that registers the Server using SystemInfo.defaultNonLoopbackIpV4Address() as a host and Server.activePort() as a port_number.
legacy(Endpoint) - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
Returns the ZooKeeperRegistrationSpec that registers the Server using the specified Endpoint.
length() - Method in interface com.linecorp.armeria.common.HttpData
Returns the length of this data.
length() - Method in class com.linecorp.armeria.server.file.HttpFileAttributes
Returns the length in bytes.
length(T) - Method in interface com.linecorp.armeria.common.stream.SignalLengthGetter
Returns the length of obj.
LENGTH_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
411 Length Required.
lifeCycleListener(LifeCycle.Listener) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Adds the specified life cycle listener to the Jetty Server.
limit() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns the bucket size, which defines the count of tokens which can be held by the bucket and defines the speed at which tokens are regenerated in the bucket.
limit(long, long, long, Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder
Adds new BandwidthLimit.
limit(long, long, Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder
Adds new BandwidthLimit.
limit(long, Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder
Adds new BandwidthLimit.
limitHeader() - Method in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders
Returns the name of the "limit" throttling header for the given scheme, like "X-RateLimit-Limit".
limits() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket
Returns multiple limits applied to the bucket.
limits(BandwidthLimit...) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder
Adds a number of BandwidthLimit.
limits(Iterable<BandwidthLimit>) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder
Adds a number of BandwidthLimit.
LINE_NUMBER_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
LINK - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Link" header field name.
LINUX - com.linecorp.armeria.common.util.OsType
 
list(Executor, String) - Method in class com.linecorp.armeria.server.file.AbstractBlockingHttpVfs
Lists the files at the specified directory path non-recursively.
list(Executor, String) - Method in class com.linecorp.armeria.server.file.AbstractHttpVfs
 
list(Executor, String) - Method in interface com.linecorp.armeria.server.file.HttpVfs
Lists the files at the specified directory path non-recursively.
Listenable<T> - Interface in com.linecorp.armeria.common.util
An interface that accepts item change listeners.
ListenableAsyncCloseable - Interface in com.linecorp.armeria.common.util
A variant of AsyncCloseable which allows a user to check whether the object is closed or to get notified when closed.
ListenableHealthChecker - Interface in com.linecorp.armeria.server.healthcheck
A HealthChecker which notifies its state change to its listeners.
listener(CircuitBreakerListener) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
loadDocStrings(Set<ServiceConfig>) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Loads the documentation strings that describes services and their methods, enums and their values and structs/exceptions and their fields.
LOCAL_HOST - com.linecorp.armeria.common.logging.BuiltInProperty
"local.host" - the host name part of the local socket address.
LOCAL_IP - com.linecorp.armeria.common.logging.BuiltInProperty
"local.ip" - the IP address part of the local socket address.
LOCAL_PORT - com.linecorp.armeria.common.logging.BuiltInProperty
"local.port" - the port number part of the local socket address.
localAddress() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the local socket address of the connection.
localAddress() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
localAddress() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the local address of this request, or null if the connection is not established yet.
localAddress() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
localAddress() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
localAddress() - Method in class com.linecorp.armeria.server.ServerPort
Returns the local address this ServerPort listens to.
localAddress() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the local address of this request.
localAddress() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
localAddress(SocketAddress) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
localAddress(SocketAddress) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the local socket address of the connection.
localAddress(SocketAddress) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
LocalArmeriaPort - Exception in com.linecorp.armeria.spring
Specifies an active local port of an Armeria server.
LocalArmeriaPort - Annotation Type in com.linecorp.armeria.spring
Specifies an active local port of an Armeria server.
LocalArmeriaPorts - Exception in com.linecorp.armeria.spring
Specifies active ports of an Armeria server.
LocalArmeriaPorts - Annotation Type in com.linecorp.armeria.spring
Specifies active ports of an Armeria server.
location() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the location of the field.
location(FieldLocation) - Method in class com.linecorp.armeria.server.docs.FieldInfoBuilder
Sets the FieldLocation of the field.
LOCATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Location" header field name.
LOCKED - Static variable in class com.linecorp.armeria.common.HttpStatus
423 Locked (WebDAV, RFC4918).
log() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
log() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the RequestLogAccess that provides the access to the RequestLog, which contains the information collected while processing the current Request.
log() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
log() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
log(RequestLog) - Method in interface com.linecorp.armeria.server.logging.AccessLogWriter
Logs the specified RequestLog.
log(RequestLog) - Method in class com.linecorp.armeria.server.logging.kafka.KafkaAccessLogWriter
 
log(Throwable) - Static method in class com.linecorp.armeria.common.util.CompletionActions
Logs the specified Throwable.
log(Logger, String) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Logs a message at this level.
log(Logger, String, Object) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Logs a message at this level.
log(Logger, String, Object...) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Logs a message at this level.
log(Logger, String, Object, Object) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Logs a message at this level.
log(Logger, String, Object, Object, Object) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Logs a message at this level.
logBuilder() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
logBuilder() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the RequestLogBuilder that collects the information about the current Request.
logBuilder() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
logBuilder() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
logger() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the Logger the user specified to use, or null if not set and a default logger should be used.
logger(String) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
logger(String) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
logger(String) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the name of the Logger to use when logging.
logger(Logger) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
logger(Logger) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
logger(Logger) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Logger to use when logging.
logger(Logger) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
logging() - Static method in interface com.linecorp.armeria.client.ConnectionPoolListener
Returns a ConnectionPoolListener that logs the connection pool events.
logging(Ticker) - Static method in interface com.linecorp.armeria.client.ConnectionPoolListener
Returns a ConnectionPoolListener that logs the connection pool events with an alternative Ticker.
LoggingClient - Class in com.linecorp.armeria.client.logging
Decorates an HttpClient to log Requests and Responses.
LoggingClientBuilder - Class in com.linecorp.armeria.client.logging
Builds a new LoggingClient.
LoggingDecorator - Annotation Type in com.linecorp.armeria.server.annotation.decorator
A LoggingService decorator for annotated HTTP services.
LoggingDecoratorBuilder - Class in com.linecorp.armeria.common.logging
Builds a new logging decorator.
LoggingDecoratorBuilder() - Constructor for class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
 
LoggingDecoratorFactoryFunction - Class in com.linecorp.armeria.server.annotation.decorator
A factory which creates a LoggingService decorator.
LoggingDecoratorFactoryFunction() - Constructor for class com.linecorp.armeria.server.annotation.decorator.LoggingDecoratorFactoryFunction
 
LoggingDecorators - Annotation Type in com.linecorp.armeria.server.annotation.decorator
The containing annotation type for LoggingDecorator.
LoggingRpcClient - Class in com.linecorp.armeria.client.logging
Decorates an RpcClient to log Requests and Responses.
LoggingRpcClientBuilder - Class in com.linecorp.armeria.client.logging
Builds a new LoggingRpcClient.
LoggingService - Class in com.linecorp.armeria.server.logging
Decorates an HttpService to log HttpRequests and HttpResponses.
LoggingServiceBuilder - Class in com.linecorp.armeria.server.logging
Builds a new LoggingService.
logIfUnexpected(Logger, Channel, SessionProtocol, String, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
logIfUnexpected(Logger, Channel, SessionProtocol, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
logIfUnexpected(Logger, Channel, String, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
logIfUnexpected(Logger, Channel, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
loginFailed(ServiceRequestContext, AggregatedHttpRequest, MessageContext<Response>, Throwable) - Method in interface com.linecorp.armeria.server.saml.SamlSingleSignOnHandler
Invoked when the single sign-on is failed.
loginSucceeded(ServiceRequestContext, AggregatedHttpRequest, MessageContext<Response>, String, String) - Method in interface com.linecorp.armeria.server.saml.SamlSingleSignOnHandler
Invoked when the single sign-on is succeeded.
LogLevel - Enum in com.linecorp.armeria.common.logging
Log level.
logoutFailed(ServiceRequestContext, AggregatedHttpRequest, Throwable) - Method in interface com.linecorp.armeria.server.saml.SamlSingleLogoutHandler
Invoked when the single logout request is failed.
logoutSucceeded(ServiceRequestContext, AggregatedHttpRequest, MessageContext<LogoutRequest>) - Method in interface com.linecorp.armeria.server.saml.SamlSingleLogoutHandler
Invoked when the single logout request is succeeded.
longCommitHash() - Method in class com.linecorp.armeria.common.util.Version
Returns the long hash of the release commit.
longPolling(long) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Enables or disables long-polling support.
longPolling(long, double, long) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Enables or disables long-polling support.
longPolling(Duration) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Enables or disables long-polling support.
longPolling(Duration, double, Duration) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Enables or disables long-polling support.
LruMap<T,​U> - Class in com.linecorp.armeria.common.util
LRU (Least Recently Used) cache Map.
LruMap(int) - Constructor for class com.linecorp.armeria.common.util.LruMap
Creates a new instance with the specified maximum number of allowed entries.

M

MAC - com.linecorp.armeria.common.util.OsType
 
makeContextAware(Runnable) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a Runnable that makes sure the current RequestContext is set and then invokes the input runnable.
makeContextAware(Callable<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a Callable that makes sure the current RequestContext is set and then invokes the input callable.
makeContextAware(CompletableFuture<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a CompletableFuture that makes sure the current RequestContext is set and then invokes the input future.
makeContextAware(CompletionStage<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a CompletionStage that makes sure the current RequestContext is set and then invokes the input stage.
makeContextAware(Executor) - Method in interface com.linecorp.armeria.common.RequestContext
Returns an Executor that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
makeContextAware(ExecutorService) - Method in interface com.linecorp.armeria.common.RequestContext
Returns an ExecutorService that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
makeContextAware(ScheduledExecutorService) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a ScheduledExecutorService that will execute callbacks in the given executor, making sure to propagate the current RequestContext into the callback execution.
makeContextAware(BiConsumer<T, U>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a BiConsumer that makes sure the current RequestContext is set and then invokes the input action.
makeContextAware(BiFunction<T, U, V>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a BiFunction that makes sure the current RequestContext is set and then invokes the input function.
makeContextAware(Consumer<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a Consumer that makes sure the current RequestContext is set and then invokes the input action.
makeContextAware(Function<T, R>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a Function that makes sure the current RequestContext is set and then invokes the input function.
makeContextAware(Logger) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a Logger which prepends this RequestContext to the log message.
MANIFEST_JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
MANIFEST_JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/manifest+json; charset=utf-8".
mapCurrent(Function<? super ClientRequestContext, T>, Supplier<T>) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
Maps the client-side context of the Request that is being handled in the current thread.
mapCurrent(Function<? super RequestContext, T>, Supplier<T>) - Static method in interface com.linecorp.armeria.common.RequestContext
Maps the context of the Request that is being handled in the current thread.
mapCurrent(Function<? super ServiceRequestContext, T>, Supplier<T>) - Static method in interface com.linecorp.armeria.server.ServiceRequestContext
Maps the server-side context of the Request that is being handled in the current thread.
mappedPath() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
mappedPath() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the RequestContext.path() with its context path removed.
mappedPath() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
mapping(CircuitBreakerMapping) - Method in class com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClientBuilder
mapping(CircuitBreakerMapping) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClientBuilder
 
mapping(CircuitBreakerMapping) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClientBuilder
 
match(MediaType) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches the specified media range.
match(MediaType, MediaType...) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the specified media ranges.
match(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the specified media ranges.
MATCHED - com.linecorp.armeria.server.RoutingResultType
A Route matched a RoutingContext.
MatchesHeader - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a predicate which evaluates whether a request can be accepted by a service method.
matchesHeaders(CharSequence, Predicate<? super String>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
matchesHeaders(CharSequence, Predicate<? super String>) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified headerName header.
matchesHeaders(CharSequence, Predicate<? super String>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
matchesHeaders(CharSequence, Predicate<? super String>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
matchesHeaders(CharSequence, Predicate<? super String>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
matchesHeaders(Iterable<String>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
matchesHeaders(Iterable<String>) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders.
matchesHeaders(Iterable<String>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
matchesHeaders(Iterable<String>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
matchesHeaders(Iterable<String>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
matchesHeaders(String...) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
matchesHeaders(String...) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders.
matchesHeaders(String...) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
matchesHeaders(String...) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
matchesHeaders(String...) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
MatchesHeaders - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for MatchesHeader.
MatchesParam - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a predicate which evaluates whether a request can be accepted by a service method.
matchesParams(Iterable<String>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
matchesParams(Iterable<String>) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters.
matchesParams(Iterable<String>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
matchesParams(Iterable<String>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
matchesParams(Iterable<String>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
matchesParams(String...) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
matchesParams(String...) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters.
matchesParams(String...) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
matchesParams(String...) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
matchesParams(String...) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
matchesParams(String, Predicate<? super String>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
matchesParams(String, Predicate<? super String>) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified paramName parameter.
matchesParams(String, Predicate<? super String>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
matchesParams(String, Predicate<? super String>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
matchesParams(String, Predicate<? super String>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
MatchesParams - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for MatchesParam.
matchHeaders(CharSequence...) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the media ranges specified in the specified string.
matchHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the media ranges specified in the specified string.
MAX_FORWARDS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Max-Forwards" header field name.
MAX_INBOUND_MESSAGE_SIZE_BYTES - Static variable in class com.linecorp.armeria.client.grpc.GrpcClientOptions
The maximum size, in bytes, of messages coming in a response.
MAX_OUTBOUND_MESSAGE_SIZE_BYTES - Static variable in class com.linecorp.armeria.client.grpc.GrpcClientOptions
The maximum size, in bytes, of messages sent in a request.
MAX_RESPONSE_LENGTH - Static variable in class com.linecorp.armeria.client.ClientOptions
The maximum allowed length of a server response.
maxAge() - Method in interface com.linecorp.armeria.common.Cookie
Returns the maximum age of this Cookie in seconds.
maxAge() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
The value of the CORS "Access-Control-Max-Age" response header which enables the caching of the preflight response for the specified time.
maxAge() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Gets the maxAge setting.
maxAge(long) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the maximum age of the Cookie in seconds.
maxAge(long) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
maxAge(long) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
maxAge(long) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Sets the CORS "Access-Control-Max-Age" response header and enables the caching of the preflight response for the specified time.
maxAge(Duration) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
maxAge(Duration) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
maxAge(Duration) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Sets the CORS "Access-Control-Max-Age" response header and enables the caching of the preflight response for the specified time.
maxAgeSeconds() - Method in class com.linecorp.armeria.common.CacheControl
Returns the value of the "max-age" directive or -1 if disabled.
maxAgeSeconds(long) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
maxAgeSeconds(long) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
maxCacheEntries(int) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
Sets the maximum allowed number of cached file entries.
maxCacheEntrySizeBytes() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
Returns the maximum allowed size of a cached file entry.
maxCacheEntrySizeBytes(int) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
Sets the maximum allowed size of a cached file entry.
maxConnectionAge(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed age of a connection for keep-alive.
maxConnectionAgeMillis() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum allowed age of a connection in milliseconds for keep-alive.
maxConnectionAgeMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed age of a connection in millis for keep-alive.
maxEndpointCount(int) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the maximum endpoint count of target selected candidates.
maxEndpointCount(int) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
maxEndpointRatio(double) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the maximum endpoint ratio of target selected candidates.
maxEndpointRatio(double) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
maxLength(int) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the maximum length of the produced preview.
maxNumConnections() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side maximum number of connections.
maxNumConnections() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum allowed number of open connections.
maxNumConnections(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed number of open connections.
maxNumEventLoopsFunction(ToIntFunction<Endpoint>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the ToIntFunction which takes an Endpoint and produces the maximum number of EventLoops which will be used to handle connections to the specified Endpoint.
maxNumEventLoopsPerEndpoint(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum number of EventLoops which will be used to handle HTTP/2 connections except the ones specified by ClientFactoryBuilder.maxNumEventLoopsFunction(ToIntFunction).
maxNumEventLoopsPerHttp1Endpoint(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum number of EventLoops which will be used to handle HTTP/1.1 connections except the ones specified by ClientFactoryBuilder.maxNumEventLoopsFunction(ToIntFunction).
maxPayloadSize(int) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the capacity of the datagram packet buffer in bytes.
maxQueriesPerResolve(int) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Returns the maximum allowed number of DNS queries to send when resolving a host name.
maxRequestLength() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
maxRequestLength() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the maximum allowed length of the content decoded at the session layer.
maxRequestLength() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the maximum length of the current Request.
maxRequestLength() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
maxRequestLength() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the maximum allowed length of the content decoded at the session layer.
maxRequestLength(long) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
 
maxRequestLength(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed length of the content decoded at the session layer.
maxRequestLength(long) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
maxRequestLength(long) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
 
maxRequestLength(long) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the maximum allowed length of the content decoded at the session layer.
maxRequestLength(long) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
maxResponseLength() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the maximum allowed length of a server response.
maxResponseLength() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the maximum length of the received Response.
maxResponseLength() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
maxResponseLength() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
maxResponseLength(long) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the maximum allowed length of a server response in bytes.
maxResponseLength(long) - Method in class com.linecorp.armeria.client.ClientBuilder
 
maxResponseLength(long) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
maxResponseLength(long) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
maxResponseLength(long) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
maxResponseLength(long) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
maxResponseLength(long) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
maxStale() - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables the "max-stale directive without a value.
maxStale(boolean) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables or disables the "max-stale" directive.
maxStale(Duration) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables or disables the "max-stale" directive.
maxStaleSeconds() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns the value of the "max-stale" directive or -1 if disabled or the value is not specified.
maxStaleSeconds(long) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables the "max-stale" directive.
maxTotalAttempts(int) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClientBuilder
Sets the maximum allowed number of total attempts.
maxTotalAttempts(int) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
 
maxTotalAttempts(int) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
 
MBOX - Static variable in class com.linecorp.armeria.common.MediaType
MBOX - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/mbox".
measureAll(MeterRegistry) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns a newly-created immutable Map which contains all values of Meters in the specified MeterRegistry.
mediaType() - Method in class com.linecorp.armeria.common.SerializationFormat
Returns the primary MediaType of this format.
MediaType - Class in com.linecorp.armeria.common
Represents an Internet Media Type (also known as a MIME Type or Content Type).
MediaTypeNames - Class in com.linecorp.armeria.common
String constants defined in MediaType class.
mediaTypes() - Method in class com.linecorp.armeria.common.SerializationFormat
Returns the media types accepted by this format.
MediaTypeSet - Class in com.linecorp.armeria.common
An immutable Set of MediaTypes which provides useful methods for content negotiation.
merge(Iterable<ServiceSpecification>) - Static method in class com.linecorp.armeria.server.docs.ServiceSpecification
Merges the specified ServiceSpecifications into one.
mergeCause(ThrowableProto) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
mergeFrom(CodedInputStream, ExtensionRegistryLite) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
mergeFrom(CodedInputStream, ExtensionRegistryLite) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
mergeFrom(Message) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
mergeFrom(Message) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
mergeFrom(StackTraceElementProto) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
mergeFrom(ThrowableProto) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
mergeUnknownFields(UnknownFieldSet) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
mergeUnknownFields(UnknownFieldSet) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
messageRead(ArmeriaMessageDeframer.DeframedMessage) - Method in interface com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.Listener
Called to deliver the next complete message.
metadata() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
Returns the metadata.
metadata(Map<String, String>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the metadata.
metadata(Map<String, String>) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
Sets the metadata.
metadataPath(String) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a URL for retrieving a metadata of this service provider.
METER_REGISTRY - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The MeterRegistry which collects various stats.
MeterIdPrefix - Class in com.linecorp.armeria.common.metric
A common prefix of Meter.Id which consists of Meter name and Tags.
MeterIdPrefix(String) - Constructor for class com.linecorp.armeria.common.metric.MeterIdPrefix
Creates a new instance with no Tags.
MeterIdPrefix(String, Iterable<Tag>) - Constructor for class com.linecorp.armeria.common.metric.MeterIdPrefix
Creates a new instance.
MeterIdPrefix(String, String...) - Constructor for class com.linecorp.armeria.common.metric.MeterIdPrefix
Creates a new instance.
MeterIdPrefixFunction - Interface in com.linecorp.armeria.common.metric
Creates a MeterIdPrefix from a RequestLog.
MeterIdPrefixFunctionCustomizer - Interface in com.linecorp.armeria.common.metric
Transforms a MeterIdPrefix into another.
meterRegistry() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the MeterRegistry that collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the MeterRegistry which collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
meterRegistry() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the MeterRegistry.
meterRegistry() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
meterRegistry() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the MeterRegistry that collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
meterRegistry() - Method in class com.linecorp.armeria.server.Server
Returns the MeterRegistry that collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the MeterRegistry that collects various stats.
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the MeterRegistry which collects various stats.
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the MeterRegistry.
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the MeterRegistry that collects various stats.
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
meterTag() - Method in interface com.linecorp.armeria.server.file.HttpVfs
Returns the value of the "vfs" Tag in a Meter.
method() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the HttpMethod of the request.
method() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Returns the METHOD of this request.
method() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the method of this request.
method() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
method() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the HTTP method of the current Request.
method() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
method() - Method in interface com.linecorp.armeria.common.RpcRequest
Returns the method name.
method() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns HttpMethod of the request.
method(HttpMethod) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
method(HttpMethod) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the HttpMethod of the request.
method(HttpMethod) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
Sets the ":method" header.
METHOD - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP ":method" pseudo header field name.
METHOD_NAME_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
METHOD_NOT_ALLOWED - Static variable in class com.linecorp.armeria.common.HttpStatus
405 Method Not Allowed.
MethodInfo - Class in com.linecorp.armeria.server.docs
Metadata about a function of a Service.
MethodInfo(String, TypeSignature, Iterable<FieldInfo>, Iterable<TypeSignature>, Iterable<EndpointInfo>, HttpMethod, String) - Constructor for class com.linecorp.armeria.server.docs.MethodInfo
Creates a new instance.
MethodInfo(String, TypeSignature, Iterable<FieldInfo>, Iterable<TypeSignature>, Iterable<EndpointInfo>, Iterable<HttpHeaders>, Iterable<String>, Iterable<String>, Iterable<String>, HttpMethod, String) - Constructor for class com.linecorp.armeria.server.docs.MethodInfo
Creates a new instance.
methods() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the metadata about the methods available in the service.
methods() - Method in interface com.linecorp.armeria.server.grpc.GrpcService
Returns a Map whose key is a route path and whose value is ServerMethodDefinition, which is serviced by this service.
methods() - Method in interface com.linecorp.armeria.server.Route
Returns the Set of non-empty HttpMethods that this Route supports.
methods(HttpMethod...) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
methods(HttpMethod...) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to support the specified HttpMethods.
methods(HttpMethod...) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
methods(HttpMethod...) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
methods(HttpMethod...) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
methods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
methods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to support the specified HttpMethods.
methods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
methods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
methods(Iterable<HttpMethod>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
metricCollecting(MeterRegistry) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Returns a new CircuitBreakerListener that collects metric with the specified MeterRegistry.
metricCollecting(MeterRegistry, String) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Returns a new CircuitBreakerListener that collects metric with the specified MeterRegistry and Meter name.
MetricCollectingClient - Class in com.linecorp.armeria.client.metric
Decorates an HttpClient to collect metrics into MeterRegistry.
MetricCollectingRpcClient - Class in com.linecorp.armeria.client.metric
Decorates an RpcClient to collect metrics into MeterRegistry.
MetricCollectingService - Class in com.linecorp.armeria.server.metric
Decorates an HttpService to collect metrics into MeterRegistry.
MICROSOFT_EXCEL - Static variable in class com.linecorp.armeria.common.MediaType
Microsoft Excel spreadsheets.
MICROSOFT_EXCEL - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.ms-excel".
MICROSOFT_OUTLOOK - Static variable in class com.linecorp.armeria.common.MediaType
MICROSOFT_OUTLOOK - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.ms-outlook".
MICROSOFT_POWERPOINT - Static variable in class com.linecorp.armeria.common.MediaType
Microsoft Powerpoint presentations.
MICROSOFT_POWERPOINT - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.ms-powerpoint".
MICROSOFT_WORD - Static variable in class com.linecorp.armeria.common.MediaType
Microsoft Word documents.
MICROSOFT_WORD - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/msword".
minBytesToForceChunkedEncoding(int) - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
Sets the specified minimum length to force chunked encoding.
minFresh(Duration) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables or disables the "min-fresh" directive.
minFreshSeconds() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns the value of the "min-fresh" directive or -1 if disabled.
minFreshSeconds(long) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables the "min-fresh" directive.
minimumBackoff(Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder
Optional Duration that defines a minimum backoff period for throttled requests.
minimumRequestThreshold(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the minimum number of requests within a time window necessary to detect a remote service fault.
MISDIRECTED_REQUEST - Static variable in class com.linecorp.armeria.common.HttpStatus
421 Misdirected Request.
MockWebServerExtension - Class in com.linecorp.armeria.testing.junit5.server.mock
An Extension primarily for testing clients.
MockWebServerExtension() - Constructor for class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
 
MoreMeters - Class in com.linecorp.armeria.common.metric
Provides utilities for accessing MeterRegistry.
MOVED_PERMANENTLY - Static variable in class com.linecorp.armeria.common.HttpStatus
301 Moved Permanently.
MP4_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
MP4_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/mp4".
MP4_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
MP4_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/mp4".
MPEG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
MPEG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/mpeg".
MPEG_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
MPEG_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/mpeg".
MULTI_STATUS - Static variable in class com.linecorp.armeria.common.HttpStatus
207 Multi-Status (WebDAV, RFC2518).
MULTIPLE_CHOICES - Static variable in class com.linecorp.armeria.common.HttpStatus
300 Multiple Choices.
mustRevalidate() - Method in class com.linecorp.armeria.common.ServerCacheControl
Returns whether the "must-revalidate" directive is enabled.
mustRevalidate() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables the "must-revalidate" directive.
mustRevalidate(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables or disables the "must-revalidate" directive.
mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder>) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Mutates the HttpHeaders which will be included when a Client sends an HttpRequest.
mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder>) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder>) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder>) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder>) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Mutates the HttpHeaders which will be included when a Service sends an HttpResponse.
mutateAdditionalResponseHeaders(Consumer<HttpHeadersBuilder>) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder>) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder>) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Mutates the HttpHeaders which is included along with any other trailers when a Service completes an HttpResponse.
mutateAdditionalResponseTrailers(Consumer<HttpHeadersBuilder>) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 

N

NACL_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaType
NaCl applications.
NACL_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/x-nacl".
NACL_PORTABLE_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaType
NaCl portable applications.
NACL_PORTABLE_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/x-pnacl".
name() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Returns the name of the circuit breaker.
name() - Method in interface com.linecorp.armeria.common.Cookie
Returns the name of this Cookie.
name() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the human-readable simple name of the Request, such as: gRPC - A capitalized method name defined in io.grpc.MethodDescriptor (e.g, GetItems) Thrift and annotated service - a method name (e.g, getItems) HttpService - an HTTP method name This property is often used as a meter tag or distributed trace's span name.
name() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the name.
name() - Method in class com.linecorp.armeria.common.util.AbstractOption
Returns the name of this option.
name() - Method in annotation type com.linecorp.armeria.server.annotation.AdditionalHeader
The name of the HTTP header to set.
name() - Method in annotation type com.linecorp.armeria.server.annotation.AdditionalTrailer
The name of the HTTP trailer to set.
name() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.RateLimitingDecorator
The name of the configured ThrottlingStrategy.
name() - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Returns the name of this plugin.
name() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
name() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
Returns the name of the enum value.
name() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
name() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the fully qualified type name of the field.
name() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the name of the function.
name() - Method in interface com.linecorp.armeria.server.docs.NamedTypeInfo
Returns the fully qualified type name.
name() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the fully qualified type name of the service.
name() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
name() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the name of the type.
name() - Method in class com.linecorp.armeria.server.thrift.ThriftServiceEntry
Returns the service name.
name() - Method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns the name of this ThrottlingStrategy.
name(String) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the name of the Cookie.
name(String) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets the human-readable name of the Request, such as RPC method name, annotated service method name or HTTP method name.
name(String) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the name concatenated by the specified suffix.
name(String) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder
Optional name of the strategy.
name(String, String) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets the human-readable service name and method name of the Request such as: A service and method name for gRPC and Thrift An innermost class and method name for annotated service A path pattern and HTTP method name for HttpService This property is often used as a meter tag or distributed trace's span name.
NAME - com.linecorp.armeria.common.logging.RequestLogProperty
namedTypeDescriptor() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the descriptor of the type if and only if this type signature represents a named type.
NamedTypeInfo - Interface in com.linecorp.armeria.server.docs
Metadata about a named type.
nameIdPolicy() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns a NameIDPolicy of the service provider which is sent to the identity provider via an authentication request.
nameIdPolicy(SamlNameIdPolicy) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets a SamlNameIdPolicy to configure an AuthnRequest.
nameWithoutParameters() - Method in class com.linecorp.armeria.common.MediaType
Returns a name of this MediaType only consisting of the type and the sub type.
ndots(int) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the number of dots which must appear in a name before an initial absolute query is made.
negativeTtl(int) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the TTL of the cache for the failed DNS queries in seconds.
negotiatedResponseMediaType() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
negotiatedResponseMediaType() - Method in class com.linecorp.armeria.server.RoutingResult
Returns the negotiated producible media type.
negotiatedResponseMediaType() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the negotiated producible media type.
negotiatedResponseMediaType() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
negotiatedResponseMediaType(MediaType) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
Sets the negotiated producible MediaType.
NETWORK_AUTHENTICATION_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
511 Network Authentication Required (RFC6585).
never() - Static method in interface com.linecorp.armeria.common.util.Sampler
Returns a sampler that will always return false.
never() - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns a singleton ThrottlingStrategy that never accepts requests.
newBuilder() - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
newBuilder() - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
newBuilder(StackTraceElementProto) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
newBuilder(ThrowableProto) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
newBuilderForType() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
newBuilderForType() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
newBuilderForType(GeneratedMessageV3.BuilderParent) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
newBuilderForType(GeneratedMessageV3.BuilderParent) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
newCheckerFactory() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Returns the Function that starts to send health check requests to the Endpoint specified in a given HealthCheckerContext when invoked.
newCheckerFactory() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
newClient(ClientBuilderParams) - Method in interface com.linecorp.armeria.client.ClientFactory
Creates a new client with the specified ClientBuilderParams.
newClient(ClientBuilderParams) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
newClient(Scheme, EndpointGroup, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified EndpointGroup with the specified Scheme using the default ClientFactory.
newClient(Scheme, EndpointGroup, String, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified EndpointGroup with the specified Scheme and path using the default ClientFactory.
newClient(SessionProtocol, EndpointGroup, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified EndpointGroup with the specified SessionProtocol using the default ClientFactory.
newClient(SessionProtocol, EndpointGroup, String, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified EndpointGroup with the specified SessionProtocol and path using the default ClientFactory.
newClient(String, EndpointGroup, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified EndpointGroup with the specified scheme using the default ClientFactory.
newClient(String, EndpointGroup, String, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified EndpointGroup with the specified scheme and path using the default ClientFactory.
newClient(String, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified uri using the default ClientFactory.
newClient(URI, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified URI using the default ClientFactory.
newContextCaptor() - Static method in class com.linecorp.armeria.client.Clients
Prepare to capture the ClientRequestContext of the next request sent from the current thread.
newCounter(Meter.Id) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newDecoder(ByteBufAllocator) - Method in interface com.linecorp.armeria.client.encoding.StreamDecoderFactory
Deprecated.
Construct a new StreamDecoder to use to decode an HttpResponse.
newDecoder(ByteBufAllocator) - Method in interface com.linecorp.armeria.common.encoding.StreamDecoderFactory
Construct a new StreamDecoder to use to decode an HttpResponse.
newDecorator() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClientBuilder
Returns a newly-created decorator that decorates an HttpClient with a new CircuitBreakerClient based on the properties of this builder.
newDecorator() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClientBuilder
Returns a newly-created decorator that decorates an RpcClient with a new CircuitBreakerRpcClient based on the properties of this builder.
newDecorator() - Static method in class com.linecorp.armeria.client.encoding.DecodingClient
Creates a new DecodingClient decorator with the default encodings of 'gzip' and 'deflate'.
newDecorator() - Static method in class com.linecorp.armeria.client.logging.LoggingClient
Returns a new HttpClient decorator that logs Requests and Responses at LogLevel.DEBUG for success, LogLevel.WARN for failure.
newDecorator() - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
Returns a newly-created LoggingClient decorator based on the properties of this builder.
newDecorator() - Static method in class com.linecorp.armeria.client.logging.LoggingRpcClient
Returns a new RpcClient decorator that logs Requests and Responses at LogLevel.DEBUG for success, LogLevel.WARN for failure.
newDecorator() - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
Returns a newly-created LoggingRpcClient decorator based on the properties of this builder.
newDecorator() - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
Returns a newly-created decorator that decorates an HttpClient with a new RetryingClient based on the properties of this builder.
newDecorator() - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
Returns a newly-created decorator that decorates an RpcClient with a new RetryingRpcClient based on the properties of this builder.
newDecorator() - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
Returns a newly-created decorator that decorates an HttpService with a new AuthService based on the Authorizers added to this builder.
newDecorator() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Returns a newly-created decorator that decorates an HttpService with a new CorsService based on the properties of this builder.
newDecorator() - Static method in class com.linecorp.armeria.server.encoding.DecodingService
Creates a new DecodingService decorator with the default encodings of 'gzip' and 'deflate'.
newDecorator() - Static method in class com.linecorp.armeria.server.encoding.EncodingService
Returns a new HttpService decorator.
newDecorator() - Method in class com.linecorp.armeria.server.encoding.EncodingServiceBuilder
Returns a newly-created decorator that decorates an HttpService with a new EncodingService based on the properties of this builder.
newDecorator() - Static method in class com.linecorp.armeria.server.logging.LoggingService
Returns a new HttpService decorator that logs HttpRequests and HttpResponses at LogLevel.DEBUG for success, LogLevel.WARN for failure.
newDecorator() - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
Returns a newly-created LoggingService decorator based on the properties of this builder.
newDecorator() - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new decorator that supports all thrift protocols and defaults to TBinary protocol when the client doesn't specify one.
newDecorator() - Method in class com.linecorp.armeria.server.throttling.ThrottlingRpcServiceBuilder
Returns a newly-created decorator that decorates an Service with a new ThrottlingService based on the ThrottlingStrategys added to this builder.
newDecorator() - Method in class com.linecorp.armeria.server.throttling.ThrottlingServiceBuilder
Returns a newly-created decorator that decorates an Service with a new ThrottlingService based on the ThrottlingStrategys added to this builder.
newDecorator(int) - Static method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Creates a new HttpClient decorator that limits the concurrent number of active HTTP requests.
newDecorator(int) - Static method in class com.linecorp.armeria.client.logging.ContentPreviewingClient
Creates a new ContentPreviewingClient decorator which produces text preview with the specified maxLength limit.
newDecorator(int) - Static method in class com.linecorp.armeria.server.logging.ContentPreviewingService
Creates a new ContentPreviewingService decorator which produces text preview with the specified maxLength limit.
newDecorator(int, long, TimeUnit) - Static method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Creates a new HttpClient decorator that limits the concurrent number of active HTTP requests.
newDecorator(int, Charset) - Static method in class com.linecorp.armeria.client.logging.ContentPreviewingClient
Creates a new ContentPreviewingClient decorator which produces text preview with the specified maxLength limit.
newDecorator(int, Charset) - Static method in class com.linecorp.armeria.server.logging.ContentPreviewingService
Creates a new ContentPreviewingService decorator which produces text preview with the specified maxLength limit.
newDecorator(HttpTracing) - Static method in class com.linecorp.armeria.client.brave.BraveClient
Creates a new tracing HttpClient decorator using the specified HttpTracing instance.
newDecorator(HttpTracing) - Static method in class com.linecorp.armeria.server.brave.BraveService
Creates a new tracing HttpService decorator using the specified HttpTracing instance.
newDecorator(Tracing) - Static method in class com.linecorp.armeria.client.brave.BraveClient
Creates a new tracing HttpClient decorator using the specified Tracing instance.
newDecorator(Tracing) - Static method in class com.linecorp.armeria.server.brave.BraveService
Creates a new tracing HttpService decorator using the specified Tracing instance.
newDecorator(Tracing, String) - Static method in class com.linecorp.armeria.client.brave.BraveClient
Creates a new tracing HttpClient decorator using the specified Tracing instance and the remote service name.
newDecorator(CircuitBreakerMapping, CircuitBreakerRule) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRule.
newDecorator(CircuitBreakerMapping, CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRuleWithContent.
newDecorator(CircuitBreakerMapping, CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRuleWithContent.
newDecorator(CircuitBreaker, CircuitBreakerRule) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerRule.
newDecorator(CircuitBreaker, CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerRuleWithContent.
newDecorator(CircuitBreaker, CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerRuleWithContent.
newDecorator(StreamDecoderFactory...) - Static method in class com.linecorp.armeria.client.encoding.DecodingClient
Creates a new DecodingClient decorator with the specified StreamDecoderFactorys.
newDecorator(RetryRule) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryRule, int) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryRule, int, long) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryRuleWithContent<HttpResponse>, int) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryRuleWithContent<HttpResponse>, int, long) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.
newDecorator(RetryRuleWithContent<RpcResponse>, int) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.
newDecorator(RetryRuleWithContent<RpcResponse>, int, long) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.
newDecorator(StreamDecoderFactory...) - Static method in class com.linecorp.armeria.server.encoding.DecodingService
Creates a new DecodingService decorator with the specified StreamDecoderFactorys.
newDecorator(CoroutineContextProvider) - Static method in class com.linecorp.armeria.server.kotlin.CoroutineContextService
Returns a new HttpService decorator that injects into annotated services the coroutine context provided by the specified provider.
newDecorator(ContentPreviewerFactory) - Static method in class com.linecorp.armeria.client.logging.ContentPreviewingClient
Creates a new ContentPreviewingClient decorator with the specified ContentPreviewerFactory.
newDecorator(ContentPreviewerFactory) - Static method in class com.linecorp.armeria.server.logging.ContentPreviewingService
Creates a new ContentPreviewingService decorator with the specified ContentPreviewerFactory.
newDecorator(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.client.metric.MetricCollectingClient
Returns an HttpClient decorator that tracks request stats using MeterRegistry.
newDecorator(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.client.metric.MetricCollectingRpcClient
Returns an RpcClient decorator that tracks request stats using MeterRegistry.
newDecorator(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.server.metric.MetricCollectingService
Returns a new HttpService decorator that tracks request stats using MeterRegistry.
newDecorator(SerializationFormat) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new decorator that supports all thrift protocols and defaults to the specified defaultSerializationFormat when the client doesn't specify one.
newDecorator(SerializationFormat, SerializationFormat...) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new decorator that supports only the formats specified and defaults to the specified defaultSerializationFormat when the client doesn't specify one.
newDecorator(SerializationFormat, Iterable<SerializationFormat>) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new decorator that supports the protocols specified in otherSupportedSerializationFormats and defaults to the specified defaultSerializationFormat when the client doesn't specify one.
newDecorator(CorsDecorator) - Method in class com.linecorp.armeria.server.cors.CorsDecoratorFactoryFunction
 
newDecorator(CorsDecorators) - Method in class com.linecorp.armeria.server.cors.CorsDecoratorsFactoryFunction
 
newDecorator(LoggingDecorator) - Method in class com.linecorp.armeria.server.annotation.decorator.LoggingDecoratorFactoryFunction
Creates a new decorator with the specified parameter.
newDecorator(RateLimitingDecorator) - Method in class com.linecorp.armeria.server.annotation.decorator.RateLimitingDecoratorFactoryFunction
Creates a new decorator with the specified parameter.
newDecorator(Authorizer<HttpRequest>...) - Static method in class com.linecorp.armeria.server.auth.AuthService
Creates a new HTTP authorization HttpService decorator using the specified Authorizers.
newDecorator(ThrottlingStrategy<HttpRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingService
Creates a new decorator using the specified ThrottlingStrategy.
newDecorator(ThrottlingStrategy<HttpRequest>, ThrottlingRejectHandler<HttpRequest, HttpResponse>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingService
Creates a new decorator using the specified ThrottlingStrategy and ThrottlingRejectHandler.
newDecorator(ThrottlingStrategy<RpcRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingRpcService
Creates a new decorator using the specified ThrottlingStrategy.
newDecorator(ThrottlingStrategy<RpcRequest>, ThrottlingRejectHandler<RpcRequest, RpcResponse>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingRpcService
Creates a new decorator using the specified ThrottlingStrategy and ThrottlingRejectHandler.
newDecorator(Iterable<? extends StreamDecoderFactory>) - Static method in class com.linecorp.armeria.client.encoding.DecodingClient
Creates a new DecodingClient decorator with the specified StreamDecoderFactorys.
newDecorator(Iterable<? extends StreamDecoderFactory>) - Static method in class com.linecorp.armeria.server.encoding.DecodingService
Creates a new DecodingService decorator with the specified StreamDecoderFactorys.
newDecorator(Iterable<? extends Authorizer<HttpRequest>>) - Static method in class com.linecorp.armeria.server.auth.AuthService
Creates a new HTTP authorization HttpService decorator using the specified Authorizers.
newDecorator(T) - Method in interface com.linecorp.armeria.server.annotation.DecoratorFactoryFunction
Creates a new decorator with the specified parameter.
newDeferredResponse(ClientRequestContext, CompletionStage<HttpResponse>) - Method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
 
newDeferredResponse(ClientRequestContext, CompletionStage<O>) - Method in class com.linecorp.armeria.client.limit.AbstractConcurrencyLimitingClient
Implement this method to return a new Response which delegates to the Response the specified CompletionStage is completed with.
newDerivedClient(T, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.Clients
Creates a new derived client that connects to the same URI with the specified client and the specified additionalOptions.
newDerivedClient(T, Iterable<ClientOptionValue<?>>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new derived client that connects to the same URI with the specified client and the specified additionalOptions.
newDerivedClient(T, Function<? super ClientOptions, ClientOptions>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new derived client that connects to the same URI with the specified client but with different ClientOptions.
newDerivedContext(ClientRequestContext, HttpRequest, RpcRequest, boolean) - Static method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Creates a new derived ClientRequestContext, replacing the requests.
newDerivedContext(RequestId, HttpRequest, RpcRequest, Endpoint) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having different Request, Endpoint and its own RequestLog.
newDerivedContext(RequestId, HttpRequest, RpcRequest, Endpoint) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
newDerivedContext(RequestId, HttpRequest, RpcRequest, Endpoint) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
newDistributionSummary(Meter.Id, DistributionStatisticConfig, double) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newDistributionSummary(MeterRegistry, String, Iterable<Tag>) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns a newly-registered DistributionSummary configured by MoreMeters.distributionStatisticConfig().
newEventLoopGroup(int) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, boolean) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, String) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, String, boolean) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, ThreadFactory) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopThreadFactory(String, boolean) - Static method in class com.linecorp.armeria.common.util.ThreadFactories
Creates a new ThreadFactory for event loop thread.
newFactory(ClientFactory) - Method in interface com.linecorp.armeria.client.ClientFactoryProvider
Creates a new ClientFactory.
newFunctionCounter(Meter.Id, T, ToDoubleFunction<T>) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newFunctionTimer(Meter.Id, T, ToLongFunction<T>, ToDoubleFunction<T>, TimeUnit) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newGauge(Meter.Id, T, ToDoubleFunction<T>) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newHttpClient(ClientBuilderParams) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
Creates a new HttpClient which uses the same SessionProtocol, EndpointGroup and ClientOptions with the specified ClientBuilderParams.
newId() - Method in interface com.linecorp.armeria.server.saml.SamlRequestIdManager
Returns a newly-generated request ID.
newInstance(GeneratedMessageV3.UnusedPrivateParameter) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
newInstance(GeneratedMessageV3.UnusedPrivateParameter) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
newLongTaskTimer(Meter.Id) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newMeter(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newMeterBinder(MeterIdPrefix) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup.
newMeterBinder(String) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup with the default meter names.
newPerHostAndMethodDecorator(BiFunction<String, String, ? extends CircuitBreaker>, CircuitBreakerRule) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per host and HttpMethod with the specified CircuitBreakerRule.
newPerHostAndMethodDecorator(BiFunction<String, String, ? extends CircuitBreaker>, CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per host and HttpMethod with the specified CircuitBreakerRuleWithContent.
newPerHostAndMethodDecorator(BiFunction<String, String, ? extends CircuitBreaker>, CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator that binds one CircuitBreaker per host and RPC method name with the specified CircuitBreakerRuleWithContent.
newPerHostDecorator(Function<String, ? extends CircuitBreaker>, CircuitBreakerRule) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerRule.
newPerHostDecorator(Function<String, ? extends CircuitBreaker>, CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerRuleWithContent.
newPerHostDecorator(Function<String, ? extends CircuitBreaker>, CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerRuleWithContent.
newPerMethodDecorator(Function<String, ? extends CircuitBreaker>, CircuitBreakerRule) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerRule.
newPerMethodDecorator(Function<String, ? extends CircuitBreaker>, CircuitBreakerRuleWithContent<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerRuleWithContent.
newPerMethodDecorator(Function<String, ? extends CircuitBreaker>, CircuitBreakerRuleWithContent<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator that binds one CircuitBreaker per RPC method name with the specified CircuitBreakerRuleWithContent.
newRegistry() - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the default HierarchicalNameMapper.
newRegistry() - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
Returns a newly-created PrometheusMeterRegistry instance with a new CollectorRegistry.
newRegistry(MetricRegistry) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified MetricRegistry and the default HierarchicalNameMapper.
newRegistry(MetricRegistry, HierarchicalNameMapper) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified MetricRegistry and HierarchicalNameMapper.
newRegistry(MetricRegistry, HierarchicalNameMapper, Clock) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified MetricRegistry, HierarchicalNameMapper and Clock.
newRegistry(HierarchicalNameMapper) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified HierarchicalNameMapper.
newRegistry(HierarchicalNameMapper, Clock) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified HierarchicalNameMapper and Clock.
newRegistry(CollectorRegistry) - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
Returns a newly-created PrometheusMeterRegistry instance with the specified CollectorRegistry.
newRegistry(CollectorRegistry, Clock) - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
Returns a newly-created PrometheusMeterRegistry instance with the specified CollectorRegistry and Clock.
newSamlDecorator() - Method in class com.linecorp.armeria.server.saml.SamlServiceProvider
Creates a decorator which initiates a SAML authentication if a request is not authenticated.
newSamlService() - Method in class com.linecorp.armeria.server.saml.SamlServiceProvider
Creates an HttpService which handles SAML messages.
newScope(TraceContext) - Method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContext
 
newSelector(EndpointGroup) - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Creates a new EndpointSelector that selects an Endpoint from the specified EndpointGroup.
newStorage() - Method in interface com.linecorp.armeria.common.RequestContextStorageProvider
Creates a new RequestContextStorage.
newStream() - Method in class com.linecorp.armeria.server.file.StreamingHttpFile
Opens a new stream which reads from the file.
newThreadFactory(String, boolean) - Static method in class com.linecorp.armeria.common.util.ThreadFactories
Creates a new ThreadFactory for non event loop thread.
newTimer(Meter.Id, DistributionStatisticConfig, PauseDetector) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newTimer(MeterRegistry, String, Iterable<Tag>) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns a newly-registered Timer configured by MoreMeters.distributionStatisticConfig().
newValue(V) - Method in class com.linecorp.armeria.common.util.AbstractOption
Returns a newly created option value.
next() - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerDecision
Returns a CircuitBreakerDecision that skips the current CircuitBreakerRule and tries to evaluate a next CircuitBreakerRule.
next() - Static method in class com.linecorp.armeria.client.retry.RetryDecision
Returns a RetryDecision that skips the current RetryRule and tries to retry with the next RetryRule.
nextDelayMillis() - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckerContext
Returns the delay for the next health check request in milliseconds.
nextDelayMillis(int) - Method in class com.linecorp.armeria.client.retry.AbstractBackoff
 
nextDelayMillis(int) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns the number of milliseconds to wait for before attempting a retry.
nextDelayMillis(int) - Method in class com.linecorp.armeria.client.retry.BackoffWrapper
 
nextEventLoop() - Method in class com.linecorp.armeria.server.Server
Returns a EventLoop from the worker group.
NO_CONTENT - Static variable in class com.linecorp.armeria.common.HttpStatus
204 No Content.
NO_MAX_INBOUND_MESSAGE_SIZE - Static variable in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
 
NO_MAX_OUTBOUND_MESSAGE_SIZE - Static variable in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
 
noCache() - Method in class com.linecorp.armeria.common.CacheControl
Returns whether the "no-cache" directive is enabled.
noCache() - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
noCache() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
noCache(boolean) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
noCache(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
nodeName(String) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
Sets the specified nodeName.
NON_AUTHORITATIVE_INFORMATION - Static variable in class com.linecorp.armeria.common.HttpStatus
203 Non-Authoritative Information (since HTTP/1.1).
nonBaseClientFactory(BiFunction<? super SessionProtocol, ? super Endpoint, ? extends WebClient>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
Specifies the BiFunction that creates a new non-base WebClient, which is used for sending requests to other authorities than that of base URL.
nonce() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of "oauth_nonce" property.
nonce(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of oauth_nonce property.
NONE - com.linecorp.armeria.server.annotation.ExceptionVerbosity
Do not log any exceptions.
NONE - Static variable in class com.linecorp.armeria.common.SerializationFormat
No serialization format.
nonExistent() - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Returns an AggregatedHttpFile which represents a non-existent file.
nonExistent() - Static method in interface com.linecorp.armeria.server.file.HttpFile
Returns an HttpFile which represents a non-existent file.
NonNullByDefault - Annotation Type in com.linecorp.armeria.common.annotation
Indicates the return values, parameters and fields are non-nullable by default.
nonRequestThread(String) - Method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContextBuilder
Sets a regular expression that matches names of threads that should be considered non-request threads, meaning they may have spans created for clients outside of the context of an Armeria request.
nonRequestThread(Pattern) - Method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContextBuilder
Sets a regular expression that matches names of threads that should be considered non-request threads, meaning they may have spans created for clients outside of the context of an Armeria request.
NonWrappingRequestContext - Class in com.linecorp.armeria.common
A skeletal RequestContext implementation that helps to implement a non-wrapping RequestContext.
NonWrappingRequestContext(MeterRegistry, SessionProtocol, RequestId, HttpMethod, String, String, HttpRequest, RpcRequest, RequestContext) - Constructor for class com.linecorp.armeria.common.NonWrappingRequestContext
Creates a new instance.
noop() - Static method in interface com.linecorp.armeria.client.ConnectionPoolListener
Returns an instance that does nothing.
NoopMeterRegistry - Class in com.linecorp.armeria.common.metric
A MeterRegistry which does not record any values.
NoopSubscriber<T> - Class in com.linecorp.armeria.common.stream
A Subscriber that discards all elements silently.
NoopSubscriber() - Constructor for class com.linecorp.armeria.common.stream.NoopSubscriber
 
noRetry() - Static method in class com.linecorp.armeria.client.retry.RetryDecision
Returns a RetryDecision that never retries.
noStore() - Method in class com.linecorp.armeria.common.CacheControl
Returns whether the "no-store" directive is enabled.
noStore() - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
noStore() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
noStore(boolean) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
noStore(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
NOT_ACCEPTABLE - Static variable in class com.linecorp.armeria.common.HttpStatus
406 Not Acceptable.
NOT_EXTENDED - Static variable in class com.linecorp.armeria.common.HttpStatus
510 Not Extended (RFC2774).
NOT_FOUND - Static variable in class com.linecorp.armeria.common.HttpStatus
404 Not Found.
NOT_IMPLEMENTED - Static variable in class com.linecorp.armeria.common.HttpStatus
501 Not Implemented.
NOT_MATCHED - com.linecorp.armeria.server.RoutingResultType
A Route did not match a RoutingContext.
NOT_MODIFIED - Static variable in class com.linecorp.armeria.common.HttpStatus
304 Not Modified.
notificationFailed(L, Throwable) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked when an event listener raises an exception.
NOTIFY_CANCELLATION - com.linecorp.armeria.common.stream.SubscriptionOption
To get notified by Subscriber.onError(Throwable) even when the StreamMessage is cancelled.
notifyListeners(T) - Method in class com.linecorp.armeria.common.util.AbstractListenable
Notify the new value changes to the listeners added via AbstractListenable.addListener(Consumer).
notifyStarted(L, T, V) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked when the startup procedure is finished.
notifyStarting(L, T) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked when the startup procedure begins.
notifyStopped(L, U) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked when the shutdown procedure is finished.
notifyStopping(L, U) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked when the shutdown procedure begins.
noTransform() - Method in class com.linecorp.armeria.common.CacheControl
Returns whether the "no-transform" directive is enabled.
noTransform() - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
noTransform() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
noTransform(boolean) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
 
noTransform(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
 
nullOriginAllowed() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
Determines if a "null" origin is allowed.
NullToNoContentResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A response converter implementation which creates an HttpResponse of HttpStatus.NO_CONTENT when the specified result is null.
NullToNoContentResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.NullToNoContentResponseConverterFunction
 
numActiveRequests() - Method in class com.linecorp.armeria.client.limit.AbstractConcurrencyLimitingClient
Returns the number of the Requests that are being executed.
numCommonBlockingTaskThreads() - Static method in class com.linecorp.armeria.common.Flags
Returns the default number of blocking task executor threads.
numCommonWorkers() - Static method in class com.linecorp.armeria.common.Flags
Returns the default number of common worker group threads.
numConnections() - Method in class com.linecorp.armeria.server.Server
Returns the number of open connections on this Server.
numWildcards() - Method in class com.linecorp.armeria.common.MediaType
Returns the number of wildcards of this MediaType.

O

oAuth1a() - Static method in class com.linecorp.armeria.server.auth.AuthTokenExtractors
Returns an OAuth1aToken extractor function.
OAuth1aToken - Class in com.linecorp.armeria.common.auth
The bearer token of OAuth 1.0a authentication.
OAuth1aTokenBuilder - Class in com.linecorp.armeria.common.auth
Builds a new OAuth1aToken.
oAuth2() - Static method in class com.linecorp.armeria.server.auth.AuthTokenExtractors
Returns an OAuth2Token extractor function.
OAuth2Token - Class in com.linecorp.armeria.common.auth
The bearer token of OAuth 2.0 authentication.
ObservableResponseConverterFunction - Class in com.linecorp.armeria.server.rxjava2
A ResponseConverterFunction which converts the Observable instance to a Flowable first, then converts it to an HttpResponse using the specified responseConverter.
ObservableResponseConverterFunction - Class in com.linecorp.armeria.server.rxjava3
A ResponseConverterFunction which converts the Observable instance to a Flowable first, then converts it to an HttpResponse using the specified responseConverter.
ObservableResponseConverterFunction(ResponseConverterFunction, ExceptionHandlerFunction) - Constructor for class com.linecorp.armeria.server.rxjava2.ObservableResponseConverterFunction
Creates a new ResponseConverterFunction instance.
ObservableResponseConverterFunction(ResponseConverterFunction, ExceptionHandlerFunction) - Constructor for class com.linecorp.armeria.server.rxjava3.ObservableResponseConverterFunction
Creates a new ResponseConverterFunction instance.
obtrudeException(Throwable) - Method in class com.linecorp.armeria.common.CompletableRpcResponse
 
obtrudeException(Throwable) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
obtrudeValue(T) - Method in class com.linecorp.armeria.common.util.UnmodifiableFuture
OCTET_STREAM - Static variable in class com.linecorp.armeria.common.MediaType
 
OCTET_STREAM - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/octet-stream".
of() - Static method in class com.linecorp.armeria.client.ClientDecoration
Returns an empty ClientDecoration which does not decorate a Client.
of() - Static method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns an empty singleton ClientFactoryOptions.
of() - Static method in class com.linecorp.armeria.client.ClientOptions
Returns an empty singleton ClientOptions.
of() - Static method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns a singleton EndpointGroup which does not contain any Endpoints.
of() - Static method in interface com.linecorp.armeria.client.WebClient
Returns a WebClient without a base URI using the default ClientFactory and the default ClientOptions.
of() - Static method in interface com.linecorp.armeria.common.Cookies
Returns an immutable empty Set of Cookies.
of() - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns an empty HttpHeaders.
of() - Static method in interface com.linecorp.armeria.common.QueryParams
Returns an empty QueryParams.
of() - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish no objects, just a close event.
of() - Static method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
Returns a new AsyncCloseableSupport that will be completed immediately on AsyncCloseableSupport.close() or AsyncCloseableSupport.closeAsync().
of(int) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response.
of(int) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified statusCode.
of(int) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified statusCode.
of(int) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified HTTP status code.
of(int) - Static method in exception com.linecorp.armeria.server.HttpStatusException
Returns a new HttpStatusException instance with the specified HTTP status code.
of(int, Throwable) - Static method in exception com.linecorp.armeria.server.HttpStatusException
Returns a new HttpStatusException instance with the specified HTTP status code and cause.
of(long) - Static method in interface com.linecorp.armeria.common.RequestId
Returns a RequestId created from the specified 64-bit integer.
of(long, long) - Static method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns a new EventCount with the specified number of successes and failures.
of(long, long, long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns a newly created BandwidthLimit.
of(long, long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns a newly created BandwidthLimit.
of(long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns a newly created simple BandwidthLimit.
of(long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket
Returns a newly created TokenBucket with a single simple BandwidthLimit.
of(CircuitBreakerRule...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a CircuitBreakerRule that combines the specified CircuitBreakerRules.
of(CircuitBreakerRuleWithContent<T>...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a CircuitBreakerRuleWithContent that combines the specified CircuitBreakerRuleWithContents.
of(ClientFactoryOptions, ClientFactoryOptionValue<?>...) - Static method in class com.linecorp.armeria.client.ClientFactoryOptions
of(ClientFactoryOptions, Iterable<? extends ClientFactoryOptionValue<?>>) - Static method in class com.linecorp.armeria.client.ClientFactoryOptions
of(ClientFactoryOptionValue<?>...) - Static method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
of(ClientOptions, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.ClientOptions
Merges the specified ClientOptions and ClientOptionValues.
of(ClientOptions, Iterable<? extends ClientOptionValue<?>>) - Static method in class com.linecorp.armeria.client.ClientOptions
Merges the specified ClientOptions and ClientOptionValues.
of(ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.ClientOptions
Returns the ClientOptions with the specified ClientOptionValues.
of(DecoratingHttpClientFunction) - Static method in class com.linecorp.armeria.client.ClientDecoration
Creates a new instance from a single DecoratingHttpClientFunction.
of(EndpointGroup...) - Static method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
of(EndpointGroup, String) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns a newly created HealthCheckedEndpointGroup that sends HTTP HEAD health check requests with default options.
of(EndpointSelectionStrategy, EndpointGroup...) - Static method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
of(EndpointSelectionStrategy, Iterable<? extends EndpointGroup>) - Static method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
of(ProxyConfig) - Static method in interface com.linecorp.armeria.client.proxy.ProxyConfigSelector
Returns a ProxyConfigSelector which selects a static ProxyConfig for all requests.
of(RetryRule...) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a RetryRule that combines the specified retryRules.
of(RetryRuleWithContent<T>...) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a RetryRuleWithContent that combines the specified retryRules.
of(WebClient) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit which sends requests using the specified WebClient.
of(AggregatedHttpResponse) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified AggregatedHttpResponse.
of(Cookie...) - Static method in interface com.linecorp.armeria.common.Cookies
Creates an instance with a copy of the specified set of Cookies.
of(HttpData) - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Creates a new AggregatedHttpFile which streams the specified HttpData.
of(HttpData) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Creates a new HttpFile which streams the specified HttpData.
of(HttpData, long) - Static method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Creates a new AggregatedHttpFile with the specified HttpData with the specified lastModifiedMillis.
of(HttpData, long) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Creates a new HttpFile which streams the specified HttpData with the specified lastModifiedMillis.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders copied from the specified HttpHeaders.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders copied from the specified HttpHeaders.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified headers and without content.
of(HttpHeaders, T) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified headers and content.
of(HttpHeaders, T, HttpHeaders) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified headers, content and trailers.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request with empty content.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request with empty content and closes the stream.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod and path.
of(HttpMethod, String, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(HttpMethod, String, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(HttpMethod, String, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(HttpMethod, String, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, CharSequence) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(HttpMethod, String, MediaType, CharSequence) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, String) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(HttpMethod, String, MediaType, String) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(HttpMethod, String, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and an additional header.
of(HttpMethod, String, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and additional headers.
of(HttpMethod, String, CharSequence, Object, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and additional headers.
of(HttpMethod, String, CharSequence, Object, CharSequence, Object, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and additional headers.
of(HttpMethod, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and an additional header.
of(HttpMethod, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and additional headers.
of(HttpMethod, String, CharSequence, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and additional headers.
of(HttpMethod, String, CharSequence, String, CharSequence, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.RequestHeaders
Returns a new RequestHeaders with the specified HttpMethod, path and additional headers.
of(HttpObject...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified objects.
of(HttpRequest) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a new ClientRequestContext created from the specified HttpRequest.
of(HttpRequest) - Static method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns a new ServiceRequestContext created from the specified HttpRequest.
of(HttpResponse) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified HttpResponse.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus.
of(HttpStatus) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified HttpStatus and without content.
of(HttpStatus) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified HttpStatus.
of(HttpStatus) - Static method in exception com.linecorp.armeria.server.HttpStatusException
Returns a new HttpStatusException instance with the specified HttpStatus.
of(HttpStatus, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, CharSequence) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, CharSequence) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, String) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and an additional header.
of(HttpStatus, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
of(HttpStatus, CharSequence, Object, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
of(HttpStatus, CharSequence, Object, CharSequence, Object, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
of(HttpStatus, CharSequence, String) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and an additional header.
of(HttpStatus, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
of(HttpStatus, CharSequence, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
of(HttpStatus, CharSequence, String, CharSequence, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.ResponseHeaders
Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
of(HttpStatus, Throwable) - Static method in exception com.linecorp.armeria.server.HttpStatusException
Returns a new HttpStatusException instance with the specified HttpStatus and cause.
of(HttpStatus, T) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified HttpStatus and content.
of(HttpStatus, T, HttpHeaders) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified HttpStatus, content and trailers.
of(MediaType...) - Static method in class com.linecorp.armeria.common.MediaTypeSet
Returns the MediaTypeSet which is composed of the specified MediaTypes.
of(MediaType, String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content.
of(MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content.
of(RequestContext, EventLoop) - Static method in interface com.linecorp.armeria.common.ContextAwareEventLoop
Returns a new ContextAwareEventLoop that sets the specified RequestContext before executing any submitted tasks.
of(RequestContext, ScheduledExecutorService) - Static method in interface com.linecorp.armeria.common.ContextAwareScheduledExecutorService
Returns a new ContextAwareScheduledExecutorService that sets the specified RequestContext before executing any submitted tasks.
of(RequestHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request with empty content.
of(RequestHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest with empty content and closes the stream.
of(RequestHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(RequestHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest and closes the stream.
of(RequestHeaders, HttpData...) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest that publishes the given HttpObjects and closes the stream.
of(RequestHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Creates a new HTTP request.
of(RequestHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest and closes the stream.
of(RequestHeaders, Publisher<? extends HttpObject>) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new instance from an existing RequestHeaders and Publisher.
of(ResponseHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response with empty content.
of(ResponseHeaders) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified headers.
of(ResponseHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response.
of(ResponseHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified headers and content.
of(ResponseHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response.
of(ResponseHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified objects.
of(RpcRequest, String) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a new ClientRequestContext created from the specified RpcRequest and URI.
of(RpcRequest, URI) - Static method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a new ClientRequestContext created from the specified RpcRequest and URI.
of(Scheme, EndpointGroup, String, Class<?>, ClientOptions) - Static method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns a newly created ClientBuilderParams from the specified properties.
of(SerializationFormat, SessionProtocol) - Static method in class com.linecorp.armeria.common.Scheme
Returns the Scheme of the specified SerializationFormat and SessionProtocol.
of(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroup that retrieves the Endpoint list from the specified EndpointGroup.
of(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit which sends requests to the specified Endpoint using the specified SessionProtocol.
of(SessionProtocol, EndpointGroup) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClient that connects to the specified EndpointGroup with the specified SessionProtocol using the default ClientFactory and the default ClientOptions.
of(SessionProtocol, EndpointGroup) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListener which registers the current Server to the specified EndpointGroup.
of(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroup that retrieves the Endpoint list from the specified EndpointGroup under the specified path.
of(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit which sends requests to the specified Endpoint using the specified SessionProtocol and path.
of(SessionProtocol, EndpointGroup, String) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClient that connects to the specified EndpointGroup with the specified SessionProtocol and path using the default ClientFactory and the default ClientOptions.
of(SessionProtocol, EndpointGroup, String) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListener which registers the current Server to the specified EndpointGroup under the specified path.
of(HttpVfs) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileService for the specified HttpVfs.
of(HealthChecker...) - Static method in class com.linecorp.armeria.server.healthcheck.HealthCheckService
Returns a newly created HealthCheckService with the specified HealthCheckers.
of(SamlNameIdFormat, boolean) - Static method in class com.linecorp.armeria.server.saml.SamlNameIdPolicy
Returns a SamlNameIdPolicy with the specified SamlNameIdFormat and isCreatable.
of(ServiceDescriptor) - Static method in interface com.linecorp.armeria.common.grpc.GrpcJsonMarshaller
Returns a newly-created GrpcJsonMarshaller which serializes and deserializes a Message served by the service.
of(AsciiString) - Static method in class com.linecorp.armeria.common.HttpHeaderNames
Lower-cases and converts the specified header name into an AsciiString.
of(File) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileService for the specified rootDir in an O/S file system.
of(File) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Creates a new HttpFile which streams the specified File.
of(File) - Static method in interface com.linecorp.armeria.server.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in an O/S file system.
of(File) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
of(File, String) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
of(CharSequence) - Static method in class com.linecorp.armeria.common.HttpHeaderNames
Lower-cases and converts the specified header name into an AsciiString.
of(CharSequence, Object) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified header.
of(CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified headers.
of(CharSequence, Object, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified headers.
of(CharSequence, Object, CharSequence, Object, CharSequence, Object, CharSequence, Object) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified headers.
of(CharSequence, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified header.
of(CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified headers.
of(CharSequence, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified headers.
of(CharSequence, String, CharSequence, String, CharSequence, String, CharSequence, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new HttpHeaders with the specified headers.
of(Class<?>, String) - Static method in interface com.linecorp.armeria.common.RpcRequest
Creates a new instance with no parameter.
of(Class<?>, String) - Static method in class com.linecorp.armeria.common.util.AbstractOption
Returns the option of the specified option type and name.
of(Class<?>, String, Iterable<?>) - Static method in interface com.linecorp.armeria.common.RpcRequest
Creates a new instance with the specified parameters.
of(Class<?>, String, Object) - Static method in interface com.linecorp.armeria.common.RpcRequest
Creates a new instance with a single parameter.
of(Class<?>, String, Object...) - Static method in interface com.linecorp.armeria.common.RpcRequest
Creates a new instance with the specified parameters.
of(ClassLoader, String) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileService for the specified rootDir in the current class path.
of(ClassLoader, String) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Creates a new HttpFile which streams the resource at the specified path, loaded by the specified ClassLoader.
of(ClassLoader, String) - Static method in interface com.linecorp.armeria.server.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in the current class path.
of(ClassLoader, String, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Returns a new PropertiesEndpointGroup created from the specified classpath resource.
of(Iterable<? extends CircuitBreakerRule>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a CircuitBreakerRule that combines the specified CircuitBreakerRules.
of(Iterable<? extends CircuitBreakerRuleWithContent<T>>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a CircuitBreakerRuleWithContent that combines the specified CircuitBreakerRuleWithContents.
of(Iterable<? extends ClientFactoryOptionValue<?>>) - Static method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
of(Iterable<? extends ClientOptionValue<?>>) - Static method in class com.linecorp.armeria.client.ClientOptions
Returns the ClientOptions with the specified ClientOptionValues.
of(Iterable<? extends EndpointGroup>) - Static method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
of(Iterable<? extends RetryRule>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a RetryRule that combines all the RetryRule of the retryRules.
of(Iterable<? extends RetryRuleWithContent<T>>) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a RetryRuleWithContent that combines all the RetryRuleWithContent of the retryRules.
of(Iterable<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookies
Creates an instance with a copy of the specified set of Cookies.
of(Iterable<? extends HealthChecker>) - Static method in class com.linecorp.armeria.server.healthcheck.HealthCheckService
Returns a newly created HealthCheckService with the specified HealthCheckers.
of(Iterable<MediaType>) - Static method in class com.linecorp.armeria.common.MediaTypeSet
Returns the MediaTypeSet which is composed of the specified MediaTypes.
of(Iterable<ResponseHeaders>, ResponseHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Creates a new HTTP response.
of(Iterable<Pattern>) - Static method in class com.linecorp.armeria.common.logging.RegexBasedSanitizer
Returns a new instance created from the specified Patterns.
of(Object) - Static method in interface com.linecorp.armeria.common.RpcResponse
Returns a newly created successfully complete RpcResponse.
of(Object) - Static method in class com.linecorp.armeria.server.thrift.ThriftCallService
Creates a new ThriftCallService with the specified service implementation.
of(Object) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new THttpService with the specified service implementation, supporting all thrift protocols and defaulting to TBinary protocol when the client doesn't specify one.
of(Object, SerializationFormat) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new THttpService with the specified service implementation, supporting all thrift protocols and defaulting to the specified defaultSerializationFormat when the client doesn't specify one.
of(String) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Creates a new CircuitBreaker that has the specified name and the default configurations.
of(String) - Static method in class com.linecorp.armeria.client.ClientFactoryOption
Returns the ClientFactoryOption with the specified name.
of(String) - Static method in class com.linecorp.armeria.client.ClientOption
Returns the ClientOption with the specified name.
of(String) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroup
Creates a DnsAddressEndpointGroup with an unspecified port that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(String) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroup
Creates a DnsServiceEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(String) - Static method in class com.linecorp.armeria.client.Endpoint
Creates a new host Endpoint with unspecified port number.
of(String) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroup that retrieves the Endpoint list from the specified eurekaUri.
of(String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit with the specified baseUrl.
of(String) - Static method in class com.linecorp.armeria.client.retrofit2.RetrofitMeterIdPrefixFunction
Returns a newly created RetrofitMeterIdPrefixFunction with the specified name.
of(String) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Creates a new Backoff that computes backoff delay using one of Backoff.exponential(long, long, double), Backoff.fibonacci(long, long), Backoff.fixed(long) and Backoff.random(long, long) chaining with Backoff.withJitter(double, double) and Backoff.withMaxAttempts(int) from the specification string that conforms to the following format: exponential=[initialDelayMillis:maxDelayMillis:multiplier] is for Backoff.exponential(long, long, double) (multiplier will be 2.0 if it's omitted) fibonacci=[initialDelayMillis:maxDelayMillis] is for Backoff.fibonacci(long, long) fixed=[delayMillis] is for Backoff.fixed(long) random=[minDelayMillis:maxDelayMillis] is for Backoff.random(long, long) jitter=[minJitterRate:maxJitterRate] is for Backoff.withJitter(double, double) (if only one jitter value is specified, it will be used for Backoff.withJitter(double) maxAttempts=[maxAttempts] is for Backoff.withMaxAttempts(int) The order of options does not matter, and the specification needs at least one option.
of(String) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClient that connects to the specified uri using the default options.
of(String) - Static method in class com.linecorp.armeria.common.auth.OAuth2Token
Creates a new OAuth2Token from the given accessToken.
of(String) - Static method in class com.linecorp.armeria.common.grpc.GrpcMeterIdPrefixFunction
Returns a newly created GrpcMeterIdPrefixFunction with the specified name.
of(String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content as UTF_8.
of(String) - Static method in class com.linecorp.armeria.common.SerializationFormat
Returns the SerializationFormat with the specified SerializationFormat.uriText().
of(String) - Static method in enum com.linecorp.armeria.common.SessionProtocol
Returns the SessionProtocol with the specified SessionProtocol.uriText().
of(String) - Static method in interface com.linecorp.armeria.common.util.Sampler
Returns a Sampler that is configured as specified in the given specification string.
of(String) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListener which registers the current Server to the specified eurekaUri.
of(String) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns a newly created BandwidthLimit.
of(String) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket
Returns a newly created TokenBucket.
of(String, int) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroup
Creates a DnsAddressEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(String, int) - Static method in class com.linecorp.armeria.client.Endpoint
Creates a new host Endpoint.
of(String, EndpointGroup) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit which sends requests to the specified Endpoint using the specified protocol.
of(String, EndpointGroup) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClient that connects to the specified EndpointGroup with the specified protocol using the default ClientFactory and the default ClientOptions.
of(String, EndpointGroup, String) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit which sends requests to the specified Endpoint using the specified protocol and path.
of(String, EndpointGroup, String) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClient that connects to the specified EndpointGroup with the specified protocol and path using the default ClientFactory and the default ClientOptions.
of(String, TypeSignature) - Static method in class com.linecorp.armeria.server.docs.FieldInfo
Creates a new FieldInfo with the specified name and TypeSignature.
of(String, Object) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameter.
of(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content as UTF_8.
of(String, Object, String, Object) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameters.
of(String, Object, String, Object, String, Object) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameters.
of(String, Object, String, Object, String, Object, String, Object) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameters.
of(String, String) - Static method in class com.linecorp.armeria.common.auth.BasicToken
Creates a new BasicToken from the given username and password.
of(String, String) - Static method in interface com.linecorp.armeria.common.Cookie
Returns a newly created Cookie.
of(String, String) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameter.
of(String, String, ZooKeeperDiscoverySpec) - Static method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup
Returns a new ZooKeeperEndpointGroup that retrieves the Endpoint list from the ZNode at the specified connection string and path.
of(String, String, ZooKeeperRegistrationSpec) - Static method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
Creates a ZooKeeper server listener, which registers the Server into ZooKeeper.
of(String, String, String, String) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameters.
of(String, String, String, String, String, String) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameters.
of(String, String, String, String, String, String, String, String) - Static method in interface com.linecorp.armeria.common.QueryParams
Returns a new QueryParams with the specified parameters.
of(String, Function<byte[], Endpoint>) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroup
Creates a DnsTextEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(Throwable) - Static method in exception com.linecorp.armeria.client.UnprocessedRequestException
Returns a new UnprocessedRequestException with the specified message and Throwable.
of(InetSocketAddress) - Static method in class com.linecorp.armeria.server.ProxiedAddresses
Creates a new instance with the specified sourceAddress.
of(InetSocketAddress, Iterable<? extends InetSocketAddress>) - Static method in class com.linecorp.armeria.server.ProxiedAddresses
Creates a new instance with the specified sourceAddress and destinationAddresses.
of(InetSocketAddress, InetSocketAddress) - Static method in class com.linecorp.armeria.server.ProxiedAddresses
Creates a new instance with the specified sourceAddress and destinationAddress.
of(ProxySelector) - Static method in interface com.linecorp.armeria.client.proxy.ProxyConfigSelector
Provides a way to reuse an existing ProxySelector with some limitations.
of(URI) - Static method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroup
Returns a new EurekaEndpointGroup that retrieves the Endpoint list from the specified eurekaUri.
of(URI) - Static method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofit
Returns a new Retrofit with the specified baseUrl.
of(URI) - Static method in interface com.linecorp.armeria.client.WebClient
Returns a new WebClient that connects to the specified URI using the default options.
of(URI) - Static method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
Returns a new EurekaUpdatingListener which registers the current Server to the specified eurekaUri.
of(URI, Class<?>, ClientOptions) - Static method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns a newly created ClientBuilderParams from the specified properties.
of(Charset, CharSequence) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into an HttpData.
of(Charset, String) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into an HttpData.
of(Charset, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified formatted string into an HttpData.
of(Path) - Static method in class com.linecorp.armeria.server.file.FileService
Returns a new FileService for the specified rootDir in an O/S file system.
of(Path) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Creates a new HttpFile which streams the file at the specified Path.
of(Path) - Static method in interface com.linecorp.armeria.server.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in an O/S file system.
of(Path) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
of(Path, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Returns a new PropertiesEndpointGroup created from the file at the specified Path.
of(Path, String) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
of(BiFunction<? super ServiceRequestContext, T, ? extends CompletionStage<Boolean>>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
of(BiFunction<? super ServiceRequestContext, T, ? extends CompletionStage<Boolean>>, String) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
of(BiFunction<? super MeterRegistry, ? super RequestOnlyLog, MeterIdPrefix>) - Static method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns a MeterIdPrefixFunction which generates a MeterIdPrefix from the given MeterRegistry and RequestOnlyLog.
of(Consumer<CompletableFuture<?>>) - Static method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
of(Function<? super HttpClient, ? extends HttpClient>) - Static method in class com.linecorp.armeria.client.ClientDecoration
Creates a new instance from a single decorator Function.
of(Map<String, ? extends Iterable<?>>) - Static method in class com.linecorp.armeria.server.thrift.ThriftCallService
Creates a new multiplexed ThriftCallService with the specified list service implementations.
of(Properties, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Returns a new PropertiesEndpointGroup created from the specified Properties.
of(Pattern...) - Static method in class com.linecorp.armeria.common.logging.RegexBasedSanitizer
Returns a new instance created from the specified Patterns.
of(Connector) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService from an existing Tomcat Connector instance.
of(Connector, String) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService from an existing Tomcat Connector instance.
of(Tomcat) - Static method in class com.linecorp.armeria.server.tomcat.TomcatService
Creates a new TomcatService from an existing Tomcat instance.
of(CuratorFramework, String, ZooKeeperDiscoverySpec) - Static method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup
Returns a new ZooKeeperEndpointGroup that retrieves the Endpoint list from the ZNode at the specified path using the specified CuratorFramework.
of(CuratorFramework, String, ZooKeeperRegistrationSpec) - Static method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
Creates a ZooKeeper server listener, which registers the Server into ZooKeeper.
of(Server) - Static method in class com.linecorp.armeria.server.jetty.JettyService
Creates a new JettyService from an existing Jetty Server.
of(Server, String) - Static method in class com.linecorp.armeria.server.jetty.JettyService
Creates a new JettyService from an existing Jetty Server.
of(Publisher<? extends HttpObject>) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response whose stream is produced from an existing Publisher.
of(T) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish the single obj.
of(T) - Static method in interface com.linecorp.armeria.server.annotation.HttpResult
Creates a new HttpResult with the specified content and the HttpStatus.OK status.
of(T...) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish the given objs.
of(T, T) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish the two obj1 and obj2.
ofAnnotated() - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true only for the services detected by the annotated service plugin.
ofAscii(CharSequence) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into a US-ASCII HttpData.
ofAscii(String) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into a US-ASCII HttpData.
ofAscii(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified formatted string into a US-ASCII HttpData.
ofBase(String) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for a base type.
ofCached(HttpFile, int) - Static method in interface com.linecorp.armeria.server.file.HttpFile
Creates a new HttpFile which caches the content and attributes of the specified HttpFile.
ofCatchAll() - Static method in interface com.linecorp.armeria.server.Route
Returns the catch-all Route which matches every request.
ofCidr(String) - Static method in class com.linecorp.armeria.common.util.InetAddressPredicates
Returns a Predicate which returns true if the given InetAddress is in the range of a Classless Inter-domain Routing (CIDR) block.
ofCidr(InetAddress, int) - Static method in class com.linecorp.armeria.common.util.InetAddressPredicates
Returns a Predicate which returns true if the given InetAddress is in the range of a Classless Inter-domain Routing (CIDR) block.
ofCidr(InetAddress, String) - Static method in class com.linecorp.armeria.common.util.InetAddressPredicates
Returns a Predicate which returns true if the given InetAddress is in the range of a Classless Inter-domain Routing (CIDR) block.
ofComment(String) - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Creates a new ServerSentEvent with the specified comment.
ofContainer(String, TypeSignature...) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new container type with the specified container type name and the type signatures of the elements it contains.
ofContainer(String, Iterable<TypeSignature>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new container type with the specified container type name and the type signatures of the elements it contains.
ofCreatable(SamlNameIdFormat) - Static method in class com.linecorp.armeria.server.saml.SamlNameIdPolicy
Returns a SamlNameIdPolicy with the specified SamlNameIdFormat and isCreatable = true.
ofData(String) - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Creates a new ServerSentEvent with the specified data.
ofDefault() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
Returns the default CircuitBreakerMapping.
ofDefault() - Static method in interface com.linecorp.armeria.client.ClientFactory
Returns the default ClientFactory implementation.
ofDefault() - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns the default Backoff.
ofDefault() - Static method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContext
Returns the default CurrentTraceContext.
ofDefault(String) - Static method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns the default function that creates a MeterIdPrefix with the specified name and the Tags derived from the RequestLog properties.
ofDefaultName() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Creates a new CircuitBreaker that has a default name and the default configurations.
ofEvent(String) - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Creates a new ServerSentEvent with the specified event.
ofExact(String) - Static method in class com.linecorp.armeria.common.util.InetAddressPredicates
Returns a Predicate which returns true if the given InetAddress equals to the specified address.
ofExact(InetAddress) - Static method in class com.linecorp.armeria.common.util.InetAddressPredicates
Returns a Predicate which returns true if the given InetAddress equals to the specified address.
OFF - com.linecorp.armeria.common.logging.LogLevel
OFF log level.
ofFailure(Throwable) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new failed HTTP response.
ofFailure(Throwable) - Static method in interface com.linecorp.armeria.common.RpcResponse
Returns a newly created exceptionally complete RpcResponse.
ofFormats(Object, SerializationFormat, SerializationFormat...) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new THttpService with the specified service implementation, supporting only the formats specified and defaulting to the specified defaultSerializationFormat when the client doesn't specify one.
ofFormats(Object, SerializationFormat, Iterable<SerializationFormat>) - Static method in class com.linecorp.armeria.server.thrift.THttpService
Creates a new THttpService with the specified service implementation, supporting the protocols specified in otherSupportedSerializationFormats and defaulting to the specified defaultSerializationFormat when the client doesn't specify one.
ofGrpc() - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true only for the services detected by the gRPC plugin.
ofHeader(CharSequence) - Static method in class com.linecorp.armeria.server.ClientAddressSource
Returns a ClientAddressSource which indicates the value of the specified header in a request will be used to determine a client address.
ofHttpPost(String) - Static method in class com.linecorp.armeria.server.saml.SamlEndpoint
Creates a SamlEndpoint of the specified uri and the HTTP POST binding protocol.
ofHttpPost(URI) - Static method in class com.linecorp.armeria.server.saml.SamlEndpoint
Creates a SamlEndpoint of the specified uri and the HTTP POST binding protocol.
ofHttpRedirect(String) - Static method in class com.linecorp.armeria.server.saml.SamlEndpoint
Creates a SamlEndpoint of the specified uri and the HTTP Redirect binding protocol.
ofHttpRedirect(URI) - Static method in class com.linecorp.armeria.server.saml.SamlEndpoint
Creates a SamlEndpoint of the specified uri and the HTTP Redirect binding protocol.
ofId(String) - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Creates a new ServerSentEvent with the specified id.
ofJwt(String, Algorithm, int, int) - Static method in interface com.linecorp.armeria.server.saml.SamlRequestIdManager
Returns a SamlRequestIdManager implementation based on JSON Web Tokens specification.
ofJwt(String, String, int, int) - Static method in interface com.linecorp.armeria.server.saml.SamlRequestIdManager
Returns a SamlRequestIdManager implementation based on JSON Web Tokens specification with the Algorithm instance using HmacSHA384.
ofList(TypeSignature) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the list with the specified element type signature.
ofList(Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the list with the specified named element type.
ofMap(TypeSignature, TypeSignature) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the map with the specified key and value type signatures.
ofMap(Class<?>, Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the map with the specified named key and value types.
ofMethodName(String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the name of the method matches the specified methodName.
ofMethodName(String, String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the name of the service and method matches the specified serviceName and methodName.
ofMethodName(String, String, String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the name of the plugin, service and method matches the specified pluginName, serviceName and methodName.
ofNamed(Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new named type signature for the specified type.
ofNamed(String, Object) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new named type signature for the provided name and arbitrary descriptor.
ofPluginName(String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the name of the plugin matches the specified pluginName.
ofProxyProtocol() - Static method in class com.linecorp.armeria.server.ClientAddressSource
Returns the ClientAddressSource which indicates the source address specified in a PROXY protocol message will be used to determine a client address.
ofRedirect(HttpStatus, String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the redirect to specific location.
ofRedirect(HttpStatus, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the redirect to specific location using string format.
ofRedirect(String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the temporary redirect to specific location.
ofRedirect(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the temporary redirect to specific location using string format.
ofRegex(String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the concatenated name of the plugin, service and method matches the specified regex.
ofRegex(Pattern) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the concatenated name of the plugin, service and method matches the specified Pattern.
ofRetry(Duration) - Static method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Creates a new ServerSentEvent with the specified retry.
ofRouteDecoratingService(List<RouteDecoratingService>) - Static method in class com.linecorp.armeria.server.Routers
Returns the default implementation of the Router to find a RouteDecoratingService.
ofRpc(DecoratingRpcClientFunction) - Static method in class com.linecorp.armeria.client.ClientDecoration
Creates a new instance from a single DecoratingRpcClientFunction.
ofRpc(Function<? super RpcClient, ? extends RpcClient>) - Static method in class com.linecorp.armeria.client.ClientDecoration
Creates a new instance from a single decorator Function.
ofServiceName(String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the name of the service matches the specified serviceName.
ofServiceName(String, String) - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true when the name of the plugin and service matches the specified pluginName and serviceName.
ofSet(TypeSignature) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the set with the specified element type signature.
ofSet(Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the set with the specified named element type.
ofThrift() - Static method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a DocServiceFilter which returns true only for the services detected by the Thrift plugin.
ofUnresolved(String) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new unresolved type signature with the specified type name.
ofUtf8(CharSequence) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into a UTF-8 HttpData.
ofUtf8(String) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into a UTF-8 HttpData.
ofUtf8(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified formatted string into a UTF-8 HttpData.
ofVirtualHost(VirtualHost, Iterable<ServiceConfig>, RejectedRouteHandler) - Static method in class com.linecorp.armeria.server.Routers
Returns the default implementation of the Router to find a ServiceConfig.
OGG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
OGG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/ogg".
OGG_CONTAINER - Static variable in class com.linecorp.armeria.common.MediaType
 
OGG_CONTAINER - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/ogg".
OGG_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
OGG_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/ogg".
OK - Static variable in class com.linecorp.armeria.common.HttpStatus
200 OK.
onAcceptedRequest(ThrottlingAcceptHandler<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.throttling.ThrottlingServiceBuilder
onAcceptedRequest(ThrottlingAcceptHandler<RpcRequest, RpcResponse>) - Method in class com.linecorp.armeria.server.throttling.ThrottlingRpcServiceBuilder
onComplete() - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onComplete(T) - Method in class com.linecorp.armeria.common.thrift.ThriftFuture
 
onComplete(T) - Method in class com.linecorp.armeria.common.thrift.ThriftListenableFuture
 
onData(HttpData) - Method in interface com.linecorp.armeria.common.logging.ContentPreviewer
Invoked after request/response data is received.
OneElementFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that only publishes one object.
OneElementFixedStreamMessage(T) - Constructor for class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
 
onError(Exception) - Method in class com.linecorp.armeria.common.thrift.ThriftFuture
 
onError(Exception) - Method in class com.linecorp.armeria.common.thrift.ThriftListenableFuture
 
onError(Throwable) - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onEventCountUpdated(String, EventCount) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit breaker's internal EventCount is updated.
onEventCountUpdated(String, EventCount) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListenerAdapter
 
onException() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds any Exception.
onException() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if an Exception is raised.
onException() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(CircuitBreakerRuleBuilder.thenSuccess(), CircuitBreakerRuleBuilder.thenFailure() and CircuitBreakerRuleBuilder.thenIgnore()), if an Exception is raised.
onException() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
onException() - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that retries with default backoff on any Exception.
onException() - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Makes a RetryRule retry on any Exception.
onException() - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Makes a RetryRuleWithContent retry on any Exception.
onException(Class<? extends Throwable>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified exception type.
onException(Class<? extends Throwable>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if an Exception is raised and it is an instance of the specified exception.
onException(Class<? extends Throwable>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified exception type for a CircuitBreakerRule.
onException(Class<? extends Throwable>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified exception type for a CircuitBreakerRuleWithContent.
onException(Class<? extends Throwable>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created a RetryRule that will retry with the default backoff if an Exception is raised and that is instance of the specified exception.
onException(Class<? extends Throwable>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified exception type for a RetryRule which will retry if an Exception is raised and it is an instance of the specified exception.
onException(Class<? extends Throwable>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified exception type for a RetryRuleWithContent which will retry if an Exception is raised and it is an instance of the specified exception.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified exceptionFilter.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if an Exception is raised and the specified exceptionFilter returns true.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified exceptionFilter for a CircuitBreakerRule.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified exceptionFilter for a CircuitBreakerRuleWithContent.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if an Exception is raised and the specified exceptionFilter returns true.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified exceptionFilter for a RetryRule which will retry if an Exception is raised and the specified exceptionFilter returns true.
onException(BiPredicate<? super ClientRequestContext, ? super Throwable>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified exceptionFilter for a RetryRuleWithContent which will retry if an Exception is raised and the specified exceptionFilter returns true.
onFailure() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Reports a remote invocation failure.
onFailure(AuthFailureHandler) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
Sets the AuthFailureHandler which handles the requests with failed authorization.
onInitialized(String, CircuitState) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit breaker is initialized.
onInitialized(String, CircuitState) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListenerAdapter
 
onlyIfCached() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns whether the "only-if-cached" directive is enabled.
onlyIfCached() - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables the "only-if-cached" directive.
onlyIfCached(boolean) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables or disables the "only-if-cached" directive.
onNext(T) - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onRejectedRequest(ThrottlingRejectHandler<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.throttling.ThrottlingServiceBuilder
onRejectedRequest(ThrottlingRejectHandler<RpcRequest, RpcResponse>) - Method in class com.linecorp.armeria.server.throttling.ThrottlingRpcServiceBuilder
onRequestRejected(String) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit breaker rejects a request.
onRequestRejected(String) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListenerAdapter
 
onResponse(BiFunction<? super ClientRequestContext, ? super T, ? extends CompletionStage<Boolean>>) - Method in class com.linecorp.armeria.client.AbstractRuleWithContentBuilder
Adds the specified responseFilter.
onResponse(BiFunction<? super ClientRequestContext, ? super T, ? extends CompletionStage<Boolean>>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a newly created CircuitBreakerRuleWithContent that will report a Response as a failure if the specified responseFilter completes with true.
onResponse(BiFunction<? super ClientRequestContext, ? super T, ? extends CompletionStage<Boolean>>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified responseFilter for a CircuitBreakerRuleWithContent.
onResponse(BiFunction<? super ClientRequestContext, ? super T, ? extends CompletionStage<Boolean>>) - Static method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a newly created RetryRuleWithContent that will retry with the default backoff if the specified retryFunction completes with true.
onResponse(BiFunction<? super ClientRequestContext, ? super T, ? extends CompletionStage<Boolean>>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified responseFilter for a RetryRuleWithContent which will retry if the specified responseFilter completes with true.
onResponseHeaders(BiPredicate<? super ClientRequestContext, ? super ResponseHeaders>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified responseHeadersFilter.
onResponseHeaders(BiPredicate<? super ClientRequestContext, ? super ResponseHeaders>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified responseHeadersFilter for a CircuitBreakerRule.
onResponseHeaders(BiPredicate<? super ClientRequestContext, ? super ResponseHeaders>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified responseHeadersFilter for a CircuitBreakerRuleWithContent.
onResponseHeaders(BiPredicate<? super ClientRequestContext, ? super ResponseHeaders>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified responseHeadersFilter for a RetryRule which will retry if the responseHeadersFilter returns true.
onResponseHeaders(BiPredicate<? super ClientRequestContext, ? super ResponseHeaders>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified responseHeadersFilter for a RetryRuleWithContent which will retry if the responseHeadersFilter returns true.
onResponseTrailers(BiPredicate<? super ClientRequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified responseTrailersFilter.
onResponseTrailers(BiPredicate<? super ClientRequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified responseTrailersFilter for a CircuitBreakerRule.
onResponseTrailers(BiPredicate<? super ClientRequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified responseTrailersFilter for a CircuitBreakerRuleWithContent.
onResponseTrailers(BiPredicate<? super ClientRequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified responseTrailersFilter for a RetryRuleWithContent which will retry if the responseTrailersFilter returns true.
onResponseTrailers(BiPredicate<? super ClientRequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified responseTrailersFilter for a RetryRuleWithContent which will retry if the responseTrailersFilter returns true.
onRetryingComplete(ClientRequestContext) - Static method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
This should be called when retrying is finished.
onServerErrorStatus() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
onServerErrorStatus() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the class of the response status is HttpStatusClass.SERVER_ERROR.
onServerErrorStatus() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
onServerErrorStatus() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
onServerErrorStatus() - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if the class of the response status is HttpStatusClass.SERVER_ERROR.
onServerErrorStatus() - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the HttpStatusClass.SERVER_ERROR for a RetryRule which will retry if a class of the response status is HttpStatusClass.SERVER_ERROR.
onServerErrorStatus() - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the HttpStatusClass.SERVER_ERROR for a RetryRuleWithContent which will retry if a class of the response status is HttpStatusClass.SERVER_ERROR.
onStateChanged(String, CircuitState) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit state is changed.
onStateChanged(String, CircuitState) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListenerAdapter
 
onStatus(HttpStatus...) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified HttpStatuses.
onStatus(HttpStatus...) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the response status is one of the specified HttpStatuses.
onStatus(HttpStatus...) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified HttpStatuses for a CircuitBreakerRule.
onStatus(HttpStatus...) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified HttpStatuses for a CircuitBreakerRuleWithContent.
onStatus(HttpStatus...) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if the response status is one of the specified HttpStatuses.
onStatus(HttpStatus...) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified HttpStatuses for a RetryRule which will retry if a response status is one of the specified HttpStatuses.
onStatus(HttpStatus...) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified HttpStatuses for a RetryRuleWithContent which will retry if a response status is one of the specified HttpStatuses.
onStatus(Iterable<HttpStatus>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified HttpStatuses.
onStatus(Iterable<HttpStatus>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the response status is one of the specified HttpStatuses.
onStatus(Iterable<HttpStatus>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified HttpStatuses for a CircuitBreakerRule.
onStatus(Iterable<HttpStatus>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified HttpStatuses for a CircuitBreakerRuleWithContent.
onStatus(Iterable<HttpStatus>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if the response status is one of the specified HttpStatuses.
onStatus(Iterable<HttpStatus>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified HttpStatuses for a RetryRule which will retry if a response status is one of the specified HttpStatuses.
onStatus(Iterable<HttpStatus>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified HttpStatuses for a RetryRuleWithContent which will retry if a response status is one of the specified HttpStatuses.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified statusFilter.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the specified statusFilter returns true.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified statusFilter for a CircuitBreakerRule.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Adds the specified statusFilter for a CircuitBreakerRuleWithContent.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created a RetryRule that will retry with the default backoff if the response status matches the specified statusFilter.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified statusFilter for a RetryRule which will retry if a response status matches the specified statusFilter.
onStatus(BiPredicate<? super ClientRequestContext, ? super HttpStatus>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified statusFilter for a RetryRuleWithContent which will retry if a response status matches the specified statusFilter.
onStatusClass(HttpStatusClass) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the class of the response status is one of the specified HttpStatusClasses.
onStatusClass(HttpStatusClass) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if the class of the response status is the specified HttpStatusClass.
onStatusClass(HttpStatusClass...) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified HttpStatusClasses.
onStatusClass(HttpStatusClass...) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified HttpStatusClasses for a CircuitBreakerRule.
onStatusClass(HttpStatusClass...) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
onStatusClass(HttpStatusClass...) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified HttpStatusClasses for a RetryRule which will retry if a class of the response status is one of the specified HttpStatusClasses.
onStatusClass(HttpStatusClass...) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified HttpStatusClasses for a RetryRuleWithContent which will retry if a class of the response status is one of the specified HttpStatusClasses.
onStatusClass(Iterable<HttpStatusClass>) - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Adds the specified HttpStatusClasses.
onStatusClass(Iterable<HttpStatusClass>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the class of the response status is one of the specified HttpStatusClasses.
onStatusClass(Iterable<HttpStatusClass>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Adds the specified HttpStatusClasses for a CircuitBreakerRule.
onStatusClass(Iterable<HttpStatusClass>) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
onStatusClass(Iterable<HttpStatusClass>) - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a newly created RetryRule that will retry with the default backoff if the class of the response status is one of the specified HttpStatusClasses.
onStatusClass(Iterable<HttpStatusClass>) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Adds the specified HttpStatusClasses for a RetryRule which will retry if a class of the response status is one of the specified HttpStatusClasses.
onStatusClass(Iterable<HttpStatusClass>) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Adds the specified HttpStatusClasses for a RetryRuleWithContent which will retry if a class of the response status is one of the specified HttpStatusClasses.
onSubscribe(Subscription) - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onSuccess() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Reports a remote invocation success.
onSuccess(AuthSuccessHandler) - Method in class com.linecorp.armeria.server.auth.AuthServiceBuilder
Sets the AuthSuccessHandler which handles successfully authorized requests.
onUnprocessed() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
onUnprocessed() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(CircuitBreakerRuleBuilder.thenSuccess(), CircuitBreakerRuleBuilder.thenFailure() and CircuitBreakerRuleBuilder.thenIgnore()), if an UnprocessedRequestException, which means that the request has not been processed by the server, is raised.
onUnprocessed() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(CircuitBreakerRuleWithContentBuilder.thenSuccess(), CircuitBreakerRuleWithContentBuilder.thenFailure() and CircuitBreakerRuleWithContentBuilder.thenIgnore()), if an UnprocessedRequestException, which means that the request has not been processed by the server, is raised.
onUnprocessed() - Static method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a RetryRule that retries with the default backoff on an UnprocessedRequestException which means that the request has not been processed by the server.
onUnprocessed() - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Makes a RetryRule retry on an UnprocessedRequestException which means that the request has not been processed by the server.
onUnprocessed() - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Makes a RetryRuleWithContent retry on an UnprocessedRequestException which means that the request has not been processed by the server.
OOXML_DOCUMENT - Static variable in class com.linecorp.armeria.common.MediaType
 
OOXML_DOCUMENT - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.openxmlformats-officedocument.wordprocessingml.document".
OOXML_PRESENTATION - Static variable in class com.linecorp.armeria.common.MediaType
 
OOXML_PRESENTATION - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.openxmlformats-officedocument.presentationml.presentation".
OOXML_SHEET - Static variable in class com.linecorp.armeria.common.MediaType
 
OOXML_SHEET - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet".
OPEN - com.linecorp.armeria.client.circuitbreaker.CircuitState
The circuit is tripped.
OPENDOCUMENT_GRAPHICS - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_GRAPHICS - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.oasis.opendocument.graphics".
OPENDOCUMENT_PRESENTATION - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_PRESENTATION - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.oasis.opendocument.presentation".
OPENDOCUMENT_SPREADSHEET - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_SPREADSHEET - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.oasis.opendocument.spreadsheet".
OPENDOCUMENT_TEXT - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_TEXT - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.oasis.opendocument.text".
option() - Method in class com.linecorp.armeria.common.util.AbstractOptionValue
Returns the option that this option value holder belongs to.
option(ClientFactoryOption<T>, T) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Adds the specified ClientFactoryOption and its value.
option(ClientFactoryOptionValue<T>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Adds the specified ClientFactoryOptionValue.
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified ClientOption and its value.
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.ClientBuilder
 
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
option(ClientOption<T>, T) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified ClientOptionValue.
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.client.ClientBuilder
 
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
option(ClientOptionValue<T>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
OPTIONAL - com.linecorp.armeria.server.docs.FieldRequirement
The field is optional.
options() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the options of the client.
options() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the ClientFactoryOptions that has been used to create this ClientFactory.
options() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the ClientOptions of the current Request.
options() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
options() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
options() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
options() - Method in class com.linecorp.armeria.client.UserClient
 
options(ClientFactoryOptions) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Adds the specified ClientFactoryOptions.
options(ClientOptions) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified ClientOptions.
options(ClientOptions) - Method in class com.linecorp.armeria.client.ClientBuilder
 
options(ClientOptions) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
options(ClientOptions) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
Sets the ClientOptions of the client.
options(ClientOptions) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
options(ClientOptions) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
options(ClientOptions) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
options(ClientOptions) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified ClientOptionValues.
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.ClientBuilder
 
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
options(ClientOptionValue<?>...) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified ClientOptionValues.
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.client.ClientBuilder
 
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
options(Iterable<ClientOptionValue<?>>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
options(String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP OPTIONS request.
options(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
options(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
options(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
options(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
Options - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.OPTIONS onto specific method.
OPTIONS - com.linecorp.armeria.common.HttpMethod
The OPTIONS method which represents a request for information about the communication options available on the request/response chain identified by the Request-URI.
optResourceEnabled(boolean) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Enables the automatic inclusion of a optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response.
or(DocServiceFilter) - Method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Returns a composite DocServiceFilter that represents a short-circuiting logical OR of this filter and other.
order() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.LoggingDecorator
The order of decoration, where a Decorator of lower value will be applied first.
order() - Method in annotation type com.linecorp.armeria.server.annotation.Decorator
The order of decoration, where a Decorator of lower value will be applied first.
order() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.RateLimitingDecorator
The order of decoration, where a Decorator of lower value will be applied first.
Order - Annotation Type in com.linecorp.armeria.server.annotation
Specifies an order which is used to sort the annotated service methods.
orElse(CircuitBreakerRule) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a composed CircuitBreakerRule that represents a logical OR of this CircuitBreakerRule and another.
orElse(CircuitBreakerRule) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a composed CircuitBreakerRuleWithContent that represents a logical OR of this CircuitBreakerRuleWithContent and the specified CircuitBreakerRule.
orElse(CircuitBreakerRuleWithContent<T>) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a composed CircuitBreakerRuleWithContent that represents a logical OR of this CircuitBreakerRuleWithContent and another.
orElse(EndpointGroup) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Creates a new EndpointGroup that tries this EndpointGroup first and then the specified EndpointGroup when this EndpointGroup does not have a requested resource.
orElse(RetryRule) - Method in interface com.linecorp.armeria.client.retry.RetryRule
Returns a composed RetryRule that represents a logical OR of this RetryRule and another.
orElse(RetryRule) - Method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a composed RetryRuleWithContent that represents a logical OR of this RetryRuleWithContent and the specified RetryRule.
orElse(RetryRuleWithContent<T>) - Method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns a composed RetryRuleWithContent that represents a logical OR of this RetryRuleWithContent and another.
orElse(Authorizer<T>) - Method in interface com.linecorp.armeria.server.auth.Authorizer
Returns a new Authorizer that delegates the authorization request to the specified Authorizer if this Authorizer rejects the authorization request by returning a CompletionStage completed with false.
orElse(HttpService) - Method in class com.linecorp.armeria.server.file.FileService
Creates a new HttpService that tries this FileService first and then the specified HttpService when this FileService does not have a requested resource.
origin() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Returns the allowed origin.
ORIGIN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Origin" header field name.
ORIGIN_TRIAL - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Origin-Trial" header field name.
ORIGINAL_CLASS_NAME_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.ThrowableProto
 
ORIGINAL_MESSAGE_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.ThrowableProto
 
origins() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
Allowed origins.
origins() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Returns the set of allowed origins.
osType() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Returns the operating system for the currently running process.
OsType - Enum in com.linecorp.armeria.common.util
Operating system.
OTHERS - com.linecorp.armeria.common.util.OsType
 
otherSerializationFormats(SerializationFormat) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
Adds other SerializationFormat to the builder.
otherSerializationFormats(Iterable<SerializationFormat>) - Method in class com.linecorp.armeria.server.thrift.THttpServiceBuilder
Adds other SerializationFormat to the builder.
overdraftLimit() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns the maximum overdraft count of tokens which can be held by the bucket.
overridePath(String) - Method in interface com.linecorp.armeria.server.RoutingContext
Returns a wrapped RoutingContext which holds the specified path.
ownAttr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
ownAttr(AttributeKey<V>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns the value associated with the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object).
ownAttr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
ownAttrs() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
ownAttrs() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the Iterator of all Map.Entrys this context contains.
ownAttrs() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 

P

P3P - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "P3P" header field name.
Param - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping a parameter of a request onto the following elements.
PARAMETERIZED - com.linecorp.armeria.server.RoutePathType
The path which contains path parameters. e.g, "/:", "/foo/:/bar/:"
parameters() - Method in class com.linecorp.armeria.common.MediaType
Returns a multimap containing the parameters of this media type.
parameters() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the metadata about the parameters of the function.
paramNames() - Method in interface com.linecorp.armeria.server.Route
Returns the names of the path parameters extracted by this mapping.
params() - Method in interface com.linecorp.armeria.common.RpcRequest
Returns the parameters.
params() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns the query parameters retrieved from the request path.
parent() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLogAccess that provides access to the parent RequestLog.
parse(Iterable<String>) - Static method in class com.linecorp.armeria.common.ClientCacheControl
Parses the specified "cache-control" header values into a ClientCacheControl.
parse(Iterable<String>) - Static method in class com.linecorp.armeria.common.ServerCacheControl
Parses the specified "cache-control" header values into a ServerCacheControl.
parse(String) - Static method in class com.linecorp.armeria.client.Endpoint
Parse the authority part of a URI.
parse(String) - Static method in class com.linecorp.armeria.common.MediaType
Parses a media type from its string representation.
parse(String) - Static method in class com.linecorp.armeria.common.Scheme
Parses the specified String into a Scheme.
parse(String...) - Static method in class com.linecorp.armeria.common.ClientCacheControl
Parses the specified "cache-control" header values into a ClientCacheControl.
parse(String...) - Static method in class com.linecorp.armeria.common.ServerCacheControl
Parses the specified "cache-control" header values into a ServerCacheControl.
parseDelimitedFrom(InputStream) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseDelimitedFrom(InputStream) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseDelimitedFrom(InputStream, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseDelimitedFrom(InputStream, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parsedPathCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the parsedPathCache parameter.
parseFrom(byte[]) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(byte[]) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(byte[], ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(byte[], ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(ByteString) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(ByteString) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(ByteString, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(ByteString, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(CodedInputStream) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(CodedInputStream) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(CodedInputStream, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(CodedInputStream, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(InputStream) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(InputStream) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(InputStream, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(InputStream, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(ByteBuffer) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(ByteBuffer) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parseFrom(ByteBuffer, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parseFrom(ByteBuffer, ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
parser() - Static method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
parser() - Static method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
partial() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns the RequestLog for the Request, where all properties may not be available yet.
PARTIAL_CONTENT - Static variable in class com.linecorp.armeria.common.HttpStatus
206 Partial Content.
password() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
Returns the configured password.
password() - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
Returns the configured password.
password() - Method in class com.linecorp.armeria.common.auth.BasicToken
Returns the password.
password(String) - Method in class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Sets a password of the KeyStore.
patch(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
patch(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
patch(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
patch(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
patch(String, byte[]) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PATCH request with the specified content.
patch(String, HttpData) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PATCH request with the specified content.
patch(String, String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PATCH request with the specified content.
patch(String, String, Charset) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PATCH request with the specified content.
Patch - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.PATCH onto specific method.
PATCH - com.linecorp.armeria.common.HttpMethod
The PATCH method which requests that a set of changes described in the request entity be applied to the resource identified by the Request-URI.
path() - Method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
Returns the path for finding the byte array representation of registered instances.
path() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the path of the request, excluding the query part.
path() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Returns the PATH of this request.
path() - Method in interface com.linecorp.armeria.common.Cookie
Returns the path of this Cookie.
path() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the path of this request.
path() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
path() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the absolute path part of the current Request URI, excluding the query part, as defined in RFC3986.
path() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
path() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns the absolute path retrieved from the request, as defined in RFC3986.
path() - Method in class com.linecorp.armeria.server.RoutingResult
Returns the path mapped by the Route.
path() - Method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
Returns the path for registering the Server.
path(String) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the path of the Cookie.
path(String) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
Sets the ":path" header.
path(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
path(String) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match the specified pathPattern. e.g.
path(String) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
Sets the mapped path, encoded as defined in RFC3986.
path(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
path(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
path(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
path(String, String) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match the specified prefix and pathPattern.
Path - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping dynamic web requests onto specific method.
PATH - com.linecorp.armeria.server.docs.FieldLocation
The field is located in the path.
PATH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP ":path" pseudo header field name.
pathMapping() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the path mapping of this endpoint.
pathOrUri() - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
Returns the String representation of the file path or URI, which is given to the entityTagFunction specified with the constructor.
pathParam(String) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the value of the specified path parameter.
pathParams() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
pathParams() - Method in class com.linecorp.armeria.server.RoutingResult
Returns the path parameters extracted by the Route.
pathParams() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the path parameters mapped by the Route associated with the Service that is handling the current Request.
pathParams() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
pathPatterns() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
The path patterns that this policy is supposed to be applied to.
pathPrefix(String) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
Sets the path prefix to be used for this AnnotatedServiceBindingBuilder.
pathPrefix(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
pathPrefix(String) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match when a path is under the specified prefix.
pathPrefix(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
pathPrefix(String) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
Sets the path prefix to be used for this VirtualHostAnnotatedServiceBindingBuilder.
pathPrefix(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
pathPrefix(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
pathPrefix(String, boolean) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match when a path is under the specified prefix.
PathPrefix - Annotation Type in com.linecorp.armeria.server.annotation
Annotation that can be used on a class as a path prefix for all the methods that handle http request.
paths() - Method in interface com.linecorp.armeria.server.Route
Returns the list of paths that this Route has.
Paths - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for Path.
pathType() - Method in interface com.linecorp.armeria.server.Route
Returns the type of the path which was specified when this is created.
patternString() - Method in interface com.linecorp.armeria.server.Route
Returns the path pattern of this Route.
payload(T) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the payload.
PAYMENT_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
402 Payment Required.
PDF - Static variable in class com.linecorp.armeria.common.MediaType
 
PDF - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/pdf".
peel(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Returns the cause of the specified throwable peeling it recursively, if it is one of the CompletionException, ExecutionException, InvocationTargetException or ExceptionInInitializerError.
pendingAcquisitionDurationNanos() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the duration which was taken to wait for the completion of an existing connection attempt in order to use one connection for HTTP/2.
pendingAcquisitionEnd() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimingsBuilder
Sets the time when the client ended to wait for an existing connection attempt in order to use one connection for HTTP/2.
pendingAcquisitionStart() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimingsBuilder
Sets the time when the client started to wait for the completion of an existing connection attempt in order to use one connection for HTTP/2.
pendingAcquisitionStartTimeMicros() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the time when the client started to wait for the completion of an existing connection attempt, in microseconds since the epoch.
pendingAcquisitionStartTimeMillis() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the time when the client started to wait for the completion of an existing connection attempt, in milliseconds since the epoch.
perHost(Function<String, ? extends CircuitBreaker>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
Creates a new CircuitBreakerMapping which maps CircuitBreakers with the remote host name.
perHostAndMethod(BiFunction<String, String, ? extends CircuitBreaker>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
Creates a new CircuitBreakerMapping which maps CircuitBreakers with the remote host and method name.
period() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
Returns the time window, during which the tokens will be regenerated for the given bandwidth limit.
perMethod(Function<String, ? extends CircuitBreaker>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
Creates a new CircuitBreakerMapping which maps CircuitBreakers with method name.
PERSISTENT - com.linecorp.armeria.server.saml.SamlNameIdFormat
Persistent name format.
pid() - Static method in class com.linecorp.armeria.common.util.SystemInfo
Returns the current process ID.
PING_FROM - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Ping-From" header field name.
PING_INTERVAL_MILLIS - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The PING interval in milliseconds.
PING_TO - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Ping-To" header field name.
pingInterval(Duration) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the PING interval.
pingInterval(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the HTTP/2 PING interval.
pingIntervalMillis() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the PING interval in milliseconds.
pingIntervalMillis() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the HTTP/2 PING interval in milliseconds.
pingIntervalMillis(long) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the PING interval in milliseconds.
pingIntervalMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the HTTP/2 PING interval.
PLAIN_TEXT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
PLAIN_TEXT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/plain; charset=utf-8".
PNG - Static variable in class com.linecorp.armeria.common.MediaType
 
PNG - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/png".
policies() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns the policies.
PooledObjects - Class in com.linecorp.armeria.unsafe
Utility class that provides ways to create a pooled HttpData and manage its life cycle.
pop(RequestContext, RequestContext) - Method in interface com.linecorp.armeria.common.RequestContextStorage
Pops the current RequestContext in the storage and pushes back the specified toRestore.
pop(RequestContext, RequestContext) - Method in class com.linecorp.armeria.common.RequestContextStorageWrapper
 
port() - Method in class com.linecorp.armeria.client.Endpoint
Returns the port number of this endpoint.
port(int) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
Sets the port number of the Endpoints created by DnsAddressEndpointGroup.
port(int) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the port where a health check request will be sent instead of the original port number specified by EndpointGroup's Endpoints.
port(int) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
port(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns the port number of this endpoint.
port(int) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the port used for SessionProtocol.HTTP.
port(int) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a port of this service provider.
port(int) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the port.
port(int, SessionProtocol...) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
port(int, Iterable<SessionProtocol>) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
port(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the port number of the Server for the specified SessionProtocol.
port(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the port number of the Server for the specified SessionProtocol.
port(ServerPort) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the specified ServerPort.
port(InetSocketAddress, SessionProtocol...) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
port(InetSocketAddress, Iterable<SessionProtocol>) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
Port() - Constructor for class com.linecorp.armeria.spring.ArmeriaSettings.Port
 
ports() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ServerPorts to listen on.
post(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
post(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
post(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
post(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
post(String, byte[]) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP POST request with the specified content.
post(String, HttpData) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP POST request with the specified content.
post(String, String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP POST request with the specified content.
post(String, String, Charset) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP POST request with the specified content.
Post - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.POST onto specific method.
POST - com.linecorp.armeria.common.HttpMethod
The POST method which is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line.
postProcessProperties(PropertyValues, Object, String) - Method in class com.linecorp.armeria.spring.ArmeriaBeanPostProcessor
Post-processes the given property values before the factory apply them to the given bean.
POSTSCRIPT - Static variable in class com.linecorp.armeria.common.MediaType
 
POSTSCRIPT - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/postscript".
PRAGMA - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Pragma" header field name.
PRECONDITION_FAILED - Static variable in class com.linecorp.armeria.common.HttpStatus
412 Precondition Failed.
PRECONDITION_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
428 Precondition Required (RFC6585).
PREFER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Prefer" header field name.
preferredIpV4Addresses() - Static method in class com.linecorp.armeria.common.Flags
Returns the Predicate that is used to choose the non-loopback IP v4 address in SystemInfo.defaultNonLoopbackIpV4Address().
PREFIX - com.linecorp.armeria.server.RoutePathType
The prefix path type. e.g, "/", "/foo/"
preflightRequestDisabled() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
Determines if no preflight response headers should be added to a CORS preflight response.
preflightRequestHeaders() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorator
The HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeader(CharSequence, Iterable<?>) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
preflightResponseHeader(CharSequence, Iterable<?>) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
preflightResponseHeader(CharSequence, Iterable<?>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeader(CharSequence, Object...) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
preflightResponseHeader(CharSequence, Object...) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
preflightResponseHeader(CharSequence, Object...) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeader(CharSequence, Supplier<?>) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
preflightResponseHeader(CharSequence, Supplier<?>) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
preflightResponseHeader(CharSequence, Supplier<?>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
printStackTrace() - Method in exception com.linecorp.armeria.common.util.CompositeException
All of the following printStackTrace functionality is derived from JDK Throwable printStackTrace.
printStackTrace(PrintStream) - Method in exception com.linecorp.armeria.common.util.CompositeException
 
printStackTrace(PrintWriter) - Method in exception com.linecorp.armeria.common.util.CompositeException
 
priority(int) - Method in class com.linecorp.armeria.common.util.ThreadFactoryBuilder
Sets priority for new threads.
privateKey() - Method in class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Returns the PrivateKey of the self-signed certificate.
privateKey() - Method in class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Returns the PrivateKey of the self-signed certificate.
privateKeyFile() - Method in class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Returns the private key file of the self-signed certificate.
privateKeyFile() - Method in class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Returns the private key file of the self-signed certificate.
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.linecorp.armeria.server.annotation.processor.DocumentationProcessor
 
PROCESSING - Static variable in class com.linecorp.armeria.common.HttpStatus
102 Processing (WebDAV, RFC2518).
produce() - Method in interface com.linecorp.armeria.common.logging.ContentPreviewer
Produces the preview of the request or response.
produces() - Method in interface com.linecorp.armeria.server.Route
Returns the Set of MediaTypes that this Route produces.
produces(MediaType...) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
produces(MediaType...) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to produce the specified MediaTypes.
produces(MediaType...) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
produces(MediaType...) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
produces(MediaType...) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
produces(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
produces(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to produce the specified MediaTypes.
produces(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
produces(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
produces(Iterable<MediaType>) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
Produces - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a media type which would be produced by the service method or class.
ProducesBinary - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces(MediaTypeNames.APPLICATION_BINARY).
ProducesEventStream - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces(MediaTypeNames.EVENT_STREAM) and @ResponseConverter(ServerSentEventResponseConverterFunction.class).
ProducesGroup - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for Produces.
ProducesJson - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces(MediaTypeNames.JSON_UTF_8).
ProducesJsonSequences - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces(MediaTypeNames.JSON_SEQ).
ProducesOctetStream - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces(MediaTypeNames.OCTET_STREAM).
ProducesText - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces(MediaTypeNames.PLAIN_TEXT_UTF_8).
PrometheusExpositionService - Class in com.linecorp.armeria.server.metric
Exposes Prometheus metrics in text format 0.0.4.
PrometheusExpositionService(CollectorRegistry) - Constructor for class com.linecorp.armeria.server.metric.PrometheusExpositionService
Creates a new instance.
PrometheusMeterRegistries - Class in com.linecorp.armeria.common.metric
Provides the convenient factory methods for PrometheusMeterRegistry with more sensible defaults for NamingConvention.
PropertiesEndpointGroup - Class in com.linecorp.armeria.client.endpoint
PropertiesEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint
PROTO - Static variable in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
gRPC protobuf serialization format.
PROTO_WEB - Static variable in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
gRPC-Web protobuf serialization format.
PROTO_WEB_TEXT - Static variable in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
gRPC-web-text protobuf serialization format.
PROTOBUF - Static variable in class com.linecorp.armeria.common.MediaType
PROTOBUF - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/protobuf".
protocol() - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckerContext
Returns the SessionProtocol to be used when sending health check requests.
protocol(SessionProtocol) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the SessionProtocol to be used when making health check requests.
protocol(SessionProtocol) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
protocols() - Method in class com.linecorp.armeria.server.ServerPort
Returns the SessionProtocols this ServerPort uses.
ProtocolViolationException - Exception in com.linecorp.armeria.common
A RuntimeException raised when a remote peer violated the current SessionProtocol.
ProtocolViolationException() - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new exception.
ProtocolViolationException(String) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified message.
ProtocolViolationException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified message and cause.
ProtocolViolationException(Throwable) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified cause.
provide(ServiceRequestContext) - Method in interface com.linecorp.armeria.common.kotlin.CoroutineContextProvider
Returns a CoroutineContext.
proxiedAddresses() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
proxiedAddresses() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the proxied addresses of the current Request.
proxiedAddresses() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
proxiedAddresses(ProxiedAddresses) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Sets the ProxiedAddresses of the request.
ProxiedAddresses - Class in com.linecorp.armeria.server
An interface to provide source and destination addresses delivered from a proxy server.
PROXY - com.linecorp.armeria.common.SessionProtocol
PROXY protocol - v1 or v2.
PROXY_AUTHENTICATE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Proxy-Authenticate" header field name.
PROXY_AUTHENTICATION_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
407 Proxy Authentication Required.
PROXY_AUTHORIZATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Proxy-Authorization" header field name.
PROXY_CONFIG_SELECTOR - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The ProxyConfigSelector which determines the ProxyConfig to be used.
proxyAddress() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
 
proxyAddress() - Method in class com.linecorp.armeria.client.proxy.DirectProxyConfig
 
proxyAddress() - Method in class com.linecorp.armeria.client.proxy.HAProxyConfig
 
proxyAddress() - Method in class com.linecorp.armeria.client.proxy.ProxyConfig
Returns the proxy address which is null only for ProxyType.DIRECT.
proxyAddress() - Method in class com.linecorp.armeria.client.proxy.Socks4ProxyConfig
 
proxyAddress() - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
 
proxyConfig(ProxyConfig) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the ProxyConfig which contains proxy related configuration.
proxyConfig(ProxyConfigSelector) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the ProxyConfigSelector which determines the ProxyConfig to be used.
proxyConfig(ProxySelector) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the ProxySelector which determines the ProxyConfig to be used.
ProxyConfig - Class in com.linecorp.armeria.client.proxy
Base configuration for proxy settings used by ClientFactory.
proxyConfigSelector() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
The ProxyConfigSelector which determines the ProxyConfig to be used.
ProxyConfigSelector - Interface in com.linecorp.armeria.client.proxy
Selects the ProxyConfig to use when connecting to a network resource specified by the SessionProtocol and Endpoint parameter.
proxyProtocolMaxTlvSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum size of additional data (TLV, Tag-Length-Value).
proxyProtocolMaxTlvSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum size of additional data for PROXY protocol.
proxyRevalidate() - Method in class com.linecorp.armeria.common.ServerCacheControl
Returns whether the "proxy-revalidate" directive is enabled.
proxyRevalidate() - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables the "proxy-revalidate" directive.
proxyRevalidate(boolean) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables or disables the "proxy-revalidate" directive.
proxyType() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
 
proxyType() - Method in class com.linecorp.armeria.client.proxy.DirectProxyConfig
 
proxyType() - Method in class com.linecorp.armeria.client.proxy.HAProxyConfig
 
proxyType() - Method in class com.linecorp.armeria.client.proxy.ProxyConfig
Returns the proxy type.
proxyType() - Method in class com.linecorp.armeria.client.proxy.Socks4ProxyConfig
 
proxyType() - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
 
ProxyType - Enum in com.linecorp.armeria.client.proxy
The proxy protocol type.
PSD - Static variable in class com.linecorp.armeria.common.MediaType
The Photoshop File Format (psd files) as defined by IANA, and found in /etc/mime.types, e.g.
PSD - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/vnd.adobe.photoshop".
PUBLIC_KEY_PINS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Public-Key-Pins header field name.
PUBLIC_KEY_PINS_REPORT_ONLY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Public-Key-Pins-Report-Only header field name.
PublisherBasedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
Adapts a Publisher into a StreamMessage.
PublisherBasedStreamMessage(Publisher<? extends T>) - Constructor for class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
Creates a new instance with the specified delegate Publisher.
push() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Pushes this context to the thread-local stack.
push() - Method in interface com.linecorp.armeria.common.RequestContext
Pushes the specified context to the thread-local stack.
push() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Pushes this context to the thread-local stack.
push(RequestContext) - Method in interface com.linecorp.armeria.common.RequestContextStorage
Pushes the specified RequestContext into the storage.
push(RequestContext) - Method in class com.linecorp.armeria.common.RequestContextStorageWrapper
 
put(RequestContext, String, String) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Binds the specified request-scoped MDC property to the specified RequestContext.
put(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
put(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
put(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
put(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
put(String, byte[]) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PUT request with the specified content.
put(String, HttpData) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PUT request with the specified content.
put(String, String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PUT request with the specified content.
put(String, String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the specified key-value parameter.
put(String, String, Charset) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP PUT request with the specified content.
Put - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.PUT onto specific method.
PUT - com.linecorp.armeria.common.HttpMethod
The PUT method which requests that the enclosed entity be stored under the supplied Request-URI.
putAll(RequestContext, Map<String, String>) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Binds the specified request-scoped MDC properties to the specified RequestContext.
putAll(Map<String, String>) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the specified Map.

Q

qualityFactor() - Method in class com.linecorp.armeria.common.MediaType
Returns the quality factor of this MediaType.
qualityFactor(float) - Method in class com.linecorp.armeria.common.MediaType
Returns the quality factor of this MediaType.
query() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the query part of the request, excluding the leading question mark ('?').
query() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
query() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the query part of the current Request URI, without the leading '?', as defined in RFC3986.
query() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
query() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns the query retrieved from the request, as defined in RFC3986.
query() - Method in class com.linecorp.armeria.server.RoutingResult
Returns the query mapped by the Route.
query(String) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
Sets the specified query.
QUERY - com.linecorp.armeria.server.docs.FieldLocation
The field is located in the query.
QueryParams - Interface in com.linecorp.armeria.common
Immutable HTTP query parameters.
QueryParamsBuilder - Interface in com.linecorp.armeria.common
Builds a QueryParams.
queryTimeout(Duration) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the timeout of the DNS query performed by this resolver.
queryTimeout(Duration) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
queryTimeout(Duration) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
queryTimeout(Duration) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
queryTimeoutMillis(long) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the timeout of the DNS query performed by this resolver in milliseconds.
queryTimeoutMillis(long) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
queryTimeoutMillis(long) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
queryTimeoutMillis(long) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
QUICKTIME - Static variable in class com.linecorp.armeria.common.MediaType
 
QUICKTIME - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/quicktime".

R

random() - Static method in interface com.linecorp.armeria.common.RequestId
Returns a RequestId created from a 64-bit random integer.
random(float) - Static method in interface com.linecorp.armeria.common.util.Sampler
Returns a probabilistic sampler which samples at the specified probability between 0.0 and 1.0.
random(long, long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that computes backoff delay which is a random value between minDelayMillis and maxDelayMillis chosen by ThreadLocalRandom.
random(long, long, Supplier<Random>) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that computes backoff delay which is a random value between minDelayMillis and maxDelayMillis.
RANGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Range" header field name.
RATELIMIT - Static variable in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders
rateLimiting(double) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns a new ThrottlingStrategy that provides a throttling strategy based on requests per second.
rateLimiting(double, String) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns a new ThrottlingStrategy that provides a throttling strategy based on requests per second.
rateLimiting(int) - Static method in interface com.linecorp.armeria.common.util.Sampler
Returns a rate-limiting sampler which rate-limits up to the specified samplesPerSecond.
RateLimitingDecorator - Annotation Type in com.linecorp.armeria.server.annotation.decorator
A ThrottlingService decorator for annotated HTTP services.
RateLimitingDecoratorFactoryFunction - Class in com.linecorp.armeria.server.annotation.decorator
A factory which creates a ThrottlingService decorator with a ThrottlingStrategy.rateLimiting(double, String).
RateLimitingDecoratorFactoryFunction() - Constructor for class com.linecorp.armeria.server.annotation.decorator.RateLimitingDecoratorFactoryFunction
 
RateLimitingDecorators - Annotation Type in com.linecorp.armeria.server.annotation.decorator
The containing annotation type for RateLimitingDecorator.
rawParam(String, String) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
Adds an encoded path parameter, which will be decoded in UTF-8 automatically.
rawRequestContent() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the low-level content object of the Request, which is specific to the SerializationFormat.
rawResponseContent() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the low-level content object of the Response, which is specific to the SerializationFormat.
RDF_XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
RDF/XML documents, which are XML serializations of Resource Description Framework graphs.
RDF_XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/rdf+xml; charset=utf-8".
read() - Method in interface com.linecorp.armeria.common.util.Ticker
Returns the number of nanoseconds elapsed since this ticker's fixed point of reference.
read(Executor, ByteBufAllocator) - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
 
read(Executor, ByteBufAllocator) - Method in interface com.linecorp.armeria.server.file.HttpFile
Starts to stream this file into the returned HttpResponse.
read(T, ByteBuf) - Method in class com.linecorp.armeria.server.file.StreamingHttpFile
Reads the content of src into dst.
readAttributes(Executor) - Method in interface com.linecorp.armeria.server.file.HttpFile
Retrieves the attributes of this file.
readHeaders(HttpFileAttributes) - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
Generates the ResponseHeaders from the specified HttpFileAttributes.
readHeaders(Executor) - Method in class com.linecorp.armeria.server.file.AbstractHttpFile
 
readHeaders(Executor) - Method in interface com.linecorp.armeria.server.file.HttpFile
Reads the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.
realm() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of the "realm" property.
realm(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of the realm property.
realm(Realm) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
Sets the Realm of an embedded Tomcat.
reasonPhrase() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the reason phrase of this HttpStatus.
reconfigure(TokenBucket) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategy
Resets the Token-Bucket configuration at runtime by providing a new set of limits.
RecordedRequest - Class in com.linecorp.armeria.testing.junit5.server.mock
A request that has been made to a MockWebServerExtension.
recursionDesired(boolean) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets if this resolver has to send a DNS query with the RD (recursion desired) flag set.
REDIRECTION - com.linecorp.armeria.common.HttpStatusClass
The redirection class (3xx).
RedirectService - Class in com.linecorp.armeria.server
An HttpService that sends a redirect response such as "307 Temporary Redirect".
RedirectService(HttpStatus, String) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location constructed with the specified locationPattern, preserving the query string in the request URI.
RedirectService(HttpStatus, String, boolean) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location constructed with the specified locationPattern.
RedirectService(HttpStatus, Function<? super ServiceRequestContext, String>) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location returned by locationFunction, preserving the query string in the request URI.
RedirectService(HttpStatus, Function<? super ServiceRequestContext, String>, boolean) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location returned by locationFunction.
RedirectService(String) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location constructed with the specified locationPattern, preserving the query string in the request URI.
RedirectService(String, boolean) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location constructed with the specified locationPattern.
RedirectService(Function<? super ServiceRequestContext, String>) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location returned by locationFunction, preserving the query string in the request URI.
RedirectService(Function<? super ServiceRequestContext, String>, boolean) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location returned by locationFunction.
REFERER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Referer" header field name.
REFERRER_POLICY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Referrer-Policy" header field name.
REFRESH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Refresh" header field name.
refreshBackoff(Backoff) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets Backoff which is used when the DnsNameResolver fails to update the cache.
RefusedStreamException - Exception in com.linecorp.armeria.client
A RuntimeException raised when a server set HTTP/2 MAX_CONCURRENT_STREAMS to 0, which means a client can't send anything.
regex(String) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match the specified regex.
regex(Pattern) - Method in class com.linecorp.armeria.server.RouteBuilder
Sets the Route to match the specified regex.
REGEX - com.linecorp.armeria.server.RoutePathType
The regex path type. e.g, "^/(?<foo>.*)$" The Route which is created using RouteBuilder.glob(String) and RouteBuilder.regex(String) can be this type.
REGEX_WITH_PREFIX - com.linecorp.armeria.server.RoutePathType
The path which has the prefix and the regex.
RegexBasedSanitizer - Class in com.linecorp.armeria.common.logging
Regex based sanitizer.
regexPathPrefix() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the prefix of this endpoint if the EndpointInfo.pathMapping() returns a regular expression string of endpoint and the prefix exists, otherwise null.
regexPathPrefix(String) - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
Sets the prefix of the pathMapping if the pathMapping is a regular expression string and the prefix exists.
regions(Iterable<String>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the specified regions.
regions(String...) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the specified regions.
registerAllExtensions(ExtensionRegistry) - Static method in class com.linecorp.armeria.common.grpc.InternalExceptionMessages
 
registerAllExtensions(ExtensionRegistryLite) - Static method in class com.linecorp.armeria.common.grpc.InternalExceptionMessages
 
registerMetrics(MeterRegistry, MeterIdPrefix) - Method in interface com.linecorp.armeria.server.Router
Registers the stats of this Router to the specified MeterRegistry.
registryFetchInterval(Duration) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the interval between fetching registry requests.
registryFetchIntervalMillis(long) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the interval between fetching registry requests in milliseconds.
registryFetchIntervalSeconds(long) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
RegularFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that publishes an arbitrary number of objects.
RegularFixedStreamMessage(T[]) - Constructor for class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
Creates a new instance with the specified elements.
rejectedRouteHandler(RejectedRouteHandler) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the RejectedRouteHandler which will be invoked when an attempt to bind an HttpService at a certain Route is rejected.
rejectedRouteHandler(RejectedRouteHandler) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the RejectedRouteHandler which will be invoked when an attempt to bind an HttpService at a certain Route is rejected.
RejectedRouteHandler - Interface in com.linecorp.armeria.server
A handler that is invoked when a ServerBuilder rejects to bind an HttpService at a certain Route.
ReleasableHolder<T> - Interface in com.linecorp.armeria.common.util
A holder of releasable resource ReleasableHolder.
release() - Method in interface com.linecorp.armeria.common.util.ReleasableHolder
Releases the resource.
releaseBuffer(Object, RequestContext) - Static method in class com.linecorp.armeria.unsafe.grpc.GrpcUnsafeBufferUtil
Releases the ByteBuf backing the specified Message.
remainingHeader() - Method in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders
Returns the name of the "remaining" throttling header for the given scheme, like "X-RateLimit-Remaining".
REMOTE_HOST - com.linecorp.armeria.common.logging.BuiltInProperty
"remote.host" - the host name part of the remote socket address.
REMOTE_IP - com.linecorp.armeria.common.logging.BuiltInProperty
"remote.ip" - the IP address part of the remote socket address.
REMOTE_PORT - com.linecorp.armeria.common.logging.BuiltInProperty
"remote.port" - the port number part of the remote socket address.
remoteAddress() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the remote socket address of the connection.
remoteAddress() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
remoteAddress() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the remote address of this request, or null if the connection is not established yet.
remoteAddress() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
remoteAddress() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
remoteAddress() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the remote address of this request.
remoteAddress() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
remoteAddress(SocketAddress) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
remoteAddress(SocketAddress) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the remote socket address of the connection.
remoteAddress(SocketAddress) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
remove(RequestContext, String) - Static method in class com.linecorp.armeria.common.logging.RequestScopedMdc
Unbinds the specified request-scoped MDC property from the specified RequestContext.
remove(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all headers with the specified name.
remove(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all parameters with the specified name.
removeAndThen(CharSequence) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Removes all headers with the specified name.
removeAndThen(CharSequence) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
removeAndThen(CharSequence) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
removeAndThen(String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Removes all parameters with the specified name.
removeEldestEntry(Map.Entry<T, U>) - Method in class com.linecorp.armeria.common.util.LruMap
Returns true if the HashMap.size() of this map exceeds the maximum number of allowed entries.
removeEndpoint(Endpoint) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Removes the specified Endpoint from current Endpoint list.
removeListener(ServerListener) - Method in class com.linecorp.armeria.server.Server
Removes the specified ServerListener from this Server, so that it is not notified anymore when the state of this Server changes.
removeListener(Consumer<?>) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
 
removeListener(Consumer<?>) - Method in class com.linecorp.armeria.common.util.AbstractListenable
 
removeListener(Consumer<?>) - Method in interface com.linecorp.armeria.common.util.Listenable
Remove a listener.
removeListener(L) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Removes the specified listener, so that it is not notified anymore.
removeStackTrace(int) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
renewalInterval(Duration) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the interval between renewal.
renewalIntervalMillis(long) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the interval between renewal in milliseconds.
renewalIntervalSeconds(int) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
replace() - Method in interface com.linecorp.armeria.common.RequestContext
Replaces the current RequestContext in the thread-local with this context without any validation.
REPORT_TO - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Report-To" header field name.
reportBlockedEventLoop() - Static method in class com.linecorp.armeria.common.Flags
Returns whether CompletableFutures returned by Armeria methods log a warning if CompletableFuture.join() or CompletableFuture.get() are called from an event loop thread.
reportSuccessOrFailure(CircuitBreaker, CompletionStage<CircuitBreakerDecision>) - Static method in class com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClient
Reports a success or a failure to the specified CircuitBreaker according to the completed value of the specified future.
repositoryStatus() - Method in class com.linecorp.armeria.common.util.Version
Returns the status of the repository when performing the release process.
REQ_AUTHORITY - com.linecorp.armeria.common.logging.BuiltInProperty
"req.authority" - the authority of the request, represented as "<hostname>[:<port>]".
REQ_CONTENT - com.linecorp.armeria.common.logging.BuiltInProperty
"req.content" - the content of the request.
REQ_CONTENT_LENGTH - com.linecorp.armeria.common.logging.BuiltInProperty
"req.content_length" - the byte-length of the request content.
REQ_DIRECTION - com.linecorp.armeria.common.logging.BuiltInProperty
"req.direction" - the direction of the request, which is "INBOUND" for servers and "OUTBOUND" for clients.
REQ_ID - com.linecorp.armeria.common.logging.BuiltInProperty
"req.id" - the ID of the request.
REQ_METHOD - com.linecorp.armeria.common.logging.BuiltInProperty
"req.method" - the method name of the request, such as "GET" and "POST".
REQ_NAME - com.linecorp.armeria.common.logging.BuiltInProperty
"req.name" - the human-readable name of the request, such as: gRPC - A capitalized method name defined in io.grpc.MethodDescriptor (e.g, GetItems) Thrift and annotated service - a method name (e.g, getItems) HttpService - an HTTP method name This property is often used as a meter tag or distributed trace's span name.
REQ_PATH - com.linecorp.armeria.common.logging.BuiltInProperty
"req.path" - the path of the request.
REQ_QUERY - com.linecorp.armeria.common.logging.BuiltInProperty
"req.query" - the query of the request.
REQ_SERVICE_NAME - com.linecorp.armeria.common.logging.BuiltInProperty
"req.service_name" - the human-readable name of the service that served the request, such as: gRPC - a service name (e.g, com.foo.GrpcService) Thrift - a service type (e.g, com.foo.ThriftService$AsyncIface or com.foo.ThriftService$Iface) HttpService and annotated service - an innermost class name This property is often used as a meter tag or distributed trace's span name.
request() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
request() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the HttpRequest of the context.
request() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
request() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet.
request() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
request() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the HttpRequest associated with this context.
request() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
request() - Method in class com.linecorp.armeria.testing.junit5.server.mock.RecordedRequest
The AggregatedHttpRequest received by the server.
request(int) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Requests up to the given number of messages from the call to be delivered to ArmeriaMessageDeframer.Listener.messageRead(DeframedMessage).
Request - Interface in com.linecorp.armeria.common
A request.
REQUEST_CAUSE - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_CONTENT - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_CONTENT_PREVIEW - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_END_TIME - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_ENTITY_TOO_LARGE - Static variable in class com.linecorp.armeria.common.HttpStatus
413 Request Entity Too Large.
REQUEST_FIRST_BYTES_TRANSFERRED_TIME - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in class com.linecorp.armeria.common.HttpStatus
431 Request Header Fields Too Large (RFC6585).
REQUEST_HEADERS - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_ID_GENERATOR - Static variable in class com.linecorp.armeria.client.ClientOptions
The Supplier that generates a RequestId.
REQUEST_LENGTH - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_START_TIME - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_TIMEOUT - Static variable in class com.linecorp.armeria.common.HttpStatus
408 Request Timeout.
REQUEST_TRAILERS - com.linecorp.armeria.common.logging.RequestLogProperty
REQUEST_URI_TOO_LONG - Static variable in class com.linecorp.armeria.common.HttpStatus
414 Request-URI Too Long.
RequestCancellationException - Exception in com.linecorp.armeria.server
A CancellationException raised when a request is cancelled by the user.
requestCause() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the cause of request processing failure.
requestContent() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the high-level content object of the Request, which is specific to the SerializationFormat.
requestContent(Object, Object) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestContentPreview() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the preview of request content of the Request.
requestContentPreview(String) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestContentPreviewer(RequestContext, RequestHeaders) - Method in interface com.linecorp.armeria.common.logging.ContentPreviewerFactory
Returns a newly-created request ContentPreviewer with the given RequestContext and RequestHeaders.
requestContentSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the BiFunction to use to sanitize request content before logging.
requestContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
requestContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
requestContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize request content before logging.
requestContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
RequestContext - Interface in com.linecorp.armeria.common
Provides information about a Request, its Response and related utilities.
RequestContextAssembly - Class in com.linecorp.armeria.common.rxjava2
Utility class to keep RequestContext during RxJava operations.
RequestContextAssembly - Class in com.linecorp.armeria.common.rxjava3
Utility class to keep RequestContext during RxJava operations.
RequestContextCurrentTraceContext - Class in com.linecorp.armeria.common.brave
RequestContextCurrentTraceContextBuilder - Class in com.linecorp.armeria.common.brave
A builder of RequestContextCurrentTraceContext to enable tracing of an Armeria-based application.
RequestContextExporter - Class in com.linecorp.armeria.common.logging
Exports the specified properties from current RequestContext to Map.
RequestContextExporterBuilder - Class in com.linecorp.armeria.common.logging
RequestContextExportingAppender - Class in com.linecorp.armeria.common.logback
A Logback Appender that exports the properties of the current RequestContext to MDC.
RequestContextExportingAppender() - Constructor for class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
RequestContextHooks - Class in com.linecorp.armeria.common.reactor3
Utility class to keep RequestContext during Reactor operations.
RequestContextStorage - Interface in com.linecorp.armeria.common
The storage for storing RequestContext.
requestContextStorageProvider() - Static method in class com.linecorp.armeria.common.Flags
Returns the fully qualified class name of RequestContextStorageProvider that is used to choose when multiple RequestContextStorageProviders exist.
RequestContextStorageProvider - Interface in com.linecorp.armeria.common
Creates a new RequestContextStorage dynamically via Java SPI (Service Provider Interface).
RequestContextStorageWrapper - Class in com.linecorp.armeria.common
Wraps an existing RequestContextStorage.
RequestContextStorageWrapper(RequestContextStorage) - Constructor for class com.linecorp.armeria.common.RequestContextStorageWrapper
Creates a new instance that wraps the specified RequestContextStorage.
RequestContextWrapper<T extends RequestContext> - Class in com.linecorp.armeria.common
Wraps an existing RequestContext.
RequestContextWrapper(T) - Constructor for class com.linecorp.armeria.common.RequestContextWrapper
Creates a new instance.
RequestConverter - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a RequestConverterFunction class which converts an AggregatedHttpRequest to an object.
RequestConverterFunction - Interface in com.linecorp.armeria.server.annotation
Converts an AggregatedHttpRequest to an object.
requestConverters(RequestConverterFunction...) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
requestConverters(RequestConverterFunction...) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
requestConverters(Iterable<? extends RequestConverterFunction>) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
requestConverters(Iterable<? extends RequestConverterFunction>) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
RequestConverters - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for RequestConverter.
requestDurationNanos() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the duration that was taken to consume or produce the request completely, in nanoseconds.
REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in class com.linecorp.armeria.common.HttpStatus
416 Requested Range Not Satisfiable.
requestEndTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the time when the processing of the request finished, in nanoseconds.
requestFirstBytesTransferred() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestFirstBytesTransferred(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestFirstBytesTransferredTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the time when the first bytes of the request headers were transferred over the wire.
requestHeader(CharSequence) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
Adds the specified HTTP request header name to the export list.
requestHeader(CharSequence, String) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
Adds the specified HTTP request header name to the export list.
requestHeaders() - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
Returns all HTTP request header names in the export list.
requestHeaders() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the RequestHeaders.
requestHeaders(RequestHeaders) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
RequestHeaders - Interface in com.linecorp.armeria.common
Immutable HTTP/2 headers for an HttpRequest.
RequestHeadersBuilder - Interface in com.linecorp.armeria.common
Builds a RequestHeaders.
requestHeadersFilter() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Returns the Predicate of a RequestHeaders.
requestHeadersSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the BiFunction to use to sanitize request headers before logging.
requestHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
requestHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
requestHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize request headers before logging.
requestHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
RequestId - Interface in com.linecorp.armeria.common
An identifier of a Request-Response pair.
requestIdGenerator() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the Supplier that generates a RequestId.
requestIdGenerator() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the Supplier that generates a RequestId for each Request.
requestIdGenerator(Supplier<? extends RequestId>) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the Supplier which generates a RequestId.
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the Supplier that generates a RequestId.
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.client.ClientBuilder
 
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
requestIdGenerator(Supplier<RequestId>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
requestIdManager(SamlRequestIdManager) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a SamlRequestIdManager which creates and validates a SAML request ID.
requestLength() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the length of the request content.
requestLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestLog(RequestLog) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets the RequestLog of the Jetty Server.
RequestLog - Interface in com.linecorp.armeria.common.logging
A set of informational properties collected while processing a Request and Response.
RequestLogAccess - Interface in com.linecorp.armeria.common.logging
Provides the access to a RequestLog or RequestOnlyLog, while ensuring the interested RequestLogPropertys are available.
RequestLogAvailabilityException - Exception in com.linecorp.armeria.common.logging
A RuntimeException raised when accessing a RequestLog property that's not available yet.
RequestLogAvailabilityException() - Constructor for exception com.linecorp.armeria.common.logging.RequestLogAvailabilityException
Creates a new instance.
RequestLogAvailabilityException(String) - Constructor for exception com.linecorp.armeria.common.logging.RequestLogAvailabilityException
Creates a new instance with the specified message.
RequestLogAvailabilityException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.logging.RequestLogAvailabilityException
Creates a new instance with the specified message and cause.
RequestLogAvailabilityException(Throwable) - Constructor for exception com.linecorp.armeria.common.logging.RequestLogAvailabilityException
Creates a new instance with the specified cause.
RequestLogBuilder - Interface in com.linecorp.armeria.common.logging
Updates a RequestLog with newly available information.
requestLogLevel() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.LoggingDecorator
The LogLevel to use when logging requests.
requestLogLevel(LogLevel) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
requestLogLevel(LogLevel) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
requestLogLevel(LogLevel) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the LogLevel to use when logging requests.
requestLogLevel(LogLevel) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
requestLogLevelMapper() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the LogLevel to use when logging request logs.
requestLogLevelMapper(Function<? super RequestOnlyLog, LogLevel>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
requestLogLevelMapper(Function<? super RequestOnlyLog, LogLevel>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
requestLogLevelMapper(Function<? super RequestOnlyLog, LogLevel>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Function to use when mapping the log level of request logs.
requestLogLevelMapper(Function<? super RequestOnlyLog, LogLevel>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
RequestLogProperty - Enum in com.linecorp.armeria.common.logging
A property of RequestLog, used for identifying properties that have been populated during request processing.
RequestObject - Annotation Type in com.linecorp.armeria.server.annotation
Specifies which element should be converted by RequestConverterFunction.
RequestOnlyLog - Interface in com.linecorp.armeria.common.logging
A set of informational properties for request-side only, collected while consuming a Request.
requestProperties() - Static method in enum com.linecorp.armeria.common.logging.RequestLogProperty
Returns the RequestLogPropertys for requests.
RequestScopedMdc - Class in com.linecorp.armeria.common.logging
Provides the access to request-scoped MDC properties.
requestStartTime(long, long) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
requestStartTime(long, long) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the request start time of the request.
requestStartTime(long, long) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
requestStartTimeMicros() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the number of microseconds since the epoch when the request started.
requestStartTimeMicros() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the time when the processing of the request started, in microseconds since the epoch.
requestStartTimeMillis() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the time when the processing of the request started, in milliseconds since the epoch.
requestStartTimeNanos() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the System.nanoTime() value when the request started.
requestStartTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the time when the processing of the request started, in nanoseconds.
requestTimeout(Duration) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
 
requestTimeout(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the timeout of a request.
requestTimeout(Duration) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
requestTimeout(Duration) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
 
requestTimeout(Duration) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the timeout of a request.
requestTimeout(Duration) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
RequestTimeoutException - Exception in com.linecorp.armeria.server
A TimeoutException raised when a request has not been received from a client within timeout.
requestTimeoutMillis() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
requestTimeoutMillis() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the timeout of a request.
requestTimeoutMillis() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the amount of time allowed from the start time of the Request until receiving the current Request and sending the corresponding Response completely.
requestTimeoutMillis() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
requestTimeoutMillis() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the timeout of a request.
requestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
 
requestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the timeout of a request in milliseconds.
requestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
requestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
 
requestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets the timeout of a request in milliseconds.
requestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
requestTrailers() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the HTTP trailers of the Request.
requestTrailers(HttpHeaders) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestTrailersSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the BiFunction to use to sanitize request trailers before logging.
requestTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
requestTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
requestTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize request trailers before logging.
requestTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
REQUIRED - com.linecorp.armeria.server.docs.FieldRequirement
The field is required.
requirement() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the requirement level of the field.
requirement(FieldRequirement) - Method in class com.linecorp.armeria.server.docs.FieldInfoBuilder
Sets the FieldRequirement of the field.
requiresMatchingHeadersPredicates() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns true if this context requires matching the predicates for HTTP headers.
requiresMatchingParamsPredicates() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns true if this context requires matching the predicates for query parameters.
requiresResponseTrailers() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns whether this rule requires the response trailers to determine if a Response is successful or not.
requiresResponseTrailers() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns whether this rule requires the response trailers to determine if a Response is successful or not.
requiresResponseTrailers() - Method in interface com.linecorp.armeria.client.retry.RetryRule
Returns whether this rule requires the response trailers to determine if a Response is successful or not.
requiresResponseTrailers() - Method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Returns whether this rule requires the response trailers to determine if a Response is successful or not.
RES_CONTENT - com.linecorp.armeria.common.logging.BuiltInProperty
"res.content" - the content of the response.
RES_CONTENT_LENGTH - com.linecorp.armeria.common.logging.BuiltInProperty
"res.content_length" - the byte-length of the response content.
RES_STATUS_CODE - com.linecorp.armeria.common.logging.BuiltInProperty
"res.status_code" - the protocol-specific integer representation of the response status code.
RESET_CONTENT - Static variable in class com.linecorp.armeria.common.HttpStatus
205 Reset Content.
resetHeader() - Method in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders
Returns the name of the "reset" throttling header for the given scheme, like "X-RateLimit-Reset".
resolvedAddressTypes(ResolvedAddressTypes) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets ResolvedAddressTypes which is the list of the protocol families of the address resolved.
response() - Method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Returns the AggregatedHttpResponse generated from this file.
Response - Interface in com.linecorp.armeria.common
A response stream or a holder of the future result value.
RESPONSE_CAUSE - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_CONTENT - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_CONTENT_PREVIEW - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_END_TIME - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_FIRST_BYTES_TRANSFERRED_TIME - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_HEADERS - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_LENGTH - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_START_TIME - com.linecorp.armeria.common.logging.RequestLogProperty
RESPONSE_TIMEOUT_MILLIS - Static variable in class com.linecorp.armeria.client.ClientOptions
The timeout of a server reply to a client call.
RESPONSE_TRAILERS - com.linecorp.armeria.common.logging.RequestLogProperty
ResponseCancellationException - Exception in com.linecorp.armeria.client
A CancellationException raised when a response is cancelled by the user.
responseCause() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the cause of response processing failure.
responseCauseSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the BiFunction to use to sanitize response cause before logging.
responseCauseSanitizer(BiFunction<? super RequestContext, ? super Throwable, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
responseCauseSanitizer(BiFunction<? super RequestContext, ? super Throwable, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
responseCauseSanitizer(BiFunction<? super RequestContext, ? super Throwable, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize a response cause before logging.
responseCauseSanitizer(BiFunction<? super RequestContext, ? super Throwable, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
responseContent() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the high-level content object of the Response, which is specific to the SerializationFormat.
responseContent(Object, Object) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseContentPreview() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the preview of response content of the Response.
responseContentPreview(String) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseContentPreviewer(RequestContext, ResponseHeaders) - Method in interface com.linecorp.armeria.common.logging.ContentPreviewerFactory
Returns a newly-created response ContentPreviewer with the given RequestContext and ResponseHeaders.
responseContentSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the BiFunction to use to sanitize response content before logging.
responseContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
responseContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
responseContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize response content before logging.
responseContentSanitizer(BiFunction<? super RequestContext, Object, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
ResponseConverter - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a ResponseConverterFunction class which converts the result to HttpResponse.
ResponseConverterFunction - Interface in com.linecorp.armeria.server.annotation
Converts a result object to HttpResponse.
ResponseConverterFunctionProvider - Interface in com.linecorp.armeria.server.annotation
A ResponseConverterFunction provider interface which creates a new ResponseConverterFunction for converting an object of the given type and functions.
responseConverters(ResponseConverterFunction...) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
responseConverters(ResponseConverterFunction...) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
responseConverters(Iterable<? extends ResponseConverterFunction>) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
responseConverters(Iterable<? extends ResponseConverterFunction>) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
ResponseConverters - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for ResponseConverter.
responseDurationNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the duration that was taken to consume or produce the response completely, in nanoseconds.
responseEndTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response finished, in nanoseconds.
responseFilter() - Method in class com.linecorp.armeria.client.AbstractRuleWithContentBuilder
Returns the responseFilter.
responseFirstBytesTransferred() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseFirstBytesTransferred(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets RequestLog.responseFirstBytesTransferredTimeNanos() with the specified timestamp.
responseFirstBytesTransferredTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the first bytes of the response headers were transferred over the wire.
responseHeader(CharSequence) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
Adds the specified HTTP response header name to the export list.
responseHeader(CharSequence, String) - Method in class com.linecorp.armeria.common.logging.RequestContextExporterBuilder
Adds the specified HTTP response header name to the export list.
responseHeaders() - Method in class com.linecorp.armeria.common.logging.RequestContextExporter
Returns all HTTP response header names in the export list.
responseHeaders() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the non-informational status ResponseHeaders.
responseHeaders(ResponseHeaders) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
ResponseHeaders - Interface in com.linecorp.armeria.common
Immutable HTTP/2 headers for an HttpResponse.
ResponseHeadersBuilder - Interface in com.linecorp.armeria.common
Builds a ResponseHeaders.
responseHeadersFilter() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Returns the Predicate of a ResponseHeaders.
responseHeadersSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the BiFunction to use to sanitize response headers before logging.
responseHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
responseHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
responseHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize response headers before logging.
responseHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
responseLength() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the length of the response content.
responseLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseLogLevelMapper() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the LogLevel to use when logging response logs.
responseLogLevelMapper(Function<? super RequestLog, LogLevel>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
responseLogLevelMapper(Function<? super RequestLog, LogLevel>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
responseLogLevelMapper(Function<? super RequestLog, LogLevel>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Function to use when mapping the log level of response logs.
responseLogLevelMapper(Function<? super RequestLog, LogLevel>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
responseProperties() - Static method in enum com.linecorp.armeria.common.logging.RequestLogProperty
Returns the RequestLogPropertys for responses.
responseStartTimeMicros() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response started, in microseconds since the epoch.
responseStartTimeMillis() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response started, in milliseconds since the epoch.
responseStartTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response started, in nanoseconds.
responseTimeout(Duration) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the timeout of a response.
responseTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientBuilder
 
responseTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
responseTimeout(Duration) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
responseTimeout(Duration) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
responseTimeout(Duration) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
responseTimeout(Duration) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
ResponseTimeoutException - Exception in com.linecorp.armeria.client
A TimeoutException raised when a response has not been received from a server within timeout.
responseTimeoutForEachAttempt(Duration) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClientBuilder
Sets the response timeout for each attempt.
responseTimeoutForEachAttempt(Duration) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
 
responseTimeoutForEachAttempt(Duration) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
 
responseTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the timeout of a server reply to a client call.
responseTimeoutMillis() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started or the Request was fully sent.
responseTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
responseTimeoutMillis() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the timeout of a response in milliseconds.
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientBuilder
 
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
responseTimeoutMillis(long) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
responseTimeoutMillisForEachAttempt(long) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClientBuilder
Sets the response timeout for each attempt in milliseconds.
responseTimeoutMillisForEachAttempt(long) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
 
responseTimeoutMillisForEachAttempt(long) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
 
responseTrailers() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the HTTP trailers of the Response.
responseTrailers(HttpHeaders) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseTrailersFilter() - Method in class com.linecorp.armeria.client.AbstractRuleBuilder
Returns the Predicate of a response trailers.
responseTrailersSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the Function to use to sanitize response trailers before logging.
responseTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
responseTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
responseTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the BiFunction to use to sanitize response trailers before logging.
responseTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
result() - Method in class com.linecorp.armeria.common.thrift.ThriftReply
Returns the result of this reply.
RETAINED_DUPLICATE - com.linecorp.armeria.common.ByteBufAccessMode
Gets the retained duplicate (or slice) of the underlying ByteBuf.
RetrofitMeterIdPrefixFunction - Class in com.linecorp.armeria.client.retrofit2
Returns the default function for retrofit that creates a MeterIdPrefix with the specified name and the Tags derived from the RequestLog properties and Invocation.
retry() - Method in interface com.linecorp.armeria.common.sse.ServerSentEvent
Returns a reconnection time in milliseconds, if it exists.
retry(Backoff) - Static method in class com.linecorp.armeria.client.retry.RetryDecision
Returns a RetryDecision that retries with the specified Backoff.
retry(Duration) - Method in class com.linecorp.armeria.common.sse.ServerSentEventBuilder
Sets the specified retry.
RETRY_AFTER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Retry-After" header field name.
retryBackoff(Backoff) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the backoff between health check requests.
retryBackoff(Backoff) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
RetryDecision - Class in com.linecorp.armeria.client.retry
A RetryDecision that determines whether a RetryRule retries with a Backoff, skips the current RetryRule or no retries.
RetryingClient - Class in com.linecorp.armeria.client.retry
An HttpClient decorator that handles failures of an invocation and retries HTTP requests.
RetryingClientBuilder - Class in com.linecorp.armeria.client.retry
Builds a new RetryingClient or its decorator function.
RetryingRpcClient - Class in com.linecorp.armeria.client.retry
An RpcClient decorator that handles failures of an invocation and retries RPC requests.
RetryingRpcClientBuilder - Class in com.linecorp.armeria.client.retry
Builds a new RetryingRpcClient or its decorator function.
retryInterval(Duration) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the interval between health check requests.
retryInterval(Duration) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
retryIntervalMillis(long) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the interval between health check requests in milliseconds.
retryIntervalMillis(long) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
retryRule() - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Returns the RetryRule.
RetryRule - Interface in com.linecorp.armeria.client.retry
Determines whether a failed request should be retried.
RetryRuleBuilder - Class in com.linecorp.armeria.client.retry
A builder for creating a new RetryRule.
retryRuleWithContent() - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
RetryRuleWithContent<T extends Response> - Interface in com.linecorp.armeria.client.retry
Determines whether a failed request should be retried using the content of a Response.
RetryRuleWithContentBuilder<T extends Response> - Class in com.linecorp.armeria.client.retry
A builder for creating a new RetryRuleWithContent.
returnTypeSignature() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the signature of the return type of the function.
REVALIDATED - Static variable in class com.linecorp.armeria.common.ServerCacheControl
"no-cache, must-revalidate".
rollbackFailed(Throwable) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Invoked when failed to stop during the rollback after startup failure.
root() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
root() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the root ServiceRequestContext of this context.
root() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
root() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the root ServiceRequestContext of this context.
root() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
roundRobin() - Static method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Returns a round-robin strategy, which ignores Endpoint.weight().
route() - Method in class com.linecorp.armeria.server.Routed
Returns the Route which matched the RoutingContext.
route() - Method in class com.linecorp.armeria.server.ServerBuilder
Returns a ServiceBindingBuilder which is for binding an HttpService fluently.
route() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the Route of the ServiceConfig.service().
route() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Returns a ServiceBindingBuilder which is for binding an HttpService fluently.
route(Route) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Sets the Route of the request.
route(String) - Method in class com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder
 
route(String) - Method in class com.linecorp.armeria.server.cors.CorsPolicyBuilder
 
route(String) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Adds a path pattern that this policy is supposed to be applied to.
Route - Interface in com.linecorp.armeria.server
Route maps from an incoming HTTP request to an HttpService based on its path, method, content type and accepted types.
RouteBuilder - Class in com.linecorp.armeria.server
Builds a new Route.
routeCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the routeCache parameter.
Routed<T> - Class in com.linecorp.armeria.server
A value mapped by Router.
routeDecorator() - Method in class com.linecorp.armeria.server.ServerBuilder
Returns a DecoratingServiceBindingBuilder which is for binding a decorator fluently.
routeDecorator() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Returns a VirtualHostDecoratingServiceBindingBuilder which is for binding a decorator fluently.
routeDecoratorCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the routeDecoratorCache parameter.
RoutePathType - Enum in com.linecorp.armeria.server
The type of the path which was specified when a Route is created.
Router<V> - Interface in com.linecorp.armeria.server
Finds a mapping that matches a given RoutingContext.
Routers - Class in com.linecorp.armeria.server
A factory that creates a Router instance.
routes() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
Returns the list of Routes that this policy is supposed to be applied to.
routes() - Method in interface com.linecorp.armeria.server.ServiceWithRoutes
Returns the set of Routes to which this HttpService is bound.
routingContext() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
routingContext() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the RoutingContext used to find the Service.
routingContext() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
RoutingContext - Interface in com.linecorp.armeria.server
Holds the parameters which are required to find a service available to handle the request.
routingResult() - Method in class com.linecorp.armeria.server.Routed
Returns the RoutingResult.
routingResult(RoutingResult) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Sets the RoutingResult of the request.
RoutingResult - Class in com.linecorp.armeria.server
The result returned by Route.apply(RoutingContext).
RoutingResultBuilder - Class in com.linecorp.armeria.server
Builds a new RoutingResult.
routingResultType() - Method in class com.linecorp.armeria.server.Routed
Returns the type of RoutingResult.
RoutingResultType - Enum in com.linecorp.armeria.server
The type of RoutingResult.
RpcClient - Interface in com.linecorp.armeria.client
Sends an RpcRequest to a remote Endpoint.
rpcDecorate(RpcClient) - Method in class com.linecorp.armeria.client.ClientDecoration
Decorates the specified RpcClient using the decorator.
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified RPC-level decorator.
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.AbstractWebClientBuilder
Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.ClientBuilder
 
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
rpcDecorator(DecoratingRpcClientFunction) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Adds the specified RPC-level decorator.
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.AbstractWebClientBuilder
Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.ClientBuilder
 
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
rpcDecorator(Function<? super RpcClient, ? extends RpcClient>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
rpcDecorators() - Method in class com.linecorp.armeria.client.ClientDecoration
Returns the RPC-level decorators.
rpcRequest() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context.
rpcRequest() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the RpcRequest of the context.
rpcRequest() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
rpcRequest() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context.
rpcRequest() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
rpcRequest() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context.
RpcRequest - Interface in com.linecorp.armeria.common
An RPC Request.
RpcResponse - Interface in com.linecorp.armeria.common
An RPC Response.
RpcService - Interface in com.linecorp.armeria.server
An RPC Service.
RpcServiceWithRoutes - Interface in com.linecorp.armeria.server
An interface that enables getting all the Routes where an RpcService should be bound.
RTF_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
RTF_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/rtf; charset=utf-8".
run(C, Environment) - Method in class com.linecorp.armeria.dropwizard.ArmeriaBundle
 
runForEachTest() - Method in class com.linecorp.armeria.testing.junit5.common.AbstractAllOrEachExtension
Returns whether this extension should run around each test method instead of the entire test class.

S

SafeCloseable - Interface in com.linecorp.armeria.common.util
An AutoCloseable whose SafeCloseable.close() method does not throw an exception.
sameSite() - Method in interface com.linecorp.armeria.common.Cookie
Returns the "SameSite" attribute of this Cookie.
sameSite(String) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the SameSite attribute of the Cookie.
SamlAssertionConsumerConfig - Class in com.linecorp.armeria.server.saml
A configuration for an assertion consumer service of a service provider.
SamlAssertionConsumerConfigBuilder - Class in com.linecorp.armeria.server.saml
A builder which builds a SamlAssertionConsumerConfig.
SamlBindingProtocol - Enum in com.linecorp.armeria.server.saml
SAML binding protocols.
SamlEndpoint - Class in com.linecorp.armeria.server.saml
A SAML service URL and its binding protocol.
SamlException - Exception in com.linecorp.armeria.server.saml
Indicates that an error occurred while processing a SAML request.
SamlException() - Constructor for exception com.linecorp.armeria.server.saml.SamlException
Creates a new exception.
SamlException(String) - Constructor for exception com.linecorp.armeria.server.saml.SamlException
Creates a new instance with the specified message.
SamlException(String, Throwable) - Constructor for exception com.linecorp.armeria.server.saml.SamlException
Creates a new instance with the specified message and cause.
SamlException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.server.saml.SamlException
Creates a new instance with the specified message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
SamlException(Throwable) - Constructor for exception com.linecorp.armeria.server.saml.SamlException
Creates a new instance with the specified cause.
SamlIdentityProviderConfig - Class in com.linecorp.armeria.server.saml
A configuration for an identity provider.
SamlIdentityProviderConfigBuilder - Class in com.linecorp.armeria.server.saml
A builder which builds a SamlIdentityProviderConfig.
SamlIdentityProviderConfigSelector - Interface in com.linecorp.armeria.server.saml
A SamlIdentityProviderConfig selector for the request.
SamlNameIdFormat - Enum in com.linecorp.armeria.server.saml
SAML name ID formats.
SamlNameIdPolicy - Class in com.linecorp.armeria.server.saml
SAML name ID format and its option.
SamlRequestIdManager - Interface in com.linecorp.armeria.server.saml
An interface which generates and validates a request ID when transferring a SAML message between a service provider and an identity provider.
SamlServiceProvider - Class in com.linecorp.armeria.server.saml
A SAML service provider implementation.
SamlServiceProviderBuilder - Class in com.linecorp.armeria.server.saml
A builder which builds a SamlServiceProvider.
SamlSingleLogoutHandler - Interface in com.linecorp.armeria.server.saml
A callback which is invoked when a SAML single logout request is received.
SamlSingleSignOnHandler - Interface in com.linecorp.armeria.server.saml
Callbacks which are invoked to handle SAML messages exchanging with an identity provider.
SamlUtil - Class in com.linecorp.armeria.server.saml
A utility class which helps a user to easily handle a SAML message.
sampler(Sampler<? super ClientRequestContext>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
sampler(Sampler<? super ClientRequestContext>) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
sampler(Sampler<? super ServiceRequestContext>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
Sets the Sampler that determines which request needs logging.
Sampler<T> - Interface in com.linecorp.armeria.common.util
Sampler is responsible for deciding if a particular trace should be "sampled", i.e. whether the overhead of tracing will occur and/or if a trace will be reported to the collection tier.
samplingRate() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.LoggingDecorator
The rate at which to sample requests to log.
samplingRate(float) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
samplingRate(float) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
samplingRate(float) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
Sets the rate at which to sample requests to log.
scheduleNextRetry(ClientRequestContext, Consumer<? super Throwable>, Runnable, long) - Static method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
Schedules next retry.
scheme() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the Scheme of the client.
scheme() - Method in class com.linecorp.armeria.client.UserClient
 
scheme() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Returns the SCHEME of this request.
scheme() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the scheme of this request.
scheme() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the Scheme of the Request.
scheme(SessionProtocol) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
Sets the ":scheme" header from the specified SessionProtocol.
scheme(SessionProtocol) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a protocol scheme of this service provider.
scheme(String) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
Sets the ":scheme" header.
Scheme - Class in com.linecorp.armeria.common
SCHEME - com.linecorp.armeria.common.logging.BuiltInProperty
"scheme" - the scheme of the request, represented by Scheme.uriText(), such as "tbinary+h2".
SCHEME - com.linecorp.armeria.common.logging.RequestLogProperty
SCHEME - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP ":scheme" pseudo header field name.
schemeAndPort(ServerPort) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a ServerPort of this service provider.
score() - Method in class com.linecorp.armeria.server.RoutingResult
Returns the score of this result.
score(int) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
Sets the score.
searchDomains(Iterable<String>) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the list of search domains of the resolver.
searchDomains(String...) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the search domains of the resolver.
SEC_PROVIDED_TOKEN_BINDING_ID - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Sec-Provided-Token-Binding-ID header field name.
SEC_REFERRED_TOKEN_BINDING_ID - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Sec-Referred-Token-Binding-ID header field name.
SEC_TOKEN_BINDING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Sec-Token-Binding header field name.
second() - Static method in class com.linecorp.armeria.common.util.Functions
Returns a BiFunction that returns the second argument.
secure(boolean) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the security status of the Cookie.
secureHealthCheckUrl(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the secure health check URL.
securePort(int) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the port used for SessionProtocol.HTTPS.
secureVipAddress(String) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the specified secureVipAddress.
secureVipAddress(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the secure VIP address.
SEE_OTHER - Static variable in class com.linecorp.armeria.common.HttpStatus
303 See Other (since HTTP/1.1).
select(ClientRequestContext, ScheduledExecutorService, long) - Method in class com.linecorp.armeria.client.endpoint.AbstractEndpointSelector
 
select(ClientRequestContext, ScheduledExecutorService, long) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
select(ClientRequestContext, ScheduledExecutorService, long) - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Selects an Endpoint asynchronously from the EndpointGroup associated with the specified ClientRequestContext, waiting up to the specified timeoutMillis.
select(ClientRequestContext, ScheduledExecutorService, long) - Method in class com.linecorp.armeria.client.Endpoint
 
select(SessionProtocol, Endpoint) - Method in interface com.linecorp.armeria.client.proxy.ProxyConfigSelector
Selects the ProxyConfig to use when connecting to a network resource specified by the SessionProtocol and Endpoint parameter.
select(SamlServiceProvider, ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.saml.SamlIdentityProviderConfigSelector
Returns a SamlIdentityProviderConfig which is used for authenticating the request.
selectionStrategy() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
selectionStrategy() - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
selectionStrategy() - Method in class com.linecorp.armeria.client.Endpoint
 
selectionStrategy(EndpointSelectionStrategy) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
selectionStrategy(EndpointSelectionStrategy) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
selectionStrategy(EndpointSelectionStrategy) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
selectionStrategy(EndpointSelectionStrategy) - Method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroupBuilder
selectionStrategy(EndpointSelectionStrategy) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
selectionStrategy(EndpointSelectionStrategy) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
selectNow(ClientRequestContext) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
selectNow(ClientRequestContext) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Selects an Endpoint from this EndpointGroup.
selectNow(ClientRequestContext) - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext.
selectNow(ClientRequestContext) - Method in class com.linecorp.armeria.client.Endpoint
 
SelfSignedCertificateExtension - Class in com.linecorp.armeria.testing.junit5.server
An Extension that provides a temporary self-signed certificate.
SelfSignedCertificateExtension() - Constructor for class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Creates a new instance.
SelfSignedCertificateExtension(String) - Constructor for class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Creates a new instance.
SelfSignedCertificateExtension(String, SecureRandom, int) - Constructor for class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Creates a new instance.
SelfSignedCertificateExtension(String, SecureRandom, int, TemporalAccessor, TemporalAccessor) - Constructor for class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Creates a new instance.
SelfSignedCertificateExtension(String, TemporalAccessor, TemporalAccessor) - Constructor for class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Creates a new instance.
SelfSignedCertificateExtension(TemporalAccessor, TemporalAccessor) - Constructor for class com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension
Creates a new instance.
SelfSignedCertificateRule - Class in com.linecorp.armeria.testing.junit4.server
A TestRule that provides a temporary self-signed certificate.
SelfSignedCertificateRule() - Constructor for class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Creates a new instance.
SelfSignedCertificateRule(String) - Constructor for class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Creates a new instance.
SelfSignedCertificateRule(String, SecureRandom, int) - Constructor for class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Creates a new instance.
SelfSignedCertificateRule(String, SecureRandom, int, TemporalAccessor, TemporalAccessor) - Constructor for class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Creates a new instance.
SelfSignedCertificateRule(String, TemporalAccessor, TemporalAccessor) - Constructor for class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Creates a new instance.
SelfSignedCertificateRule(TemporalAccessor, TemporalAccessor) - Constructor for class com.linecorp.armeria.testing.junit4.server.SelfSignedCertificateRule
Creates a new instance.
sequential(boolean) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
Sets whether to create the ZooKeeper node using CreateMode.EPHEMERAL_SEQUENTIAL or not.
serializationFormat() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the SerializationFormat of the Request.
serializationFormat() - Method in class com.linecorp.armeria.common.Scheme
Returns the SerializationFormat.
serializationFormat(SerializationFormat) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
SerializationFormat - Class in com.linecorp.armeria.common
Serialization format of a remote procedure call and its reply.
SerializationFormatProvider - Class in com.linecorp.armeria.common
Registers the SerializationFormats dynamically via Java SPI (Service Provider Interface).
SerializationFormatProvider() - Constructor for class com.linecorp.armeria.common.SerializationFormatProvider
 
SerializationFormatProvider.Entry - Class in com.linecorp.armeria.common
A registration entry of a SerializationFormat.
serializeExampleRequest(String, String, Object) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Serializes the specified example request into a string.
serializeMessage(MethodDescriptor.Marshaller<T>, T, OutputStream) - Method in interface com.linecorp.armeria.common.grpc.GrpcJsonMarshaller
Serializes a gRPC message into JSON.
serve(HttpService, ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.DecoratingHttpServiceFunction
Serves an incoming HttpRequest.
serve(RpcService, ServiceRequestContext, RpcRequest) - Method in interface com.linecorp.armeria.server.DecoratingRpcServiceFunction
Serves an incoming RpcRequest.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.auth.AuthService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.brave.BraveService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.cors.CorsService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.docs.DocService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.encoding.DecodingService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.encoding.EncodingService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckService
 
serve(ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.HttpService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.jetty.JettyService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.kotlin.CoroutineContextService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.logging.ContentPreviewingService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.logging.LoggingService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.metric.MetricCollectingService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.RedirectService
NB: For now we redirect all methods.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.thrift.THttpService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.tomcat.TomcatService
 
serve(ServiceRequestContext, RpcRequest) - Method in interface com.linecorp.armeria.server.RpcService
 
serve(ServiceRequestContext, RpcRequest) - Method in class com.linecorp.armeria.server.thrift.ThriftCallService
 
serve(ServiceRequestContext, I) - Method in interface com.linecorp.armeria.server.Service
Serves an incoming Request.
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.throttling.AbstractThrottlingService
 
serveCompressedFiles() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
Returns whether pre-compressed files should be served.
serveCompressedFiles(boolean) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
Sets whether pre-compressed files should be served.
server() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the Server.
server() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the Server the ServiceConfig.service() belongs to.
server() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the Server where this VirtualHost belongs to.
server() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the started Server.
server() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the started Server.
Server - Class in com.linecorp.armeria.server
Listens to ServerPorts and delegates client requests to Services.
SERVER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Server" header field name.
SERVER_ERROR - com.linecorp.armeria.common.HttpStatusClass
The server error class (5xx).
SERVER_TIMING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Server-Timing" header field name.
serverAddresses(Iterable<InetSocketAddress>) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
serverAddresses(Iterable<InetSocketAddress>) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
serverAddresses(Iterable<InetSocketAddress>) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
serverAddresses(InetSocketAddress...) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
serverAddresses(InetSocketAddress...) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
serverAddresses(InetSocketAddress...) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
ServerBuilder - Class in com.linecorp.armeria.server
Builds a new Server and its ServerConfig.
ServerCacheControl - Class in com.linecorp.armeria.common
Directives for HTTP caching mechanisms in responses.
ServerCacheControlBuilder - Class in com.linecorp.armeria.common
Creates a new ServerCacheControl using the builder pattern.
serverChannelType(EventLoopGroup) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns the ServerChannel class that is available for this eventLoopGroup, for use in configuring a custom Bootstrap.
ServerConfig - Class in com.linecorp.armeria.server
Server configuration.
serverConfigurator(Consumer<? super ServerBuilder>) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Adds the Consumer that configures the given ServerBuilder.
ServerExtension - Class in com.linecorp.armeria.testing.junit5.server
An Extension that allows easy set-up and tear-down of a Server.
ServerExtension() - Constructor for class com.linecorp.armeria.testing.junit5.server.ServerExtension
Creates a new instance with auto-start enabled.
ServerExtension(boolean) - Constructor for class com.linecorp.armeria.testing.junit5.server.ServerExtension
Creates a new instance.
serverListener(ServerListener) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the specified ServerListener.
ServerListener - Interface in com.linecorp.armeria.server
Listens to life cycle events of a Server.
ServerListenerAdapter - Class in com.linecorp.armeria.server
A skeletal ServerListener implementation in order for a user to implement only the methods what he or she really needs.
ServerListenerAdapter() - Constructor for class com.linecorp.armeria.server.ServerListenerAdapter
 
ServerListenerBuilder - Class in com.linecorp.armeria.server
Builds a new ServerListener.
ServerPort - Class in com.linecorp.armeria.server
A pair of server-side bind address and SessionProtocol.
ServerPort(int, SessionProtocol...) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
ServerPort(int, Iterable<SessionProtocol>) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
ServerPort(InetSocketAddress, SessionProtocol...) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
ServerPort(InetSocketAddress, Iterable<SessionProtocol>) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
ServerRule - Class in com.linecorp.armeria.testing.junit4.server
A TestRule that allows easy set-up and tear-down of a Server.
ServerRule() - Constructor for class com.linecorp.armeria.testing.junit4.server.ServerRule
Creates a new instance with auto-start enabled.
ServerRule(boolean) - Constructor for class com.linecorp.armeria.testing.junit4.server.ServerRule
Creates a new instance.
ServerSentEvent - Interface in com.linecorp.armeria.common.sse
An interface for the Server-Sent Events specification.
ServerSentEventBuilder - Class in com.linecorp.armeria.common.sse
A builder which creates a ServerSentEvent instance.
ServerSentEventResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A response converter implementation which creates an HttpResponse with content-type: text/event-stream.
ServerSentEventResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.ServerSentEventResponseConverterFunction
 
ServerSentEvents - Class in com.linecorp.armeria.server.streaming
A utility class which helps to create a Server-Sent Events stream from a content Publisher or Stream.
serverSets() - Static method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
Returns a ZooKeeperDiscoverySpec that is compatible with Finagle ServerSets.
serverSets() - Static method in interface com.linecorp.armeria.server.zookeeper.ZooKeeperRegistrationSpec
Returns the ZooKeeperRegistrationSpec that registers the Server using the format of Finagle ServerSets.
serverSets(Function<? super ServerSetsInstance, Endpoint>) - Static method in interface com.linecorp.armeria.client.zookeeper.ZooKeeperDiscoverySpec
Returns a ZooKeeperDiscoverySpec that is compatible with Finagle ServerSets.
ServerSetsInstance - Class in com.linecorp.armeria.common.zookeeper
A class that represents a service instance used by Finagle ServerSets.
ServerSetsInstance(Endpoint, Map<String, Endpoint>, Integer, Map<String, String>) - Constructor for class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
Creates a new instance.
ServerSetsRegistrationSpecBuilder - Class in com.linecorp.armeria.server.zookeeper
serverStarted(Server) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
 
serverStarted(Server) - Method in interface com.linecorp.armeria.server.ServerListener
Invoked when a Server finished its startup procedure successfully and it started to serve incoming requests.
serverStarted(Server) - Method in class com.linecorp.armeria.server.ServerListenerAdapter
 
serverStarted(Server) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
 
serverStarting(Server) - Method in interface com.linecorp.armeria.server.ServerListener
Invoked when a Server begins its startup procedure.
serverStarting(Server) - Method in class com.linecorp.armeria.server.ServerListenerAdapter
 
serverStopped(Server) - Method in interface com.linecorp.armeria.server.ServerListener
Invoked when a Server finished its shutdown procedure and it stopped to serve incoming requests.
serverStopped(Server) - Method in class com.linecorp.armeria.server.ServerListenerAdapter
 
serverStopping(Server) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListener
 
serverStopping(Server) - Method in interface com.linecorp.armeria.server.ServerListener
Invoked when a Server begins its shutdown procedure.
serverStopping(Server) - Method in class com.linecorp.armeria.server.ServerListenerAdapter
 
serverStopping(Server) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener
 
service() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the HttpService.
service(HttpService) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
Sets the Service that handles the request.
service(HttpServiceWithRoutes, Iterable<? extends Function<? super HttpService, ? extends HttpService>>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates and binds the specified HttpServiceWithRoutes at multiple Routes of the default VirtualHost.
service(HttpServiceWithRoutes, Iterable<? extends Function<? super HttpService, ? extends HttpService>>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates and binds the specified HttpServiceWithRoutes at multiple Routes of the default VirtualHost.
service(HttpServiceWithRoutes, Function<? super HttpService, ? extends HttpService>...) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates and binds the specified HttpServiceWithRoutes at multiple Routes of the default VirtualHost.
service(HttpServiceWithRoutes, Function<? super HttpService, ? extends HttpService>...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Decorates and binds the specified HttpServiceWithRoutes at multiple Routes of the default VirtualHost.
service(Route, HttpService) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified HttpService at the specified Route of the default VirtualHost.
service(Route, HttpService) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Binds the specified HttpService at the specified Route.
service(String, HttpService) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified HttpService at the specified path pattern of the default VirtualHost.
service(String, HttpService) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Binds the specified HttpService at the specified path pattern. e.g.
Service<I extends Request,​O extends Response> - Interface in com.linecorp.armeria.server
Handles a Request received by a Server.
SERVICE_UNAVAILABLE - Static variable in class com.linecorp.armeria.common.HttpStatus
503 Service Unavailable.
SERVICE_WORKER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Service-Worker header field name.
SERVICE_WORKER_ALLOWED - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Service-Worker-Allowed header field name.
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.DecoratingService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.docs.DocService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.file.FileService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.jetty.JettyService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.RedirectService
 
serviceAdded(ServiceConfig) - Method in interface com.linecorp.armeria.server.Service
Invoked when this service has been added to a Server with the specified configuration.
serviceAddress(String) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the service address.
ServiceBindingBuilder - Class in com.linecorp.armeria.server
A builder class for binding an HttpService fluently.
ServiceCallbackInvoker - Class in com.linecorp.armeria.server
A helper class that invokes the callback methods in Service.
ServiceConfig - Class in com.linecorp.armeria.server
An HttpService configuration.
serviceConfigs() - Method in class com.linecorp.armeria.server.Server
Returns the information of all available Services in the Server.
serviceConfigs() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the information of all available HttpServices in the Server.
serviceConfigs() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the information about the HttpServices bound to this virtual host.
serviceEndpoint() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
Returns the service Endpoint.
serviceEndpoint(Endpoint) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
Sets the specified Endpoint.
serviceId(String) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the service ID.
ServiceInfo - Class in com.linecorp.armeria.server.docs
Metadata about a Service.
ServiceInfo(String, Iterable<MethodInfo>) - Constructor for class com.linecorp.armeria.server.docs.ServiceInfo
Creates a new instance.
ServiceInfo(String, Iterable<MethodInfo>, Iterable<HttpHeaders>, String) - Constructor for class com.linecorp.armeria.server.docs.ServiceInfo
Creates a new instance.
ServiceInfo(String, Iterable<MethodInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.ServiceInfo
Creates a new instance.
serviceName() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the human-readable name of the service that served the Request, such as: gRPC - a service name (e.g, com.foo.GrpcService) Thrift - a service type (e.g, com.foo.ThriftService$AsyncIface or com.foo.ThriftService$Iface) HttpService and annotated service - an innermost class name This property is often used as a meter tag or distributed trace's span name.
serviceName(String) - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
Sets the name of the StandardService of an embedded Tomcat.
ServiceName - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for service name that is often used as a meter tag or distributed trace's span name.
ServiceRequestContext - Interface in com.linecorp.armeria.server
Provides information about an invocation and related utilities.
ServiceRequestContextBuilder - Class in com.linecorp.armeria.server
Builds a new ServiceRequestContext.
ServiceRequestContextWrapper - Class in com.linecorp.armeria.server
Wraps an existing ServiceRequestContext.
ServiceRequestContextWrapper(ServiceRequestContext) - Constructor for class com.linecorp.armeria.server.ServiceRequestContextWrapper
Creates a new instance.
services() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the services in this specification.
services() - Method in interface com.linecorp.armeria.server.grpc.GrpcService
Returns the ServerServiceDefinitions serviced by this service.
ServiceSpecification - Class in com.linecorp.armeria.server.docs
The specification of one or more Services that provides their ServiceInfos and NamedTypeInfos.
ServiceSpecification(Iterable<ServiceInfo>, Iterable<EnumInfo>, Iterable<StructInfo>, Iterable<ExceptionInfo>) - Constructor for class com.linecorp.armeria.server.docs.ServiceSpecification
Creates a new instance.
ServiceSpecification(Iterable<ServiceInfo>, Iterable<EnumInfo>, Iterable<StructInfo>, Iterable<ExceptionInfo>, Iterable<HttpHeaders>) - Constructor for class com.linecorp.armeria.server.docs.ServiceSpecification
Creates a new instance.
serviceType() - Method in interface com.linecorp.armeria.common.RpcRequest
Returns the type of the service this RpcRequest is called upon.
serviceType(ServiceType) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the ServiceType.
serviceUnder(String, HttpService) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified HttpService under the specified directory of the default VirtualHost.
serviceUnder(String, HttpService) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Binds the specified HttpService under the specified directory.
ServiceWithRoutes<I extends Request,​O extends Response> - Interface in com.linecorp.armeria.server
An interface that enables getting all the Routes where a Service should be bound.
session(Channel, SessionProtocol, ClientConnectionTimings) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets the properties related with socket connection.
session(Channel, SessionProtocol, SSLSession, ClientConnectionTimings) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets the properties related with socket connection.
SESSION - com.linecorp.armeria.common.logging.RequestLogProperty
sessionIdManager(SessionIdManager) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets the SessionIdManager of the Jetty Server.
sessionIdManagerFactory(Function<? super Server, ? extends SessionIdManager>) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets the factory that creates a new instance of SessionIdManager for the Jetty Server.
sessionProtocol() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the SessionProtocol of the request.
sessionProtocol() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the SessionProtocol of the Request.
sessionProtocol() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
sessionProtocol() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the SessionProtocol of the current Request.
sessionProtocol() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
sessionProtocol() - Method in class com.linecorp.armeria.common.Scheme
Returns the SessionProtocol.
sessionProtocol(SessionProtocol) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
sessionProtocol(SessionProtocol) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the SessionProtocol of the request.
sessionProtocol(SessionProtocol) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
SessionProtocol - Enum in com.linecorp.armeria.common
Session-level protocol that provides facilities such as framing and flow control.
SessionProtocolNegotiationCache - Class in com.linecorp.armeria.client
Keeps the recent SessionProtocol negotiation failures.
SessionProtocolNegotiationException - Exception in com.linecorp.armeria.client
An exception triggered when failed to negotiate the desired SessionProtocol with a server.
SessionProtocolNegotiationException(SessionProtocol, SessionProtocol, String) - Constructor for exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Creates a new instance with the specified expected and actual SessionProtocols.
SessionProtocolNegotiationException(SessionProtocol, String) - Constructor for exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Creates a new instance with the specified expected SessionProtocol.
sessionTimeout(Duration) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
 
sessionTimeout(Duration) - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
Sets the session timeout.
sessionTimeout(Duration) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListenerBuilder
 
sessionTimeoutMillis(long) - Method in class com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroupBuilder
 
sessionTimeoutMillis(long) - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
Sets the session timeout in milliseconds.
sessionTimeoutMillis(long) - Method in class com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListenerBuilder
 
set(RequestContext, HttpHeaders) - Static method in class com.linecorp.armeria.common.grpc.GrpcWebTrailers
Sets the specified gRPC-Web trailers to the RequestContext.
set(RequestContext, CoroutineContext) - Static method in class com.linecorp.armeria.common.kotlin.CoroutineContexts
Associates the given coroutine context with COROUTINE_CONTEXT_KEY attribute in the context.
set(CharSequence, Iterable<String>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a new header with the specified name and values.
set(CharSequence, Iterable<String>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
set(CharSequence, Iterable<String>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
set(CharSequence, String) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name and value.
set(CharSequence, String) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
set(CharSequence, String) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
set(CharSequence, String...) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name and values.
set(CharSequence, String...) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
set(CharSequence, String...) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
set(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Retains all current headers but calls HttpHeadersBuilder.set(CharSequence, String) for each header in the specified entries.
set(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
set(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
set(Iterable<? extends Map.Entry<? extends String, String>>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Retains all current parameters but calls QueryParamsBuilder.set(String, String) for each entry in the specified entries.
set(String, Iterable<String>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a new parameter with the specified name and values.
set(String, String) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name and value.
set(String, String...) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name and values.
SET_COOKIE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Set-Cookie" header field name.
SET_COOKIE2 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Set-Cookie2" header field name.
SET_FROM_NOW - com.linecorp.armeria.common.util.TimeoutMode
Schedules a timeout from the current time.
SET_FROM_START - com.linecorp.armeria.common.util.TimeoutMode
Schedules a timeout from the start time of the Request.
setAdditionalRequestHeader(CharSequence, Object) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Sets a header with the specified name and value.
setAdditionalRequestHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setAdditionalRequestHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setAdditionalResponseHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setAdditionalResponseHeader(CharSequence, Object) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets a header with the specified name and value.
setAdditionalResponseHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setAdditionalResponseTrailer(CharSequence, Object) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setAdditionalResponseTrailer(CharSequence, Object) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets a trailer with the specified name and value.
setAdditionalResponseTrailer(CharSequence, Object) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setAttr(AttributeKey<V>, V) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
setAttr(AttributeKey<V>, V) - Method in interface com.linecorp.armeria.common.RequestContext
Associates the specified value with the given AttributeKey in this context.
setAttr(AttributeKey<V>, V) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
setCause(ThrowableProto) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
setCause(ThrowableProto.Builder) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The cause of this Throwable.
setCiphers(List<String>) - Method in class com.linecorp.armeria.spring.Ssl
Sets the supported SSL ciphers.
setClassName(String) - 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.
setClassNameBytes(ByteString) - 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.
setClientAuth(ClientAuth) - Method in class com.linecorp.armeria.spring.Ssl
Sets whether the client authentication is not none (ClientAuth.NONE), optional (ClientAuth.OPTIONAL) or required (ClientAuth.REQUIRE).
setCompression(ArmeriaSettings.Compression) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the HTTP content encoding configuration that the Server uses.
setCompressor(Compressor) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
Sets the Compressor.
setCurrentThreadNotRequestThread(boolean) - Static method in class com.linecorp.armeria.common.brave.RequestContextCurrentTraceContext
Sets whether the current thread is not a request thread, meaning it is never executed in the scope of a server or client request and will never have a RequestContext available.
setDistributionStatisticConfig(DistributionStatisticConfig) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Sets the DistributionStatisticConfig to use when the factory methods in MoreMeters create a Timer or a DistributionSummary.
setDocsPath(String) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the path of the DocService.
setDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name to value.
setDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setDouble(CharSequence, double) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setDouble(String, double) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name to value.
setEnabled(boolean) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Sets whether the HTTP content encoding is enabled.
setEnabled(boolean) - Method in class com.linecorp.armeria.spring.Ssl
Enables (or disables) SSL support.
setEnabledProtocols(List<String>) - Method in class com.linecorp.armeria.spring.Ssl
Sets the enabled SSL protocols.
setEnableMetrics(boolean) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets whether to enable metrics exposition service at the path specified via ArmeriaSettings.setMetricsPath(String).
setEndpoints(Iterable<Endpoint>) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Sets the specified Endpoints as current Endpoint list.
setExcludedUserAgents(String[]) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Sets the "user-agent" header values which are not applicable for the HTTP content encoding.
setExport(String) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
Adds the property represented by the specified MDC key to the export list.
setExports(String) - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
Adds the properties represented by the specified comma-separated MDC keys to the export list.
setField(Descriptors.FieldDescriptor, Object) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
setField(Descriptors.FieldDescriptor, Object) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
setFileName(String) - 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.
setFileNameBytes(ByteString) - 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.
setFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name to value.
setFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setFloat(CharSequence, float) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setFloat(String, float) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name to value.
setGracefulShutdownQuietPeriodMillis(long) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the number of milliseconds to wait for active requests to go end before shutting down.
setGracefulShutdownTimeoutMillis(long) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the number of milliseconds to wait before shutting down the server regardless of active requests.
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the specified HTTP header.
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.ClientBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Sets the specified HTTP header.
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
 
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
Sets the specified HTTP header.
setHeader(CharSequence, Object) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the specified HTTP headers.
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.ClientBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
Sets the specified HTTP headers.
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.AggregatedHttpFileBuilder
 
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
Sets the specified HTTP headers.
setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in class com.linecorp.armeria.server.file.HttpFileBuilder
 
setHealthCheckPath(String) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the path of the HealthCheckService.
setHealthy(boolean) - Method in class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
Sets if the Server is healthy or not.
setIfAbsent(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Copies the entries missing in this headers from the specified entries.
setIfAbsent(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setIfAbsent(Iterable<? extends Map.Entry<? extends CharSequence, String>>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setIfAbsent(Iterable<? extends Map.Entry<? extends String, String>>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Copies the entries missing in this parameters from the specified entries.
setIface(String) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Registers a network interface that the Server uses.
setInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name to value.
setInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setInt(CharSequence, int) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setInt(String, int) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name to value.
setIp(String) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Registers an IP address that the Server uses.
setKeyAlias(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the alias that identifies the key in the key store.
setKeyPassword(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the password used to access the key in the key store.
setKeyStore(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the path to the key store that holds the SSL certificate (typically a jks file).
setKeyStorePassword(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the password used to access the key store.
setKeyStoreProvider(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the provider for the key store.
setKeyStoreType(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the type of the key store.
setLineNumber(int) - 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.
setLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name to value.
setLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setLong(CharSequence, long) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setLong(String, long) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name to value.
setMaxInboundMessageSizeBytes(int) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets the maximum size in bytes of an individual incoming message.
setMaxOutboundMessageSizeBytes(int) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets the maximum size in bytes of an individual outgoing message.
setMaxRequestLength(long) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setMaxRequestLength(long) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets the maximum length of the current Request.
setMaxRequestLength(long) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setMaxResponseLength(long) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Sets the maximum length of the received Response.
setMaxResponseLength(long) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setMaxResponseLength(long) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setMessageCompression(boolean) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
Enables or disables message compression.
setMeterRegistry(MeterRegistry) - Method in interface com.linecorp.armeria.client.ClientFactory
Sets the MeterRegistry that collects various stats.
setMeterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
setMethodName(String) - 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
setMethodNameBytes(ByteString) - 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
setMetricsPath(String) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the path of the metrics exposition service.
setMimeTypes(String[]) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Sets the MIME Types of an HTTP response which are applicable for the HTTP content encoding.
setMinResponseSize(String) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Compression
Sets the minimum bytes for encoding the content of an HTTP response.
setObject(CharSequence, Iterable<?>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name and values.
setObject(CharSequence, Iterable<?>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setObject(CharSequence, Iterable<?>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a new header.
setObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setObject(CharSequence, Object) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setObject(CharSequence, Object...) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name and values.
setObject(CharSequence, Object...) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setObject(CharSequence, Object...) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setObject(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Retains all current headers but calls HttpHeadersBuilder.setObject(CharSequence, Object) for each entry in the specified entries.
setObject(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setObject(Iterable<? extends Map.Entry<? extends CharSequence, ?>>) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setObject(Iterable<? extends Map.Entry<? extends String, ?>>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Retains all current parameters but calls QueryParamsBuilder.setObject(String, Object) for each entry in the specified entries.
setObject(String, Iterable<?>) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name and values.
setObject(String, Object) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a new parameter.
setObject(String, Object...) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name and values.
setOriginalClassName(String) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The name of the class of the exception that was actually thrown.
setOriginalClassNameBytes(ByteString) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The name of the class of the exception that was actually thrown.
setOriginalMessage(String) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The message of this throwable.
setOriginalMessageBytes(ByteString) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The message of this throwable.
setPort(int) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Registers a port that the Server uses.
setPorts(List<ArmeriaSettings.Port>) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the ArmeriaSettings.Ports of the Server.
setProtocol(SessionProtocol) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Registers a SessionProtocol that the Server uses.
setProtocols(List<SessionProtocol>) - Method in class com.linecorp.armeria.spring.ArmeriaSettings.Port
Registers a list of SessionProtocols that the Server uses.
setProvider(SslProvider) - Method in class com.linecorp.armeria.spring.Ssl
Sets Netty SSL Provider namely JDK or OPENSSL SslProvider.
setRepeatedField(Descriptors.FieldDescriptor, int, Object) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
setRepeatedField(Descriptors.FieldDescriptor, int, Object) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
setRequestTimeout(TimeoutMode, Duration) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setRequestTimeout(TimeoutMode, Duration) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeout.
setRequestTimeout(TimeoutMode, Duration) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setRequestTimeout(Duration) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified amount time from now.
setRequestTimeoutMillis(long) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified amount time from now.
setRequestTimeoutMillis(TimeoutMode, long) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setRequestTimeoutMillis(TimeoutMode, long) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Schedules the request timeout that is triggered when the Request is not fully received or the corresponding Response is not sent completely within the specified TimeoutMode and the specified requestTimeoutMillis.
setRequestTimeoutMillis(TimeoutMode, long) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setResponseTimeout(ClientRequestContext) - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClient
setResponseTimeout(TimeoutMode, Duration) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent.
setResponseTimeout(TimeoutMode, Duration) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setResponseTimeout(TimeoutMode, Duration) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setResponseTimeout(Duration) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now.
setResponseTimeoutMillis(long) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now.
setResponseTimeoutMillis(TimeoutMode, long) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent.
setResponseTimeoutMillis(TimeoutMode, long) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setResponseTimeoutMillis(TimeoutMode, long) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setSsl(Ssl) - Method in class com.linecorp.armeria.spring.ArmeriaSettings
Sets the Ssl configuration that the Server uses.
setStackTrace(int, StackTraceElementProto) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
setStackTrace(int, StackTraceElementProto.Builder) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
The stack trace of this Throwable.
SettableHealthChecker - Class in com.linecorp.armeria.server.healthcheck
A simple ListenableHealthChecker whose state can be set by a caller.
SettableHealthChecker() - Constructor for class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
Constructs a new SettableHealthChecker which starts out in a healthy state and can be changed using SettableHealthChecker.setHealthy(boolean).
SettableHealthChecker(boolean) - Constructor for class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
Constructs a new SettableHealthChecker which starts out in the specified health state and can be changed using SettableHealthChecker.setHealthy(boolean).
setTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Sets a header with the specified name to value.
setTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
setTimeMillis(CharSequence, long) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
setTimeMillis(String, long) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Sets a parameter with the specified name to value.
setTrustStore(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the trust store that holds SSL certificates.
setTrustStorePassword(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the password used to access the trust store.
setTrustStoreProvider(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the provider for the trust store.
setTrustStoreType(String) - Method in class com.linecorp.armeria.spring.Ssl
Sets the type of the trust store.
setUnknownFields(UnknownFieldSet) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto.Builder
 
setUnknownFields(UnknownFieldSet) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto.Builder
 
setUnsupported(SocketAddress, SessionProtocol) - Static method in class com.linecorp.armeria.client.SessionProtocolNegotiationCache
Updates the cache with the information that the specified remoteAddress does not support the specified SessionProtocol.
setupModule(Module.SetupContext) - Method in class com.linecorp.armeria.common.thrift.ThriftJacksonModule
 
setWriteTimeout(Duration) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the amount of time allowed until the initial write attempt of the current Request succeeds.
setWriteTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setWriteTimeout(Duration) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setWriteTimeoutMillis(long) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the amount of time allowed until the initial write attempt of the current Request succeeds.
setWriteTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setWriteTimeoutMillis(long) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
SFNT - Static variable in class com.linecorp.armeria.common.MediaType
SFNT fonts (which includes TrueType and OpenType fonts).
SFNT - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/font-sfnt".
shardId() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
Returns the shard ID.
shardId(int) - Method in class com.linecorp.armeria.server.zookeeper.ServerSetsRegistrationSpecBuilder
Sets the shard ID.
SHOCKWAVE_FLASH - Static variable in class com.linecorp.armeria.common.MediaType
 
SHOCKWAVE_FLASH - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/x-shockwave-flash".
shortCircuit() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorators
Specifies that a CORS request should be rejected if it's invalid before being processed further.
shortCircuit() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Specifies that a CORS request should be rejected if it's invalid before being further processing.
shortCommitHash() - Method in class com.linecorp.armeria.common.util.Version
Returns the short hash of the release commit.
shortText() - Method in interface com.linecorp.armeria.common.RequestId
Returns the human-friendly short textual representation of this ID.
shouldCachePath(String, String, Route) - Method in class com.linecorp.armeria.server.DecoratingService
 
shouldCachePath(String, String, Route) - Method in class com.linecorp.armeria.server.file.FileService
 
shouldCachePath(String, String, Route) - Method in interface com.linecorp.armeria.server.grpc.GrpcService
 
shouldCachePath(String, String, Route) - Method in interface com.linecorp.armeria.server.Service
Returns whether the given path and query should be cached if the service's result is successful.
shouldReportAsSuccess(ClientRequestContext, Throwable) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRule
Returns a CompletionStage that contains a CircuitBreakerDecision which indicates a Response is successful or not.
shouldReportAsSuccess(ClientRequestContext, T, Throwable) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContent
Returns a CompletionStage that contains a CircuitBreakerDecision.
shouldRetry(ClientRequestContext, Throwable) - Method in interface com.linecorp.armeria.client.retry.RetryRule
Tells whether the request sent with the specified ClientRequestContext requires a retry or not.
shouldRetry(ClientRequestContext, T, Throwable) - Method in interface com.linecorp.armeria.client.retry.RetryRuleWithContent
Tells whether the request sent with the specified ClientRequestContext requires a retry or not.
shutdown() - Method in interface com.linecorp.armeria.server.logging.AccessLogWriter
Shuts down this AccessLogWriter.
shutdown() - Method in class com.linecorp.armeria.server.logging.kafka.KafkaAccessLogWriter
 
SHUTDOWN_WORKER_GROUP_ON_CLOSE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
Whether to shut down the worker EventLoopGroup when the ClientFactory is closed.
shutdownAccessLogWriterOnStop() - Method in class com.linecorp.armeria.server.ServiceConfig
Tells whether the AccessLogWriter is shut down when the Server stops.
shutdownAccessLogWriterOnStop() - Method in class com.linecorp.armeria.server.VirtualHost
Tells whether the AccessLogWriter is shut down when the Server stops.
shutdownBlockingTaskExecutorOnStop() - Method in class com.linecorp.armeria.server.ServerConfig
Returns whether the worker Executor is shut down when the Server stops.
shutdownWorkerGroupOnClose() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the flag whether to shut down the worker EventLoopGroup when the ClientFactory is closed.
shutdownWorkerGroupOnStop() - Method in class com.linecorp.armeria.server.ServerConfig
Returns whether the worker EventLoopGroup is shut down when the Server stops.
SignalLengthGetter<T> - Interface in com.linecorp.armeria.common.stream
A function that accepts one signal and produces the length of the signal.
signature() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of "oauth_signature" property.
signature() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the String representation of this type signature, as described in the class documentation.
signature(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of oauth_signature property.
signatureAlgorithm(String) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a signature algorithm which is used for signing by this service provider.
signatureMethod() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of "oauth_signature_method" property.
signatureMethod(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of oauth_signature_method property.
signingCredential() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns a Credential of the identity provider for signing.
signingKey(String) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets a signing key name for an identity provider.
signingKey(String) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a signing key name for this service provider.
SimpleDecoratingClient<I extends Request,​O extends Response> - Class in com.linecorp.armeria.client
Decorates a Client.
SimpleDecoratingClient(Client<I, O>) - Constructor for class com.linecorp.armeria.client.SimpleDecoratingClient
Creates a new instance that decorates the specified Client.
SimpleDecoratingHttpClient - Class in com.linecorp.armeria.client
Decorates an HttpClient.
SimpleDecoratingHttpClient(HttpClient) - Constructor for class com.linecorp.armeria.client.SimpleDecoratingHttpClient
Creates a new instance that decorates the specified HttpClient.
SimpleDecoratingHttpService - Class in com.linecorp.armeria.server
An HttpService that decorates another HttpService.
SimpleDecoratingHttpService(HttpService) - Constructor for class com.linecorp.armeria.server.SimpleDecoratingHttpService
Creates a new instance that decorates the specified HttpService.
SimpleDecoratingRpcClient - Class in com.linecorp.armeria.client
Decorates an RpcClient.
SimpleDecoratingRpcClient(RpcClient) - Constructor for class com.linecorp.armeria.client.SimpleDecoratingRpcClient
Creates a new instance that decorates the specified RpcClient.
SimpleDecoratingRpcService - Class in com.linecorp.armeria.server
An RpcService that decorates another RpcService.
SimpleDecoratingRpcService(RpcService) - Constructor for class com.linecorp.armeria.server.SimpleDecoratingRpcService
Creates a new instance that decorates the specified Service.
SimpleDecoratingService<I extends Request,​O extends Response> - Class in com.linecorp.armeria.server
A Service that decorates another Service.
SimpleDecoratingService(Service<I, O>) - Constructor for class com.linecorp.armeria.server.SimpleDecoratingService
Creates a new instance that decorates the specified Service.
size() - Method in interface com.linecorp.armeria.client.ClientRequestContextCaptor
Returns the number of ClientRequestContext captured so far.
size() - Method in class com.linecorp.armeria.common.MediaTypeSet
 
size() - Method in exception com.linecorp.armeria.common.util.CompositeException
Returns the number of suppressed exceptions.
size(long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Creates a new StringBuilder whose content is the human-readable representation of the byte-unit size.
sizeHint(int) - Method in interface com.linecorp.armeria.common.HttpHeadersBuilder
Specifies the hint about the number of headers which may improve the memory efficiency and performance of the underlying data structure.
sizeHint(int) - Method in interface com.linecorp.armeria.common.QueryParamsBuilder
Specifies the hint about the number of parameters which may improve the memory efficiency and performance of the underlying data structure.
sizeHint(int) - Method in interface com.linecorp.armeria.common.RequestHeadersBuilder
 
sizeHint(int) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
 
SKETCHUP - Static variable in class com.linecorp.armeria.common.MediaType
skp files produced by the 3D Modeling software SketchUp.
SKETCHUP - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/vnd.sketchup.skp".
sloEndpoint(SamlEndpoint) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Adds a new single logout service endpoint of this service provider.
sloHandler(SamlSingleLogoutHandler) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a SamlSingleLogoutHandler which handles SAML messages for a single sign-on.
sloReqEndpoint() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns a SamlEndpoint of the identity provider for receiving a single logout request.
sloReqEndpoint(SamlEndpoint) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets a single logout request endpoint of an identity provider.
sloResEndpoint() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns a SamlEndpoint of the identity provider for receiving a single logout response.
sloResEndpoint(SamlEndpoint) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets a single logout response endpoint of an identity provider.
sMaxAge(Duration) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables or disables the "s-maxage" directive.
sMaxAgeSeconds() - Method in class com.linecorp.armeria.common.ServerCacheControl
Returns the value of the "s-maxage" directive or -1 if disabled.
sMaxAgeSeconds(long) - Method in class com.linecorp.armeria.common.ServerCacheControlBuilder
Enables the "s-maxage" directive.
SOAP_XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
As described in RFC 3902, this constant (application/soap+xml) is used to identify SOAP 1.2 message envelopes that have been serialized with XML 1.0.
SOAP_XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/soap+xml; charset=utf-8".
socketAddress(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the InetSocketAddress of the specified SessionProtocol for the Server.
socketAddress(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the InetSocketAddress of the specified SessionProtocol for the Server.
socketAddress(SocketAddress) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Formats the given SocketAddress.
socketChannelType(EventLoopGroup) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns the available SocketChannel class for eventLoopGroup, for use in configuring a custom Bootstrap.
socketConnectDurationNanos() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the duration which was taken to connect to a remote peer, in nanoseconds.
socketConnectEnd() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimingsBuilder
Sets the time when the client ended to connect to a remote peer.
socketConnectStart() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimingsBuilder
Sets the time when the client started to connect to a remote peer.
socketConnectStartTimeMicros() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the time when the client started to connect to a remote peer, in microseconds since the epoch.
socketConnectStartTimeMillis() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
Returns the time when the client started to connect to a remote peer, in milliseconds since the epoch.
socks4(InetSocketAddress) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Creates a ProxyConfig configuration for SOCKS4 protocol.
socks4(InetSocketAddress, String) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Creates a ProxyConfig configuration for SOCKS4 protocol.
SOCKS4 - com.linecorp.armeria.client.proxy.ProxyType
SOCKS4 proxy protocol.
Socks4ProxyConfig - Class in com.linecorp.armeria.client.proxy
SOCKS4 proxy configuration.
socks5(InetSocketAddress) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Creates a ProxyConfig configuration for SOCKS5 protocol.
socks5(InetSocketAddress, String, String) - Static method in class com.linecorp.armeria.client.proxy.ProxyConfig
Creates a ProxyConfig configuration for SOCKS5 protocol.
SOCKS5 - com.linecorp.armeria.client.proxy.ProxyType
SOCKS5 proxy protocol.
Socks5ProxyConfig - Class in com.linecorp.armeria.client.proxy
SOCKS5 proxy configuration.
SOURCE_MAP - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "SourceMap" header field name.
sourceAddress() - Method in class com.linecorp.armeria.client.proxy.HAProxyConfig
Represents the source address.
sourceAddress() - Method in class com.linecorp.armeria.server.ProxiedAddresses
Returns the source address of the proxied request.
Ssl - Class in com.linecorp.armeria.spring
Simple server-independent abstraction for SSL configuration.
Ssl() - Constructor for class com.linecorp.armeria.spring.Ssl
 
sslContext() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the SslContext of this virtual host.
sslPort(int) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the SSL port.
sslSession() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
sslSession() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns the SSLSession of the connection.
sslSession() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the SSLSession of the connection which handled the Request.
sslSession() - Method in interface com.linecorp.armeria.common.RequestContext
The SSLSession for this request if the connection is made over TLS, or null if the connection is not established yet or the connection is not a TLS connection.
sslSession() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
sslSession() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
sslSession(SSLSession) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
sslSession(SSLSession) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the SSLSession of the connection.
sslSession(SSLSession) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
ssoEndpoint() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
Returns a SamlEndpoint of the identity provider for receiving an authentication request.
ssoEndpoint(SamlEndpoint) - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfigBuilder
Sets a single sign-on endpoint of an identity provider.
ssoHandler(SamlSingleSignOnHandler) - Method in class com.linecorp.armeria.server.saml.SamlServiceProviderBuilder
Sets a SamlSingleSignOnHandler which handles SAML messages for a single sign-on.
STACK_TRACE_FIELD_NUMBER - Static variable in class com.linecorp.armeria.common.grpc.ThrowableProto
 
StackTraceElementProto - Class in com.linecorp.armeria.common.grpc
An element in a stack trace, based on the Java type of the same name.
StackTraceElementProto.Builder - Class in com.linecorp.armeria.common.grpc
An element in a stack trace, based on the Java type of the same name.
StackTraceElementProtoOrBuilder - Interface in com.linecorp.armeria.common.grpc
 
staleIfError(Duration) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables or disables the "stale-if-error" directive.
staleIfErrorSeconds() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns the value of the "stale-if-error" directive or -1 if disabled.
staleIfErrorSeconds(long) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables the "stale-if-error" directive.
staleWhileRevalidate(Duration) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables or disables the "stale-while-revalidate" directive.
staleWhileRevalidateSeconds() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns the value of the "stale-while-revalidate" directive or -1 if disabled.
staleWhileRevalidateSeconds(long) - Method in class com.linecorp.armeria.common.ClientCacheControlBuilder
Enables the "stale-while-revalidate" directive.
start() - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
start() - Method in class com.linecorp.armeria.server.Server
Starts this Server to listen to the ServerPorts specified in the ServerConfig.
start() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
start() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
start(boolean) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Begins the startup procedure without an argument by calling StartStopSupport.doStart(Object), ensuring that neither StartStopSupport.doStart(Object) nor StartStopSupport.doStop(Object) is invoked concurrently.
start(T, boolean) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Begins the startup procedure without an argument by calling StartStopSupport.doStart(Object), ensuring that neither StartStopSupport.doStart(Object) nor StartStopSupport.doStop(Object) is invoked concurrently.
start(T, U, boolean) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Begins the startup procedure by calling StartStopSupport.doStart(Object), ensuring that neither StartStopSupport.doStart(Object) nor StartStopSupport.doStop(Object) is invoked concurrently.
startRequest() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of the Request information.
startRequest(long, long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of the Request information.
startResponse() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of Response information.
startResponse(long, long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of Response information.
startStopExecutor(Executor) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the Executor which will invoke the callbacks of Server.start(), Server.stop() and ServerListener.
StartStopSupport<T,​U,​V,​L> - Class in com.linecorp.armeria.common.util
Provides asynchronous start-stop life cycle support.
StartStopSupport(Executor) - Constructor for class com.linecorp.armeria.common.util.StartStopSupport
Creates a new instance.
status() - Method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Returns the STATUS of this response.
status(int) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
Sets the ":status" header.
status(HttpStatus) - Method in interface com.linecorp.armeria.common.ResponseHeadersBuilder
Sets the ":status" header.
STATUS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP ":status" pseudo header field name.
StatusCauseException - Exception in com.linecorp.armeria.common.grpc
A RuntimeException reconstructed from debug information in a failed gRPC response, containing information about the cause of the exception at the server side.
StatusCauseException(ThrowableProto) - Constructor for exception com.linecorp.armeria.common.grpc.StatusCauseException
Constructs a StatusCauseException from the information in the ThrowableProto.
StatusCode - Annotation Type in com.linecorp.armeria.server.annotation
An annotation which specifies a default HTTP status code of a response produced by an annotated HTTP service.
StatusMessageEscaper - Class in com.linecorp.armeria.common.grpc.protocol
Utility to escape status messages (e.g., error messages) for saving to ascii headers.
statusPageUrl(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the status page URL.
sticky(ToLongFunction<? super ClientRequestContext>) - Static method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Returns a sticky strategy which uses a user passed ToLongFunction to compute hashes for consistent hashing.
stop() - Method in class com.linecorp.armeria.common.logback.RequestContextExportingAppender
 
stop() - Method in class com.linecorp.armeria.common.util.StartStopSupport
Begins the shutdown procedure without an argument by calling StartStopSupport.doStop(Object), ensuring that neither StartStopSupport.doStart(Object) nor StartStopSupport.doStop(Object) is invoked concurrently.
stop() - Method in class com.linecorp.armeria.server.Server
Stops this Server to close all active ServerPorts.
stop() - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Stops the Server asynchronously.
stop() - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Stops the Server asynchronously.
stop(U) - Method in class com.linecorp.armeria.common.util.StartStopSupport
Begins the shutdown procedure by calling StartStopSupport.doStop(Object), ensuring that neither StartStopSupport.doStart(Object) nor StartStopSupport.doStop(Object) is invoked concurrently.
stopTimeoutMillis(long) - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
Sets the graceful stop time of the AbstractLifeCycle.stop() in milliseconds.
storeBuffer(ByteBuf, Object, RequestContext) - Static method in class com.linecorp.armeria.unsafe.grpc.GrpcUnsafeBufferUtil
Stores the ByteBuf backing the specified Message to be released later using GrpcUnsafeBufferUtil.releaseBuffer(Object, RequestContext).
stream() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
Returns the InputStream.
StreamDecoder - Interface in com.linecorp.armeria.client.encoding
Deprecated.
Use StreamDecoder instead.
StreamDecoder - Interface in com.linecorp.armeria.common.encoding
An interface for objects that apply HTTP content decoding to incoming HttpData.
StreamDecoderFactory - Interface in com.linecorp.armeria.client.encoding
Deprecated.
StreamDecoderFactory - Interface in com.linecorp.armeria.common.encoding
An interface that constructs a new StreamDecoder for a given Content-Encoding header value.
streaming() - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that can stream an arbitrary number of HttpObject to the client.
streaming(boolean) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
Sets the streaming flag to make Armeria client fully support Streaming.
streaming(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request that can be used to stream an arbitrary number of HttpObject with the initial RequestHeaders of the specified HttpMethod and path.
streaming(RequestHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request that can be used to stream an arbitrary number of HttpObject with the specified initial RequestHeaders.
StreamingHttpFile<T extends Closeable> - Class in com.linecorp.armeria.server.file
A skeletal HttpFile that simplifies the streaming of potentially large content.
StreamingHttpFile(MediaType, Clock, boolean, boolean, BiFunction<String, HttpFileAttributes, String>, HttpHeaders) - Constructor for class com.linecorp.armeria.server.file.StreamingHttpFile
Creates a new instance.
StreamMessage<T> - Interface in com.linecorp.armeria.common.stream
A variant of Reactive Streams Publisher, which allows only one Subscriber.
StreamMessageDuplicator<T> - Interface in com.linecorp.armeria.common.stream
A duplicator that duplicates a StreamMessage into one or more StreamMessages, which publish the same elements.
StreamMessageWrapper<T> - Class in com.linecorp.armeria.common.stream
Wraps a StreamMessage and forwards its method invocations to delegate.
StreamMessageWrapper(StreamMessage<? extends T>) - Constructor for class com.linecorp.armeria.common.stream.StreamMessageWrapper
Creates a new instance that wraps a delegate.
StreamWriter<T> - Interface in com.linecorp.armeria.common.stream
Produces the objects to be published by a StreamMessage.
STRICT_TRANSPORT_SECURITY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Strict-Transport-Security header field name.
StringRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
A RequestConverterFunction which converts a text body of the AggregatedHttpRequest to a String.
StringRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.StringRequestConverterFunction
 
StringResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A ResponseConverterFunction which creates an HttpResponse when: the result is instance of CharSequence the "content-type" of the ResponseHeaders is MediaType.ANY_TEXT_TYPE Note that this ResponseConverterFunction is applied to the annotated service by default, so you don't have to set explicitly.
StringResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.StringResponseConverterFunction
 
StructInfo - Class in com.linecorp.armeria.server.docs
Metadata about a struct type.
StructInfo(String, Iterable<FieldInfo>) - Constructor for class com.linecorp.armeria.server.docs.StructInfo
Creates a new instance.
StructInfo(String, Iterable<FieldInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.StructInfo
Creates a new instance.
structs() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the structs related with the services in this specification.
subscribe(Subscriber<? super T>) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data to the specified Subscriber.
subscribe(Subscriber<? super T>, SubscriptionOption...) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data to the specified Subscriber.
subscribe(Subscriber<? super T>, EventExecutor) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
subscribe(Subscriber<? super T>, EventExecutor) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data to the specified Subscriber.
subscribe(Subscriber<? super T>, EventExecutor) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
subscribe(Subscriber<? super T>, EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
subscribe(Subscriber<? super T>, EventExecutor, SubscriptionOption...) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data to the specified Subscriber.
subscribe(Subscriber<? super T>, EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
subscribe(Subscriber<? super U>, EventExecutor) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
subscribe(Subscriber<? super U>, EventExecutor, SubscriptionOption...) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
SubscriptionOption - Enum in com.linecorp.armeria.common.stream
Options used when subscribing to a StreamMessage.
subtype() - Method in class com.linecorp.armeria.common.MediaType
Returns the media subtype.
success() - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerDecision
Returns a CircuitBreakerDecision that reports a Response as a success.
success() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the number of success events.
SUCCESS - com.linecorp.armeria.common.HttpStatusClass
The success class (2xx).
successfulResponseLogLevel() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.LoggingDecorator
The LogLevel to use when logging successful responses (e.g., no unhandled exception).
successfulResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
successfulResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.client.logging.LoggingRpcClientBuilder
 
successfulResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception).
successfulResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
successRate() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the success rate (success/total), or throws an ArithmeticException if total is 0.
supportedExampleRequestTypes() - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Returns the Set of the example request types supported by this plugin.
supportedSchemes() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the Schemes supported by this ClientFactory.
supportedSchemes() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
supportedSerializationFormats() - Method in interface com.linecorp.armeria.server.grpc.GrpcService
Returns the SerializationFormats supported by this service.
supportedSerializationFormats() - Method in class com.linecorp.armeria.server.thrift.THttpService
Returns the SerializationFormats supported by this service.
supportedSerializationFormats(SerializationFormat...) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets the SerializationFormats supported by this server.
supportedSerializationFormats(Iterable<SerializationFormat>) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets the SerializationFormats supported by this server.
supportedServiceTypes() - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Returns the Set of the Service types supported by this plugin.
SVG_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
SVG_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/svg+xml; charset=utf-8".
SWITCHING_PROTOCOLS - Static variable in class com.linecorp.armeria.common.HttpStatus
101 Switching Protocols.
SystemInfo - Class in com.linecorp.armeria.common.util
Provides utilities for accessing the information about the current system and process.
systemTicker() - Static method in interface com.linecorp.armeria.common.util.Ticker
A ticker that reads the current time using System.nanoTime().

T

tags() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the Tags.
tags(Iterable<Tag>) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the Tags concatenated by the specified tags.
tags(String...) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the Tags concatenated by the specified tags.
takeRequest() - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
Returns the next RecordedRequest the server received.
takeRequest(int, TimeUnit) - Method in class com.linecorp.armeria.testing.junit5.server.mock.MockWebServerExtension
Returns the next RecordedRequest the server received.
TAR - Static variable in class com.linecorp.armeria.common.MediaType
 
TAR - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/x-tar".
taskFunction(Function<? super Runnable, ? extends Runnable>) - Method in class com.linecorp.armeria.common.util.ThreadFactoryBuilder
Sets task function for new threads.
TE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "TE" header field name.
TEMPORARY_REDIRECT - Static variable in class com.linecorp.armeria.common.HttpStatus
307 Temporary Redirect (since HTTP/1.1).
test(String, String, String) - Method in interface com.linecorp.armeria.server.docs.DocServiceFilter
Evaluates this DocServiceFilter on the specified pluginName, serviceName and methodName.
text() - Method in interface com.linecorp.armeria.common.RequestId
Returns the full textual representation of this ID.
text(int) - Static method in interface com.linecorp.armeria.common.logging.ContentPreviewerFactory
Returns a new ContentPreviewerFactory which creates a ContentPreviewer.
text(int, Charset) - Static method in interface com.linecorp.armeria.common.logging.ContentPreviewerFactory
Returns a new ContentPreviewerFactory which creates a ContentPreviewer.
text(MediaType...) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes to produce the text preview when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
text(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified MediaTypes to produce the text preview when the content type of the RequestHeaders or ResponseHeaders is one of the MediaTypes.
text(BiPredicate<? super RequestContext, ? super HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.ContentPreviewerFactoryBuilder
Sets the specified BiPredicate to produce the text preview when the predicate returns true.
TEXT - Static variable in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
TProtocolFactory for the Thrift TText protocol.
TEXT - Static variable in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
Thrift TText serialization format.
TEXT_JAVASCRIPT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
RFC 4329 declares application/javascript to be the correct media type for JavaScript, but this may be necessary in certain situations for compatibility.
TEXT_JAVASCRIPT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/javascript; charset=utf-8".
TEXT_NAMED_ENUM - Static variable in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
TProtocolFactory for the Thrift TText protocol with named enums.
TEXT_NAMED_ENUM - Static variable in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
Thrift TText serialization format with named enums.
TextFormatter - Class in com.linecorp.armeria.common.util
A utility class to format things as a String with ease.
thenBackoff() - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Sets the default backoff and returns a newly created RetryRule.
thenBackoff() - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Sets the default backoff and returns a newly created RetryRuleWithContent.
thenBackoff(Backoff) - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Sets the specified Backoff and returns a newly created RetryRule.
thenBackoff(Backoff) - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Sets the specified Backoff and returns a newly created RetryRuleWithContent.
thenFailure() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Returns a newly created CircuitBreakerRule that determines a Response as a failure when the rule matches.
thenFailure() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Returns a newly created CircuitBreakerRuleWithContent that determines a Response as a failure when the rule matches.
thenIgnore() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Returns a newly created CircuitBreakerRule that ignores a Response when the rule matches.
thenIgnore() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Returns a newly created CircuitBreakerRuleWithContent that ignores a Response when the rule matches.
thenNoRetry() - Method in class com.linecorp.armeria.client.retry.RetryRuleBuilder
Returns a newly created RetryRule that never retries.
thenNoRetry() - Method in class com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder
Returns a newly created RetryRuleWithContent that never retries.
thenSuccess() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder
Returns a newly created CircuitBreakerRule that determines a Response as a success when the rule matches.
thenSuccess() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder
Returns a newly created CircuitBreakerRuleWithContent that determines a Response as a success when the rule matches.
ThreadFactories - Class in com.linecorp.armeria.common.util
Provides a builder for ThreadFactory.
ThreadFactoryBuilder - Class in com.linecorp.armeria.common.util
Builds a new ThreadFactory.
threadGroup(ThreadGroup) - Method in class com.linecorp.armeria.common.util.ThreadFactoryBuilder
Sets thread group for new threads.
threadLocal() - Static method in interface com.linecorp.armeria.common.RequestContextStorage
Returns the default RequestContextStorage which stores the RequestContext in the thread-local.
THREE_GPP_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
The 3GP multimedia container format.
THREE_GPP_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/3gpp".
THREE_GPP2_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
The 3G2 multimedia container format.
THREE_GPP2_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/3gpp2".
ThriftCall - Class in com.linecorp.armeria.common.thrift
A container of a Thrift one-way or two-way call object (TBase) and its header (TMessage).
ThriftCall(TMessage, TBase<?, ?>) - Constructor for class com.linecorp.armeria.common.thrift.ThriftCall
Creates a new instance that contains a Thrift TMessageType.CALL or TMessageType.ONEWAY message.
ThriftCallService - Class in com.linecorp.armeria.server.thrift
An RpcService that handles a Thrift RpcRequest.
ThriftFuture<T> - Class in com.linecorp.armeria.common.thrift
A CompletableFuture that can be passed in as an AsyncMethodCallback when making an asynchronous client-side Thrift RPC.
ThriftFuture() - Constructor for class com.linecorp.armeria.common.thrift.ThriftFuture
 
ThriftJacksonModule - Class in com.linecorp.armeria.common.thrift
Jackson Module for Thrift types.
ThriftJacksonModule() - Constructor for class com.linecorp.armeria.common.thrift.ThriftJacksonModule
Creates a new instance with the default settings.
ThriftJacksonModule(boolean) - Constructor for class com.linecorp.armeria.common.thrift.ThriftJacksonModule
Creates a new instance.
ThriftListenableFuture<T> - Class in com.linecorp.armeria.common.thrift
A ListenableFuture that can be passed in as an AsyncMethodCallback when making an asynchronous client-side Thrift RPC.
ThriftListenableFuture() - Constructor for class com.linecorp.armeria.common.thrift.ThriftListenableFuture
 
ThriftMessage - Class in com.linecorp.armeria.common.thrift
A container of a Thrift message produced by Apache Thrift.
ThriftProtocolFactories - Class in com.linecorp.armeria.common.thrift
Provides a set of the known TProtocolFactory instances.
ThriftReply - Class in com.linecorp.armeria.common.thrift
A container of a Thrift reply or exception object (TBase or TApplicationException) and its header (TMessage).
ThriftReply(TMessage, TApplicationException) - Constructor for class com.linecorp.armeria.common.thrift.ThriftReply
Creates a new instance that contains a Thrift TMessageType.EXCEPTION message.
ThriftReply(TMessage, TBase<?, ?>) - Constructor for class com.linecorp.armeria.common.thrift.ThriftReply
Creates a new instance that contains a Thrift TMessageType.REPLY message.
ThriftSerializationFormats - Class in com.linecorp.armeria.common.thrift
Thrift-related SerializationFormat instances.
ThriftServiceEntry - Class in com.linecorp.armeria.server.thrift
The information about a Thrift service served by THttpService or ThriftCallService.
ThrottlingAcceptHandler<I extends Request,​O extends Response> - Interface in com.linecorp.armeria.server.throttling
A callback which is invoked to handle accepted (successful) requests indicated by ThrottlingStrategy.
ThrottlingHeaders - Interface in com.linecorp.armeria.common.throttling
A RateLimit Header Scheme for HTTP.
ThrottlingRejectHandler<I extends Request,​O extends Response> - Interface in com.linecorp.armeria.server.throttling
A callback which is invoked to handle rejected (failure) requests indicated by ThrottlingStrategy.
ThrottlingRpcService - Class in com.linecorp.armeria.server.throttling
Decorates an RPC Service to throttle incoming requests.
ThrottlingRpcServiceBuilder - Class in com.linecorp.armeria.server.throttling
Builds a new ThrottlingRpcService.
ThrottlingService - Class in com.linecorp.armeria.server.throttling
Decorates an HttpService to throttle incoming requests.
ThrottlingServiceBuilder - Class in com.linecorp.armeria.server.throttling
Builds a new ThrottlingService.
ThrottlingStrategy<T extends Request> - Class in com.linecorp.armeria.server.throttling
Determines whether a request should be throttled.
ThrottlingStrategy() - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy with a default name.
ThrottlingStrategy(String) - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy with specified name.
ThrowableProto - Class in com.linecorp.armeria.common.grpc
An exception that was thrown by some code, based on the Java type of the same name.
ThrowableProto.Builder - Class in com.linecorp.armeria.common.grpc
An exception that was thrown by some code, based on the Java type of the same name.
ThrowableProtoOrBuilder - Interface in com.linecorp.armeria.common.grpc
 
throwIfFatal(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Throws a particular Throwable only if it belongs to a set of "fatal" error varieties.
throwUnsafely(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Throws the specified exception violating the throws clause of the enclosing method.
THttpClient - Interface in com.linecorp.armeria.client.thrift
A generic Thrift-over-HTTP client.
THttpService - Class in com.linecorp.armeria.server.thrift
An HttpService that handles a Thrift call.
THttpServiceBuilder - Class in com.linecorp.armeria.server.thrift
A fluent builder to build an instance of THttpService.
Ticker - Interface in com.linecorp.armeria.common.util
A time source; returns a time value representing the number of nanoseconds elapsed since some fixed but arbitrary point in time.
TIFF - Static variable in class com.linecorp.armeria.common.MediaType
 
TIFF - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/tiff".
timedOut() - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Returns whether a timeout is set.
timedOut(boolean) - Method in class com.linecorp.armeria.client.ClientRequestContextBuilder
 
timedOut(boolean) - Method in class com.linecorp.armeria.common.AbstractRequestContextBuilder
Sets the specified timedOut.
timedOut(boolean) - Method in class com.linecorp.armeria.server.ServiceRequestContextBuilder
 
TimeoutException - Exception in com.linecorp.armeria.common
A RuntimeException raised when a requested invocation does not complete before its deadline.
TimeoutException() - Constructor for exception com.linecorp.armeria.common.TimeoutException
Creates a new exception.
TimeoutException(String) - Constructor for exception com.linecorp.armeria.common.TimeoutException
Creates a new instance with the specified message.
TimeoutException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.TimeoutException
Creates a new instance with the specified message and cause.
TimeoutException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.common.TimeoutException
Creates a new instance with the specified message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
TimeoutException(Throwable) - Constructor for exception com.linecorp.armeria.common.TimeoutException
Creates a new instance with the specified cause.
TimeoutMode - Enum in com.linecorp.armeria.common.util
The timeout mode.
timeoutNow() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Times out the response.
timeoutNow() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
timeoutNow() - Method in interface com.linecorp.armeria.common.RequestContext
Times out the current Request.
timeoutNow() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Times out the request.
timeoutNow() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
timestamp() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of "oauth_timestamp" property.
timestamp(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of oauth_timestamp property.
TIMING_ALLOW_ORIGIN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP Timing-Allow-Origin header field name.
tls(File, File) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the Server from the specified keyCertChainFile and cleartext keyFile.
tls(File, File) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified keyCertChainFile and cleartext keyFile.
tls(File, File, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the Server from the specified keyCertChainFile, keyFile and keyPassword.
tls(File, File, String) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified keyCertChainFile, keyFile and keyPassword.
tls(InputStream, InputStream) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified keyCertChainInputStream and cleartext keyInputStream.
tls(InputStream, InputStream) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified keyCertChainInputStream and cleartext keyInputStream.
tls(InputStream, InputStream, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified keyCertChainInputStream, keyInputStream and keyPassword.
tls(InputStream, InputStream, String) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified keyCertChainInputStream, keyInputStream and keyPassword.
tls(PrivateKey, Iterable<? extends X509Certificate>) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified cleartext PrivateKey and X509Certificate chain.
tls(PrivateKey, Iterable<? extends X509Certificate>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified cleartext PrivateKey and X509Certificate chain.
tls(PrivateKey, String, Iterable<? extends X509Certificate>) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified PrivateKey, keyPassword and X509Certificate chain.
tls(PrivateKey, String, Iterable<? extends X509Certificate>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified cleartext PrivateKey, keyPassword and X509Certificate chain.
tls(PrivateKey, String, X509Certificate...) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified PrivateKey, keyPassword and X509Certificate chain.
tls(PrivateKey, String, X509Certificate...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified cleartext PrivateKey, keyPassword and X509Certificate chain.
tls(PrivateKey, X509Certificate...) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified cleartext PrivateKey and X509Certificate chain.
tls(PrivateKey, X509Certificate...) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified cleartext PrivateKey and X509Certificate chain.
tls(KeyManagerFactory) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of this Server with the specified KeyManagerFactory.
tls(KeyManagerFactory) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with the specified KeyManagerFactory.
TLS_CIPHER - com.linecorp.armeria.common.logging.BuiltInProperty
"tls.cipher" - the current TLS cipher suite.
TLS_CUSTOMIZER - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
TLS_PROTO - com.linecorp.armeria.common.logging.BuiltInProperty
"tls.proto" - the current SSLSession.getProtocol() TLS protocol}.
TLS_SESSION_ID - com.linecorp.armeria.common.logging.BuiltInProperty
"tls.session_id" - the hexadecimal representation of the current TLS session ID.
tlsCustomizer() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
tlsCustomizer(Consumer<? super SslContextBuilder>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
tlsCustomizer(Consumer<? super SslContextBuilder>) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
tlsCustomizer(Consumer<? super SslContextBuilder>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
tlsNoVerify() - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Disables the verification of server's TLS certificate chain.
tlsNoVerifyHosts(String...) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Disables the verification of server's TLS certificate chain for specific hosts.
tlsSelfSigned() - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the Server with an auto-generated self-signed certificate.
tlsSelfSigned() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate.
tlsSelfSigned(boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the Server with an auto-generated self-signed certificate.
tlsSelfSigned(boolean) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate.
toBuilder() - Method in class com.linecorp.armeria.client.ClientOptions
Returns a new ClientOptionsBuilder created from this ClientOptions.
toBuilder() - Method in class com.linecorp.armeria.common.CacheControl
Returns a newly created CacheControlBuilder which has the same initial directives with this CacheControl.
toBuilder() - Method in class com.linecorp.armeria.common.ClientCacheControl
Returns a newly created ClientCacheControlBuilder which has the same initial directives with this ClientCacheControl.
toBuilder() - Method in interface com.linecorp.armeria.common.Cookie
Returns a new CookieBuilder created from this Cookie.
toBuilder() - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
toBuilder() - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
toBuilder() - Method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new builder created from the entries of this headers.
toBuilder() - Method in interface com.linecorp.armeria.common.QueryParams
Returns a new builder created from the entries of this parameters.
toBuilder() - Method in interface com.linecorp.armeria.common.RequestHeaders
 
toBuilder() - Method in interface com.linecorp.armeria.common.ResponseHeaders
 
toBuilder() - Method in class com.linecorp.armeria.common.ServerCacheControl
Returns a newly created ServerCacheControlBuilder which has the same initial directives with this ServerCacheControl.
toCookieHeader() - Method in interface com.linecorp.armeria.common.Cookie
Encodes this Cookie into a single "Cookie" header value.
toCookieHeader(boolean) - Method in interface com.linecorp.armeria.common.Cookie
Encodes this Cookie into a single "Cookie" header value.
toCookieHeader(boolean, Cookie...) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into a "Cookie" header value.
toCookieHeader(boolean, Iterable<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into a "Cookie" header value.
toCookieHeader(boolean, Collection<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into a "Cookie" header value.
toCookieHeader(Cookie...) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into a "Cookie" header value.
toCookieHeader(Iterable<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into a "Cookie" header value.
toCookieHeader(Collection<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into a "Cookie" header value.
toDuplicator() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns a new HttpRequestDuplicator that duplicates this HttpRequest into one or more HttpRequests, which publish the same elements.
toDuplicator() - Method in interface com.linecorp.armeria.common.HttpResponse
Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements.
toDuplicator() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements.
toDuplicator() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
toDuplicator(long) - Method in interface com.linecorp.armeria.common.HttpRequest
Returns a new HttpRequestDuplicator that duplicates this HttpRequest into one or more HttpRequests, which publish the same elements.
toDuplicator(long) - Method in interface com.linecorp.armeria.common.HttpResponse
Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements.
toDuplicator(EventExecutor) - Method in interface com.linecorp.armeria.common.HttpRequest
Returns a new HttpRequestDuplicator that duplicates this HttpRequest into one or more HttpRequests, which publish the same elements.
toDuplicator(EventExecutor) - Method in interface com.linecorp.armeria.common.HttpResponse
Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements.
toDuplicator(EventExecutor) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements.
toDuplicator(EventExecutor) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
toDuplicator(EventExecutor, long) - Method in interface com.linecorp.armeria.common.HttpRequest
Returns a new HttpRequestDuplicator that duplicates this HttpRequest into one or more HttpRequests, which publish the same elements.
toDuplicator(EventExecutor, long) - Method in interface com.linecorp.armeria.common.HttpResponse
Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements.
toHttpData() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the HttpData whose content is "<code> <reasonPhrase>" encoded in UTF-8.
toHttpFile() - Method in interface com.linecorp.armeria.server.file.AggregatedHttpFile
Converts this file into an HttpFile.
toHttpRequest() - Method in interface com.linecorp.armeria.common.AggregatedHttpRequest
Converts this request into a new complete HttpRequest.
toHttpResponse() - Method in interface com.linecorp.armeria.common.AggregatedHttpResponse
Converts this response into a new complete HttpResponse.
toInputStream() - Method in interface com.linecorp.armeria.common.HttpData
Returns a new InputStream that is sourced from this data.
token() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of the "oauth_token" property.
token(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of the oauth_token property.
TokenBucket - Class in com.linecorp.armeria.server.throttling.bucket4j
Stores configuration of the Token-Bucket algorithm, comprised of multiple limits.
TokenBucketBuilder - Class in com.linecorp.armeria.server.throttling.bucket4j
Builds a TokenBucket instance.
TokenBucketThrottlingStrategy<T extends Request> - Class in com.linecorp.armeria.server.throttling.bucket4j
A ThrottlingStrategy that provides a throttling strategy based on Token-Bucket algorithm.
TokenBucketThrottlingStrategyBuilder<T extends Request> - Class in com.linecorp.armeria.server.throttling.bucket4j
TomcatService - Class in com.linecorp.armeria.server.tomcat
An HttpService that dispatches its requests to a web application running in an embedded Tomcat.
TomcatServiceBuilder - Class in com.linecorp.armeria.server.tomcat
Builds a TomcatService.
TomcatServiceException - Exception in com.linecorp.armeria.server.tomcat
A RuntimeException that is raised when configuring or starting an embedded Tomcat fails.
TomcatServiceException() - Constructor for exception com.linecorp.armeria.server.tomcat.TomcatServiceException
Creates a new instance.
TomcatServiceException(String) - Constructor for exception com.linecorp.armeria.server.tomcat.TomcatServiceException
Creates a new instance with the specified message.
TomcatServiceException(String, Throwable) - Constructor for exception com.linecorp.armeria.server.tomcat.TomcatServiceException
Creates a new instance with the specified message and cause.
TomcatServiceException(Throwable) - Constructor for exception com.linecorp.armeria.server.tomcat.TomcatServiceException
Creates a new instance with the specified cause.
TOO_MANY_REQUESTS - Static variable in class com.linecorp.armeria.common.HttpStatus
429 Too Many Requests (RFC6585).
toReader(Charset) - Method in interface com.linecorp.armeria.common.HttpData
Returns a new Reader that is sourced from this data and decoded using the specified Charset.
toReaderAscii() - Method in interface com.linecorp.armeria.common.HttpData
Returns a new Reader that is sourced from this data and decoded using StandardCharsets.US_ASCII.
toReaderUtf8() - Method in interface com.linecorp.armeria.common.HttpData
Returns a new Reader that is sourced from this data and decoded using StandardCharsets.UTF_8.
toSerializationFormat(TProtocolFactory) - Static method in class com.linecorp.armeria.common.thrift.ThriftProtocolFactories
Returns the SerializationFormat for the specified TProtocolFactory.
toSetCookieHeader() - Method in interface com.linecorp.armeria.common.Cookie
Encodes this Cookie into a single "Set-Cookie" header value.
toSetCookieHeader(boolean) - Method in interface com.linecorp.armeria.common.Cookie
Encodes this Cookie into a single "Set-Cookie" header value.
toSetCookieHeaders(boolean, Cookie...) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into "Set-Cookie" header values.
toSetCookieHeaders(boolean, Iterable<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into "Set-Cookie" header values.
toSetCookieHeaders(boolean, Collection<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into "Set-Cookie" header values.
toSetCookieHeaders(Cookie...) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into "Set-Cookie" header values.
toSetCookieHeaders(Iterable<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into "Set-Cookie" header values.
toSetCookieHeaders(Collection<? extends Cookie>) - Static method in interface com.linecorp.armeria.common.Cookie
Encodes the specified Cookies into "Set-Cookie" header values.
toString() - Method in class com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClientBuilder
 
toString() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerDecision
 
toString() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
 
toString() - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
 
toString() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
toString() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
 
toString() - Method in class com.linecorp.armeria.client.Endpoint
 
toString() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
 
toString() - Method in class com.linecorp.armeria.client.proxy.DirectProxyConfig
 
toString() - Method in class com.linecorp.armeria.client.proxy.HAProxyConfig
 
toString() - Method in class com.linecorp.armeria.client.proxy.Socks4ProxyConfig
 
toString() - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
 
toString() - Method in class com.linecorp.armeria.client.retry.AbstractRetryingClientBuilder
 
toString() - Method in class com.linecorp.armeria.client.retry.RetryDecision
 
toString() - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
 
toString() - Method in class com.linecorp.armeria.common.auth.BasicToken
 
toString() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
 
toString() - Method in class com.linecorp.armeria.common.auth.OAuth2Token
 
toString() - Method in class com.linecorp.armeria.common.CacheControl
 
toString() - Method in class com.linecorp.armeria.common.CompletableRpcResponse
 
toString() - Method in class com.linecorp.armeria.common.HttpStatus
 
toString() - Method in class com.linecorp.armeria.common.logging.ClientConnectionTimings
 
toString() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
 
toString() - Method in class com.linecorp.armeria.common.MediaType
Returns the string representation of this media type in the format described in RFC 2045.
toString() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
 
toString() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
toString() - Method in class com.linecorp.armeria.common.Scheme
 
toString() - Method in class com.linecorp.armeria.common.SerializationFormat
 
toString() - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
toString() - Method in enum com.linecorp.armeria.common.SessionProtocol
 
toString() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
toString() - Method in class com.linecorp.armeria.common.thrift.text.TTextProtocolFactory
 
toString() - Method in class com.linecorp.armeria.common.thrift.ThriftCall
 
toString() - Method in class com.linecorp.armeria.common.thrift.ThriftReply
 
toString() - Method in class com.linecorp.armeria.common.util.AbstractOption
 
toString() - Method in class com.linecorp.armeria.common.util.AbstractOptions
 
toString() - Method in class com.linecorp.armeria.common.util.AbstractOptionValue
 
toString() - Method in class com.linecorp.armeria.common.util.AbstractUnwrappable
 
toString() - Method in class com.linecorp.armeria.common.util.StartStopSupport
 
toString() - Method in class com.linecorp.armeria.common.util.Version
 
toString() - Method in class com.linecorp.armeria.common.zookeeper.ServerSetsInstance
 
toString() - Method in class com.linecorp.armeria.server.ClientAddressSource
 
toString() - Method in class com.linecorp.armeria.server.cors.CorsConfig
 
toString() - Method in class com.linecorp.armeria.server.cors.CorsPolicy
 
toString() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
toString() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.EndpointInfoBuilder
 
toString() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.FieldInfoBuilder
 
toString() - Method in class com.linecorp.armeria.server.docs.MethodInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.TypeSignature
 
toString() - Method in class com.linecorp.armeria.server.file.AbstractHttpVfs
Returns the HttpVfs.meterTag() of this HttpVfs.
toString() - Method in class com.linecorp.armeria.server.file.FileServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
 
toString() - Method in class com.linecorp.armeria.server.file.HttpFileAttributes
 
toString() - Method in class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
 
toString() - Method in class com.linecorp.armeria.server.jetty.JettyServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.ProxiedAddresses
 
toString() - Method in class com.linecorp.armeria.server.RouteBuilder
 
toString() - Method in class com.linecorp.armeria.server.Routed
 
toString() - Method in class com.linecorp.armeria.server.RoutingResult
 
toString() - Method in class com.linecorp.armeria.server.saml.SamlAssertionConsumerConfig
 
toString() - Method in class com.linecorp.armeria.server.saml.SamlEndpoint
 
toString() - Method in class com.linecorp.armeria.server.saml.SamlIdentityProviderConfig
 
toString() - Method in class com.linecorp.armeria.server.saml.SamlNameIdPolicy
 
toString() - Method in class com.linecorp.armeria.server.Server
 
toString() - Method in class com.linecorp.armeria.server.ServerBuilder
 
toString() - Method in class com.linecorp.armeria.server.ServerConfig
 
toString() - Method in class com.linecorp.armeria.server.ServerPort
 
toString() - Method in class com.linecorp.armeria.server.ServiceConfig
 
toString() - Method in class com.linecorp.armeria.server.thrift.ThriftServiceEntry
 
toString() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
 
toString() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket
 
toString() - Method in class com.linecorp.armeria.server.tomcat.TomcatServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.VirtualHost
 
toString() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
 
toString() - Method in class com.linecorp.armeria.testing.junit5.server.mock.RecordedRequest
 
toString(Charset) - Method in interface com.linecorp.armeria.common.HttpData
Decodes this data into a String.
toStringAscii() - Method in interface com.linecorp.armeria.common.HttpData
Decodes this data into a String using US-ASCII encoding.
toStringRequestOnly() - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the string representation of the Request, with no sanitization of headers or content.
toStringRequestOnly(BiFunction<? super RequestContext, ? super HttpHeaders, ?>, BiFunction<? super RequestContext, Object, ?>) - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the string representation of the Request.
toStringRequestOnly(BiFunction<? super RequestContext, ? super RequestHeaders, ?>, BiFunction<? super RequestContext, Object, ?>, BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in interface com.linecorp.armeria.common.logging.RequestOnlyLog
Returns the string representation of the Request.
toStringResponseOnly() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the string representation of the Response, with no sanitization of headers or content.
toStringResponseOnly(BiFunction<? super RequestContext, ? super HttpHeaders, ?>, BiFunction<? super RequestContext, Object, ?>) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the string representation of the Response.
toStringResponseOnly(BiFunction<? super RequestContext, ? super ResponseHeaders, ?>, BiFunction<? super RequestContext, Object, ?>, BiFunction<? super RequestContext, ? super HttpHeaders, ?>) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the string representation of the Response.
toStringUtf8() - Method in interface com.linecorp.armeria.common.HttpData
Decodes this data into a String using UTF-8 encoding.
total() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the total number of events.
totalDurationNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the amount of time taken since the Request processing started and until the Response processing ended.
touch(Object) - Method in interface com.linecorp.armeria.common.HttpData
(Advanced users only) Records the current access location of this data for debugging purposes.
touch(Object) - Static method in class com.linecorp.armeria.unsafe.PooledObjects
Calls ByteBuf.touch(Object) on the specified HttpData's underlying ByteBuf.
touch(Object, Object) - Static method in class com.linecorp.armeria.unsafe.PooledObjects
Calls ByteBuf.touch(Object) on the specified HttpData's underlying ByteBuf.
toUri(Scheme) - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into a URI using the Scheme.
toUri(Scheme, String) - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into a URI using the Scheme and the path.
toUri(SessionProtocol) - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into a URI using the SessionProtocol.
toUri(SessionProtocol, String) - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into a URI using the SessionProtocol and path.
toUri(String) - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into a URI using the scheme.
toUri(String, String) - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into a URI using the scheme and path.
toUriString() - Method in class com.linecorp.armeria.server.saml.SamlEndpoint
Returns a URI of this endpoint as a string.
trace(String) - Method in interface com.linecorp.armeria.client.WebClient
Sends an HTTP TRACE request.
trace(String) - Method in class com.linecorp.armeria.server.DecoratingServiceBindingBuilder
 
trace(String) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
trace(String) - Method in class com.linecorp.armeria.server.VirtualHostDecoratingServiceBindingBuilder
 
trace(String) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
Trace - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.TRACE onto specific method.
TRACE - com.linecorp.armeria.common.HttpMethod
The TRACE method which is used to invoke a remote, application-layer loop-back of the request message.
TRACE - com.linecorp.armeria.common.logging.LogLevel
TRACE log level.
traceEnabled(boolean) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets if this resolver should generate detailed trace information in exception messages so that it is easier to understand the cause of resolution failure.
traceText(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Converts the stack trace of the specified exception into a String.
TRAILER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Trailer" header field name.
trailers() - Method in interface com.linecorp.armeria.server.annotation.HttpResult
Returns the HTTP trailers of a response.
transfer(CompletionStage<T>, AsyncMethodCallback<? super T>) - Static method in class com.linecorp.armeria.common.thrift.AsyncMethodCallbacks
Adds a callback that transfers the outcome of the specified CompletionStage to the specified AsyncMethodCallback.
TRANSFER_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Transfer-Encoding" header field name.
TRANSIENT - com.linecorp.armeria.server.saml.SamlNameIdFormat
Transient name format.
TransientHttpService - Interface in com.linecorp.armeria.server
An HttpService that handles transient requests, for example, health check requests.
TransientRpcService - Interface in com.linecorp.armeria.server
An RpcService that handles transient requests, for example, health check requests.
TransientService<I extends Request,​O extends Response> - Interface in com.linecorp.armeria.server
A Service that handles transient requests, for example, health check requests.
trialRequestInterval(Duration) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the trial request interval in HALF_OPEN state.
trialRequestIntervalMillis(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the trial request interval in HALF_OPEN state in milliseconds.
tryClose(Throwable) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
Tries to close the stream with the specified cause.
tryParse(String) - Static method in class com.linecorp.armeria.common.Scheme
Parses the specified String into a Scheme.
tryWrite(Supplier<? extends T>) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object Supplier to the StreamMessage.
tryWrite(T) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object to the StreamMessage.
TSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
TSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/tab-separated-values; charset=utf-8".
TTextProtocolFactory - Class in com.linecorp.armeria.common.thrift.text
The TProtocolFactory that creates a TTextProtocol.
ttl(int, int) - Method in class com.linecorp.armeria.client.DnsResolverGroupBuilder
Sets the minimum and maximum TTL of the cached DNS resource records in seconds.
ttl(int, int) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
 
ttl(int, int) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
 
ttl(int, int) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
 
TwoElementFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that publishes two objects.
TwoElementFixedStreamMessage(T, T) - Constructor for class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
Constructs a new TwoElementFixedStreamMessage for the given objects.
type() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer.DeframedMessage
Returns the type.
type() - Method in class com.linecorp.armeria.common.MediaType
Returns the top-level media type.
type() - Method in class com.linecorp.armeria.server.RoutingResult
Returns the type of this result.
type(RoutingResultType) - Method in class com.linecorp.armeria.server.RoutingResultBuilder
Sets the result type.
type(String) - Method in class com.linecorp.armeria.server.saml.KeyStoreCredentialResolverBuilder
Sets a type of the KeyStore.
typeParameters() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the list of the type parameters of this type signature.
typeSignature() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the metadata about the type of the field.
TypeSignature - Class in com.linecorp.armeria.server.docs
Type signature of a method parameter, a method return value or a struct/exception field.

U

UnaryGrpcClient - Class in com.linecorp.armeria.client.grpc.protocol
A UnaryGrpcClient can be used to make requests to a gRPC server without depending on gRPC stubs.
UnaryGrpcClient(WebClient) - Constructor for class com.linecorp.armeria.client.grpc.protocol.UnaryGrpcClient
Constructs a UnaryGrpcClient for the given WebClient.
UNAUTHORIZED - Static variable in class com.linecorp.armeria.common.HttpStatus
401 Unauthorized.
UNDEFINED_MAX_AGE - Static variable in interface com.linecorp.armeria.common.Cookie
Constant for undefined MaxAge attribute value.
unescape(String) - Static method in class com.linecorp.armeria.common.grpc.protocol.StatusMessageEscaper
Unescape the provided ascii to a unicode String.
UNHANDLED - com.linecorp.armeria.server.annotation.ExceptionVerbosity
Log exceptions which are not handled by any ExceptionHandler specified by a user.
UNHEALTHY - com.linecorp.armeria.server.healthcheck.HealthCheckUpdateResult
Tells HealthCheckService to mark the Server as 'unhealthy'.
unhealthyResponse(AggregatedHttpResponse) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Sets the AggregatedHttpResponse to send when the Service is unhealthy.
UNKNOWN - com.linecorp.armeria.common.HttpMethod
A special method which represents the client sent a method that is none of the constants defined in this enum.
UNKNOWN - com.linecorp.armeria.common.HttpStatusClass
The unknown class.
UNKNOWN - Static variable in class com.linecorp.armeria.common.HttpStatus
A special status code '0' which represents that the response status is unknown.
UNKNOWN - Static variable in class com.linecorp.armeria.common.SerializationFormat
Unknown serialization format.
UnmodifiableFuture<T> - Class in com.linecorp.armeria.common.util
A CompletableFuture which prevents the caller from completing it.
UnmodifiableFuture() - Constructor for class com.linecorp.armeria.common.util.UnmodifiableFuture
Creates a new UnmodifiableFuture.
UNORDERED_COLLECTION - Static variable in class com.linecorp.armeria.common.HttpStatus
425 Unordered Collection (WebDAV, RFC3648).
UNPROCESSABLE_ENTITY - Static variable in class com.linecorp.armeria.common.HttpStatus
422 Unprocessable Entity (WebDAV, RFC4918).
UnprocessedRequestException - Exception in com.linecorp.armeria.client
A RuntimeException raised when it is certain that a request has not been handled by a server and thus can be retried safely.
UNSAFE_WRAP_RESPONSE_BUFFERS - Static variable in class com.linecorp.armeria.client.grpc.GrpcClientOptions
Enables unsafe retention of response buffers.
unsafeUpdateRequest(HttpRequest) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
Replaces the HttpRequest associated with this context with the specified one without any validation.
unsafeWrapRequestBuffers(boolean) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Enables unsafe retention of request buffers.
UNSPECIFIED - com.linecorp.armeria.server.docs.FieldLocation
The location of the field is unspecified.
UNSPECIFIED - com.linecorp.armeria.server.docs.FieldRequirement
The requirement level is unspecified and will be handled implicitly by the serialization layer.
UNSPECIFIED - com.linecorp.armeria.server.saml.SamlNameIdFormat
Unspecified name format.
UnstableApi - Annotation Type in com.linecorp.armeria.common.annotation
Indicates the API of the target is not mature enough to guarantee the compatibility between releases.
UNSUPPORTED_MEDIA_TYPE - Static variable in class com.linecorp.armeria.common.HttpStatus
415 Unsupported Media Type.
unwrap() - Method in interface com.linecorp.armeria.client.Client
Unwraps this Client and returns the object being decorated.
unwrap() - Method in interface com.linecorp.armeria.client.ClientFactory
 
unwrap() - Method in interface com.linecorp.armeria.client.ConnectionPoolListener
 
unwrap() - Method in interface com.linecorp.armeria.client.retry.Backoff
Undecorates this Backoff and returns the object being decorated.
unwrap() - Method in interface com.linecorp.armeria.client.thrift.THttpClient
 
unwrap() - Method in interface com.linecorp.armeria.client.WebClient
 
unwrap() - Method in interface com.linecorp.armeria.common.RequestContextStorage
 
unwrap() - Method in class com.linecorp.armeria.common.util.AbstractUnwrappable
 
unwrap() - Method in interface com.linecorp.armeria.common.util.Unwrappable
Unwraps this object and returns the object being decorated.
unwrap() - Method in interface com.linecorp.armeria.server.Service
Unwraps this Service and returns the object being decorated.
unwrap(Object, Class<T>) - Method in interface com.linecorp.armeria.client.ClientFactory
Unwraps the specified client object into the object of the specified type.
unwrap(Object, Class<T>) - Static method in class com.linecorp.armeria.client.Clients
Unwraps the specified client into the object of the specified type.
unwrap(Object, Class<T>) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
Unwrappable - Interface in com.linecorp.armeria.common.util
Provides a way to unwrap an object in decorator pattern, similar to down-casting in an inheritance pattern.
updatable(boolean) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Specifies whether the healthiness of the Server can be updated by sending a PUT, POST or PATCH request to the HealthCheckService.
updatable(HealthCheckUpdateHandler) - Method in class com.linecorp.armeria.server.healthcheck.HealthCheckServiceBuilder
Specifies a HealthCheckUpdateHandler which handles other HTTP methods than HEAD and GET which updates the healthiness of the Server.
updateHealth(double) - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckerContext
Updates the health of the Endpoint being checked.
updateRequest(HttpRequest) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
updateRequest(HttpRequest) - Method in interface com.linecorp.armeria.common.RequestContext
Replaces the HttpRequest associated with this context with the specified one.
updateRequest(HttpRequest) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
updateRpcRequest(RpcRequest) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
updateRpcRequest(RpcRequest) - Method in interface com.linecorp.armeria.common.RequestContext
Replaces the RpcRequest associated with this context with the specified one.
updateRpcRequest(RpcRequest) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
UPGRADE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Upgrade" header field name.
UPGRADE_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
426 Upgrade Required (RFC2817).
uri() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the endpoint URI of the client.
uri() - Method in class com.linecorp.armeria.client.UserClient
 
uri() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the URI of this request.
uri() - Method in class com.linecorp.armeria.server.saml.SamlEndpoint
Returns a URI of this endpoint.
uri(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the URI for the Server of the specified SessionProtocol.
uri(SessionProtocol) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the URI for the Server of the specified SessionProtocol.
uri(SessionProtocol, SerializationFormat) - Method in class com.linecorp.armeria.testing.junit4.server.ServerRule
Returns the URI for the Server of the specified SessionProtocol and SerializationFormat.
uri(SessionProtocol, SerializationFormat) - Method in class com.linecorp.armeria.testing.junit5.server.ServerExtension
Returns the URI for the Server of the specified SessionProtocol and SerializationFormat.
uriSpec(UriSpec) - Method in class com.linecorp.armeria.server.zookeeper.CuratorRegistrationSpecBuilder
Sets the UriSpec.
uriText() - Method in class com.linecorp.armeria.common.Scheme
Returns the textual representation ("serializationFormat+sessionProtocol").
uriText() - Method in class com.linecorp.armeria.common.SerializationFormat
Returns the textual representation of this format for use in a Scheme.
uriText() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns the textual representation of this format for use in a Scheme.
urn() - Method in enum com.linecorp.armeria.server.saml.SamlBindingProtocol
Returns the URN of this binding protocol.
urn() - Method in enum com.linecorp.armeria.server.saml.SamlNameIdFormat
Returns the URN of this name ID format.
USE_HTTP1_PIPELINING - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
Whether to use HTTP pipelining for HTTP/1 connections.
USE_HTTP2_PREFACE - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
Whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
USE_PROXY - Static variable in class com.linecorp.armeria.common.HttpStatus
305 Use Proxy (since HTTP/1.1).
useBlockingTaskExecutor(boolean) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
Sets whether the service executes service methods using the blocking executor.
useBlockingTaskExecutor(boolean) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets whether the service executes service methods using the blocking executor.
useBlockingTaskExecutor(boolean) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
Sets whether the service executes service methods using the blocking executor.
useClientTimeoutHeader(boolean) - Method in class com.linecorp.armeria.server.grpc.GrpcServiceBuilder
Sets whether to use a grpc-timeout header sent by the client to control the timeout for request processing.
useEpoll() - Static method in class com.linecorp.armeria.common.Flags
Returns whether the JNI-based /dev/epoll socket I/O is enabled.
useGet(boolean) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
Sets whether to use HTTP GET method instead of HEAD when sending a health check request.
useHttp1Pipelining() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns whether to use HTTP pipelining for HTTP/1 connections.
useHttp1Pipelining(boolean) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets whether to use HTTP pipelining for HTTP/1 connections.
useHttp2Preface() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
useHttp2Preface(boolean) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
useJdkDnsResolver() - Static method in class com.linecorp.armeria.common.Flags
Enables DefaultAddressResolverGroup that resolves domain name using JDK's built-in domain name lookup mechanism.
useOpenSsl() - Static method in class com.linecorp.armeria.common.Flags
Returns whether the JNI-based TLS support with OpenSSL is enabled.
USER_AGENT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "User-Agent" header field name.
UserClient<I extends Request,​O extends Response> - Class in com.linecorp.armeria.client
A base class for implementing a user's entry point for sending a Request.
UserClient(ClientBuilderParams, Client<I, O>, MeterRegistry, Function<CompletableFuture<O>, O>, BiFunction<ClientRequestContext, Throwable, O>) - Constructor for class com.linecorp.armeria.client.UserClient
Creates a new instance.
useRetryAfter(boolean) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
Whether retry should be attempted according to the retryHeader from the server or not.
username() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
Returns the configured username.
username() - Method in class com.linecorp.armeria.client.proxy.Socks4ProxyConfig
Returns the configured username.
username() - Method in class com.linecorp.armeria.client.proxy.Socks5ProxyConfig
Returns the configured username.
username() - Method in class com.linecorp.armeria.common.auth.BasicToken
Returns the username.
usesNamedEnums() - Method in class com.linecorp.armeria.common.thrift.text.TTextProtocolFactory
Returns whether the serialization of named enums is enabled.
useSsl(boolean) - Method in class com.linecorp.armeria.client.zookeeper.CuratorDiscoverySpecBuilder
Sets whether to connect an Endpoint using sslPort of ServiceInstance.
useTls() - Method in class com.linecorp.armeria.client.proxy.ConnectProxyConfig
Returns whether ssl is enabled.

V

validateEagerly(boolean) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
When calling Retrofit.create(java.lang.Class<T>) on the resulting Retrofit instance, eagerly validate the configuration of all methods in the supplied interface.
validateHeaders() - Static method in class com.linecorp.armeria.common.Flags
Enables validation of HTTP headers for dangerous characters like newlines - such characters can be used for injecting arbitrary content into HTTP responses.
validateHeaders(RequestHeaders) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
validateHeaders(RequestHeaders) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
Validates the specified RequestHeaders.
validateId(String) - Method in interface com.linecorp.armeria.server.saml.SamlRequestIdManager
Returns whether the specified ID is valid or not.
validateParams(ClientBuilderParams) - Method in interface com.linecorp.armeria.client.ClientFactory
Makes sure the specified ClientBuilderParams has the Scheme supported by this ClientFactory.
validateScheme(Scheme) - Method in interface com.linecorp.armeria.client.ClientFactory
Makes sure the specified Scheme is supported by this ClientFactory.
validateUri(URI) - Method in interface com.linecorp.armeria.client.ClientFactory
Makes sure the specified URI is supported by this ClientFactory.
value() - Method in interface com.linecorp.armeria.common.Cookie
Returns the value of this Cookie.
value() - Method in class com.linecorp.armeria.common.util.AbstractOptionValue
Returns the value of this option value holder has.
value() - Method in annotation type com.linecorp.armeria.server.annotation.AdditionalHeader
The values of the HTTP header to set.
value() - Method in annotation type com.linecorp.armeria.server.annotation.AdditionalHeaders
An array of AdditionalHeaders.
value() - Method in annotation type com.linecorp.armeria.server.annotation.AdditionalTrailer
The values of the HTTP trailer to set.
value() - Method in annotation type com.linecorp.armeria.server.annotation.AdditionalTrailers
An array of AdditionalTrailer.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Consumes
A media type string.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ConsumesGroup
An array of Consumes annotations.
value() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.CorsDecorators
An array of CorsDecorators.
value() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.LoggingDecorators
An array of LoggingDecorators.
value() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.RateLimitingDecorator
The number of requests per one second that the configured ThrottlingStrategy accepts.
value() - Method in annotation type com.linecorp.armeria.server.annotation.decorator.RateLimitingDecorators
An array of RateLimitingDecorators.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Decorator
DecoratingHttpServiceFunction implementation type.
value() - Method in annotation type com.linecorp.armeria.server.annotation.DecoratorFactory
DecoratorFactoryFunction implementation type.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Decorators
An array of Decorators.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Default
The default value to use as a fallback when the request parameter is not provided or has an empty value.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Delete
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Description
The description of a type, a field, a method or a parameter.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ExceptionHandler
ExceptionHandlerFunction implementation type.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ExceptionHandlers
An array of ExceptionHandlers.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Get
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Head
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Header
The name of the HTTP request header to bind to.
value() - Method in annotation type com.linecorp.armeria.server.annotation.MatchesHeader
The predicate which evaluates whether a request can be accepted by a service method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.MatchesHeaders
An array of MatchesHeader annotations.
value() - Method in annotation type com.linecorp.armeria.server.annotation.MatchesParam
The predicate which evaluates whether a request can be accepted by a service method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.MatchesParams
An array of MatchesParam annotations.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Options
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Order
An order of a method which is annotated by this annotation.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Param
The name of the request parameter to bind to.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Patch
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Path
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.PathPrefix
A path for the annotated service class.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Paths
An array of Paths.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Post
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Produces
A media type string.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ProducesGroup
An array of Produces annotations.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Put
A path pattern for the annotated method.
value() - Method in annotation type com.linecorp.armeria.server.annotation.RequestConverter
RequestConverterFunction implementation type.
value() - Method in annotation type com.linecorp.armeria.server.annotation.RequestConverters
An array of RequestConverters.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ResponseConverter
ResponseConverterFunction implementation type.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ResponseConverters
An array of ResponseConverters.
value() - Method in annotation type com.linecorp.armeria.server.annotation.ServiceName
A service name for the annotated service.
value() - Method in annotation type com.linecorp.armeria.server.annotation.StatusCode
A default HTTP status code of a response produced by an annotated HTTP service.
value() - Method in annotation type com.linecorp.armeria.server.annotation.Trace
A path pattern for the annotated method.
value() - Method in class com.linecorp.armeria.server.Routed
Returns the value.
value() - Method in annotation type com.linecorp.armeria.spring.LocalArmeriaPort
Specifies the SessionProtocol to get the port from the Server.
value(String) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets the value of the Cookie.
valueOf(int) - Static method in class com.linecorp.armeria.common.HttpStatus
Returns the HttpStatus represented by the specified status code.
valueOf(int) - Static method in enum com.linecorp.armeria.common.HttpStatusClass
Returns the class of the specified HTTP status code.
valueOf(String) - Static method in enum com.linecorp.armeria.client.circuitbreaker.CircuitState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.client.proxy.ProxyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.ByteBufAccessMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.HttpMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class com.linecorp.armeria.common.HttpStatus
Returns the HttpStatus represented by the specified status text.
valueOf(String) - Static method in enum com.linecorp.armeria.common.HttpStatusClass
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.logging.BuiltInProperty
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.logging.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.logging.RequestLogProperty
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.SessionProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.stream.SubscriptionOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.util.OsType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.util.TimeoutMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.annotation.ExceptionVerbosity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.docs.FieldLocation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.docs.FieldRequirement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.healthcheck.HealthCheckUpdateResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.RoutePathType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.RoutingResultType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.saml.SamlBindingProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.server.saml.SamlNameIdFormat
Returns the enum constant of this type with the specified name.
valueQuoted(boolean) - Method in class com.linecorp.armeria.common.CookieBuilder
Sets whether the value of the Cookie needs to be wrapped with double quotes when encoding.
values() - Static method in enum com.linecorp.armeria.client.circuitbreaker.CircuitState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.client.proxy.ProxyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.ByteBufAccessMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class com.linecorp.armeria.common.grpc.GrpcSerializationFormats
Returns the set of all known gRPC serialization formats.
values() - Static method in enum com.linecorp.armeria.common.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.HttpStatusClass
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.logging.BuiltInProperty
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.logging.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.logging.RequestLogProperty
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class com.linecorp.armeria.common.SerializationFormat
Returns all available SerializationFormats.
values() - Static method in enum com.linecorp.armeria.common.SessionProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.stream.SubscriptionOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class com.linecorp.armeria.common.thrift.ThriftSerializationFormats
Returns the set of all known Thrift serialization formats.
values() - Static method in enum com.linecorp.armeria.common.util.OsType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.util.TimeoutMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.annotation.ExceptionVerbosity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.linecorp.armeria.server.docs.EnumInfo
Returns the constant values defined by the type.
values() - Static method in enum com.linecorp.armeria.server.docs.FieldLocation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.docs.FieldRequirement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.healthcheck.HealthCheckUpdateResult
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.RoutePathType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.RoutingResultType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.saml.SamlBindingProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.server.saml.SamlNameIdFormat
Returns an array containing the constants of this enum type, in the order they are declared.
VARIANT_ALSO_NEGOTIATES - Static variable in class com.linecorp.armeria.common.HttpStatus
506 Variant Also Negotiates (RFC2295).
VARY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Vary" header field name.
VCARD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
VCARD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/vcard; charset=utf-8".
verboseExceptionSampler() - Static method in class com.linecorp.armeria.common.Flags
Returns the Sampler that determines whether to retain the stack trace of the exceptions that are thrown frequently by Armeria.
verboseExceptionSamplerSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the specification string of the Sampler that determines whether to retain the stack trace of the exceptions that are thrown frequently by Armeria.
verboseResponses() - Static method in class com.linecorp.armeria.common.Flags
Returns whether the verbose response mode is enabled.
verboseResponses() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns whether the verbose response mode is enabled.
verboseResponses() - Method in class com.linecorp.armeria.server.VirtualHost
Returns whether the verbose response mode is enabled.
verboseResponses(boolean) - Method in class com.linecorp.armeria.server.AnnotatedServiceBindingBuilder
 
verboseResponses(boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets whether the verbose response mode is enabled.
verboseResponses(boolean) - Method in class com.linecorp.armeria.server.ServiceBindingBuilder
 
verboseResponses(boolean) - Method in class com.linecorp.armeria.server.VirtualHostAnnotatedServiceBindingBuilder
 
verboseResponses(boolean) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Sets whether the verbose response mode is enabled.
verboseResponses(boolean) - Method in class com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
 
verboseSocketExceptions() - Static method in class com.linecorp.armeria.common.Flags
Returns whether to log the socket exceptions which are mostly harmless.
version() - Method in class com.linecorp.armeria.common.auth.OAuth1aToken
Returns the value of "version" property.
version() - Method in class com.linecorp.armeria.common.thrift.ThriftJacksonModule
 
version(String) - Method in class com.linecorp.armeria.common.auth.OAuth1aTokenBuilder
Sets the value of oauth_version property.
Version - Class in com.linecorp.armeria.common.util
Retrieves the version information of available Armeria artifacts.
vfs() - Method in class com.linecorp.armeria.server.file.FileServiceConfig
Returns the HttpVfs that provides the static files to an FileService.
VIA - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Via" header field name.
vipAddress(String) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
Sets the specified vipAddress.
vipAddress(String) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
Sets the VIP address.
virtualHost() - Method in interface com.linecorp.armeria.server.RoutingContext
Returns the VirtualHost instance which belongs to this RoutingContext.
virtualHost() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the VirtualHost the ServiceConfig.service() belongs to.
virtualHost(String) - Method in class com.linecorp.armeria.server.ServerBuilder
virtualHost(String, String) - Method in class com.linecorp.armeria.server.ServerBuilder
VirtualHost - Class in com.linecorp.armeria.server
VirtualHostAnnotatedServiceBindingBuilder - Class in com.linecorp.armeria.server
A builder class for binding an HttpService to a virtual host fluently.
VirtualHostBuilder - Class in com.linecorp.armeria.server
Builds a new VirtualHost.
VirtualHostDecoratingServiceBindingBuilder - Class in com.linecorp.armeria.server
A builder class for binding a decorator to a Route fluently.
virtualHosts() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the List of available VirtualHosts.
VirtualHostServiceBindingBuilder - Class in com.linecorp.armeria.server
A builder class for binding an HttpService fluently.
VND_REAL_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Real Audio.
VND_REAL_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/vnd.rn-realaudio".
VND_WAVE_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
WAVE format, as defined by RFC 2361.
VND_WAVE_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/vnd.wave".
voidFunction(BiConsumer<T, U>) - Static method in class com.linecorp.armeria.common.util.Functions
Converts the specified BiConsumer into a BiFunction that returns null.
voidFunction(Consumer<T>) - Static method in class com.linecorp.armeria.common.util.Functions
Converts the specified Consumer into a Function that returns null.
VORBIS_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Vorbis Audio, as defined by RFC 5215.
VORBIS_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/vorbis".
VTT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
As described in the VTT spec, this is used for Web Video Text Tracks (WebVTT) files, used with the HTML5 track element.
VTT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/vtt; charset=utf-8".

W

WARN - com.linecorp.armeria.common.logging.LogLevel
WARN log level.
WARN - Static variable in interface com.linecorp.armeria.server.RejectedRouteHandler
A RejectedRouteHandler that logs a warning message for a problematic Route.
WARNING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "Warning" header field name.
WASM_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaType
WASM applications.
WASM_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/wasm".
WAX_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Windows Media metafiles.
WAX_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/x-ms-wax".
WebClient - Interface in com.linecorp.armeria.client
An asynchronous web client.
WebClientBuilder - Class in com.linecorp.armeria.client
Creates a new web client that connects to the specified URI using the builder pattern.
webClientCustomizer(ClientHttpConnector) - Method in class com.linecorp.armeria.spring.web.reactive.ArmeriaClientAutoConfiguration
Returns a WebClientCustomizer which sets an ArmeriaClientHttpConnector to the WebClient.Builder.
WEBM_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
WEBM_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/webm".
WEBM_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
WEBM_VIDEO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/webm".
WEBP - Static variable in class com.linecorp.armeria.common.MediaType
WEBP - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"image/webp".
weight() - Method in class com.linecorp.armeria.client.Endpoint
Returns the weight of this endpoint.
weightedRoundRobin() - Static method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Returns a weighted round-robin strategy.
whenAvailable(RequestLogProperty) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns a CompletableFuture which will be completed when the specified RequestLogProperty is collected.
whenAvailable(RequestLogProperty...) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns a CompletableFuture which will be completed when all the specified RequestLogPropertys are collected.
whenAvailable(Iterable<RequestLogProperty>) - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns a CompletableFuture which will be completed when all the specified RequestLogPropertys are collected.
whenClosed() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
whenClosed() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
whenClosed() - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer
Returns a CompletableFuture which will be completed when this deframer has been closed.
whenClosed() - Method in class com.linecorp.armeria.common.util.AsyncCloseableSupport
 
whenClosed() - Method in interface com.linecorp.armeria.common.util.ListenableAsyncCloseable
Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.
whenClosed() - Method in class com.linecorp.armeria.common.util.StartStopSupport
 
whenClosed() - Method in class com.linecorp.armeria.server.Server
 
whenComplete() - Method in interface com.linecorp.armeria.common.HttpResponse
 
whenComplete() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns a CompletableFuture which will be completed when the Request has been processed completely and thus all properties of the RequestLog have been collected.
whenComplete() - Method in interface com.linecorp.armeria.common.Response
Returns a CompletableFuture which completes when 1) the response stream has been closed (the StreamMessage has been completed) or 2) the result value is set (the CompletionStage has completed.)
whenComplete() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns a CompletableFuture which completes when this RpcResponse completes.
whenComplete() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
whenComplete() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
whenComplete() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns a CompletableFuture that completes when this stream is complete, either successfully or exceptionally, including cancellation and abortion.
whenComplete() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
whenConsumed() - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Returns a CompletableFuture which is completed when all elements written so far have been consumed by the Subscriber.
whenReady() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Returns the CompletableFuture which is completed when the initial Endpoints are ready.
whenReady() - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Returns a CompletableFuture which is completed when the initial Endpoints are ready.
whenReady() - Method in class com.linecorp.armeria.client.Endpoint
 
whenRequestCancelled() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
whenRequestCancelled() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns a CompletableFuture which is completed with a Throwable cancellation cause after the ServiceRequestContext has been cancelled.
whenRequestCancelled() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
whenRequestCancelling() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
whenRequestCancelling() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns a CompletableFuture which is completed with a Throwable cancellation cause when the ServiceRequestContext is about to get cancelled.
whenRequestCancelling() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
whenRequestComplete() - Method in interface com.linecorp.armeria.common.logging.RequestLogAccess
Returns a CompletableFuture which will be completed when the Request has been consumed completely and thus all properties of the RequestOnlyLog have been collected.
whenRequestTimedOut() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
Deprecated.
whenRequestTimedOut() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
whenRequestTimedOut() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
Deprecated.
whenRequestTimingOut() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
Deprecated.
whenRequestTimingOut() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
whenRequestTimingOut() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
Deprecated.
whenResponseCancelled() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a CompletableFuture which is completed with a Throwable cancellation cause after the ClientRequestContext has been cancelled.
whenResponseCancelled() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
whenResponseCancelled() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
whenResponseCancelling() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns a CompletableFuture which is completed with a Throwable cancellation cause when the ClientRequestContext is about to get cancelled.
whenResponseCancelling() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
whenResponseCancelling() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
whenResponseTimedOut() - Method in interface com.linecorp.armeria.client.ClientRequestContext
whenResponseTimedOut() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
Deprecated.
whenResponseTimedOut() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
Deprecated.
whenResponseTimingOut() - Method in interface com.linecorp.armeria.client.ClientRequestContext
whenResponseTimingOut() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
Deprecated.
whenResponseTimingOut() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
Deprecated.
whenStarted(Iterable<? extends Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds Consumers invoked when the Server is started.
whenStarted(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds a Consumer invoked when the Server is started.
whenStarted(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds Consumers invoked when the Server is started.
whenStarting(Iterable<? extends Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds Consumers invoked when the Server is starting.
whenStarting(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds a Consumer invoked when the Server is starting.
whenStarting(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds Consumers invoked when the Server is starting.
whenStopped(Iterable<? extends Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopped.
whenStopped(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add a Consumer invoked when the Server is stopped.
whenStopped(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopped.
whenStopping(Iterable<? extends Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopping.
whenStopping(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Adds a Consumer invoked when the Server is stopping.
whenStopping(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopping.
WIN_DOMAIN_QUALIFIED - com.linecorp.armeria.server.saml.SamlNameIdFormat
Windows domain qualified name format.
WINDOWS - com.linecorp.armeria.common.util.OsType
 
WITH_POOLED_OBJECTS - com.linecorp.armeria.common.stream.SubscriptionOption
(Advanced users only) To receive the pooled HttpData as is, without making a copy.
withCharset(Charset) - Method in class com.linecorp.armeria.common.MediaType
Returns a new instance with the same type and subtype as this instance, with the charset parameter set to the name of the given charset.
withClientOptions(Function<? super ClientOptionsBuilder, ClientOptionsBuilder>) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder
Sets the Function that customizes a Client that sends health check requests.
withClientOptions(Function<? super ClientOptionsBuilder, ClientOptionsBuilder>) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder
 
withContextCustomizer(Consumer<? super ClientRequestContext>) - Static method in class com.linecorp.armeria.client.Clients
Sets the specified ClientRequestContext customization function in a thread-local variable so that the customized context is used when the client invokes a request from the current thread.
withDefaultPort(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified default port number.
withDefaultVirtualHost(Consumer<? super VirtualHostBuilder>) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures the default VirtualHost with the customizer.
withEndOfStream() - Method in interface com.linecorp.armeria.common.HttpData
Returns the HttpData that has the same content with this data and its HTTP/2 endOfStream flag set.
withEndOfStream(boolean) - Method in interface com.linecorp.armeria.common.HttpData
Returns the HttpData that has the same content with this data and its HTTP/2 endOfStream flag set with the specified value.
withHeader(CharSequence, Object) - Static method in class com.linecorp.armeria.client.Clients
Sets the specified HTTP header in a thread-local variable so that the header is sent by the client call made from the current thread.
withHeader(CharSequence, String) - Static method in class com.linecorp.armeria.client.Clients
Sets the specified HTTP header in a thread-local variable so that the header is sent by the client call made from the current thread.
withHeaders(RequestHeaders) - Method in interface com.linecorp.armeria.common.HttpRequest
Returns a new HttpRequest derived from this HttpRequest by replacing its RequestHeaders with the specified newHeaders.
withHeaders(RequestHeadersBuilder) - Method in interface com.linecorp.armeria.common.HttpRequest
Returns a new HttpRequest derived from this HttpRequest by replacing its RequestHeaders with what's built from the specified newHeadersBuilder.
withHeaders(Consumer<HttpHeadersBuilder>) - Static method in class com.linecorp.armeria.client.Clients
Sets the specified Consumer, which mutates HTTP headers, in a thread-local variable so that the mutated headers are sent by the client call made from the current thread.
withIpAddr(String) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified IP address.
withJitter(double) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that adds a random jitter value to the original delay using full jitter strategy.
withJitter(double, double) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that adds a random jitter value to the original delay using full jitter strategy.
withJitter(double, double, Supplier<Random>) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that adds a random jitter value to the original delay using full jitter strategy.
withMaxAttempts(int) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff which limits the number of attempts up to the specified value.
withMutations(Consumer<CookieBuilder>) - Method in interface com.linecorp.armeria.common.Cookie
Returns a new Cookie which is the result from the mutation by the specified Consumer.
withMutations(Consumer<HttpHeadersBuilder>) - Method in interface com.linecorp.armeria.common.HttpHeaders
Returns a new headers which is the result from the mutation by the specified Consumer.
withMutations(Consumer<HttpHeadersBuilder>) - Method in interface com.linecorp.armeria.common.RequestHeaders
 
withMutations(Consumer<HttpHeadersBuilder>) - Method in interface com.linecorp.armeria.common.ResponseHeaders
 
withMutations(Consumer<QueryParamsBuilder>) - Method in interface com.linecorp.armeria.common.QueryParams
Returns new parameters which is the result from the mutation by the specified Consumer.
withoutContext() - Method in interface com.linecorp.armeria.common.ContextAwareEventLoop
Returns the EventLoop that is executing submitted tasks without setting the RequestContext.
withoutContext() - Method in interface com.linecorp.armeria.common.ContextAwareScheduledExecutorService
Returns the ScheduledExecutorService that is executing submitted tasks without setting the RequestContext.
withoutDefaultPort(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the default port number removed.
withoutDelay() - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that will never wait between attempts.
withoutParameters() - Method in class com.linecorp.armeria.common.MediaType
Returns a new instance with the same type and subtype as this instance, but without any parameters.
withoutPort() - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with its port number unspecified.
withParameter(String, String) - Method in class com.linecorp.armeria.common.MediaType
Replaces all parameters with the given attribute with a single parameter with the given value.
withParameters(String, Iterable<String>) - Method in class com.linecorp.armeria.common.MediaType
Replaces all parameters with the given attribute with parameters using the given values.
withParameters(Map<String, ? extends Iterable<String>>) - Method in class com.linecorp.armeria.common.MediaType
Replaces all parameters with the given parameters.
withPort(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified port number.
withRoute(Consumer<? super ServiceBindingBuilder>) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures an HttpService of the default VirtualHost with the customizer.
withRoute(Consumer<? super VirtualHostServiceBindingBuilder>) - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Configures an HttpService of the VirtualHost with the customizer.
withTags(Iterable<Tag>) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified tags.
withTags(Iterable<Tag>) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified labels added.
withTags(String...) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified tags.
withTags(String...) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified label added.
withVirtualHost(Consumer<? super VirtualHostBuilder>) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures a VirtualHost with the customizer.
withWeight(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified weight.
WMA_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Windows Media Audio.
WMA_AUDIO - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"audio/x-ms-wma".
WML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
WML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/vnd.wap.wml; charset=utf-8".
WMV - Static variable in class com.linecorp.armeria.common.MediaType
 
WMV - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"video/x-ms-wmv".
WOFF - Static variable in class com.linecorp.armeria.common.MediaType
Web Open Font Format (WOFF) defined by the W3C.
WOFF - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/font-woff".
WOFF2 - Static variable in class com.linecorp.armeria.common.MediaType
Web Open Font Format (WOFF) version 2 defined by the W3C.
WOFF2 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/font-woff2".
WORKER_GROUP - Static variable in class com.linecorp.armeria.client.ClientFactoryOptions
The worker EventLoopGroup.
workerGroup() - Method in class com.linecorp.armeria.client.ClientFactoryOptions
Returns the worker EventLoopGroup.
workerGroup() - Static method in class com.linecorp.armeria.common.CommonPools
workerGroup() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the worker EventLoopGroup which is responsible for performing socket I/O and running Service.serve(ServiceRequestContext, Request).
workerGroup(EventLoopGroup, boolean) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the worker EventLoopGroup which is responsible for performing socket I/O and running Client.execute(ClientRequestContext, Request).
workerGroup(EventLoopGroup, boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the worker EventLoopGroup which is responsible for performing socket I/O and running Service.serve(ServiceRequestContext, Request).
wrap(byte[]) - Static method in interface com.linecorp.armeria.common.HttpData
Creates a new instance from the specified byte array.
wrap(byte[], int, int) - Static method in interface com.linecorp.armeria.common.HttpData
Creates a new instance from the specified byte array, offset and length.
wrap(ByteBuf) - Static method in interface com.linecorp.armeria.common.HttpData
(Advanced users only) Converts the specified Netty ByteBuf into a pooled HttpData.
wrap(CompletableFuture<U>) - Static method in class com.linecorp.armeria.common.util.UnmodifiableFuture
Returns an UnmodifiableFuture which will be completed when the specified CompletableFuture is completed.
write(Supplier<? extends T>) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object Supplier to the StreamMessage.
write(T) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object to the StreamMessage.
WRITE_TIMEOUT_MILLIS - Static variable in class com.linecorp.armeria.client.ClientOptions
The timeout of a socket write.
writePayload(ByteBuf) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
Writes out a payload message.
writePayload(ByteBuf, boolean) - Method in class com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageFramer
Writes out a payload message.
writeTimeout(Duration) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the timeout of a socket write attempt.
writeTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientBuilder
 
writeTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
writeTimeout(Duration) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
writeTimeout(Duration) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
writeTimeout(Duration) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
writeTimeout(Duration) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
WriteTimeoutException - Exception in com.linecorp.armeria.client
A TimeoutException raised when a client failed to send a request to the wire within timeout.
writeTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the timeout of a socket write.
writeTimeoutMillis() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the amount of time allowed until the initial write attempt of the current Request succeeds.
writeTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
writeTimeoutMillis() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.client.AbstractClientOptionsBuilder
Sets the timeout of a socket write attempt in milliseconds.
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientBuilder
 
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
 
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder
 
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder
 
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.client.WebClientBuilder
 
writeTimeoutMillis(long) - Method in class com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder
 
writeTo(CodedOutputStream) - Method in class com.linecorp.armeria.common.grpc.StackTraceElementProto
 
writeTo(CodedOutputStream) - Method in class com.linecorp.armeria.common.grpc.ThrowableProto
 
WWW_AUTHENTICATE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "WWW-Authenticate" header field name.

X

X_CONTENT_TYPE_OPTIONS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Content-Type-Options" header field name.
X_DNS_PREFETCH_CONTROL - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP X-DNS-Prefetch-Control header controls DNS prefetch behavior.
X_DO_NOT_TRACK - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Do-Not-Track" header field name.
X_DOWNLOAD_OPTIONS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Download-Options" header field name.
X_FORWARDED_FOR - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Forwarded-For" header field name (superseded by "Forwarded").
X_FORWARDED_HOST - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Forwarded-Host" header field name.
X_FORWARDED_PORT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Forwarded-Port" header field name.
X_FORWARDED_PROTO - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Forwarded-Proto" header field name.
X_FRAME_OPTIONS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Frame-Options" header field name.
X_POWERED_BY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Powered-By" header field name.
X_RATE_LIMIT - Static variable in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders
Describes another alternative RateLimit Header Scheme for HTTP, used by Twitter.
X_RATELIMIT - Static variable in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders
Describes an alternative RateLimit Header Scheme for HTTP, used by Github and Vimeo.
X_REQUESTED_WITH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-Requested-With" header field name.
X_USER_IP - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-User-IP" header field name.
X_XSS_PROTECTION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
The HTTP "X-XSS-Protection" header field name.
X509_SUBJECT - com.linecorp.armeria.server.saml.SamlNameIdFormat
X509 subject name format.
XHTML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
XHTML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/xhtml+xml; charset=utf-8".
XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
As described in RFC 3023, this constant (text/xml) is used for XML documents that are "readable by casual users."
XML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"text/xml; charset=utf-8".
XRD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
Extensible Resource Descriptors.
XRD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/xrd+xml; charset=utf-8".

Z

ZERO - Static variable in class com.linecorp.armeria.client.circuitbreaker.EventCount
An EventCount without any successes and failures.
ZIP - Static variable in class com.linecorp.armeria.common.MediaType
 
ZIP - Static variable in class com.linecorp.armeria.common.MediaTypeNames
"application/zip".
znodePath() - Method in class com.linecorp.armeria.common.zookeeper.AbstractCuratorFrameworkBuilder
Returns the znode Path.
ZooKeeperDiscoverySpec - Interface in com.linecorp.armeria.client.zookeeper
A discovery specification for ZooKeeperEndpointGroup.
ZooKeeperEndpointGroup - Class in com.linecorp.armeria.client.zookeeper
A ZooKeeper-based EndpointGroup implementation.
ZooKeeperEndpointGroupBuilder - Class in com.linecorp.armeria.client.zookeeper
ZooKeeperRegistrationSpec - Interface in com.linecorp.armeria.server.zookeeper
A registration specification for ZooKeeperUpdatingListener.
ZooKeeperUpdatingListener - Class in com.linecorp.armeria.server.zookeeper
A ServerListener which registers the current Server to ZooKeeper as an ephemeral node.
ZooKeeperUpdatingListenerBuilder - Class in com.linecorp.armeria.server.zookeeper
Builds a new ZooKeeperUpdatingListener, which registers the server to a ZooKeeper cluster.
A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes|All Packages