Skip navigation links
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 

A

AAC_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Advanced Audio Coding.
abort() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
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
Cancels the Subscription if any and closes this publisher.
AbstractClientFactory - Class in com.linecorp.armeria.client
A skeletal ClientFactory implementation.
AbstractClientFactory() - Constructor for class com.linecorp.armeria.client.AbstractClientFactory
 
AbstractCompositeService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.composition
A skeletal Service implementation that enables composing multiple Services into one.
AbstractCompositeService(CompositeServiceEntry<? super I, ? extends O>...) - Constructor for class com.linecorp.armeria.server.composition.AbstractCompositeService
Creates a new instance with the specified CompositeServiceEntrys.
AbstractCompositeService(Iterable<CompositeServiceEntry<? super I, ? extends O>>) - Constructor for class com.linecorp.armeria.server.composition.AbstractCompositeService
Creates a new instance with the specified CompositeServiceEntrys.
AbstractCompositeServiceBuilder<T extends AbstractCompositeServiceBuilder<T,I,O>,I extends Request,O extends Response> - Class in com.linecorp.armeria.server.composition
A skeletal builder implementation for AbstractCompositeService and its subclasses.
AbstractCompositeServiceBuilder() - Constructor for class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Creates a new instance.
AbstractEntry(String, String) - Constructor for class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
Creates a new instance with the specified path.
AbstractEntry(String, MediaType, String) - Constructor for class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
Creates a new instance with the specified path and mediaType.
AbstractHttp2ConnectionHandler - Class in com.linecorp.armeria.internal.http
An Http2ConnectionHandler with some workarounds and additional extension points.
AbstractHttp2ConnectionHandler(Http2ConnectionDecoder, Http2ConnectionEncoder, Http2Settings) - Constructor for class com.linecorp.armeria.internal.http.AbstractHttp2ConnectionHandler
Creates a new instance.
AbstractHttpService - Class in com.linecorp.armeria.server.http
A skeletal HttpService for easier HTTP service implementation.
AbstractHttpService() - Constructor for class com.linecorp.armeria.server.http.AbstractHttpService
 
AbstractOption<T> - Class in com.linecorp.armeria.common.util
A configuration option.
AbstractOption(int, String) - Constructor for class com.linecorp.armeria.common.util.AbstractOption
Creates a new instance.
AbstractOptions - Class in com.linecorp.armeria.common.util
A set of configuration options and their respective values.
AbstractOptions(Function<T, T>, T...) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
Creates a new instance.
AbstractOptions(Function<T, T>, Iterable<T>) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
Creates a new instance.
AbstractOptions(Function<T, T>, AbstractOptions, T...) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
Creates a new instance.
AbstractOptions(Function<T, T>, AbstractOptions, Iterable<T>) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
Creates a new instance.
AbstractOptions(AbstractOptions, AbstractOptions) - Constructor for class com.linecorp.armeria.common.util.AbstractOptions
Creates a new instance by merging two options.
AbstractOptionValue<O extends AbstractOption<V>,V> - Class in com.linecorp.armeria.common.util
A holder of a value of an AbstractOption.
AbstractOptionValue(O, V) - Constructor for class com.linecorp.armeria.common.util.AbstractOptionValue
Creates a new instance with the specified option and value.
AbstractPathMapping - Class in com.linecorp.armeria.server
A skeletal PathMapping implementation.
AbstractPathMapping() - Constructor for class com.linecorp.armeria.server.AbstractPathMapping
 
AbstractRequestContext - Class in com.linecorp.armeria.common
A skeletal RequestContext implementation.
AbstractRequestContext() - Constructor for class com.linecorp.armeria.common.AbstractRequestContext
 
ACCEPT - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"accept".
ACCEPT_CHARSET - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"accept-charset".
ACCEPT_ENCODING - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"accept-encoding".
ACCEPT_LANGUAGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"accept-language".
ACCEPT_PATCH - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"accept-patch".
ACCEPT_RANGES - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"accept-ranges".
ACCEPTED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
202 Accepted.
ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-allow-credentials".
ACCESS_CONTROL_ALLOW_HEADERS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-allow-headers".
ACCESS_CONTROL_ALLOW_METHODS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-allow-methods".
ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-allow-origin".
ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-expose-headers".
ACCESS_CONTROL_MAX_AGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-max-age".
ACCESS_CONTROL_REQUEST_HEADERS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-request-headers".
ACCESS_CONTROL_REQUEST_METHOD - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"access-control-request-method".
accessToken() - Method in class com.linecorp.armeria.server.http.auth.OAuth2Token
 
acquire(K) - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
 
acquire(K, Promise<Channel>) - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
 
acquire(K) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Acquires a Channel with the specified key.
acquire(K, Promise<Channel>) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Acquires a Channel with the specified key and get notified with the specified Promise.
activePort() - Method in class com.linecorp.armeria.server.Server
Returns the primary ServerPort that this Server is listening to.
activePorts() - Method in class com.linecorp.armeria.server.Server
Returns all ServerPorts that this Server is listening to.
actual() - Method in exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Returns the actual SessionProtocol.
add(Class<I>, Class<O>, Function<T, R>) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
Adds a new decorator Function.
add(Authorizer<HttpRequest>) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Adds an Authorizer.
add(Iterable<? extends Authorizer<HttpRequest>>) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Adds multiple Authorizers.
add(PathMapping, T) - Method in class com.linecorp.armeria.server.PathMappings
Adds the mapping from the specified PathMapping to the specified value.
addBasicAuth(Authorizer<? super BasicToken>) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Adds an HTTP basic Authorizer.
addConverter(Class<?>, ResponseConverter) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Adds a mapping from Class to ResponseConverter.
additionals() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
Returns additional (or, user-defined) parameters.
addListener(RequestLogListener, RequestLogAvailability) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
addListener(RequestLogListener, RequestLogAvailability...) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
addListener(RequestLogListener, Iterable<RequestLogAvailability>) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
addListener(RequestLogListener, RequestLogAvailability) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Adds the specified RequestLogListener so that it's notified when the specified RequestLogAvailability is satisfied.
addListener(RequestLogListener, RequestLogAvailability...) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.
addListener(RequestLogListener, Iterable<RequestLogAvailability>) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.
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.
addMapping(HttpMethod, String, DynamicHttpFunction) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Adds a new dynamic-mapped method, invoked with given HttpMethod and (dynamically-bound) path, runs synchronously.
addMapping(HttpMethod, String, DynamicHttpFunction, ResponseConverter) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Adds a new dynamic-mapped method, invoked with given HttpMethod and (dynamically-bound) path, runs synchronously.
addMapping(Iterable<HttpMethod>, String, DynamicHttpFunction) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Adds a new dynamic-mapped method, invoked with given HttpMethods and (dynamically-bound) path, runs synchronously.
addMapping(Iterable<HttpMethod>, String, DynamicHttpFunction, ResponseConverter) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Adds a new dynamic-mapped method, invoked with given HttpMethods and (dynamically-bound) path, runs synchronously.
addMappings(Object) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Add the Path annotated methods in given object.
addOAuth1a(Authorizer<? super OAuth1aToken>) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Adds an OAuth1a Authorizer.
addOAuth2(Authorizer<? super OAuth2Token>) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Adds an OAuth2 Authorizer.
ADDRESS_RESOLVER_GROUP - Static variable in class com.linecorp.armeria.client.SessionOption
The AddressResolverGroup to use to resolve remote addresses into InetSocketAddresses.
addressResolverGroup() - Method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOption.ADDRESS_RESOLVER_GROUP if non-default was specified.
AGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"age".
aggregate() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Aggregates this request.
aggregate(Executor) - Method in interface com.linecorp.armeria.common.http.HttpRequest
Aggregates this request.
aggregate() - Method in interface com.linecorp.armeria.common.http.HttpResponse
Aggregates this response.
aggregate(Executor) - Method in interface com.linecorp.armeria.common.http.HttpResponse
Aggregates this response.
AggregatedHttpMessage - Interface in com.linecorp.armeria.common.http
A complete HTTP message whose content is readily available as a single HttpData.
AllInOneClientFactory - Class in com.linecorp.armeria.client
A ClientFactory which combines all discovered ClientFactory implementations.
AllInOneClientFactory() - Constructor for class com.linecorp.armeria.client.AllInOneClientFactory
Creates a new instance with the default SessionOptions.
AllInOneClientFactory(boolean) - Constructor for class com.linecorp.armeria.client.AllInOneClientFactory
Creates a new instance with the default SessionOptions.
AllInOneClientFactory(SessionOptions) - Constructor for class com.linecorp.armeria.client.AllInOneClientFactory
Creates a new instance with the specified SessionOptions.
AllInOneClientFactory(SessionOptions, boolean) - Constructor for class com.linecorp.armeria.client.AllInOneClientFactory
Creates a new instance with the specified SessionOptions.
ALLOW - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"allow".
allowCredentials() - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
By default cookies are not included in CORS requests, but this method will enable cookies to be added to CORS requests.
allowedRequestHeaders() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Returns the allowed set of Request Headers.
allowedRequestMethods() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Returns the allowed set of Request Methods.
allowNullOrigin() - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system.
allowRequestHeaders(String...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers' response header.
allowRequestHeaders(AsciiString...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers' response header.
allowRequestMethods(HttpMethod...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Specifies the allowed set of HTTP Request Methods that should be returned in the CORS 'Access-Control-Request-Method' response header.
and() - Method in class com.linecorp.armeria.server.ChainedVirtualHostBuilder
Returns the parent ServerBuilder.
andThen(RequestLogListener) - Method in interface com.linecorp.armeria.common.logging.RequestLogListener
Returns a composed listener that calls this listener first and then the specified one.
ANY_APPLICATION_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
 
ANY_AUDIO_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
 
ANY_IMAGE_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
 
ANY_TEXT_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
 
ANY_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
 
ANY_VIDEO_TYPE - Static variable in class com.linecorp.armeria.common.MediaType
 
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
appendEpoch(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Formats the given epoch time to typical human-readable format "yyyy-MM-dd'T'HH_mm:ss.SSSX" and appends it to the specified StringBuilder.
appendSize(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Appends the human-readable representation of the specified byte-unit size to the specified StringBuffer.
APPLE_MOBILE_CONFIG - Static variable in class com.linecorp.armeria.common.MediaType
APPLE_PASSBOOK - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Apple Passbook.
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_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." MediaType.XML_UTF_8 is provided for documents that may be read by users.
apply(String) - Method in class com.linecorp.armeria.server.AbstractPathMapping
Matches the specified path and translates the matched path to another path string.
apply(String) - Method in interface com.linecorp.armeria.server.PathMapping
Matches the specified path and translates the matched path to another path string.
apply(String) - Method in class com.linecorp.armeria.server.PathMappings
Finds the Service whose PathMapping matches the specified path.
ArmeriaHttpUtil - Class in com.linecorp.armeria.internal.http
Provides various utility functions for internal use related with HTTP.
array() - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
array() - Method in interface com.linecorp.armeria.common.http.HttpData
Returns the underlying byte array of this data.
artifactId() - Method in class com.linecorp.armeria.common.util.Version
 
artifactVersion() - Method in class com.linecorp.armeria.common.util.Version
 
as(Class<T>) - Method in class com.linecorp.armeria.server.DecoratingService
 
as(Class<T>) - Method in interface com.linecorp.armeria.server.Service
Undecorates this Service to find the Service which is an instance of the specified serviceType.
asImmutable() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns the immutable view of this headers.
asMap() - Method in class com.linecorp.armeria.client.ClientOptions
Converts this ClientOptions to a Map.
asMap() - Method in class com.linecorp.armeria.client.SessionOptions
Converts this SessionOptions to a Map.
asMap0() - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns the Map whose key is AbstractOption and value is AbstractOptionValue.
asTypeInfo() - Method in enum com.linecorp.armeria.server.docs.Type
Returns the TypeInfo of this base type.
ATOM_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
attr(AttributeKey<T>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
attr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
attr(AttributeKey<T>) - Method in class com.linecorp.armeria.internal.DefaultAttributeMap
 
attrs() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
attrs() - Method in interface com.linecorp.armeria.common.RequestContext
Returns all Attributes set in this context.
attrs() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
attrs() - Method in class com.linecorp.armeria.internal.DefaultAttributeMap
Returns all Attributes this map contains.
authority() - Method in class com.linecorp.armeria.client.Endpoint
Converts this endpoint into the authority part of a URI.
authority() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the AUTHORITY of this message, in the form of "hostname:port".
authority() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
authority(String) - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
AUTHORITY - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
":authority".
authority() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Gets the HttpHeaderNames.AUTHORITY header or null if there is no such header.
authority(String) - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Sets the HttpHeaderNames.AUTHORITY header.
authority() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Returns the authority of this request.
authority(String) - Method in interface com.linecorp.armeria.common.http.HttpRequest
Sets the authority of this request.
AUTHORIZATION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"authorization".
authorize(ServiceRequestContext, T) - Method in interface com.linecorp.armeria.server.http.auth.Authorizer
Authorizes the given data.
authorize(HttpRequest, ServiceRequestContext) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthService
Determine if request is authorized for this service.
Authorizer<T> - Interface in com.linecorp.armeria.server.http.auth
Determines whether a given data is authorized for the service registered in.
AuthTokenExtractors - Class in com.linecorp.armeria.server.http.auth
A utility class that provides singleton instances of authorization token extractor functions.
availabilities() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
availabilities() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the set of satisfied RequestLogAvailabilitys.
availableMimeTypes() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the set of available MIME types of this endpoint.

B

BAD_GATEWAY - Static variable in class com.linecorp.armeria.common.http.HttpStatus
502 Bad Gateway.
BAD_REQUEST - Static variable in class com.linecorp.armeria.common.http.HttpStatus
400 Bad Request.
BASIC - Static variable in class com.linecorp.armeria.server.http.auth.AuthTokenExtractors
A BasicToken extractor function instance.
BASIC_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Basic Audio, as defined by RFC 2046.
BasicToken - Class in com.linecorp.armeria.server.http.auth
beforeComplete(Subscriber<? super U>) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
A callback executed just before calling Subscriber.onComplete() on subscriber.
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.
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.
BINARY - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The 'binary' type.
blockingTaskExecutor() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
blockingTaskExecutor(Executor) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the Executor dedicated to the execution of blocking tasks or invocations.
blockingTaskExecutor() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ExecutorService dedicated to the execution of blocking tasks or invocations.
blockingTaskExecutor() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the ExecutorService that could be used for executing a potentially long-running task.
blockingTaskExecutor() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
BMP - Static variable in class com.linecorp.armeria.common.MediaType
 
BOOL - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The 'boolean' type.
build() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Builds a CircuitBreaker instance.
build(Class<T>) - Method in class com.linecorp.armeria.client.ClientBuilder
Creates a new client which implements the specified clientType.
build() - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
Creates a new ClientDecoration with the decorators added so far via ClientDecorationBuilder.add(Class, Class, Function).
build() - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
Creates a new ClientOptions.
build() - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
Creates a new SimpleCompositeService with the Services added by the service*() methods.
build(Service<? super HttpRequest, ? extends HttpResponse>) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Creates a new HttpAuthService instance with the given delegate and all of the authorization Authorizers.
build(Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Builds a CorsConfig with settings specified by previous method calls.
build() - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
Creates a new DynamicHttpService with the configuration properties set so far.
build() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Creates a new HttpFileService.
build(RequestLog) - Method in interface com.linecorp.armeria.server.logging.structured.StructuredLogBuilder
Builds a structured log instance based on a given RequestLog.
build() - Method in class com.linecorp.armeria.server.ServerBuilder
Creates a new Server with the configuration properties set so far.
build() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
Creates a new VirtualHost.
ByteArrayEntry(String, byte[]) - Constructor for class com.linecorp.armeria.server.http.file.HttpVfs.ByteArrayEntry
Creates a new instance with the specified path and byte array.
ByteArrayEntry(String, byte[], long) - Constructor for class com.linecorp.armeria.server.http.file.HttpVfs.ByteArrayEntry
Creates a new instance with the specified path and byte array.
ByteArrayEntry(String, MediaType, byte[]) - Constructor for class com.linecorp.armeria.server.http.file.HttpVfs.ByteArrayEntry
Creates a new instance with the specified path, mediaType and byte array.
ByteArrayEntry(String, MediaType, byte[], long) - Constructor for class com.linecorp.armeria.server.http.file.HttpVfs.ByteArrayEntry
Creates a new instance with the specified path, mediaType and byte array.
BZIP2 - Static variable in class com.linecorp.armeria.common.MediaType
 

C

CACHE_CONTROL - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"cache-control".
CACHE_MANIFEST_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
cancel(boolean) - Method in class com.linecorp.armeria.common.DefaultRpcResponse
 
CancelledSubscriptionException - Exception in com.linecorp.armeria.common.stream
A RuntimeException that is raised to notify StreamMessage.closeFuture() when a Subscriber has cancelled its Subscription.
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.
cause() - Method in class com.linecorp.armeria.common.DefaultRpcResponse
 
cause() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns the cause of the failure if this RpcResponse completed exceptionally.
ChainedVirtualHostBuilder - Class in com.linecorp.armeria.server
Builds a new VirtualHost.
channel() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
channel() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
channel() - Method in interface com.linecorp.armeria.common.logging.RequestLog
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
 
channelAcquired(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
channelAcquired(K, Channel) - Method in class com.linecorp.armeria.client.pool.DecoratingKeyedChannelPoolHandler
 
channelAcquired(K, Channel) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPoolHandler
Invoked when the specified channel has been acquired from the pool.
channelAcquired(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerAdapter
 
channelClosed(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
channelClosed(K, Channel) - Method in class com.linecorp.armeria.client.pool.DecoratingKeyedChannelPoolHandler
 
channelClosed(K, Channel) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPoolHandler
Invoked when the specified channel has been closed and removed from the pool.
channelClosed(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerAdapter
 
channelCreated(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
channelCreated(K, Channel) - Method in class com.linecorp.armeria.client.pool.DecoratingKeyedChannelPoolHandler
 
channelCreated(K, Channel) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPoolHandler
Invoked when the specified channel has been created for the specified key.
channelCreated(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerAdapter
 
channelIdle(ChannelHandlerContext, IdleStateEvent) - Method in class com.linecorp.armeria.internal.IdleTimeoutHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
channelReadComplete(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
channelRegistered(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.TrafficLoggingHandler
 
channelReleased(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
channelReleased(K, Channel) - Method in class com.linecorp.armeria.client.pool.DecoratingKeyedChannelPoolHandler
 
channelReleased(K, Channel) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPoolHandler
Invoked when the specified channel has been released to the pool.
channelReleased(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerAdapter
 
channelUnregistered(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.TrafficLoggingHandler
 
channelWritabilityChanged(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
charset() - Method in class com.linecorp.armeria.common.MediaType
Returns an optional charset for the value of the charset parameter if it is specified.
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.
CircuitBreakerBuilder(String) - Constructor for class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Creates a new CircuitBreakerBuilder with the specified name.
CircuitBreakerBuilder() - Constructor for class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Creates a new CircuitBreakerBuilder.
CircuitBreakerClient<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.
CircuitBreakerListener - Interface in com.linecorp.armeria.client.circuitbreaker
The listener interface for receiving CircuitBreaker events.
CircuitBreakerMapping - Interface in com.linecorp.armeria.client.circuitbreaker
Returns a CircuitBreaker instance from remote invocation parameters.
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.
CircuitState - Enum in com.linecorp.armeria.client.circuitbreaker
Defines the states of circuit breaker.
classes() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the metadata about the structs, enums and exceptions related with the service.
classes() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the structs, enums and exceptions related with the services in this specification.
ClassInfo - Interface in com.linecorp.armeria.server.docs
Metadata about a struct type, an enum type or an exception type.
clear() - Static method in class com.linecorp.armeria.client.SessionProtocolNegotiationCache
Clears the cache.
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 - Static variable in class com.linecorp.armeria.internal.TrafficLoggingHandler
 
ClientBuilder - Class in com.linecorp.armeria.client
Creates a new client that connects to the specified URI using the builder pattern.
ClientBuilder(String) - Constructor for class com.linecorp.armeria.client.ClientBuilder
Creates a new ClientBuilder that builds the client that connects to the specified uri.
ClientBuilder(URI) - Constructor for class com.linecorp.armeria.client.ClientBuilder
Creates a new ClientBuilder that builds the client that connects to the specified URI.
ClientBuilderParams - Interface in com.linecorp.armeria.client
Provides the construction parameters of a client.
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.
ClientDecorationBuilder() - Constructor for class com.linecorp.armeria.client.ClientDecorationBuilder
 
ClientFactory - Interface in com.linecorp.armeria.client
Creates and manages clients.
clientFactory() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns the ClientFactory that will process HealthCheckedEndpointGroup.EndpointHealthChecker's healthcheck requests.
ClientFactoryProvider - Interface in com.linecorp.armeria.client
Creates a new ClientFactory dynamically via Java SPI (Service Provider Interface).
ClientOption<T> - Class in com.linecorp.armeria.client
A client option.
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.
ClientOptionsBuilder() - Constructor for class com.linecorp.armeria.client.ClientOptionsBuilder
Creates a new instance with the default options.
ClientOptionsBuilder(ClientOptions) - Constructor for class com.linecorp.armeria.client.ClientOptionsBuilder
Creates a new instance with the specified base options.
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.
ClientRequestContextWrapper - Class in com.linecorp.armeria.client
Wraps an existing ServiceRequestContext.
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.DefaultClientBuilderParams
 
clientType() - Method in class com.linecorp.armeria.client.UserClient
 
clock(Clock) - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Sets the Clock that provides the current date and time.
clock() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceConfig
Returns the Clock the provides the current date and time to an HttpFileService.
close() - Method in class com.linecorp.armeria.client.AllInOneClientFactory
 
close() - Method in interface com.linecorp.armeria.client.ClientFactory
Closes all clients managed by this factory and shuts down the EventLoopGroup created implicitly by this factory.
close() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
close() - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
 
close(Throwable) - Method in interface com.linecorp.armeria.client.limit.ConcurrencyLimitingClient.Deferred
Closes the ConcurrencyLimitingClient.Deferred.response() without delegating.
close() - Method in class com.linecorp.armeria.client.NonDecoratingClientFactory
 
close() - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
 
close() - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Closes all Channels managed by this pool.
close() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
close(Throwable) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
close() - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
Closes the deferred stream without setting a delegate.
close(Throwable) - 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.StreamWriter
Closes the StreamMessage successfully.
close(Throwable) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Closes the StreamMessage exceptionally.
close() - Method in interface com.linecorp.armeria.common.util.SafeCloseable
 
close(ChannelHandlerContext, ChannelPromise) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
close(ChannelHandlerContext, ChannelPromise) - Method in class com.linecorp.armeria.internal.http.AbstractHttp2ConnectionHandler
 
close() - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
Releases the resources related with this encoder and fails any unfinished writes.
close() - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
Cleanup resources which were opened for logging.
close() - Method in class com.linecorp.armeria.server.Server
A shortcut to stop().get().
closeDefault() - Static method in interface com.linecorp.armeria.client.ClientFactory
Closes the default ClientFactory.
ClosedPublisherException - Exception in com.linecorp.armeria.common.stream
A RuntimeException that is raised when a StreamWriter attempts to write an object to a closed StreamMessage.
ClosedSessionException - Exception in com.linecorp.armeria.common
A RuntimeException raised when the connection to the remote peer has been closed unexpectedly.
closeFuture() - Method in interface com.linecorp.armeria.common.http.HttpResponse
 
closeFuture() - 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 closed) or 2) the result value is set (the CompletionStage has completed.)
closeFuture() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns a CompletableFuture which completes when this RpcResponse completes.
closeFuture() - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
closeFuture() - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
 
closeFuture() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
closeFuture() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
closeFuture() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns a CompletableFuture that completes when this publisher is complete, either successfully or exceptionally.
code() - Method in class com.linecorp.armeria.common.http.HttpStatus
Returns the code of this HttpStatus.
codeAsText() - Method in class com.linecorp.armeria.common.http.HttpStatus
Returns the status code as String.
codeClass() - Method in class com.linecorp.armeria.common.http.HttpStatus
Returns the class of this HttpStatus.
CollectionInfo - Interface in com.linecorp.armeria.server.docs
Metadata about a list type or a set type.
com.linecorp.armeria.client - package com.linecorp.armeria.client
Client core.
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.circuitbreaker.metrics - package com.linecorp.armeria.client.circuitbreaker.metrics
Metrics monitoring for CircuitBreaker.
com.linecorp.armeria.client.endpoint - package com.linecorp.armeria.client.endpoint
Endpoint groups and their registry.
com.linecorp.armeria.client.endpoint.healthcheck - package com.linecorp.armeria.client.endpoint.healthcheck
com.linecorp.armeria.client.http - package com.linecorp.armeria.client.http
HTTP client.
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 and metric-collecting client decorators.
com.linecorp.armeria.client.pool - package com.linecorp.armeria.client.pool
Asynchronous Channel pool.
com.linecorp.armeria.common - package com.linecorp.armeria.common
Common types.
com.linecorp.armeria.common.http - package com.linecorp.armeria.common.http
HTTP-related classes.
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.stream - package com.linecorp.armeria.common.stream
Streamed message types.
com.linecorp.armeria.common.util - package com.linecorp.armeria.common.util
Generic utility classes.
com.linecorp.armeria.internal - package com.linecorp.armeria.internal
Various classes used internally.
com.linecorp.armeria.internal.http - package com.linecorp.armeria.internal.http
Various classes used internally.
com.linecorp.armeria.internal.logging - package com.linecorp.armeria.internal.logging
 
com.linecorp.armeria.server - package com.linecorp.armeria.server
Server core.
com.linecorp.armeria.server.composition - package com.linecorp.armeria.server.composition
Service composition.
com.linecorp.armeria.server.docs - package com.linecorp.armeria.server.docs
Documentation service.
com.linecorp.armeria.server.http - package com.linecorp.armeria.server.http
HTTP service.
com.linecorp.armeria.server.http.auth - package com.linecorp.armeria.server.http.auth
HTTP authorization service.
com.linecorp.armeria.server.http.cors - package com.linecorp.armeria.server.http.cors
com.linecorp.armeria.server.http.dynamic - package com.linecorp.armeria.server.http.dynamic
Dynamic HTTP service.
com.linecorp.armeria.server.http.encoding - package com.linecorp.armeria.server.http.encoding
HTTP content encoding service.
com.linecorp.armeria.server.http.file - package com.linecorp.armeria.server.http.file
HTTP static file service.
com.linecorp.armeria.server.http.healthcheck - package com.linecorp.armeria.server.http.healthcheck
HTTP health check service for load balancers.
com.linecorp.armeria.server.logging - package com.linecorp.armeria.server.logging
Logging and metric-collecting service decorators.
com.linecorp.armeria.server.logging.structured - package com.linecorp.armeria.server.logging.structured
Structured logging support for full request and response.
commitTimeMillis() - Method in class com.linecorp.armeria.common.util.Version
 
compareTo(HttpStatus) - Method in class com.linecorp.armeria.common.http.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(SessionProtocol) - Method in class com.linecorp.armeria.common.SessionProtocol
 
compareTo(SessionProtocolProvider.Entry) - Method in class com.linecorp.armeria.common.SessionProtocolProvider.Entry
 
compareTo(ServerPort) - Method in class com.linecorp.armeria.server.ServerPort
 
completeExceptionally(Throwable) - Method in class com.linecorp.armeria.common.DefaultRpcResponse
 
CompletionActions - Class in com.linecorp.armeria.common.util
Provides the common actions that are useful when handling a CompletionStage.
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).
CompositeServiceEntry<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.composition
A pair of a PathMapping and a Service bound to it.
ConcurrencyLimitingClient<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.
ConcurrencyLimitingClient(Client<? super I, ? extends O>, int) - Constructor for class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Creates a new instance that decorates the specified delegate to limit the concurrent number of active requests to maxConcurrency, with the default timeout of milliseconds.
ConcurrencyLimitingClient(Client<? super I, ? extends O>, int, long, TimeUnit) - Constructor for class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Creates a new instance that decorates the specified delegate to limit the concurrent number of active requests to maxConcurrency.
ConcurrencyLimitingClient.Deferred<O extends Response> - Interface in com.linecorp.armeria.client.limit
Provides the interface for updating the result of a Request execution when its Response is ready.
ConcurrencyLimitingHttpClient - Class in com.linecorp.armeria.client.limit
A Client decorator that limits the concurrent number of active HTTP requests.
config() - Method in class com.linecorp.armeria.server.http.cors.CorsService
Returns the CorsConfig.
config() - Method in class com.linecorp.armeria.server.http.file.HttpFileService
Returns the configuration.
config() - Method in class com.linecorp.armeria.server.Server
Returns the configuration of this Server.
CONFLICT - Static variable in class com.linecorp.armeria.common.http.HttpStatus
409 Conflict.
CONNECT_TIMEOUT - Static variable in class com.linecorp.armeria.client.SessionOption
The timeout of a socket connection attempt.
CONNECTION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"connection".
connectTimeout() - Method in class com.linecorp.armeria.client.SessionOptions
connectTimeoutMillis() - Method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOption.CONNECT_TIMEOUT value as milliseconds.
constants() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
Returns the constants defined by the type.
constants() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
constants() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
constants() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
consumerKey() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
contains(int) - Method in enum com.linecorp.armeria.common.http.HttpStatusClass
Returns true if and only if the specified HTTP status code falls into this class.
content() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the content of this message.
CONTENT_BASE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-base".
CONTENT_DISPOSITION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-disposition".
CONTENT_ENCODING - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-encoding".
CONTENT_LANGUAGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-language".
CONTENT_LENGTH - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-length".
CONTENT_LOCATION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-location".
CONTENT_MD5 - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-md5".
CONTENT_RANGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-range".
CONTENT_TRANSFER_ENCODING - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-transfer-encoding".
CONTENT_TYPE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"content-type".
contentEncoding() - Method in class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
 
contentEncoding() - Method in interface com.linecorp.armeria.server.http.file.HttpVfs.Entry
The content encoding of the entry.
ContentTooLargeException - Exception in com.linecorp.armeria.common
A RuntimeException raised when the length of request or response content exceeds its limit.
context() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
context() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the RequestContext associated with the Request being handled.
contextAwareEventLoop() - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
contextAwareEventLoop() - Method in interface com.linecorp.armeria.common.RequestContext
Returns an EventLoop that will make sure this RequestContext is set as the current context before executing any callback.
CONTINUE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
100 Continue.
convert(Object) - Method in interface com.linecorp.armeria.server.http.dynamic.ResponseConverter
Returns HttpResponse instance corresponds to the given resObj.
Converter - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for specifying ResponseConverter onto a class or a method.
Converters - Annotation Type in com.linecorp.armeria.server.http.dynamic
The containing annotation type for Converter.
COOKIE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"cookie".
copyOf(HttpHeaders) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns a copy of the specified HttpHeaders.
CorsConfig - Class in com.linecorp.armeria.server.http.cors
CorsService<I extends HttpRequest,O extends HttpResponse> - Class in com.linecorp.armeria.server.http.cors
Decorates an HTTP Service to add the Cross-Origin Resource Sharing (CORS) support.
CorsService(Service<? super I, ? extends O>, CorsConfig) - Constructor for class com.linecorp.armeria.server.http.cors.CorsService
Creates a new CorsService that decorates the specified delegate to add CORS support.
CorsServiceBuilder - Class in com.linecorp.armeria.server.http.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.
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.
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.http.HttpStatus
201 Created.
createEndpointHealthChecker(Endpoint) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Creates a new HealthCheckedEndpointGroup.EndpointHealthChecker instance that will check endpoint healthiness.
createEndpointHealthChecker(Endpoint) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroup
 
CRW - Static variable in class com.linecorp.armeria.common.MediaType
The media type for the Canon Image File Format (crw files), a widely-used "raw image" format for cameras.
CSS_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
CSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
current() - Static method in interface com.linecorp.armeria.common.RequestContext
Returns the context of the Request that is being handled in the current thread.

D

DART_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
Media type for dart files.
DATE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"date".
dec(int) - Method in class com.linecorp.armeria.internal.InboundTrafficController
 
dec() - Method in class com.linecorp.armeria.server.GracefulShutdownSupport
Decreases the number of pending responses.
decorate(Class<I>, Class<O>, Client<I, O>) - Method in class com.linecorp.armeria.client.ClientDecoration
Decorates the specified Client using the decorator with matching requestType and responseType.
decorate(Class<R>) - Method in interface com.linecorp.armeria.server.Service
Creates a new Service that decorates this Service with a new Service instance of the specified serviceType.
decorate(Function<T, R>) - Method in interface com.linecorp.armeria.server.Service
Creates a new Service that decorates this Service with the specified decorator.
decorate(DecoratingServiceFunction<? super I, ? extends O>) - Method in interface com.linecorp.armeria.server.Service
Creates a new Service that decorates this Service with the specified DecoratingServiceFunction.
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<? super T_I, ? extends 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.
DecoratingKeyedChannelPoolHandler<K> - Class in com.linecorp.armeria.client.pool
A KeyedChannelPoolHandler that decorates an existing KeyedChannelPoolHandler.
DecoratingKeyedChannelPoolHandler(KeyedChannelPoolHandler<K>) - Constructor for class com.linecorp.armeria.client.pool.DecoratingKeyedChannelPoolHandler
Creates a new decorator with the specified delegate.
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<? super T_I, ? extends T_O>) - Constructor for class com.linecorp.armeria.server.DecoratingService
Creates a new instance that decorates the specified Service.
DecoratingServiceFunction<I extends Request,O extends Response> - Interface in com.linecorp.armeria.server
A functional interface that enables building a DecoratingService with Service.decorate(DecoratingServiceFunction).
DECORATION - Static variable in class com.linecorp.armeria.client.ClientOption
The Function that decorates the client components.
decoration() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the Functions that decorate the components of a client.
decorator(Function<T, R>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates all Services with the specified decorator.
DEFAULT - Static variable in interface com.linecorp.armeria.client.ClientFactory
The default ClientFactory implementation.
DEFAULT - Static variable in class com.linecorp.armeria.client.ClientOptions
The default ClientOptions.
DEFAULT - Static variable in class com.linecorp.armeria.client.SessionOptions
The default SessionOptions.
DEFAULT_HEALTHCHECK_RETRY_INTERVAL - Static variable in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
 
DEFAULT_MAX_RESPONSE_LENGTH - Static variable in class com.linecorp.armeria.client.ClientOption
The default maximum allowed length of a server response.
DEFAULT_RESPONSE_TIMEOUT_MILLIS - Static variable in class com.linecorp.armeria.client.ClientOption
The default timeout of a server reply to a client call.
DEFAULT_WRITE_TIMEOUT_MILLIS - Static variable in class com.linecorp.armeria.client.ClientOption
The default timeout of a socket write.
DefaultAttributeMap - Class in com.linecorp.armeria.internal
Default AttributeMap implementation which use simple synchronization per bucket to keep the memory overhead as low as possible.
DefaultAttributeMap() - Constructor for class com.linecorp.armeria.internal.DefaultAttributeMap
 
DefaultClientBuilderParams - Class in com.linecorp.armeria.client
Default ClientBuilderParams implementation.
DefaultClientBuilderParams(ClientFactory, URI, Class<?>, ClientOptions) - Constructor for class com.linecorp.armeria.client.DefaultClientBuilderParams
Creates a new instance.
DefaultClientRequestContext - Class in com.linecorp.armeria.client
Default ClientRequestContext implementation.
DefaultClientRequestContext(EventLoop, SessionProtocol, Endpoint, String, String, String, ClientOptions, Object) - Constructor for class com.linecorp.armeria.client.DefaultClientRequestContext
Creates a new instance.
defaultHostname() - Method in class com.linecorp.armeria.server.Server
Returns the hostname of the default VirtualHost, which is the hostname of the machine unless configured explicitly via ServerBuilder.defaultVirtualHost(VirtualHost).
defaultHostname() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the default hostname of this virtual host.
DefaultHttpData - Class in com.linecorp.armeria.common.http
Default HttpData implementation.
DefaultHttpData(byte[], int, int, boolean) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpData
Creates a new instance.
DefaultHttpHeaders - Class in com.linecorp.armeria.common.http
Default HttpHeaders implementation.
DefaultHttpHeaders() - Constructor for class com.linecorp.armeria.common.http.DefaultHttpHeaders
Creates a new instance.
DefaultHttpHeaders(boolean) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpHeaders
Creates a new instance.
DefaultHttpHeaders(boolean, int) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpHeaders
Creates a new instance.
DefaultHttpHeaders(boolean, int, boolean) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpHeaders
Creates a new instance.
DefaultHttpRequest - Class in com.linecorp.armeria.common.http
Default HttpRequest implementation.
DefaultHttpRequest() - Constructor for class com.linecorp.armeria.common.http.DefaultHttpRequest
Creates a new instance with empty headers.
DefaultHttpRequest(HttpHeaders) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpRequest
Creates a new instance with the specified headers.
DefaultHttpRequest(HttpMethod, String) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpRequest
Creates a new instance with the specified HttpMethod and path.
DefaultHttpRequest(HttpHeaders, boolean) - Constructor for class com.linecorp.armeria.common.http.DefaultHttpRequest
Creates a new instance with the specified headers.
DefaultHttpResponse - Class in com.linecorp.armeria.common.http
Default HttpResponse instance.
DefaultHttpResponse() - Constructor for class com.linecorp.armeria.common.http.DefaultHttpResponse
 
DefaultKeyedChannelPool<K> - Class in com.linecorp.armeria.client.pool
Default KeyedChannelPool implementation.
DefaultKeyedChannelPool(EventLoop, Function<K, Future<Channel>>, KeyedChannelPoolHandler<K>) - Constructor for class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
Creates a new instance.
DefaultKeyedChannelPool(EventLoop, Function<K, Future<Channel>>, ChannelHealthChecker, KeyedChannelPoolHandler<K>) - Constructor for class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
Creates a new instance.
DefaultKeyedChannelPool(EventLoop, Function<K, Future<Channel>>, ChannelHealthChecker, KeyedChannelPoolHandler<K>, boolean) - Constructor for class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
Creates a new instance.
defaultMaxRequestLength(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed length of the content decoded at the session layer.
defaultMaxRequestLength() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default maximum allowed length of the content decoded at the session layer.
defaultMaxResponseLength() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the maximum allowed length of a server response.
defaultMimeType() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the default MIME type of this endpoint.
defaultPort() - Method in class com.linecorp.armeria.common.SessionProtocol
Returns the default INET port number of this protocol.
DefaultRequestLog - Class in com.linecorp.armeria.common.logging
Default RequestLog implementation.
DefaultRequestLog(RequestContext) - Constructor for class com.linecorp.armeria.common.logging.DefaultRequestLog
Creates a new instance.
defaultRequestTimeout(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the default timeout of a request.
defaultRequestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the default timeout of a request in milliseconds.
defaultRequestTimeoutMillis() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default timeout of a request.
defaultResponseTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the default timeout of a server reply to a client call.
DefaultRpcRequest - Class in com.linecorp.armeria.common
Default RpcRequest implementation.
DefaultRpcRequest(Class<?>, String) - Constructor for class com.linecorp.armeria.common.DefaultRpcRequest
Creates a new instance with no parameter.
DefaultRpcRequest(Class<?>, String, Object) - Constructor for class com.linecorp.armeria.common.DefaultRpcRequest
Creates a new instance with a single parameter.
DefaultRpcRequest(Class<?>, String, Iterable<?>) - Constructor for class com.linecorp.armeria.common.DefaultRpcRequest
Creates a new instance with the specified parameters.
DefaultRpcRequest(Class<?>, String, Object...) - Constructor for class com.linecorp.armeria.common.DefaultRpcRequest
Creates a new instance with the specified parameters.
DefaultRpcResponse - Class in com.linecorp.armeria.common
Default RpcResponse implementation.
DefaultRpcResponse() - Constructor for class com.linecorp.armeria.common.DefaultRpcResponse
Creates a new incomplete response.
DefaultRpcResponse(Object) - Constructor for class com.linecorp.armeria.common.DefaultRpcResponse
Creates a new successfully complete response.
DefaultRpcResponse(Throwable) - Constructor for class com.linecorp.armeria.common.DefaultRpcResponse
Creates a new exceptionally complete response.
DefaultServiceRequestContext - Class in com.linecorp.armeria.server
Default ServiceRequestContext implementation.
DefaultServiceRequestContext(ServiceConfig, Channel, SessionProtocol, String, String, String, Object, SSLSession) - 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 with a new ConcurrentLinkedQueue.
DefaultStreamMessage(Queue<Object>) - Constructor for class com.linecorp.armeria.common.stream.DefaultStreamMessage
Creates a new instance with the specified Queue.
defaultVirtualHost(VirtualHost) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the default VirtualHost, which is used when no other VirtualHosts match the host name of a client request.
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.
defaultWriteTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the default timeout of a socket write.
defer(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Defers the specified Request.
defer(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingHttpClient
 
DeferredHttpResponse - Class in com.linecorp.armeria.common.http
An HttpResponse whose stream is published later by another HttpResponse.
DeferredHttpResponse() - Constructor for class com.linecorp.armeria.common.http.DeferredHttpResponse
 
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
 
deferRequestContent() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
deferRequestContent() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
deferResponseContent() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
deferResponseContent() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
delegate() - Method in class com.linecorp.armeria.client.DecoratingClient
Returns the Client being decorated.
delegate() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
Returns the delegate ClientFactory.
delegate(O) - Method in interface com.linecorp.armeria.client.limit.ConcurrencyLimitingClient.Deferred
Delegates the response to the specified Response.
delegate() - Method in class com.linecorp.armeria.client.pool.DecoratingKeyedChannelPoolHandler
Returns the KeyedChannelPoolHandler this handler decorates.
delegate() - Method in class com.linecorp.armeria.client.UserClient
Returns the Client that will process Requests.
delegate(HttpResponse) - Method in class com.linecorp.armeria.common.http.DeferredHttpResponse
Sets the delegate HttpResponse which will publish the stream actually.
delegate() - Method in class com.linecorp.armeria.common.RequestContextWrapper
Returns the delegate context.
delegate(StreamMessage<T>) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
Sets the delegate HttpResponse which will publish the stream actually.
delegate() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
Returns the delegate Publisher.
delegate() - Method in class com.linecorp.armeria.server.DecoratingService
Returns the Service being decorated.
delete(String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP DELETE request.
Delete - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.DELETE onto specific method.
dependencies() - Method in interface com.linecorp.armeria.client.ClientFactoryProvider
Returns the type of the ClientFactory required for this provider to create a new ClientFactory.
deserialize(JsonParser, DeserializationContext) - Method in class com.linecorp.armeria.common.http.HttpHeadersJsonDeserializer
 
DISABLED - Static variable in class com.linecorp.armeria.server.http.cors.CorsConfig
CorsConfig with CORS disabled.
disablePreflightResponseHeaders() - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Specifies that no preflight response headers should be added to a preflight response.
disconnect(ChannelHandlerContext, ChannelPromise) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
doApply(String) - Method in class com.linecorp.armeria.server.AbstractPathMapping
Invoked by AbstractPathMapping.apply(String) to perform the actual path matching and translation.
doClose() - Method in class com.linecorp.armeria.internal.http.Http1ObjectEncoder
 
doClose() - Method in class com.linecorp.armeria.internal.http.Http2ObjectEncoder
 
doClose() - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
 
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.
DocService(Map<Class<?>, ? extends Iterable<HttpHeaders>>) - Constructor for class com.linecorp.armeria.server.docs.DocService
Creates a new instance with example HTTP headers.
docString() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
Returns the documentation string.
docString() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
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.FunctionInfo
Returns the documentation string of the function.
docString() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the documentation string.
docString() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
doDelete(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a DELETE request.
doGet(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a GET request.
doGet(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.file.HttpFileService
 
doGet(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.healthcheck.HttpHealthCheckService
 
doHead(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a HEAD request.
doHead(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.healthcheck.HttpHealthCheckService
 
doOptions(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles an OPTIONS request.
doPatch(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a PATCH request.
doPost(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a POST request.
doPut(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a PUT request.
doTrace(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Handles a TRACE request.
DOUBLE - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The double float type.
doWriteData(ChannelHandlerContext, int, int, HttpData, boolean) - Method in class com.linecorp.armeria.internal.http.Http1ObjectEncoder
 
doWriteData(ChannelHandlerContext, int, int, HttpData, boolean) - Method in class com.linecorp.armeria.internal.http.Http2ObjectEncoder
 
doWriteData(ChannelHandlerContext, int, int, HttpData, boolean) - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
 
doWriteHeaders(ChannelHandlerContext, int, int, HttpHeaders, boolean) - Method in class com.linecorp.armeria.internal.http.Http1ObjectEncoder
 
doWriteHeaders(ChannelHandlerContext, int, int, HttpHeaders, boolean) - Method in class com.linecorp.armeria.internal.http.Http2ObjectEncoder
 
doWriteHeaders(ChannelHandlerContext, int, int, HttpHeaders, boolean) - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
 
doWriteReset(ChannelHandlerContext, int, int, Http2Error) - Method in class com.linecorp.armeria.internal.http.Http1ObjectEncoder
 
doWriteReset(ChannelHandlerContext, int, int, Http2Error) - Method in class com.linecorp.armeria.internal.http.Http2ObjectEncoder
 
doWriteReset(ChannelHandlerContext, int, int, Http2Error) - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
 
DropwizardMetricCollectingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.logging
Decorates a Client to collect metrics into Dropwizard MetricRegistry.
DropwizardMetricCollectingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.logging
Decorates a Service to collect metrics into Dropwizard MetricRegistry.
DropwizardMetricCollector - Class in com.linecorp.armeria.internal.logging
(Internal use only) Collects the metric data and stores it into the MetricRegistry.
DropwizardMetricCollector(MetricRegistry, Function<RequestLog, String>) - Constructor for class com.linecorp.armeria.internal.logging.DropwizardMetricCollector
Creates a new instance.
DropwizardMetricsCircuitBreakerListener - Class in com.linecorp.armeria.client.circuitbreaker.metrics
A CircuitBreakerListener which monitors the status of CircuitBreakers using dropwizard metrics.
DropwizardMetricsCircuitBreakerListener(MetricRegistry, String) - Constructor for class com.linecorp.armeria.client.circuitbreaker.metrics.DropwizardMetricsCircuitBreakerListener
Creates a new instance.
DynamicHttpFunction - Interface in com.linecorp.armeria.server.http.dynamic
Path variable-enabled function.
DynamicHttpService - Class in com.linecorp.armeria.server.http.dynamic
An HttpService that serves dynamic contents.
DynamicHttpService() - Constructor for class com.linecorp.armeria.server.http.dynamic.DynamicHttpService
Create a DynamicHttpService instance.
DynamicHttpServiceBuilder - Class in com.linecorp.armeria.server.http.dynamic
Builds a new DynamicHttpService.
DynamicHttpServiceBuilder() - Constructor for class com.linecorp.armeria.server.http.dynamic.DynamicHttpServiceBuilder
 

E

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.
elapsedAndSize(long, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Similar to TextFormatter.appendElapsedAndSize(StringBuilder, long, long, long) except that this method creates a new StringBuilder.
elementTypeInfo() - Method in interface com.linecorp.armeria.server.docs.CollectionInfo
Returns the metadata about the element type of this collection.
elementTypeInfo() - Method in class com.linecorp.armeria.server.docs.ListInfo
 
elementTypeInfo() - Method in class com.linecorp.armeria.server.docs.SetInfo
 
empty() - Static method in class com.linecorp.armeria.server.PathMapped
Returns a singleton instance of a PathMapped that represents a non-existent value.
EMPTY_DATA - Static variable in interface com.linecorp.armeria.common.http.HttpData
Empty HTTP/2 data.
EMPTY_HEADERS - Static variable in interface com.linecorp.armeria.common.http.HttpHeaders
An immutable empty HTTP/2 headers.
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 - Class in com.linecorp.armeria.client
A remote endpoint that refers to a single host or a group of multiple hosts.
endpoint() - Method in class com.linecorp.armeria.client.UserClient
Returns the Endpoint of the UserClient.delegate().
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, Throwable) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified message and cause.
EndpointGroupException(String) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified message.
EndpointGroupException(Throwable) - Constructor for exception com.linecorp.armeria.client.endpoint.EndpointGroupException
Creates a new instance with the specified 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.
EndpointGroupRegistry - Class in com.linecorp.armeria.client.endpoint
An in-memory registry of server groups.
EndpointInfo - Class in com.linecorp.armeria.server.docs
Metadata about the endpoints exposed by a Service.
EndpointInfo(String, String, String, SerializationFormat, Iterable<SerializationFormat>) - Constructor for class com.linecorp.armeria.server.docs.EndpointInfo
Creates a new instance.
endpoints() - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
Return the endpoints held by this EndpointGroup.
endpoints() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
 
endpoints() - Method in class com.linecorp.armeria.client.endpoint.StaticEndpointGroup
 
endpoints() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the endpoints exposed by the service.
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 class com.linecorp.armeria.common.logging.DefaultRequestLog
 
endRequest(Throwable) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
endRequest() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets RequestLog.requestDurationNanos() and finishes the collection of the information.
endRequest(Throwable) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets RequestLog.requestDurationNanos() and finishes the collection of the information.
endResponse() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
endResponse(Throwable) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
endResponse() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets RequestLog.responseDurationNanos() and finishes the collection of the information.
endResponse(Throwable) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets RequestLog.responseDurationNanos() and finishes the collection of the information.
ensureAbsolutePath(String, String) - Static method in class com.linecorp.armeria.server.AbstractPathMapping
Ensures that the specified path is an absolute path.
ensureAvailability(RequestLogAvailability) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Ensures that the specified RequestLogAvailability is satisfied.
ensureAvailability(RequestLogAvailability...) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Ensures that all of the specified RequestLogAvailabilitys are satisfied.
ensureAvailability(Iterable<RequestLogAvailability>) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Ensures that all of the specified RequestLogAvailabilitys are satisfied.
entries() - Method in class com.linecorp.armeria.common.http.HttpSessionProtocolProvider
 
entries() - Method in class com.linecorp.armeria.common.SerializationFormatProvider
entries() - Method in class com.linecorp.armeria.common.SessionProtocolProvider
Returns the SessionProtocolProvider.Entrys to register as SessionProtocols.
Entry(String, MediaType, MediaType...) - Constructor for class com.linecorp.armeria.common.SerializationFormatProvider.Entry
Creates a new instance.
Entry(String, boolean, boolean, int) - Constructor for class com.linecorp.armeria.common.SessionProtocolProvider.Entry
Creates a new instance.
EnumInfo - Class in com.linecorp.armeria.server.docs
Metadata about an enum type.
EnumInfo(String, Iterable<Object>) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Iterable<Object>, String) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EOT - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Embedded OpenType fonts.
epoch(long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Formats the given epoch time 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.
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.pool.PoolKey
 
equals(Object) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
equals(Object) - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
equals(Object) - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
equals(Object) - Method in class com.linecorp.armeria.common.http.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.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.SessionProtocol
 
equals(Object) - Method in class com.linecorp.armeria.common.SessionProtocolProvider.Entry
 
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.ExceptionInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.FunctionInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.ListInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.MapInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.SetInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.StructInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.http.auth.BasicToken
 
equals(Object) - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
equals(Object) - Method in class com.linecorp.armeria.server.http.auth.OAuth2Token
 
equals(Object) - Method in class com.linecorp.armeria.server.ServerPort
 
ETAG - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"etag".
EVENT_LOOP_GROUP - Static variable in class com.linecorp.armeria.client.SessionOption
The EventLoopGroup that will provide the EventLoop for I/O and asynchronous invocations.
EventCount - Class in com.linecorp.armeria.client.circuitbreaker
An immutable object that stores the count of events.
EventCount(long, long) - Constructor for class com.linecorp.armeria.client.circuitbreaker.EventCount
Creates a new instance with the specified number of successes and failures.
eventLoop() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
eventLoop() - Method in class com.linecorp.armeria.client.UserClient
Retrieves an EventLoop supplied by the ClientFactory.
eventLoop() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the EventLoop that is handling the current Request.
eventLoop() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
eventLoop() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
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
 
eventLoopGroup() - Method in class com.linecorp.armeria.client.NonDecoratingClientFactory
 
eventLoopGroup() - Method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOption.EVENT_LOOP_GROUP if non-default was specified.
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
 
eventLoopSupplier() - Method in class com.linecorp.armeria.client.NonDecoratingClientFactory
 
exactPath() - Method in class com.linecorp.armeria.server.AbstractPathMapping
 
exactPath() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the exact path of this path mapping if it is an exact path mapping, or Optional.empty() otherwise.
exampleHttpHeaders() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the example HTTP headers of the service.
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
exceptionFilter(ExceptionFilter) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the ExceptionFilter that decides whether the circuit breaker should deal with a given error.
ExceptionFilter - Interface in com.linecorp.armeria.client.circuitbreaker
A filter that decides whether circuit breaker should deal with a given error raised by remote service.
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 - Class in com.linecorp.armeria.common.util
Provides the methods that are useful for handling exceptions.
exceptions() - Method in class com.linecorp.armeria.server.docs.FunctionInfo
Returns the metadata about the exceptions declared by the function.
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
 
execute(ClientRequestContext, I) - Method in interface com.linecorp.armeria.client.Client
Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
execute(HttpRequest) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends the specified HTTP request.
execute(AggregatedHttpMessage) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends the specified HTTP request.
execute(HttpHeaders) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an empty HTTP request with the specified headers.
execute(HttpHeaders, HttpData) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP request with the specified headers and content.
execute(HttpHeaders, byte[]) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP request with the specified headers and content.
execute(HttpHeaders, String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP request with the specified headers and content.
execute(HttpHeaders, String, Charset) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP request with the specified headers and content.
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
 
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.logging.DropwizardMetricCollectingClient
 
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.logging.LoggingClient
 
execute(String, String, String, I, Function<Throwable, O>) - Method in class com.linecorp.armeria.client.UserClient
Executes the specified Request via UserClient.delegate().
execute(EventLoop, String, String, String, I, Function<Throwable, O>) - Method in class com.linecorp.armeria.client.UserClient
Executes the specified Request via UserClient.delegate().
EXPECT - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"expect".
EXPECTATION_FAILED - Static variable in class com.linecorp.armeria.common.http.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.http.HttpHeaderNames
"expires".
exposedHeaders() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Returns a set of headers to be exposed to calling clients.
exposeHeaders(String...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Specifies the headers to be exposed to calling clients.
exposeHeaders(AsciiString...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Specifies the headers to be exposed to calling clients.

F

factory(ClientFactory) - Method in class com.linecorp.armeria.client.ClientBuilder
Sets the ClientFactory of the client.
factory() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the ClientFactory who created the client.
factory() - Method in class com.linecorp.armeria.client.DefaultClientBuilderParams
 
factory() - Method in class com.linecorp.armeria.client.UserClient
 
FAILED_DEPENDENCY - Static variable in class com.linecorp.armeria.common.http.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.
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.
FieldInfo - Class in com.linecorp.armeria.server.docs
Metadata about a field of a struct or an exception.
FieldInfo(String, FieldRequirement, TypeInfo) - Constructor for class com.linecorp.armeria.server.docs.FieldInfo
Creates a new instance.
FieldInfo(String, FieldRequirement, TypeInfo, String) - Constructor for class com.linecorp.armeria.server.docs.FieldInfo
Creates a new instance.
FieldRequirement - Enum in com.linecorp.armeria.server.docs
The requirement level of a field.
fields() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
Returns the metadata about the fields of the type.
fields() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
fields() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
fields() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
fillInStackTrace() - Method in exception com.linecorp.armeria.client.circuitbreaker.FailFastException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.client.SessionProtocolNegotiationException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.common.ProtocolViolationException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.common.TimeoutException
 
filter(T) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
The filter to apply to published objects.
FilteredHttpResponse - Class in com.linecorp.armeria.common.http
An HttpResponse that filters objects as they are published.
FilteredHttpResponse(HttpResponse) - Constructor for class com.linecorp.armeria.common.http.FilteredHttpResponse
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.
find(String) - Static method in class com.linecorp.armeria.common.SerializationFormat
find(MediaType) - Static method in class com.linecorp.armeria.common.SerializationFormat
Finds the SerializationFormat which is accepted by the specified MediaType.
find(String) - Static method in class com.linecorp.armeria.common.SessionProtocol
Finds the SessionProtocol with the specified SessionProtocol.uriText().
findPool(Channel) - Static method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Finds the KeyedChannelPool that the specified Channel belongs to.
findService(String) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
Finds the Service whose PathMapping matches the path.
findService(String) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeService
 
findServiceConfig(String) - Method in class com.linecorp.armeria.server.VirtualHost
Finds the Service whose PathMapping matches the path.
findVirtualHost(String) - Method in class com.linecorp.armeria.server.ServerConfig
Finds the VirtualHost that matches the specified hostname.
findVirtualHosts(Service<?, ?>) - Method in class com.linecorp.armeria.server.ServerConfig
Finds the List of VirtualHosts that contains the specified Service.
flush(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
flush(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.TrafficLoggingHandler
 
FlushConsolidationHandler - Class in com.linecorp.armeria.internal
ChannelDuplexHandler which consolidate ChannelOutboundInvoker.flush() operations (which also includes ChannelOutboundInvoker.writeAndFlush(Object) and ChannelOutboundInvoker.writeAndFlush(Object, ChannelPromise)).
FlushConsolidationHandler() - Constructor for class com.linecorp.armeria.internal.FlushConsolidationHandler
Create new instance which explicit flush after 256 pending flush operations latest.
FlushConsolidationHandler(int) - Constructor for class com.linecorp.armeria.internal.FlushConsolidationHandler
Create new instance.
FLV_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Flash video.
forAnyOrigin() - Static method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Creates a new builder with its origin set to '*'.
FORBIDDEN - Static variable in class com.linecorp.armeria.common.http.HttpStatus
403 Forbidden.
forClassPath(String) - Static method in class com.linecorp.armeria.server.http.file.HttpFileService
Creates a new HttpFileService for the specified rootDir in the current class path.
forClassPath(ClassLoader, String) - Static method in class com.linecorp.armeria.server.http.file.HttpFileService
Creates a new HttpFileService for the specified rootDir in the current class path.
forClassPath(String) - Static method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Creates a new HttpFileServiceBuilder with the specified rootDir in the current class path.
forClassPath(ClassLoader, String) - Static method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Creates a new HttpFileServiceBuilder with the specified rootDir in the current class path.
forFileSystem(String) - Static method in class com.linecorp.armeria.server.http.file.HttpFileService
Creates a new HttpFileService for the specified rootDir in an O/S file system.
forFileSystem(Path) - Static method in class com.linecorp.armeria.server.http.file.HttpFileService
Creates a new HttpFileService for the specified rootDir in an O/S file system.
forFileSystem(String) - Static method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Creates a new HttpFileServiceBuilder with the specified rootDir in an O/S file system.
forFileSystem(Path) - Static method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Creates a new HttpFileServiceBuilder with the specified rootDir in an O/S file system.
FORM_DATA - Static variable in class com.linecorp.armeria.common.MediaType
 
forOrigin(String) - Static method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Creates a new builder with the specified origin.
forOrigins(String...) - Static method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Creates a new builder with the specified origins.
forVfs(HttpVfs) - Static method in class com.linecorp.armeria.server.http.file.HttpFileService
Creates a new HttpFileService for the specified HttpVfs.
forVfs(HttpVfs) - Static method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Creates a new HttpFileServiceBuilder with the specified HttpVfs.
FOUND - Static variable in class com.linecorp.armeria.common.http.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.
freeze() - Method in class com.linecorp.armeria.server.PathMappings
Prevents adding a new mapping via PathMappings.add(PathMapping, Object).
FROM - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"from".
fromMediaType(String) - Static method in class com.linecorp.armeria.common.SerializationFormat
FunctionInfo - Class in com.linecorp.armeria.server.docs
Metadata about a function of a Service.
FunctionInfo(String, TypeInfo, Iterable<FieldInfo>, Iterable<ExceptionInfo>, String, String) - Constructor for class com.linecorp.armeria.server.docs.FunctionInfo
Creates a new instance.
Functions - Class in com.linecorp.armeria.common.util
Utility methods related with function composition.
functions() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the metadata about the functions available in the service.

G

GATEWAY_TIMEOUT - Static variable in class com.linecorp.armeria.common.http.HttpStatus
504 Gateway Timeout.
generate(Set<ServiceConfig>, Map<Class<?>, List<HttpHeaders>>) - Method in interface com.linecorp.armeria.server.docs.ServiceSpecificationGenerator
Generates a new ServiceSpecification that provides the information about the supported Services.
get(ClientRequestContext, Request) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerMapping
Returns the CircuitBreaker mapped to the given parameters.
get(ClientRequestContext, Request) - Method in class com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping
 
get(ClientRequestContext, Request) - Method in interface com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping.KeySelector
Returns the mapping key of the given Request.
get(ClientOption<T>) - Method in class com.linecorp.armeria.client.ClientOptions
Returns the value of the specified ClientOption.
get(String) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Get the EndpointGroup for the specified case-insensitive groupName.
get(String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP GET request.
get() - Static method in exception com.linecorp.armeria.client.ResponseTimeoutException
Returns a ResponseTimeoutException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get(SessionOption<T>) - Method in class com.linecorp.armeria.client.SessionOptions
Returns the value of the specified SessionOption.
get() - Static method in exception com.linecorp.armeria.client.WriteTimeoutException
Returns a WriteTimeoutException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get() - Static method in exception com.linecorp.armeria.common.ClosedSessionException
Returns a ClosedSessionException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get() - Static method in exception com.linecorp.armeria.common.ContentTooLargeException
Returns a ContentTooLargeException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
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 whether the verbose mode is enabled.
get() - Static method in exception com.linecorp.armeria.common.stream.ClosedPublisherException
Returns a ClosedPublisherException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get() - Static method in class com.linecorp.armeria.common.stream.NoopSubscriber
Returns a singleton NoopSubscriber.
Get - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.GET onto specific method.
get(String, String) - Method in interface com.linecorp.armeria.server.http.file.HttpVfs
Finds the file at the specified path.
get() - Static method in exception com.linecorp.armeria.server.RequestTimeoutException
Returns a RequestTimeoutException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get() - Static method in exception com.linecorp.armeria.server.ResourceNotFoundException
Returns a ResourceNotFoundException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get() - Static method in exception com.linecorp.armeria.server.ServiceUnavailableException
Returns a ServiceUnavailableException which may be a singleton or a new instance, depending on whether the verbose mode is enabled.
get0(AbstractOption<V>) - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns the value of the specified option.
getAllInterfaces(Class<?>) - Static method in class com.linecorp.armeria.internal.Types
Returns a set of all interfaces defined for cls.
getCircuitBreaker() - Method in exception com.linecorp.armeria.client.circuitbreaker.FailFastException
Returns the CircuitBreaker that has detected the failure.
getNodeSelector(String) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Returns the EndpointSelector for the specified case-insensitive groupName.
getOrElse(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.ClientOptions
Returns the value of the specified ClientOption.
getOrElse(SessionOption<T>, T) - Method in class com.linecorp.armeria.client.SessionOptions
Returns the value of the specified SessionOption.
getOrElse0(O, V) - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns the value of the specified option.
GIF - Static variable in class com.linecorp.armeria.common.MediaType
 
GONE - Static variable in class com.linecorp.armeria.common.http.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.
GracefulShutdownSupport - Class in com.linecorp.armeria.server
Keeps track of pending requests to allow shutdown to happen after a fixed quiet period passes after the last pending request.
gracefulShutdownTimeout(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.
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.
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.
group() - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Returns the EndpointGroup held by this selector.
groupName() - Method in class com.linecorp.armeria.client.Endpoint
Returns the group name of this endpoint.
GZIP - Static variable in class com.linecorp.armeria.common.MediaType
 

H

H1 - Static variable in class com.linecorp.armeria.common.http.HttpSessionProtocols
HTTP/1 - over TLS.
H1 - Static variable in class com.linecorp.armeria.common.SessionProtocol
Deprecated.
H1C - Static variable in class com.linecorp.armeria.common.http.HttpSessionProtocols
HTTP/1 - cleartext.
H1C - Static variable in class com.linecorp.armeria.common.SessionProtocol
Deprecated.
H2 - Static variable in class com.linecorp.armeria.common.http.HttpSessionProtocols
HTTP/2 - over TLS.
H2 - Static variable in class com.linecorp.armeria.common.SessionProtocol
Deprecated.
H2C - Static variable in class com.linecorp.armeria.common.http.HttpSessionProtocols
HTTP/2 - over TLS.
H2C - Static variable in class com.linecorp.armeria.common.SessionProtocol
Deprecated.
handlerRemoved(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.FlushConsolidationHandler
 
hasAttr(AttributeKey<T>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
hasAttr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
hasAttr(AttributeKey<T>) - Method in class com.linecorp.armeria.internal.DefaultAttributeMap
 
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.pool.PoolKey
 
hashCode() - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
hashCode() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
hashCode() - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
hashCode() - Method in class com.linecorp.armeria.common.http.HttpStatus
 
hashCode() - Method in class com.linecorp.armeria.common.MediaType
 
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.SessionProtocol
 
hashCode() - Method in class com.linecorp.armeria.common.SessionProtocolProvider.Entry
 
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.ExceptionInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.FunctionInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.ListInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.MapInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.SetInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
hashCode() - Method in class com.linecorp.armeria.server.http.auth.BasicToken
 
hashCode() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
hashCode() - Method in class com.linecorp.armeria.server.http.auth.OAuth2Token
 
hashCode() - Method in class com.linecorp.armeria.server.ServerPort
 
hasRequestsInProgress(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.IdleTimeoutHandler
 
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.http.HttpClient
Sends an HTTP HEAD request.
Head - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.HEAD onto specific method.
headers() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the HTTP headers.
headers() - Method in class com.linecorp.armeria.common.http.DefaultHttpRequest
 
headers() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Returns the initial HTTP/2 headers of this request.
HealthCheckedEndpointGroup - Class in com.linecorp.armeria.client.endpoint.healthcheck
An EndpointGroup decorator that only provides healthy Endpoints.
HealthCheckedEndpointGroup(ClientFactory, EndpointGroup, Duration) - Constructor for class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Creates a new instance.
HealthCheckedEndpointGroup.EndpointHealthChecker - Interface in com.linecorp.armeria.client.endpoint.healthcheck
Returns whether an Endpoint is healthy or not.
HealthChecker - Interface in com.linecorp.armeria.server.http.healthcheck
Determines whether the Server is healthy.
HOST - Static variable in interface com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping.KeySelector
A KeyedCircuitBreakerMapping.KeySelector that returns a key consisted of remote host name and port number.
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.http.HttpHeaderNames
"host".
host() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
host() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the host name of the Request.
HOST_AND_METHOD - Static variable in interface com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping.KeySelector
A KeyedCircuitBreakerMapping.KeySelector that returns a key consisted of remote host name, port number, and method name.
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
HTML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
HTTP - Static variable in class com.linecorp.armeria.common.http.HttpSessionProtocols
HTTP - cleartext, HTTP/2 preferred.
HTTP - Static variable in class com.linecorp.armeria.common.SessionProtocol
Deprecated.
Http1ClientCodec - Class in com.linecorp.armeria.internal.http
A combination of HttpRequestEncoder and HttpResponseDecoder which enables easier client side HTTP implementation.
Http1ClientCodec() - Constructor for class com.linecorp.armeria.internal.http.Http1ClientCodec
Creates a new instance with the default decoder options (maxInitialLineLength (4096}, maxHeaderSize (8192), and maxChunkSize (8192)).
Http1ClientCodec(int, int, int) - Constructor for class com.linecorp.armeria.internal.http.Http1ClientCodec
Creates a new instance with the specified decoder options.
Http1ClientCodec(int, int, int, boolean) - Constructor for class com.linecorp.armeria.internal.http.Http1ClientCodec
Creates a new instance with the specified decoder options.
Http1ClientCodec(int, int, int, boolean, boolean) - Constructor for class com.linecorp.armeria.internal.http.Http1ClientCodec
Creates a new instance with the specified decoder options.
Http1ObjectEncoder - Class in com.linecorp.armeria.internal.http
 
Http1ObjectEncoder(boolean) - Constructor for class com.linecorp.armeria.internal.http.Http1ObjectEncoder
 
HTTP2_HEADER_NAME_HASHER - Static variable in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
The default case-sensitive AsciiString hasher and comparator for HTTP/2 headers.
Http2GoAwayListener - Class in com.linecorp.armeria.internal.http
A Http2ConnectionAdapter that logs the received GOAWAY frames and makes sure disconnection.
Http2GoAwayListener(Channel) - Constructor for class com.linecorp.armeria.internal.http.Http2GoAwayListener
 
Http2ObjectEncoder - Class in com.linecorp.armeria.internal.http
 
Http2ObjectEncoder(Http2ConnectionEncoder) - Constructor for class com.linecorp.armeria.internal.http.Http2ObjectEncoder
 
HTTP_HEADERS - Static variable in class com.linecorp.armeria.client.ClientOption
The additional HTTP headers to send with requests.
HTTP_HEADERS - Static variable in interface com.linecorp.armeria.client.ClientRequestContext
The AttributeKey of the HttpHeaders to include when a Client sends an HttpRequest.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
505 HTTP Version Not Supported.
HttpAuthService - Class in com.linecorp.armeria.server.http.auth
A DecoratingService that provides HTTP authorization functionality.
HttpAuthService(Service<? super HttpRequest, ? extends HttpResponse>) - Constructor for class com.linecorp.armeria.server.http.auth.HttpAuthService
Creates a new instance that provides HTTP authorization functionality to delegate.
HttpAuthServiceBuilder - Class in com.linecorp.armeria.server.http.auth
Builds a new HttpAuthService.
HttpAuthServiceBuilder() - Constructor for class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
 
HttpClient - Interface in com.linecorp.armeria.client.http
An HTTP client.
HttpClientFactory - Class in com.linecorp.armeria.client.http
A ClientFactory that creates an HTTP client.
HttpClientFactory() - Constructor for class com.linecorp.armeria.client.http.HttpClientFactory
Creates a new instance with the default SessionOptions.
HttpClientFactory(boolean) - Constructor for class com.linecorp.armeria.client.http.HttpClientFactory
Creates a new instance with the default SessionOptions.
HttpClientFactory(SessionOptions) - Constructor for class com.linecorp.armeria.client.http.HttpClientFactory
Creates a new instance with the specified SessionOptions.
HttpClientFactory(SessionOptions, boolean) - Constructor for class com.linecorp.armeria.client.http.HttpClientFactory
Creates a new instance with the specified SessionOptions.
HttpClientFactoryProvider - Class in com.linecorp.armeria.client.http
HttpClientFactoryProvider() - Constructor for class com.linecorp.armeria.client.http.HttpClientFactoryProvider
 
HttpData - Interface in com.linecorp.armeria.common.http
HTTP/2 data.
HttpEncodingService - Class in com.linecorp.armeria.server.http.encoding
A DecoratingService that applies HTTP encoding (e.g., gzip) to an HttpService.
HttpEncodingService(Service<? super HttpRequest, ? extends HttpResponse>) - Constructor for class com.linecorp.armeria.server.http.encoding.HttpEncodingService
Creates a new DecoratingService that HTTP encodes response data published from delegate.
HttpEncodingService(Service<? super HttpRequest, ? extends HttpResponse>, Predicate<MediaType>, int) - Constructor for class com.linecorp.armeria.server.http.encoding.HttpEncodingService
Creates a new DecoratingService that HTTP encodes response data published from delegate.
HttpFileService - Class in com.linecorp.armeria.server.http.file
An HttpService that serves static files from a file system.
HttpFileServiceBuilder - Class in com.linecorp.armeria.server.http.file
HttpFileServiceConfig - Class in com.linecorp.armeria.server.http.file
HttpFileService configuration.
HttpHeaderNames - Class in com.linecorp.armeria.common.http
Standard HTTP header names.
httpHeaders() - Method in class com.linecorp.armeria.client.ClientOptions
Returns the additional HTTP headers to send with requests.
HttpHeaders - Interface in com.linecorp.armeria.common.http
HTTP/2 headers.
HttpHeadersJsonDeserializer - Class in com.linecorp.armeria.common.http
Jackson JsonDeserializer for HttpHeaders.
HttpHeadersJsonDeserializer() - Constructor for class com.linecorp.armeria.common.http.HttpHeadersJsonDeserializer
Creates a new instance.
HttpHeadersJsonSerializer - Class in com.linecorp.armeria.common.http
Jackson JsonSerializer for HttpHeaders.
HttpHeadersJsonSerializer() - Constructor for class com.linecorp.armeria.common.http.HttpHeadersJsonSerializer
Creates a new instance.
HttpHealthCheckedEndpointGroup - Class in com.linecorp.armeria.client.endpoint.healthcheck
HTTP implementation of HealthCheckedEndpointGroup.
HttpHealthCheckService - Class in com.linecorp.armeria.server.http.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.
HttpHealthCheckService(HealthChecker...) - Constructor for class com.linecorp.armeria.server.http.healthcheck.HttpHealthCheckService
Creates a new instance.
HttpMethod - Enum in com.linecorp.armeria.common.http
HTTP request method.
HttpObject - Interface in com.linecorp.armeria.common.http
The common interface for HTTP/2 message objects, HttpHeaders and HttpData.
HttpObjectEncoder - Class in com.linecorp.armeria.internal.http
Converts an HttpObject into a protocol-specific object and writes it into a Channel.
HttpObjectEncoder() - Constructor for class com.linecorp.armeria.internal.http.HttpObjectEncoder
 
HttpRequest - Interface in com.linecorp.armeria.common.http
A streamed HTTP/2 Request.
HttpRequestWriter - Interface in com.linecorp.armeria.common.http
HttpResponse - Interface in com.linecorp.armeria.common.http
A streamed HTTP/2 Response.
HttpResponseWriter - Interface in com.linecorp.armeria.common.http
HTTPS - Static variable in class com.linecorp.armeria.common.http.HttpSessionProtocols
HTTP - over TLS, HTTP/2 preferred.
HTTPS - Static variable in class com.linecorp.armeria.common.SessionProtocol
Deprecated.
HttpServerPipelineConfigurator - Class in com.linecorp.armeria.server.http
Configures Netty ChannelPipeline to serve HTTP/1 and 2 requests.
HttpServerPipelineConfigurator(ServerConfig, ServerPort, DomainNameMapping<SslContext>, GracefulShutdownSupport) - Constructor for class com.linecorp.armeria.server.http.HttpServerPipelineConfigurator
Creates a new instance.
HttpService - Interface in com.linecorp.armeria.server.http
An HTTP/2 Service.
HttpSessionProtocolProvider - Class in com.linecorp.armeria.common.http
SessionProtocolProvider that provides the HTTP-related SessionProtocols.
HttpSessionProtocolProvider() - Constructor for class com.linecorp.armeria.common.http.HttpSessionProtocolProvider
 
HttpSessionProtocols - Class in com.linecorp.armeria.common.http
HTTP-related SessionProtocol instances.
HttpStatus - Class in com.linecorp.armeria.common.http
HTTP response code and its description.
HttpStatus(int, String) - Constructor for class com.linecorp.armeria.common.http.HttpStatus
Creates a new instance with the specified code and its reasonPhrase.
HttpStatusClass - Enum in com.linecorp.armeria.common.http
The class of HTTP status.
HttpVfs - Interface in com.linecorp.armeria.server.http.file
A virtual file system that provides the files requested by HttpFileService.
HttpVfs.AbstractEntry - Class in com.linecorp.armeria.server.http.file
A skeletal HttpVfs.Entry implementation.
HttpVfs.ByteArrayEntry - Class in com.linecorp.armeria.server.http.file
An HttpVfs.Entry whose content is backed by a byte array.
HttpVfs.Entry - Interface in com.linecorp.armeria.server.http.file
A file entry in an HttpVfs.

I

I16 - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The signed 16-bit integer type.
I32 - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The signed 32-bit integer type.
I64 - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The signed 64-bit integer type.
I8 - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The signed 8-bit integer type.
I_CALENDAR_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
ICO - Static variable in class com.linecorp.armeria.common.MediaType
 
identify() - Static method in class com.linecorp.armeria.common.util.Version
Retrieves the version information of Armeria artifacts using the current context class loader.
identify(ClassLoader) - Static method in class com.linecorp.armeria.common.util.Version
Retrieves the version information of Armeria artifacts using the specified ClassLoader.
IDLE_TIMEOUT - Static variable in class com.linecorp.armeria.client.SessionOption
The idle timeout of a socket connection.
idleTimeout() - Method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOption.IDLE_TIMEOUT value.
idleTimeout(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the idle timeout of a connection.
IdleTimeoutHandler - Class in com.linecorp.armeria.internal
 
IdleTimeoutHandler(String, long) - Constructor for class com.linecorp.armeria.internal.IdleTimeoutHandler
 
idleTimeoutMillis() - Method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOption.IDLE_TIMEOUT value as milliseconds.
idleTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the idle timeout of a connection in milliseconds.
idleTimeoutMillis() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the idle timeout of a connection in milliseconds.
IF_MATCH - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"if-match".
IF_MODIFIED_SINCE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"if-modified-since".
IF_NONE_MATCH - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"if-none-match".
IF_RANGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"if-range".
IF_UNMODIFIED_SINCE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"if-unmodified-since".
InboundTrafficController - Class in com.linecorp.armeria.internal
 
InboundTrafficController(Channel) - Constructor for class com.linecorp.armeria.internal.InboundTrafficController
 
InboundTrafficController(Channel, int, int) - Constructor for class com.linecorp.armeria.internal.InboundTrafficController
 
inc(int) - Method in class com.linecorp.armeria.internal.InboundTrafficController
 
inc() - Method in class com.linecorp.armeria.server.GracefulShutdownSupport
Increases the number of pending responses.
increaseRequestLength(long) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
increaseRequestLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Increases the RequestLog.requestLength() by deltaBytes.
increaseResponseLength(long) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
increaseResponseLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Increases the RequestLog.responseLength() by deltaBytes.
informationals() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the informational class (1xx) HTTP headers.
init() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Update healty servers and start to schedule healthcheck.
initChannel(Channel) - Method in class com.linecorp.armeria.server.http.HttpServerPipelineConfigurator
 
INSTANCE - Static variable in class com.linecorp.armeria.internal.ReadSuppressingHandler
The singleton ReadSuppressingHandler instance.
INSUFFICIENT_STORAGE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
507 Insufficient Storage (WebDAV, RFC4918).
INTERNAL_SERVER_ERROR - Static variable in class com.linecorp.armeria.common.http.HttpStatus
500 Internal Server Error.
InvalidResponseException - Exception in com.linecorp.armeria.client
A RuntimeException raised when the client received a response with an unexpected status code.
InvalidResponseException() - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance.
InvalidResponseException(String, Throwable) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified message and cause.
InvalidResponseException(String) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified message.
InvalidResponseException(Throwable) - Constructor for exception com.linecorp.armeria.client.InvalidResponseException
Creates a new instance with the specified 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.
invokeOnEnterCallbacks() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
invokeOnEnterCallbacks() - Method in interface com.linecorp.armeria.common.RequestContext
Invokes all RequestContext.onEnter(Runnable) callbacks.
invokeOnEnterCallbacks() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
invokeOnExitCallbacks() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
invokeOnExitCallbacks() - Method in interface com.linecorp.armeria.common.RequestContext
Invokes all RequestContext.onExit(Runnable) callbacks.
invokeOnExitCallbacks() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
invokeOnRequestLog(RequestLogListener, RequestLog) - Static method in class com.linecorp.armeria.common.logging.RequestLogListenerInvoker
invokeServiceAdded(ServiceConfig, Service<?, ?>) - Static method in class com.linecorp.armeria.server.ServiceCallbackInvoker
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 MediaType is accepted by any of the SerializationFormat.mediaTypes() defined by this format.
isAnyOriginSupported() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Determines whether a wildcard origin, '*', is supported.
isAvailable(RequestLogAvailability) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
isAvailable(RequestLogAvailability...) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
isAvailable(Iterable<RequestLogAvailability>) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
isAvailable(RequestLogAvailability) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns true if the specified RequestLogAvailability is satisfied.
isAvailable(RequestLogAvailability...) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns true if all of the specified RequestLogAvailabilitys are satisfied.
isAvailable(Iterable<RequestLogAvailability>) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns true if all of the specified RequestLogAvailabilitys are satisfied.
isClean() - Method in class com.linecorp.armeria.common.util.Version
Returns true if repository status is not dirty.
isClosing() - Method in class com.linecorp.armeria.internal.http.AbstractHttp2ConnectionHandler
Returns true if ChannelOutboundInvoker.close() has been called.
isCompletedExceptionally() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns true if this RpcResponse completed exceptionally.
isContentAlwaysEmpty(HttpStatus) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Returns true if the content of the response with the given HttpStatus is expected to be always empty (1xx, 204, 205 and 304 responses.)
isCredentialsAllowed() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Determines if cookies are supported for CORS requests.
isEmpty() - Method in interface com.linecorp.armeria.common.http.HttpData
Returns whether the HttpData.length() is 0.
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.FilteredStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
isEmpty() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream has been closed and did not publish any elements.
isEnabled(Logger) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Returns true if this level is enabled.
isEnabled() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Determines if support for CORS is enabled.
isEndOfStream() - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
isEndOfStream() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
isEndOfStream() - Method in interface com.linecorp.armeria.common.http.HttpObject
Gets whether the stream should be ended when writing this object.
isEpollAvailable() - Static method in class com.linecorp.armeria.common.util.NativeLibraries
Returns true if JNI-based /dev/epoll transport is available.
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.
isGroup() - Method in class com.linecorp.armeria.client.Endpoint
Returns true if this endpoint refers to a group.
isHealthy(Endpoint) - Method in interface com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup.EndpointHealthChecker
 
isHealthy() - Method in interface com.linecorp.armeria.server.http.healthcheck.HealthChecker
Returns true if and only if the Server is healthy.
isHealthy() - Method in class com.linecorp.armeria.server.http.healthcheck.SettableHealthChecker
 
isHttp(SessionProtocol) - Static method in class com.linecorp.armeria.common.http.HttpSessionProtocols
Returns whether the specified SessionProtocol is HTTP.
isKeepAlive() - Method in class com.linecorp.armeria.common.http.DefaultHttpRequest
 
isKeepAlive() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Returns whether to keep the connection alive after this request is handled.
isMultiplex() - Method in class 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.
isNullOriginAllowed() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system.
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 publisher is not closed yet.
isOpen() - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Returns true if the StreamMessage is open.
isOpenSslAvailable() - Static method in class com.linecorp.armeria.common.util.NativeLibraries
Returns true if JNI-based OpenSSL/BoringSSL/LibreSSL transport is available.
isPresent() - Method in class com.linecorp.armeria.server.PathMapped
Returns true if and only if PathMappings found a matching value.
isRequestContentDeferred() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
isRequestContentDeferred() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Returns true if RequestLogBuilder.deferRequestContent() was ever called.
isResponseContentDeferred() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
isResponseContentDeferred() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Returns true if RequestLogBuilder.deferResponseContent() was ever called.
isShortCircuit() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Determines whether a CORS request should be rejected if it's invalid before being further processing.
isSingleDecode() - Method in class com.linecorp.armeria.internal.http.Http1ClientCodec
 
isTls() - Method in class com.linecorp.armeria.common.SessionProtocol
Returns true if and only if this protocol uses TLS as its transport-level security layer.
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.
isVerbose() - Static method in class com.linecorp.armeria.common.util.Exceptions
Returns whether the verbose mode is enabled.
iterator() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns an iterator over all HTTP/2 headers.

J

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.
JPEG - Static variable in class com.linecorp.armeria.common.MediaType
 
JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 

K

KEEP_ALIVE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
Deprecated.
Use HttpHeaderNames.CONNECTION instead. "keep-alive"
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.
KeyedChannelPool<K> - Interface in com.linecorp.armeria.client.pool
An asynchronous Channel pool that provides key-based acquisition and release.
KeyedChannelPoolHandler<K> - Interface in com.linecorp.armeria.client.pool
Handles the events produced by KeyedChannelPool.
KeyedChannelPoolHandlerAdapter<K> - Class in com.linecorp.armeria.client.pool
A skeletal KeyedChannelPoolHandler implementation to minimize the effort to implement this interface.
KeyedChannelPoolHandlerAdapter() - Constructor for class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerAdapter
 
KeyedChannelPoolLoggingHandler - Class in com.linecorp.armeria.client.logging
Decorates a KeyedChannelPoolHandler to log the connection pool events.
KeyedChannelPoolLoggingHandler(KeyedChannelPoolHandler<PoolKey>) - Constructor for class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
Creates a new instance that decorates the specified handler.
KeyedChannelPoolLoggingHandler(KeyedChannelPoolHandler<PoolKey>, Ticker) - Constructor for class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
Creates a new instance that decorates the specified handler.
KeyedCircuitBreakerMapping<K> - Class in com.linecorp.armeria.client.circuitbreaker
A CircuitBreakerMapping that binds a CircuitBreaker to its key.
KeyedCircuitBreakerMapping(KeyedCircuitBreakerMapping.KeySelector<K>, Function<K, CircuitBreaker>) - Constructor for class com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping
KeyedCircuitBreakerMapping.KeySelector<K> - Interface in com.linecorp.armeria.client.circuitbreaker
Returns the mapping key of the given Request.
keyTypeInfo() - Method in class com.linecorp.armeria.server.docs.MapInfo
Returns the metadata about the key type of the map.
KML - Static variable in class com.linecorp.armeria.common.MediaType
 
KMZ - Static variable in class com.linecorp.armeria.common.MediaType
 

L

L24_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for L24 audio, as defined by RFC 3190.
LAST_MODIFIED - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"last-modified".
lastModifiedMillis() - Method in class com.linecorp.armeria.server.http.file.HttpVfs.ByteArrayEntry
 
lastModifiedMillis() - Method in interface com.linecorp.armeria.server.http.file.HttpVfs.Entry
Returns the modification time of the entry.
length() - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
length() - Method in interface com.linecorp.armeria.common.http.HttpData
Returns the length of this data.
LENGTH_REQUIRED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
411 Length Required.
listener(CircuitBreakerListener) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
ListInfo - Class in com.linecorp.armeria.server.docs
Metadata about a list-type value.
ListInfo(TypeInfo) - Constructor for class com.linecorp.armeria.server.docs.ListInfo
Creates a new instance.
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.ServerPort
Returns the local address this ServerPort listens to.
LOCATION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"location".
LOCKED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
423 Locked (WebDAV, RFC4918).
log() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
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, Object) - Method in enum com.linecorp.armeria.common.logging.LogLevel
Logs a message at this level.
log() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the RequestLog that contains the information about the current Request.
log() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
log(Throwable) - Static method in class com.linecorp.armeria.common.util.CompletionActions
Logs the specified Throwable.
log() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
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.server.DefaultServiceRequestContext
 
logger() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Deprecated.
Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
logger() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
loggerName() - Method in class com.linecorp.armeria.server.AbstractPathMapping
 
loggerName() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the logger name.
loggerName() - Method in class com.linecorp.armeria.server.ServiceConfig
Deprecated.
Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
LoggingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.logging
Decorates a Client to log Requests and Responses.
LoggingClient(Client<? super I, ? extends O>) - Constructor for class com.linecorp.armeria.client.logging.LoggingClient
Creates a new instance that logs Requests and Responses at LogLevel.INFO.
LoggingClient(Client<? super I, ? extends O>, LogLevel) - Constructor for class com.linecorp.armeria.client.logging.LoggingClient
Creates a new instance that logs Requests and Responses at the specified LogLevel.
LoggingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.logging
Decorates a Service to log Requests and Responses.
LoggingService(Service<? super I, ? extends O>) - Constructor for class com.linecorp.armeria.server.logging.LoggingService
Creates a new instance that logs Requests and Responses at LogLevel.INFO.
LoggingService(Service<? super I, ? extends O>, LogLevel) - Constructor for class com.linecorp.armeria.server.logging.LoggingService
Creates a new instance that logs Requests and Responses at the specified LogLevel.
logIfUnexpected(Logger, Channel, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is Exceptions.isExpected(Throwable) unexpected}.
logIfUnexpected(Logger, Channel, String, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is Exceptions.isExpected(Throwable) unexpected}.
logIfUnexpected(Logger, Channel, SessionProtocol, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is Exceptions.isExpected(Throwable) unexpected}.
logIfUnexpected(Logger, Channel, SessionProtocol, String, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is Exceptions.isExpected(Throwable) unexpected}.
LogLevel - Enum in com.linecorp.armeria.common.logging
Log level.
logRequest(RequestLog) - Method in class com.linecorp.armeria.server.logging.LoggingService
Logs a stringified request of RequestLog.
logResponse(RequestLog) - Method in class com.linecorp.armeria.server.logging.LoggingService
Logs a stringified response of RequestLog.
longCommitHash() - Method in class com.linecorp.armeria.common.util.Version
 
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

makeContextAware(Executor) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(Callable<T>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(Runnable) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(Function<T, R>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(BiFunction<T, U, V>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(Consumer<T>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(BiConsumer<T, U>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(FutureListener<T>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(ChannelFutureListener) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(GenericFutureListener<T>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(CompletionStage<T>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
makeContextAware(CompletableFuture<T>) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
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(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(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(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(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(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(FutureListener<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Deprecated.
Use CompletableFuture instead.
makeContextAware(ChannelFutureListener) - Method in interface com.linecorp.armeria.common.RequestContext
Deprecated.
Use CompletableFuture instead.
makeContextAware(GenericFutureListener<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Deprecated.
Use CompletableFuture instead.
makeContextAware(CompletionStage<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a CompletionStage that makes sure the current CompletionStage is set and then invokes the input stage.
makeContextAware(CompletableFuture<T>) - Method in interface com.linecorp.armeria.common.RequestContext
Returns a CompletableFuture that makes sure the current CompletableFuture is set and then invokes the input future.
MANIFEST_JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
Media type for the Manifest for a web application.
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.
MapInfo - Class in com.linecorp.armeria.server.docs
Metadata about a map-type value.
MapInfo(TypeInfo, TypeInfo) - Constructor for class com.linecorp.armeria.server.docs.MapInfo
Creates a new instance.
mappedPath() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
mappedPath() - Method in class com.linecorp.armeria.server.PathMapped
Returns the path translated by PathMappings.
mappedPath() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the path with its context path removed.
mappedPath() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
MAX_FORWARDS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"max-forwards".
maxAge() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Gets the maxAge setting.
maxAge(long) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
When making a preflight request the client has to perform two request with can be inefficient.
maxCacheEntries(int) - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Sets the maximum allowed number of cached file entries.
maxCacheEntries() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceConfig
Returns the maximum allowed number of cached file entries.
maxCacheEntrySizeBytes(int) - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Returns the maximum allowed size of a cached file entry.
maxCacheEntrySizeBytes() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceConfig
Returns the maximum allowed size of a cached file entry.
maxConnections(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed number of open connections.
maxConnections() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum allowed number of open connections.
maxPendingRequests(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed number of pending requests.
maxPendingRequests() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum allowed number of pending requests.
maxRequestLength() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
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
 
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
 
MBOX - Static variable in class com.linecorp.armeria.common.MediaType
 
MediaType - Class in com.linecorp.armeria.common
Represents an Internet Media Type (also known as a MIME Type or Content Type).
mediaType() - Method in class com.linecorp.armeria.common.SerializationFormat
Returns the primary MediaType of this format.
mediaType() - Method in class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
 
mediaType() - Method in interface com.linecorp.armeria.server.http.file.HttpVfs.Entry
Returns the MIME type of the entry.
mediaTypes() - Method in class com.linecorp.armeria.common.SerializationFormat
Returns the media types accepted by this format.
merge(Iterable<ServiceSpecification>) - Static method in class com.linecorp.armeria.server.docs.ServiceSpecification
Merges the specified ServiceSpecifications into one.
METHOD - Static variable in interface com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping.KeySelector
A KeyedCircuitBreakerMapping.KeySelector that returns remote method name as a key.
method() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
method() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the METHOD of this message.
method() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
method(HttpMethod) - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
METHOD - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
":method".
method() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Gets the HttpHeaderNames.METHOD header or null if there is no such header.
method(HttpMethod) - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Sets the HttpHeaderNames.METHOD header.
method() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Returns the method of this request.
method(HttpMethod) - Method in interface com.linecorp.armeria.common.http.HttpRequest
Sets the method of this request.
method() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
method() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the method of the Request.
method() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
method() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the session-layer method name 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_NOT_ALLOWED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
405 Method Not Allowed.
metricName() - Method in class com.linecorp.armeria.server.AbstractPathMapping
 
metricName() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the metric name.
MICROSOFT_EXCEL - Static variable in class com.linecorp.armeria.common.MediaType
 
MICROSOFT_POWERPOINT - Static variable in class com.linecorp.armeria.common.MediaType
 
MICROSOFT_WORD - Static variable in class com.linecorp.armeria.common.MediaType
 
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.http.HttpStatus
421 Misdirected Request.
MOVED_PERMANENTLY - Static variable in class com.linecorp.armeria.common.http.HttpStatus
301 Moved Permanently.
MP4_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
MP4_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
MPEG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
MPEG_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
MULTI_STATUS - Static variable in class com.linecorp.armeria.common.http.HttpStatus
207 Multi-Status (WebDAV, RFC2518).
MULTIPLE_CHOICES - Static variable in class com.linecorp.armeria.common.http.HttpStatus
300 Multiple Choices.

N

NACL_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaType
Media type for NaCl applications.
NACL_PORTABLE_APPLICATION - Static variable in class com.linecorp.armeria.common.MediaType
Media type for NaCl portable applications.
name() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Returns the name of the circuit breaker.
name() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
Returns the fully qualified type name.
name() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
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.FunctionInfo
Returns the name of the function.
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
 
NativeLibraries - Class in com.linecorp.armeria.common.util
Reports the availability of the native libraries used by Armeria.
NETWORK_AUTHENTICATION_REQUIRED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
511 Network Authentication Required (RFC6585).
newBootstrap() - Method in class com.linecorp.armeria.client.http.HttpClientFactory
 
newBootstrap() - Method in class com.linecorp.armeria.client.NonDecoratingClientFactory
Returns a new Bootstrap whose ChannelFactory, AddressResolverGroup and socket options are pre-configured.
newClient(String, Class<T>, ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.AbstractClientFactory
 
newClient(String, Class<T>, ClientOptions) - Method in class com.linecorp.armeria.client.AbstractClientFactory
 
newClient(URI, Class<T>, ClientOptionValue<?>...) - Method in class com.linecorp.armeria.client.AbstractClientFactory
 
newClient(URI, Class<T>, ClientOptions) - Method in class com.linecorp.armeria.client.AllInOneClientFactory
 
newClient(String, Class<T>, ClientOptionValue<?>...) - Method in interface com.linecorp.armeria.client.ClientFactory
Creates a new client that connects to the specified uri.
newClient(String, Class<T>, ClientOptions) - Method in interface com.linecorp.armeria.client.ClientFactory
Creates a new client that connects to the specified uri.
newClient(URI, Class<T>, ClientOptionValue<?>...) - Method in interface com.linecorp.armeria.client.ClientFactory
Creates a new client that connects to the specified URI using the default ClientFactory.
newClient(URI, Class<T>, ClientOptions) - Method in interface com.linecorp.armeria.client.ClientFactory
Creates a new client that connects to the specified URI using the default ClientFactory.
newClient(String, Class<T>, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified uri using the default ClientFactory.
newClient(String, Class<T>, ClientOptions) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified uri using the default ClientFactory.
newClient(ClientFactory, String, Class<T>, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified uri using an alternative ClientFactory.
newClient(ClientFactory, String, Class<T>, ClientOptions) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified uri using an alternative ClientFactory.
newClient(URI, Class<T>, ClientOptionValue<?>...) - 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>, ClientOptions) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified URI using the default ClientFactory.
newClient(ClientFactory, URI, Class<T>, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified URI using an alternative ClientFactory.
newClient(ClientFactory, URI, Class<T>, ClientOptions) - Static method in class com.linecorp.armeria.client.Clients
Creates a new client that connects to the specified URI using an alternative ClientFactory.
newClient(URI, Class<T>, ClientOptions) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
newClient(URI, Class<T>, ClientOptions) - Method in class com.linecorp.armeria.client.http.HttpClientFactory
 
newDecorator(CircuitBreaker) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator using the specified CircuitBreaker instance.
newDecorator(CircuitBreakerMapping) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator with the specified CircuitBreakerMapping.
newDecorator(int) - Static method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingHttpClient
Creates a new Client decorator that limits the concurrent number of active HTTP requests.
newDecorator(int, long, TimeUnit) - Static method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingHttpClient
Creates a new Client decorator that limits the concurrent number of active HTTP requests.
newDecorator(MetricRegistry, Function<? super RequestLog, String>) - Static method in class com.linecorp.armeria.client.logging.DropwizardMetricCollectingClient
Returns a Client decorator that tracks request stats using the Dropwizard metrics library.
newDecorator(MetricRegistry, String) - Static method in class com.linecorp.armeria.client.logging.DropwizardMetricCollectingClient
Returns a Client decorator that tracks request stats using the Dropwizard metrics library.
newDecorator(Iterable<? extends Authorizer<HttpRequest>>) - Static method in class com.linecorp.armeria.server.http.auth.HttpAuthService
Creates a new HTTP authorization Service decorator using the specified Authorizers.
newDecorator(Authorizer<HttpRequest>...) - Static method in class com.linecorp.armeria.server.http.auth.HttpAuthService
Creates a new HTTP authorization Service decorator using the specified Authorizers.
newDecorator() - Method in class com.linecorp.armeria.server.http.auth.HttpAuthServiceBuilder
Creates a new HttpAuthService Service decorator that supports all of the given authorization Authorizers.
newDecorator() - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Creates a new decorator that decorates a Service with a new CorsService.
newDecorator(MetricRegistry, Function<? super RequestLog, String>) - Static method in class com.linecorp.armeria.server.logging.DropwizardMetricCollectingService
Returns a new Service decorator that tracks request stats using the Dropwizard metrics library.
newDecorator(MetricRegistry, String) - Static method in class com.linecorp.armeria.server.logging.DropwizardMetricCollectingService
Returns a new Service decorator that tracks request stats using the Dropwizard metrics library.
newDecorator() - Static method in class com.linecorp.armeria.server.logging.SampledLoggingService
Creates a new instance that logs Requests and Responses at LogLevel.INFO.
newDecorator(boolean, boolean, float) - Static method in class com.linecorp.armeria.server.logging.SampledLoggingService
Creates a new instance that logs Requests at LogLevel.INFO if logRequest is true and logs Responses at LogLevel.INFO if logRequest is true.
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.
newEndpoint(URI) - Static method in class com.linecorp.armeria.client.AbstractClientFactory
Creates a new Endpoint from the authority part of the specified URI.
newFactory(SessionOptions, Map<Class<?>, ClientFactory>) - Method in interface com.linecorp.armeria.client.ClientFactoryProvider
Creates a new ClientFactory.
newFactory(SessionOptions, Map<Class<?>, ClientFactory>) - Method in class com.linecorp.armeria.client.http.HttpClientFactoryProvider
 
newHealthyResponse(ServiceRequestContext) - Method in class com.linecorp.armeria.server.http.healthcheck.HttpHealthCheckService
Creates a new response which is sent when the Server is healthy.
newMetricSet(String) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Creates healthcheck MetricSet for this HealthCheckedEndpointGroup.
newPerHostAndMethodDecorator(Function<String, CircuitBreaker>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per host and method.
newPerHostDecorator(Function<String, CircuitBreaker>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per host.
newPerMethodDecorator(Function<String, CircuitBreaker>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new decorator that binds one CircuitBreaker per method.
newSelector(EndpointGroup) - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Creates a new EndpointSelector that selects an Endpoint from the specified EndpointGroup.
newUnhealthyResponse(ServiceRequestContext) - Method in class com.linecorp.armeria.server.http.healthcheck.HttpHealthCheckService
Creates a new response which is sent when the Server is unhealthy.
newValue(T) - Method in class com.linecorp.armeria.client.ClientOption
Creates a new value of this option.
newValue(T) - Method in class com.linecorp.armeria.client.SessionOption
Creates a new value of this option.
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.http.HttpStatus
204 No Content.
NON_AUTHORITATIVE_INFORMATION - Static variable in class com.linecorp.armeria.common.http.HttpStatus
203 Non-Authoritative Information (since HTTP/1.1).
nonce() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
NonDecoratingClientFactory - Class in com.linecorp.armeria.client
A skeletal ClientFactory that does not decorate other ClientFactory.
NonDecoratingClientFactory(boolean) - Constructor for class com.linecorp.armeria.client.NonDecoratingClientFactory
Creates a new instance with the default SessionOptions.
NonDecoratingClientFactory(SessionOptions, boolean) - Constructor for class com.linecorp.armeria.client.NonDecoratingClientFactory
Creates a new instance with the specified SessionOptions.
NONE - Static variable in class com.linecorp.armeria.client.ClientDecoration
A ClientDecoration that decorates no Client.
NONE - Static variable in class com.linecorp.armeria.common.SerializationFormat
No serialization format.
NONE - Static variable in interface com.linecorp.armeria.server.http.file.HttpVfs.Entry
A non-existent entry.
NonWrappingRequestContext - Class in com.linecorp.armeria.common
Default RequestContext implementation.
NonWrappingRequestContext(SessionProtocol, String, String, Object) - Constructor for class com.linecorp.armeria.common.NonWrappingRequestContext
Creates a new instance.
NOOP - Static variable in interface com.linecorp.armeria.common.logging.RequestLogBuilder
A dummy RequestLogBuilder that discards everything it collected.
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
 
NOT_ACCEPTABLE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
406 Not Acceptable.
NOT_EXTENDED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
510 Not Extended (RFC2774).
NOT_FOUND - Static variable in class com.linecorp.armeria.common.http.HttpStatus
404 Not Found.
NOT_IMPLEMENTED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
501 Not Implemented.
NOT_MODIFIED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
304 Not Modified.
numActiveRequests() - Method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Returns the number of the Requests that are being executed.
numBosses(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the number of boss threads.
numBosses() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the number of boss threads.
numDeferredReads() - Static method in class com.linecorp.armeria.internal.InboundTrafficController
 
numWorkers(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the number of worker threads that performs socket I/O and runs Service.serve(ServiceRequestContext, Request).
numWorkers() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the number of worker threads that perform socket I/O and run Service.serve(ServiceRequestContext, Request).

O

OAUTH1A - Static variable in class com.linecorp.armeria.server.http.auth.AuthTokenExtractors
An OAuth1aToken extractor function instance.
OAuth1aToken - Class in com.linecorp.armeria.server.http.auth
The bearer token of OAuth 1.0a authentication.
OAUTH2 - Static variable in class com.linecorp.armeria.server.http.auth.AuthTokenExtractors
An OAuth2Token extractor function instance.
OAuth2Token - Class in com.linecorp.armeria.server.http.auth
The bearer token of OAuth 2.0 authentication.
obtrudeException(Throwable) - Method in class com.linecorp.armeria.common.DefaultRpcResponse
 
OCTET_STREAM - Static variable in class com.linecorp.armeria.common.MediaType
 
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(Class<I>, Class<O>, Function<T, R>) - Static method in class com.linecorp.armeria.client.ClientDecoration
Creates a new instance from a single decorator Function.
of(ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.ClientOptions
Returns the ClientOptions with the specified ClientOptionValues.
of(Iterable<ClientOptionValue<?>>) - Static method in class com.linecorp.armeria.client.ClientOptions
Returns the ClientOptions with the specified ClientOptionValues.
of(ClientOptions, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.ClientOptions
Merges the specified ClientOptions and ClientOptionValues.
of(ClientOptions, Iterable<ClientOptionValue<?>>) - Static method in class com.linecorp.armeria.client.ClientOptions
Merges the specified ClientOptions and ClientOptionValues.
of(ClientOptions, ClientOptions) - Static method in class com.linecorp.armeria.client.ClientOptions
Merges the specified two ClientOptions into one.
of(EndpointGroup, String) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroup
Creates a new HttpHealthCheckedEndpointGroup instance.
of(EndpointGroup, String, Duration) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroup
Creates a new HttpHealthCheckedEndpointGroup instance.
of(ClientFactory, EndpointGroup, String, Duration) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroup
Creates a new HttpHealthCheckedEndpointGroup instance.
of(String, int) - Static method in class com.linecorp.armeria.client.Endpoint
Creates a new host Endpoint.
of(String) - Static method in class com.linecorp.armeria.client.Endpoint
Creates a new host Endpoint with unspecified port number.
of(String, int, int) - Static method in class com.linecorp.armeria.client.Endpoint
Creates a new host Endpoint.
of(SessionOptionValue<?>...) - Static method in class com.linecorp.armeria.client.SessionOptions
Creates a new SessionOptions with the specified SessionOptionValues.
of(Iterable<SessionOptionValue<?>>) - Static method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOptions with the specified SessionOptionValues.
of(SessionOptions, SessionOptionValue<?>...) - Static method in class com.linecorp.armeria.client.SessionOptions
Merges the specified SessionOptions and SessionOptionValues.
of(SessionOptions, Iterable<SessionOptionValue<?>>) - Static method in class com.linecorp.armeria.client.SessionOptions
Merges the specified SessionOptions and SessionOptionValues.
of(SessionOptions, SessionOptions) - Static method in class com.linecorp.armeria.client.SessionOptions
Merges the specified two SessionOptions into one.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP request with empty content.
of(HttpMethod, String, HttpData) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP request.
of(int) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP response with empty content.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP response with empty content.
of(HttpStatus, HttpData) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP response.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP message with empty content.
of(HttpHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP message.
of(HttpHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP message.
of(Iterable<HttpHeaders>, HttpHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Creates a new HTTP message.
of(byte[]) - Static method in interface com.linecorp.armeria.common.http.HttpData
Creates a new instance from the specified byte array.
of(byte[], int, int) - Static method in interface com.linecorp.armeria.common.http.HttpData
Creates a new instance from the specified byte array, offset and length.
of(Charset, String) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified text into an HttpData.
of(ByteBuf) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified Netty ByteBuf into an HttpData.
of(Charset, String, Object...) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified formatted string into an HttpData.
of(String) - Static method in class com.linecorp.armeria.common.http.HttpHeaderNames
Lower-cases and converts the specified header name into an AsciiString.
of() - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new empty HTTP headers.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP request headers.
of(int) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP response headers.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP response headers.
of(AsciiString, String) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP headers with a single entry.
of(AsciiString, String, AsciiString, String) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP headers with two entries.
of(AsciiString, String, AsciiString, String, AsciiString, String) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP headers with three entries.
of(AsciiString, String, AsciiString, String, AsciiString, String, AsciiString, String) - Static method in interface com.linecorp.armeria.common.http.HttpHeaders
Returns new HTTP headers with four entries.
of(HttpHeaders, Publisher<? extends HttpObject>) - Static method in interface com.linecorp.armeria.common.http.HttpRequest
Creates a new instance from an existing HttpHeaders and Publisher.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.http.HttpRequest
Returns a new HttpRequest with empty content.
of(Publisher<? extends HttpObject>) - Static method in interface com.linecorp.armeria.common.http.HttpResponse
Creates a new instance from an existing Publisher.
of(Class<?>, String) - Static method in interface com.linecorp.armeria.common.RpcRequest
Creates a new instance with no parameter.
of(Class<?>, String, Object) - Static method in interface com.linecorp.armeria.common.RpcRequest
Creates a new instance with a single parameter.
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 the specified parameters.
of(Object) - Static method in interface com.linecorp.armeria.common.RpcResponse
Creates a new successfully complete RpcResponse.
of(SerializationFormat, SessionProtocol) - Static method in class com.linecorp.armeria.common.Scheme
Returns the Scheme of the specified SerializationFormat and SessionProtocol.
of(String) - Static method in class com.linecorp.armeria.common.SerializationFormat
Returns the SerializationFormat with the specified SerializationFormat.uriText().
of(String) - Static method in class com.linecorp.armeria.common.SessionProtocol
Returns the SessionProtocol with the specified SessionProtocol.uriText().
of(PathMapping, Service<I, O>) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Creates a new CompositeServiceEntry with the specified PathMapping and Service.
of(String, String) - Static method in class com.linecorp.armeria.server.http.auth.BasicToken
Creates a new BasicToken from the given username and password.
of(Map<String, String>) - Static method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
Creates a new OAuth1aToken from the given arguments.
of(String) - Static method in class com.linecorp.armeria.server.http.auth.OAuth2Token
Creates a new OAuth2Token from the given accessToken.
of(String, T) - Static method in class com.linecorp.armeria.server.PathMapped
Creates a new PathMapped with the specified mappedPath and value.
ofAscii(String) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified text into a US-ASCII HttpData.
ofAscii(String, Object...) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified formatted string into a US-ASCII HttpData.
ofCatchAll(Service<I, O>) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
ofCatchAll() - Static method in interface com.linecorp.armeria.server.PathMapping
Returns a singleton PathMapping that always matches any path.
ofClassPath(String) - Static method in interface com.linecorp.armeria.server.http.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in the current class path.
ofClassPath(ClassLoader, String) - Static method in interface com.linecorp.armeria.server.http.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in the current class path.
ofDefaultName() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Creates a new CircuitBreaker that has a default name and the default configurations.
ofExact(String, Service<I, O>) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Creates a new CompositeServiceEntry whose Service is bound at the specified exact path.
ofExact(String) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that performs an exact match.
ofFailure(Throwable) - Static method in interface com.linecorp.armeria.common.RpcResponse
Creates a new exceptionally complete RpcResponse.
offerChannel(K, Channel) - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
Adds a Channel to this pool.
ofFileSystem(String) - Static method in interface com.linecorp.armeria.server.http.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in an O/S file system.
ofFileSystem(Path) - Static method in interface com.linecorp.armeria.server.http.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in an O/S file system.
offset() - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
offset() - Method in interface com.linecorp.armeria.common.http.HttpData
Returns the start offset of the HttpData.array().
ofGlob(String, Service<I, O>) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Creates a new CompositeServiceEntry whose Service is bound at the path that matches the specified glob pattern.
ofGlob(String) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches a path with the specified glob expression, where "*" matches a path component non-recursively and "**" matches path components recursively.
ofGroup(String) - Static method in class com.linecorp.armeria.client.Endpoint
Creates a new group Endpoint.
ofHttp() - Static method in class com.linecorp.armeria.common.SessionProtocol
ofPrefix(String, Service<I, O>) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Creates a new CompositeServiceEntry whose Service is bound under the specified directory.
ofPrefix(String, Service<I, O>, boolean) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Creates a new CompositeServiceEntry whose Service is bound under the specified directory.
ofPrefix(String) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches a path under the specified directory prefix.
ofPrefix(String, boolean) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches a path under the specified directory prefix.
ofRegex(Pattern, Service<I, O>) - Static method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Creates a new CompositeServiceEntry whose Service is bound at the path that matches the specified regular expression.
ofRegex(Pattern) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches a path with the specified regular expression, as defined in Pattern.
ofRegex(String) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches a path with the specified regular expression, as defined in Pattern.
ofThrift() - Static method in class com.linecorp.armeria.common.SerializationFormat
Deprecated.
Use ThriftSerializationFormats.values().
ofUtf8(String) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified text into a UTF-8 HttpData.
ofUtf8(String, Object...) - Static method in interface com.linecorp.armeria.common.http.HttpData
Converts the specified formatted string into a UTF-8 HttpData.
OGG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
OGG_CONTAINER - Static variable in class com.linecorp.armeria.common.MediaType
 
OGG_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
OK - Static variable in class com.linecorp.armeria.common.http.HttpStatus
200 OK.
onCloseRequest(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.http.AbstractHttp2ConnectionHandler
Invoked when a close request has been issued by ChannelOutboundInvoker.close() and all active streams have been closed.
onComplete() - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onConnectionError(ChannelHandlerContext, Throwable, Http2Exception) - Method in class com.linecorp.armeria.internal.http.AbstractHttp2ConnectionHandler
 
onDemand(Runnable) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
onDemand(Runnable) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Performs the specified task when there's enough demans from the Subscriber.
onEnter(Runnable) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
onEnter(Runnable) - Method in interface com.linecorp.armeria.common.RequestContext
Registers callback to be run when re-entering this RequestContext, usually when using the RequestContext.makeContextAware(java.util.concurrent.Executor) family of methods.
onEnter(Runnable) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
onError(Throwable) - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onEventCountUpdated(CircuitBreaker, EventCount) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit breaker's internal EventCount is updated.
onEventCountUpdated(CircuitBreaker, EventCount) - Method in class com.linecorp.armeria.client.circuitbreaker.metrics.DropwizardMetricsCircuitBreakerListener
 
onExit(Runnable) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
onExit(Runnable) - Method in interface com.linecorp.armeria.common.RequestContext
Registers callback to be run when re-exiting this RequestContext, usually when using the RequestContext.makeContextAware(java.util.concurrent.Executor) family of methods.
onExit(Runnable) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
onFailure(Throwable) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Reports a remote invocation failure with the reason.
onFailure() - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Reports a remote invocation failure.
onFailure(ServiceRequestContext, HttpRequest, Throwable) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthService
Invoked when req is failed.
onGoAwayReceived(int, long, ByteBuf) - Method in class com.linecorp.armeria.internal.http.Http2GoAwayListener
 
onGoAwaySent(int, long, ByteBuf) - Method in class com.linecorp.armeria.internal.http.Http2GoAwayListener
 
onNext(T) - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onRemoval(T) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
Invoked after an element is removed from the Queue and before Subscriber.onNext(Object) is invoked.
onRequestEnd(RequestLog) - Method in class com.linecorp.armeria.internal.logging.DropwizardMetricCollector
 
onRequestLog(RequestLog) - Method in interface com.linecorp.armeria.common.logging.RequestLogListener
onRequestRejected(CircuitBreaker) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit breaker rejects a request.
onRequestRejected(CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.metrics.DropwizardMetricsCircuitBreakerListener
 
onRequestStart(RequestLog) - Method in class com.linecorp.armeria.internal.logging.DropwizardMetricCollector
 
onRequestTimeoutChange(long) - Method in interface com.linecorp.armeria.server.RequestTimeoutChangeListener
Invoked when the request timeout of the current request has been changed.
onResponse(RequestLog) - Method in class com.linecorp.armeria.internal.logging.DropwizardMetricCollector
 
onStateChanged(CircuitBreaker, CircuitState) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerListener
Invoked when the circuit state is changed.
onStateChanged(CircuitBreaker, CircuitState) - Method in class com.linecorp.armeria.client.circuitbreaker.metrics.DropwizardMetricsCircuitBreakerListener
 
onStreamRemoved(Http2Stream) - Method in class com.linecorp.armeria.internal.http.Http2GoAwayListener
 
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(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthService
Invoked when req is successful.
OOXML_DOCUMENT - Static variable in class com.linecorp.armeria.common.MediaType
 
OOXML_PRESENTATION - Static variable in class com.linecorp.armeria.common.MediaType
 
OOXML_SHEET - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_GRAPHICS - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_PRESENTATION - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_SPREADSHEET - Static variable in class com.linecorp.armeria.common.MediaType
 
OPENDOCUMENT_TEXT - Static variable in class com.linecorp.armeria.common.MediaType
 
option() - Method in class com.linecorp.armeria.common.util.AbstractOptionValue
Returns the option that this option value holder belongs to.
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 session-layer options of the connections created by 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.DefaultClientBuilderParams
 
options() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
options(String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP OPTIONS request.
options() - Method in class com.linecorp.armeria.client.NonDecoratingClientFactory
 
options() - Method in class com.linecorp.armeria.client.UserClient
 
Options - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.OPTIONS onto specific method.
orElse(EndpointGroup) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
 
orElse(Service<?, ? extends HttpResponse>) - Method in class com.linecorp.armeria.server.http.file.HttpFileService
Creates a new HttpService that tries this HttpFileService first and then the specified HttpService when this HttpFileService does not have a requested resource.
ORIGIN - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"origin".
origin() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Returns the allowed origin.
origins() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Returns the set of allowed origins.

P

packageName() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
Returns the package name.
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.FunctionInfo
Returns the metadata about the parameters of the function.
params() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
params() - Method in interface com.linecorp.armeria.common.RpcRequest
Returns the parameters.
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.
PARTIAL_CONTENT - Static variable in class com.linecorp.armeria.common.http.HttpStatus
206 Partial Content.
password() - Method in class com.linecorp.armeria.server.http.auth.BasicToken
 
patch(String, HttpData) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PATCH request with the specified content.
patch(String, byte[]) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PATCH request with the specified content.
patch(String, String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PATCH request with the specified content.
patch(String, String, Charset) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PATCH request with the specified content.
Patch - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.PATCH onto specific method.
path() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the PATH of this message.
path() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
path(String) - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
PATH - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
":path".
path() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Gets the HttpHeaderNames.PATH header or null if there is no such header.
path(String) - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Sets the HttpHeaderNames.PATH header.
path() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Returns the path of this request.
path(String) - Method in interface com.linecorp.armeria.common.http.HttpRequest
Sets the path of this request.
path() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
path() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the path of the 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, as defined in the section 5.1.2 of RFC2616.
path() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
path() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the path of this endpoint.
Path - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping dynamic web requests onto specific method.
PathMapped<T> - Class in com.linecorp.armeria.server
A value mapped by PathMappings.
pathMapping() - Method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
pathMapping() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
PathMapping - Interface in com.linecorp.armeria.server
Matches the absolute path part of a URI and translates the matched path to another path string.
pathMapping() - Method in class com.linecorp.armeria.server.ServiceConfig
pathMapping() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the PathMapping associated with the Service that is handling the current Request.
pathMapping() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
PathMappings<T> - Class in com.linecorp.armeria.server
Maps a request path to a value associated with a matching PathMapping.
PathMappings() - Constructor for class com.linecorp.armeria.server.PathMappings
Creates a new instance with the default thread-local cache size (1024).
PathMappings(int) - Constructor for class com.linecorp.armeria.server.PathMappings
Creates a new instance with the specified thread-local LRU cacheSize.
PathParam - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping dynamic web requests onto specific parameter.
PAYMENT_REQUIRED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
402 Payment Required.
PDF - Static variable in class com.linecorp.armeria.common.MediaType
 
PLAIN_TEXT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
PNG - Static variable in class com.linecorp.armeria.common.MediaType
 
pollChannel(K) - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
Removes a Channel that matches the specified key from this pool.
POOL_HANDLER_DECORATOR - Static variable in class com.linecorp.armeria.client.SessionOption
The Function that decorates the KeyedChannelPoolHandler.
poolHandlerDecorator() - Method in class com.linecorp.armeria.client.SessionOptions
PoolKey - Class in com.linecorp.armeria.client.pool
The default key of KeyedChannelPool.
PoolKey(InetSocketAddress, SessionProtocol) - Constructor for class com.linecorp.armeria.client.pool.PoolKey
Creates a new key with the specified remoteAddress and sessionProtocol.
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
Returns the port number of this endpoint.
port(int, String) - 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 protocol.
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 SessionProtocol.
port(InetSocketAddress, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified localAddress using the specified protocol.
port(InetSocketAddress, SessionProtocol) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocol.
port(ServerPort) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the specified ServerPort.
ports() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ServerPorts to listen on.
post(String, HttpData) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP POST request with the specified content.
post(String, byte[]) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP POST request with the specified content.
post(String, String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP POST request with the specified content.
post(String, String, Charset) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP POST request with the specified content.
Post - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.POST onto specific method.
POSTSCRIPT - Static variable in class com.linecorp.armeria.common.MediaType
 
PRAGMA - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"pragma".
PRECONDITION_FAILED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
412 Precondition Failed.
PRECONDITION_REQUIRED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
428 Precondition Required (RFC6585).
preflightResponseHeader(String, Object...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeader(AsciiString, Object...) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeader(AsciiString, Iterable<T>) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeader(AsciiString, Supplier<T>) - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeaders() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
Returns HTTP response headers that should be added to a CORS preflight response.
prepareUpgradeFrom(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.http.Http1ClientCodec
 
prepend(String) - Method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that prepends the specified pathPrefix to the matched path.
PROCESSING - Static variable in class com.linecorp.armeria.common.http.HttpStatus
102 Processing (WebDAV, RFC2518).
PROTOBUF - Static variable in class com.linecorp.armeria.common.MediaType
protocol() - Method in class com.linecorp.armeria.server.ServerPort
Returns the SessionProtocol 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.
ProtocolViolationException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
PROXY_AUTHENTICATE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"proxy-authenticate".
PROXY_AUTHENTICATION_REQUIRED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
407 Proxy Authentication Required.
PROXY_AUTHORIZATION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"proxy-authorization".
PROXY_CONNECTION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
Deprecated.
Use HttpHeaderNames.CONNECTION instead. "proxy-connection"
PSD - Static variable in class com.linecorp.armeria.common.MediaType
The media type for the Photoshop File Format (psd files) as defined by IANA, and found in /etc/mime.types, e.g.
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(RequestContext) - Static method in interface com.linecorp.armeria.common.RequestContext
Pushes the specified context to the thread-local stack.
push(RequestContext, boolean) - Static method in interface com.linecorp.armeria.common.RequestContext
Pushes the specified context to the thread-local stack.
put(String, HttpData) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PUT request with the specified content.
put(String, byte[]) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PUT request with the specified content.
put(String, String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PUT request with the specified content.
put(String, String, Charset) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP PUT request with the specified content.
Put - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.PUT onto specific method.

Q

QUICKTIME - Static variable in class com.linecorp.armeria.common.MediaType
 

R

RANGE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"range".
rawRequestContent() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
rawRequestContent() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the low-level content object of the Request, which is specific to the SerializationFormat.
rawResponseContent() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
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
 
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(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.ReadSuppressingHandler
 
readContent(InputStream) - Method in class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
Reads the content of the entry into a new buffer.
readContent(InputStream, int) - Method in class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
Reads the content of the entry into a new buffer.
readContent() - Method in class com.linecorp.armeria.server.http.file.HttpVfs.ByteArrayEntry
 
readContent() - Method in interface com.linecorp.armeria.server.http.file.HttpVfs.Entry
Reads the content of the entry into a new buffer.
ReadSuppressingHandler - Class in com.linecorp.armeria.internal
A ChannelOutboundHandler that suppresses unnecessary ChannelHandlerContext.read() calls when auto-read is disabled.
realm() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
reasonPhrase() - Method in class com.linecorp.armeria.common.http.HttpStatus
Returns the reason phrase of this HttpStatus.
REFERER - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"referer".
register(String, EndpointGroup, EndpointSelectionStrategy) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Registers the specified EndpointGroup.
rejectPromise(Promise<?>, Throwable) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
rejectPromise(Promise<?>, Throwable) - Method in interface com.linecorp.armeria.common.RequestContext
Deprecated.
Use CompletableFuture instead.
release(K, Channel) - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
 
release(K, Channel, Promise<Void>) - Method in class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
 
release(K, Channel) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Releases the acquired Channel to the pool.
release(K, Channel, Promise<Void>) - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Releases the acquired Channel to the pool and get notified with the specified Promise.
remoteAddress() - Method in class com.linecorp.armeria.client.pool.PoolKey
Returns the remote address of the server associated with this key.
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
 
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.
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.
report() - Static method in class com.linecorp.armeria.common.util.NativeLibraries
Logs the availability of the native libraries used by Armeria.
repositoryStatus() - Method in class com.linecorp.armeria.common.util.Version
 
request() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
Request - Interface in com.linecorp.armeria.common
A request.
request() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the Request associated with this context.
request() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
REQUEST_ENTITY_TOO_LARGE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
413 Request Entity Too Large.
REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
431 Request Header Fields Too Large (RFC6585).
REQUEST_TIMEOUT - Static variable in class com.linecorp.armeria.common.http.HttpStatus
408 Request Timeout.
REQUEST_URI_TOO_LONG - Static variable in class com.linecorp.armeria.common.http.HttpStatus
414 Request-URI Too Long.
requestCause() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestCause() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the cause of request processing failure.
requestContent() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestContent(Object, Object) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestContent() - Method in interface com.linecorp.armeria.common.logging.RequestLog
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
RequestContext - Interface in com.linecorp.armeria.common
Provides information about a Request, its Response and related utilities.
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.
requestDurationNanos() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestDurationNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
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.http.HttpStatus
416 Requested Range Not Satisfiable.
requestEnvelope() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestEnvelope(Object) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestEnvelope() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the SessionProtocol-level envelope object of the Request.
requestEnvelope(Object) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestLength() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestLength(long) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestLength() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the length of the request content.
requestLength(long) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
RequestLog - Interface in com.linecorp.armeria.common.logging
A set of informational properties collected while processing a Request and its Response.
RequestLogAvailability - Enum in com.linecorp.armeria.common.logging
Tells which properties are available in a RequestLog.
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.
RequestLogAvailabilityException(String, Throwable, boolean, boolean) - Constructor for exception com.linecorp.armeria.common.logging.RequestLogAvailabilityException
Creates a new instance with the specified message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
RequestLogBuilder - Interface in com.linecorp.armeria.common.logging
Updates a RequestLog with newly available information.
RequestLogListener - Interface in com.linecorp.armeria.common.logging
RequestLogListenerInvoker - Class in com.linecorp.armeria.common.logging
Utility methods that invokes the callback methods of RequestLogListener safely.
requestSize() - Method in class com.linecorp.armeria.server.logging.structured.StructuredLog
Returns the size of request payload.
requestStartTimeMillis() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestStartTimeMillis() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the request started, in millis since the epoch.
RequestTimeoutChangeListener - Interface in com.linecorp.armeria.server
A listener that is notified when request timeout setting is changed.
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 interface com.linecorp.armeria.server.ServiceRequestContext
Returns the amount of time allowed until receiving the current Request completely.
requestTimeoutMillis() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
requirement() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the requirement level of the field.
RESET_CONTENT - Static variable in class com.linecorp.armeria.common.http.HttpStatus
205 Reset Content.
resolve() - Method in class com.linecorp.armeria.client.Endpoint
Resolves this endpoint into a host endpoint.
resolvePromise(Promise<?>, Object) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
resolvePromise(Promise<?>, Object) - Method in interface com.linecorp.armeria.common.RequestContext
Deprecated.
Use CompletableFuture instead.
ResourceNotFoundException - Exception in com.linecorp.armeria.server
A RuntimeException raised when a Service failed to find a resource.
respond(int) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified statusCode and closes the stream if the HttpStatusClass is not informational (1xx).
respond(HttpStatus) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
respond(HttpStatus, MediaType, String) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
respond(HttpStatus, MediaType, String, Object...) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
respond(HttpStatus, MediaType, byte[]) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
respond(HttpStatus, MediaType, byte[], int, int) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
respond(HttpStatus, MediaType, HttpData) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
respond(AggregatedHttpMessage) - Method in interface com.linecorp.armeria.common.http.HttpResponseWriter
Writes the specified HTTP response and closes the stream.
response() - Method in interface com.linecorp.armeria.client.limit.ConcurrencyLimitingClient.Deferred
Returns the Response which will delegate to the Response set by ConcurrencyLimitingClient.Deferred.delegate(Response).
Response - Interface in com.linecorp.armeria.common
A response stream or a holder of the future result value.
responseCause() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseCause() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the cause of response processing failure.
responseContent() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseContent(Object, Object) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
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
ResponseConverter - Interface in com.linecorp.armeria.server.http.dynamic
Converts given object into HttpResponse.
responseDurationNanos() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
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.
responseEnvelope() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseEnvelope(Object) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseEnvelope() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the SessionProtocol-level envelope object of the Response.
responseEnvelope(Object) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseLength() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseLength(long) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
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
responseSize() - Method in class com.linecorp.armeria.server.logging.structured.StructuredLog
Returns the size of response payload.
responseStartTimeMillis() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseStartTimeMillis() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response started, in millis since the epoch.
responseTimeNanos() - Method in class com.linecorp.armeria.server.logging.structured.StructuredLog
Returns the duration in ms of the time that is taken to process the request.
ResponseTimeoutException - Exception in com.linecorp.armeria.client
A TimeoutException raised when a response has not been received from a server within timeout.
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.
responseTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
responseTimeoutMillis() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
RETRY_AFTER - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"retry-after".
returnTypeInfo() - Method in class com.linecorp.armeria.server.docs.FunctionInfo
Returns the metadata about the return type of the function.
ROUND_ROBIN - Static variable in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Simple round-robin strategy.
RpcRequest - Interface in com.linecorp.armeria.common
An RPC Request.
RpcResponse - Interface in com.linecorp.armeria.common
An RPC Response.
RTF_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 

S

SafeCloseable - Interface in com.linecorp.armeria.common.util
An AutoCloseable whose SafeCloseable.close() method does not throw an exception.
SampledLoggingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.logging
Decorates a Service to log Requests and Responses.
SampledLoggingService(Service<? super I, ? extends O>, LogLevel, boolean, boolean, float) - Constructor for class com.linecorp.armeria.server.logging.SampledLoggingService
Creates a new instance that logs Requests and Responses at the specified LogLevel.
sampleJsonRequest() - Method in class com.linecorp.armeria.server.docs.FunctionInfo
Returns the sample request of the function, serialized in JSON format.
scheme() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the SCHEME of this message.
scheme() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
scheme(String) - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
SCHEME - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
":scheme".
scheme() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Gets the HttpHeaderNames.SCHEME header or null if there is no such header.
scheme(String) - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Sets the HttpHeaderNames.SCHEME header.
scheme() - Method in interface com.linecorp.armeria.common.http.HttpRequest
Returns the scheme of this request.
scheme(String) - Method in interface com.linecorp.armeria.common.http.HttpRequest
Sets the scheme of this request.
scheme() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
scheme() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the Scheme of the Request.
Scheme - Class in com.linecorp.armeria.common
SEC_WEBSOCKET_ACCEPT - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-accept".
SEC_WEBSOCKET_EXTENSIONS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-protocol".
SEC_WEBSOCKET_KEY - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-key".
SEC_WEBSOCKET_KEY1 - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-key1".
SEC_WEBSOCKET_KEY2 - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-key2".
SEC_WEBSOCKET_LOCATION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-location".
SEC_WEBSOCKET_ORIGIN - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-origin".
SEC_WEBSOCKET_PROTOCOL - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-protocol".
SEC_WEBSOCKET_VERSION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"sec-websocket-version".
SEE_OTHER - Static variable in class com.linecorp.armeria.common.http.HttpStatus
303 See Other (since HTTP/1.1).
select() - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Selects an Endpoint from the EndpointGroup.
selectNode(String) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Selects an Endpoint from the EndpointGroup associated with the specified case-insensitive groupName.
self() - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Returns this cast to the type T.
serializationFormat() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
serializationFormat(SerializationFormat) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
serializationFormat() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the SerializationFormat of the Request.
serializationFormat(SerializationFormat) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
serializationFormat() - Method in class com.linecorp.armeria.common.Scheme
Returns the SerializationFormat.
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.
serialize(HttpHeaders, JsonGenerator, SerializerProvider) - Method in class com.linecorp.armeria.common.http.HttpHeadersJsonSerializer
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
 
serve(Service<I, O>, ServiceRequestContext, I) - Method in interface com.linecorp.armeria.server.DecoratingServiceFunction
Serves an incoming Request.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.http.AbstractHttpService
Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.http.auth.HttpAuthService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.http.cors.CorsService
 
serve(ServiceRequestContext, HttpRequest, Map<String, String>) - Method in interface com.linecorp.armeria.server.http.dynamic.DynamicHttpFunction
Serves an incoming HttpRequest, with given mapped path variables args.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.http.dynamic.DynamicHttpService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.http.encoding.HttpEncodingService
 
serve(ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.http.HttpService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.logging.DropwizardMetricCollectingService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.logging.LoggingService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.logging.SampledLoggingService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
 
serve(ServiceRequestContext, I) - Method in interface com.linecorp.armeria.server.Service
Serves an incoming Request.
serveCompressedFiles(boolean) - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
Whether pre-compressed files should be served.
serveCompressedFiles() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceConfig
Whether pre-compressed files should be served.
SERVER - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"server".
SERVER - Static variable in class com.linecorp.armeria.internal.TrafficLoggingHandler
 
server() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
Server - Class in com.linecorp.armeria.server
Listens to ServerPorts and delegates client requests to Services.
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 interface com.linecorp.armeria.server.ServiceRequestContext
Returns the Server that is handling the current Request.
server() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
server() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the Server where this VirtualHost belongs to.
ServerBuilder - Class in com.linecorp.armeria.server
Builds a new Server and its ServerConfig.
ServerBuilder() - Constructor for class com.linecorp.armeria.server.ServerBuilder
 
ServerConfig - Class in com.linecorp.armeria.server
Server configuration.
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 to minimize the effort to implement this interface.
ServerListenerAdapter() - Constructor for class com.linecorp.armeria.server.ServerListenerAdapter
 
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 SessionProtocol.
ServerPort(InetSocketAddress, SessionProtocol) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified localAddress using the specified SessionProtocol.
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
 
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 interface com.linecorp.armeria.server.ServerListener
Invoked when a Server begins its shutdown procedure.
serverStopping(Server) - Method in class com.linecorp.armeria.server.ServerListenerAdapter
 
service(PathMapping, Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified Service at the specified PathMapping.
service(CompositeServiceEntry<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified CompositeServiceEntry.
service() - Method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
Returns the Service.
service(PathMapping, Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
service() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
service(PathMapping, Service<?, ?>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified Service at the specified PathMapping of the default VirtualHost.
service(PathMapping, Service<?, ?>, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Deprecated.
Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
Service<I extends Request,O extends Response> - Interface in com.linecorp.armeria.server
Handles a Request received by a Server.
service() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the Service.
service() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the Service that is handling the current Request.
service() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
SERVICE_UNAVAILABLE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
503 Service Unavailable.
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
 
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.http.healthcheck.HttpHealthCheckService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
 
serviceAdded(ServiceConfig) - Method in interface com.linecorp.armeria.server.Service
Invoked when this Service has been added to a Server with the specified configuration.
serviceAt(int) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
Returns the index-th Service in this composite Service.
serviceAt(String, Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified Service at the specified exact path.
serviceAt(int) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeService
 
serviceAt(String, Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
serviceAt(String, Service<?, ?>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified Service at the specified exact path of the default VirtualHost.
ServiceCallbackInvoker - Class in com.linecorp.armeria.server
A helper class that invokes the callback methods in Service.
ServiceConfig - Class in com.linecorp.armeria.server
ServiceConfig(VirtualHost, PathMapping, Service<?, ?>) - Constructor for class com.linecorp.armeria.server.ServiceConfig
Creates a new instance.
ServiceConfig(VirtualHost, PathMapping, Service<?, ?>, String) - Constructor for class com.linecorp.armeria.server.ServiceConfig
Creates a new instance.
serviceConfigs() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the information of all available Services in the Server.
serviceConfigs() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the information about the Services bound to this virtual host.
ServiceInfo - Class in com.linecorp.armeria.server.docs
Metadata about a Service.
ServiceInfo(String, Iterable<FunctionInfo>, Iterable<ClassInfo>, Iterable<EndpointInfo>, String, Iterable<HttpHeaders>) - Constructor for class com.linecorp.armeria.server.docs.ServiceInfo
Creates a new instance.
serviceLoggerPrefix(String) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the prefix of service logger names.
serviceLoggerPrefix() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the prefix of service logger's names.
ServiceRequestContext - Interface in com.linecorp.armeria.server
Provides information about an invocation and related utilities.
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.composition.AbstractCompositeService
Returns the list of CompositeServiceEntrys added to this composite Service.
services() - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
services() - Method in class com.linecorp.armeria.server.composition.SimpleCompositeService
 
services() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the services in this specification.
ServiceSpecification - Class in com.linecorp.armeria.server.docs
The specification of one or more Services that provides their ServiceInfos and ClassInfos.
ServiceSpecification(Iterable<ServiceInfo>, Iterable<ClassInfo>) - Constructor for class com.linecorp.armeria.server.docs.ServiceSpecification
Creates a new instance.
ServiceSpecificationGenerator - Interface in com.linecorp.armeria.server.docs
Generates the ServiceSpecifications of the supported Services.
serviceType() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
serviceType() - Method in interface com.linecorp.armeria.common.RpcRequest
Returns the type of the service this RpcRequest is called upon.
ServiceUnavailableException - Exception in com.linecorp.armeria.server
A RuntimeException that is raised when a requested invocation cannot be served.
serviceUnder(String, Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified Service under the specified directory..
serviceUnder(String, Service<? super I, ? extends O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
serviceUnder(String, Service<?, ?>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified Service under the specified directory of the default VirtualHost.
SessionOption<T> - Class in com.linecorp.armeria.client
An option that affects the session management of a ClientFactory.
SessionOptions - Class in com.linecorp.armeria.client
A set of SessionOptions and their respective values.
SessionOptionValue<T> - Class in com.linecorp.armeria.client
A value of a SessionOption.
sessionProtocol() - Method in class com.linecorp.armeria.client.pool.PoolKey
Returns the SessionProtocol of the server associated with this key.
sessionProtocol() - Method in class com.linecorp.armeria.client.UserClient
sessionProtocol() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
sessionProtocol() - Method in interface com.linecorp.armeria.common.logging.RequestLog
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 - Class 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, String) - Constructor for exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Creates a new instance with the specified expected SessionProtocol.
SessionProtocolNegotiationException(SessionProtocol, SessionProtocol, String) - Constructor for exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Creates a new instance with the specified expected and actual SessionProtocols.
SessionProtocolProvider - Class in com.linecorp.armeria.common
Registers the SessionProtocols dynamically via Java SPI (Service Provider Interface).
SessionProtocolProvider() - Constructor for class com.linecorp.armeria.common.SessionProtocolProvider
 
SessionProtocolProvider.Entry - Class in com.linecorp.armeria.common
A registration entry of a SessionProtocol.
SET_COOKIE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"set-cookie".
SET_COOKIE2 - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"set-cookie2".
setHealthy(boolean) - Method in class com.linecorp.armeria.server.http.healthcheck.SettableHealthChecker
Sets if the Server is healthy or not.
SetInfo - Class in com.linecorp.armeria.server.docs
Metadata about a set-type value.
SetInfo(TypeInfo) - Constructor for class com.linecorp.armeria.server.docs.SetInfo
Creates a new instance.
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
 
setRequestTimeout(Duration) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setRequestTimeout(Duration) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets the amount of time allowed until receiving the current Request completely.
setRequestTimeout(Duration) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setRequestTimeoutChangeListener(RequestTimeoutChangeListener) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
Sets the listener that is notified when the DefaultServiceRequestContext.requestTimeoutMillis() request timeout} of the request is changed.
setRequestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setRequestTimeoutMillis(long) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets the amount of time allowed until receiving the current Request completely.
setRequestTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setResponseTimeout(Duration) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started.
setResponseTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setResponseTimeout(Duration) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setResponseTimeoutMillis(long) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Sets the amount of time allowed until receiving the Response completely since the transfer of the Response started.
setResponseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setResponseTimeoutMillis(long) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setSingleDecode(boolean) - Method in class com.linecorp.armeria.internal.http.Http1ClientCodec
 
SettableHealthChecker - Class in com.linecorp.armeria.server.http.healthcheck
A simple HealthChecker whose state can be set by a caller.
SettableHealthChecker() - Constructor for class com.linecorp.armeria.server.http.healthcheck.SettableHealthChecker
 
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.
setWriteTimeout(Duration) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Sets the amount of time allowed until sending out the current Request completely.
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
Sets the amount of time allowed until sending out the current Request completely.
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
Media type for SFNT fonts (which includes TrueType and OpenType fonts).
SHOCKWAVE_FLASH - Static variable in class com.linecorp.armeria.common.MediaType
 
shortCircuit() - Method in class com.linecorp.armeria.server.http.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
 
shouldDealWith(Throwable) - Method in interface com.linecorp.armeria.client.circuitbreaker.ExceptionFilter
Decides whether the given error should be dealt with circuit breaker.
signature() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
 
signature() - Method in class com.linecorp.armeria.server.docs.ListInfo
 
signature() - Method in class com.linecorp.armeria.server.docs.MapInfo
 
signature() - Method in class com.linecorp.armeria.server.docs.SetInfo
 
signature() - Method in interface com.linecorp.armeria.server.docs.TypeInfo
Returns the type signature string of a field or a return value.
signature() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
signatureMethod() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
SimpleCompositeService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.composition
A general purpose AbstractCompositeService implementation.
SimpleCompositeService(CompositeServiceEntry<? super I, ? extends O>...) - Constructor for class com.linecorp.armeria.server.composition.SimpleCompositeService
Creates a new instance that is composed of the specified entries.
SimpleCompositeService(Iterable<CompositeServiceEntry<? super I, ? extends O>>) - Constructor for class com.linecorp.armeria.server.composition.SimpleCompositeService
Creates a new instance that is composed of the specified entries.
SimpleCompositeServiceBuilder<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.composition
A general purpose AbstractCompositeServiceBuilder implementation.
SimpleCompositeServiceBuilder() - Constructor for class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
simpleName() - Method in interface com.linecorp.armeria.server.docs.ClassInfo
Returns the simple type name, which does not include the package name.
simpleName() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the simple type name of the service, which does not contain the package name.
simpleServiceName() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
Returns the simplified name of the DefaultRpcRequest.serviceType().
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.
SKETCHUP - Static variable in class com.linecorp.armeria.common.MediaType
 
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.
sslContext(SslContext) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the SslContext of the default VirtualHost.
sslContext(SessionProtocol, File, File) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the SslContext of the default VirtualHost from the specified SessionProtocol, keyCertChainFile and cleartext keyFile.
sslContext(SessionProtocol, File, File, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the SslContext of the default VirtualHost from the specified SessionProtocol, keyCertChainFile, keyFile and keyPassword.
sslContext() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the SslContext of this virtual host.
sslSession() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
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
 
start() - Method in class com.linecorp.armeria.server.Server
Starts this Server to listen to the ServerPorts specified in the ServerConfig.
startRequest(Channel, SessionProtocol, String, String, String) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
startRequest(Channel, SessionProtocol, String, String, String) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of information for the Request.
startResponse() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
startResponse() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of information for the Response.
StaticEndpointGroup - Class in com.linecorp.armeria.client.endpoint
A static immutable EndpointGroup.
StaticEndpointGroup(Endpoint...) - Constructor for class com.linecorp.armeria.client.endpoint.StaticEndpointGroup
Creates a new instance.
StaticEndpointGroup(Iterable<Endpoint>) - Constructor for class com.linecorp.armeria.client.endpoint.StaticEndpointGroup
Creates a new instance.
status() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the STATUS of this message.
status() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
status(int) - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
status(HttpStatus) - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
STATUS - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
":status".
status() - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Gets the HttpHeaderNames.STATUS header or null if there is no such header.
status(int) - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Sets the HttpHeaderNames.STATUS header.
status(HttpStatus) - Method in interface com.linecorp.armeria.common.http.HttpHeaders
Sets the HttpHeaderNames.STATUS header.
statusCode() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
statusCode(int) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
statusCode() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the status code specific to the Response of the current SessionProtocol.
statusCode(int) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Sets the status code specific to the current SessionProtocol.
stop() - Method in class com.linecorp.armeria.server.Server
Stops this Server to close all active ServerPorts.
strategy() - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Returns the EndpointSelectionStrategy used by this selector to select an Endpoint.
StreamMessage<T> - Interface in com.linecorp.armeria.common.stream
A variant of Reactive Streams Publisher, which allows only one Subscriber.
StreamWriter<T> - Interface in com.linecorp.armeria.common.stream
Produces the objects to be published by a StreamMessage.
STRING - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The 'string' type.
stripParents() - Method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that removes all parent components from the matched path so that the ServiceRequestContext.mappedPath() contains only a single path component.
stripPrefix(String) - Method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that removes the specified pathPrefix from the matched path so that the ServiceRequestContext.mappedPath() does not have the specified pathPrefix.
stripPrefix(int) - Method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that removes the first <numPathComponents> path components from the matched path so that the ServiceRequestContext.mappedPath() does not have unnecessary path prefixes.
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.
StructuredLog - Class in com.linecorp.armeria.server.logging.structured
A representation and constructor of a service log which holds only very common fields that are protocol agnostic.
StructuredLog(long, long, long, long) - Constructor for class com.linecorp.armeria.server.logging.structured.StructuredLog
Creates a new instance.
StructuredLog(RequestLog) - Constructor for class com.linecorp.armeria.server.logging.structured.StructuredLog
StructuredLogBuilder<L> - Interface in com.linecorp.armeria.server.logging.structured
An interface that a structured log constructor should implement.
StructuredLoggingService<I extends Request,O extends Response,L> - Class in com.linecorp.armeria.server.logging.structured
A decorating service which provides support of structured and optionally externalized request/response content logging.
StructuredLoggingService(Service<? super I, ? extends O>, StructuredLogBuilder<L>) - Constructor for class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
subscribe(Subscriber<? super T>) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
subscribe(Subscriber<? super T>, Executor) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
subscribe(Subscriber<? super T>) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
 
subscribe(Subscriber<? super T>, Executor) - Method in class com.linecorp.armeria.common.stream.DeferredStreamMessage
 
subscribe(Subscriber<? super U>) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
subscribe(Subscriber<? super U>, Executor) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
subscribe(Subscriber<? super T>) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
subscribe(Subscriber<? super T>, Executor) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
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>, Executor) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data, invoking the specified Subscriber from the specified Executor.
subtype() - Method in class com.linecorp.armeria.common.MediaType
Returns the media subtype.
success() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the number of success events.
successRate() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the success rate (success/total), or throws an ArithmeticException if total is 0.
supportedSchemes() - Method in class com.linecorp.armeria.client.AllInOneClientFactory
 
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
 
supportedSchemes() - Method in class com.linecorp.armeria.client.http.HttpClientFactory
 
supportedServiceTypes() - Method in interface com.linecorp.armeria.server.docs.ServiceSpecificationGenerator
Returns the Set of the Service types supported by this generator.
SVG_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
SWITCHING_PROTOCOLS - Static variable in class com.linecorp.armeria.common.http.HttpStatus
101 Switching Protocols.
systemTicker() - Static method in interface com.linecorp.armeria.common.util.Ticker
A ticker that reads the current time using System.nanoTime().

T

TAR - Static variable in class com.linecorp.armeria.common.MediaType
 
TE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"te".
TEMPORARY_REDIRECT - Static variable in class com.linecorp.armeria.common.http.HttpStatus
307 Temporary Redirect (since HTTP/1.1).
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.
TextFormatter - Class in com.linecorp.armeria.common.util
A utility class to format things as a String with ease.
THREE_GPP2_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for the 3G2 multimedia container format.
THREE_GPP_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for the 3GP multimedia container format.
THRIFT_BINARY - Static variable in class com.linecorp.armeria.common.SerializationFormat
Deprecated.
Use ThriftSerializationFormats.BINARY. Note that the value of this field will be null if armeria-thrift module is not loaded.
THRIFT_COMPACT - Static variable in class com.linecorp.armeria.common.SerializationFormat
Deprecated.
Use ThriftSerializationFormats.COMPACT. Note that the value of this field will be null if armeria-thrift module is not loaded.
THRIFT_JSON - Static variable in class com.linecorp.armeria.common.SerializationFormat
Deprecated.
Use ThriftSerializationFormats.JSON. Note that the value of this field will be null if armeria-thrift module is not loaded.
THRIFT_TEXT - Static variable in class com.linecorp.armeria.common.SerializationFormat
Deprecated.
Use ThriftSerializationFormats.TEXT. Note that the value of this field will be null if armeria-thrift module is not loaded.
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
 
TimeoutException - Exception in com.linecorp.armeria.common
A RuntimeException that is raised when a requested invocation did 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(Throwable) - Constructor for exception com.linecorp.armeria.common.TimeoutException
Creates a new instance with the specified 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.
timestamp() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
timestampMillis() - Method in class com.linecorp.armeria.server.logging.structured.StructuredLog
Returns the timestamp in ms of the time that the request has been received.
toArmeria(Http2Headers) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the specified Netty HTTP/2 into Armeria HTTP/2 headers.
toArmeria(HttpRequest) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the headers of the given Netty HTTP/1.x request into Armeria HTTP/2 headers.
toArmeria(HttpResponse) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the headers of the given Netty HTTP/1.x response into Armeria HTTP/2 headers.
toArmeria(HttpHeaders) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the specified Netty HTTP/1 headers into Armeria HTTP/2 headers.
toArmeria(HttpHeaders, HttpHeaders) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the specified Netty HTTP/1 headers into Armeria HTTP/2 headers.
toByteBuf(ChannelHandlerContext, HttpData) - Static method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
 
toHttpData() - Method in class com.linecorp.armeria.common.http.HttpStatus
Returns the HttpData whose content is "<code> <reasonPhrase>" encoded in UTF-8.
token() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
toNettyHttp1(HttpHeaders) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the specified Armeria HTTP/2 headers into Netty HTTP/1 headers.
toNettyHttp1(int, HttpHeaders, HttpHeaders, HttpVersion, boolean, boolean) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Translate and add HTTP/2 headers to HTTP/1.x headers.
toNettyHttp2(HttpHeaders) - Static method in class com.linecorp.armeria.internal.http.ArmeriaHttpUtil
Converts the specified Armeria HTTP/2 headers into Netty HTTP/2 headers.
TOO_MANY_REQUESTS - Static variable in class com.linecorp.armeria.common.http.HttpStatus
429 Too Many Requests (RFC6585).
toString() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
 
toString() - Method in class com.linecorp.armeria.client.DecoratingClient
 
toString() - Method in class com.linecorp.armeria.client.DefaultClientBuilderParams
 
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.StaticEndpointGroup
 
toString() - Method in class com.linecorp.armeria.client.Endpoint
 
toString() - Method in class com.linecorp.armeria.client.pool.PoolKey
 
toString() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
toString() - Method in class com.linecorp.armeria.common.DefaultRpcResponse
 
toString() - Method in class com.linecorp.armeria.common.http.DefaultHttpData
 
toString() - Method in class com.linecorp.armeria.common.http.DefaultHttpHeaders
 
toString() - Method in class com.linecorp.armeria.common.http.DefaultHttpRequest
 
toString() - Method in class com.linecorp.armeria.common.http.DefaultHttpResponse
 
toString(Charset) - Method in interface com.linecorp.armeria.common.http.HttpData
Decodes this data into a String.
toString() - Method in class com.linecorp.armeria.common.http.HttpStatus
 
toString() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
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.Scheme
 
toString() - Method in class com.linecorp.armeria.common.SerializationFormat
 
toString() - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
toString() - Method in class com.linecorp.armeria.common.SessionProtocol
 
toString() - Method in class com.linecorp.armeria.common.SessionProtocolProvider.Entry
 
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.Version
 
toString() - Method in class com.linecorp.armeria.internal.DefaultAttributeMap
 
toString() - Method in class com.linecorp.armeria.internal.InboundTrafficController
 
toString() - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.composition.CompositeServiceEntry
 
toString() - Method in class com.linecorp.armeria.server.DecoratingService
 
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.EnumInfo
 
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.FunctionInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.ListInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.MapInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.SetInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
toString() - Method in class com.linecorp.armeria.server.http.auth.BasicToken
 
toString() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
 
toString() - Method in class com.linecorp.armeria.server.http.auth.OAuth2Token
 
toString() - Method in class com.linecorp.armeria.server.http.cors.CorsConfig
 
toString() - Method in class com.linecorp.armeria.server.http.cors.CorsServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceConfig
 
toString() - Method in class com.linecorp.armeria.server.http.file.HttpVfs.AbstractEntry
 
toString() - Method in class com.linecorp.armeria.server.http.healthcheck.SettableHealthChecker
 
toString() - Method in class com.linecorp.armeria.server.logging.structured.StructuredLog
 
toString() - Method in class com.linecorp.armeria.server.PathMapped
 
toString() - Method in class com.linecorp.armeria.server.PathMappings
 
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.VirtualHost
 
toStringAscii() - Method in interface com.linecorp.armeria.common.http.HttpData
Decodes this data into a String using US-ASCII encoding.
toStringRequestOnly() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
toStringRequestOnly() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the string representation of the Request.
toStringResponseOnly() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
toStringResponseOnly() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the string representation of the Response.
toStringUtf8() - Method in interface com.linecorp.armeria.common.http.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 class com.linecorp.armeria.common.logging.DefaultRequestLog
 
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.
trace(String) - Method in interface com.linecorp.armeria.client.http.HttpClient
Sends an HTTP TRACE request.
Trace - Annotation Type in com.linecorp.armeria.server.http.dynamic
Annotation for mapping HttpMethod.TRACE onto specific method.
traceText(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Deprecated.
Use Throwables.getStackTraceAsString(Throwable).
TrafficLoggingHandler - Class in com.linecorp.armeria.internal
A Netty handler that logs the I/O traffic of a connection.
TRAILER - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"trailer".
trailingHeaders() - Method in interface com.linecorp.armeria.common.http.AggregatedHttpMessage
Returns the trailing HTTP headers.
TRANSFER_ENCODING - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"transfer-encoding".
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.
TRUST_MANAGER_FACTORY - Static variable in class com.linecorp.armeria.client.SessionOption
The TrustManagerFactory of a TLS connection.
trustManagerFactory() - Method in class com.linecorp.armeria.client.SessionOptions
Returns the SessionOption.TRUST_MANAGER_FACTORY if non-default was specified.
tryParse(String) - Static method in class com.linecorp.armeria.common.Scheme
Parses the specified String into a Scheme.
TSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
type() - Method in class com.linecorp.armeria.common.MediaType
Returns the top-level media type.
type() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
type() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
type() - Method in class com.linecorp.armeria.server.docs.ListInfo
 
type() - Method in class com.linecorp.armeria.server.docs.MapInfo
 
type() - Method in class com.linecorp.armeria.server.docs.SetInfo
 
type() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
Type - Enum in com.linecorp.armeria.server.docs
The type of a field or a return value.
type() - Method in interface com.linecorp.armeria.server.docs.TypeInfo
Returns the type of a field or a return value.
typeInfo() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the metadata about the type of the field.
TypeInfo - Interface in com.linecorp.armeria.server.docs
Metadata about the type of a field or a return value.
Types - Class in com.linecorp.armeria.internal
Provides various utility functions for Java types.

U

UNAUTHORIZED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
401 Unauthorized.
UNKNOWN - Static variable in class com.linecorp.armeria.common.SerializationFormat
Unknown serialization format.
UNORDERED_COLLECTION - Static variable in class com.linecorp.armeria.common.http.HttpStatus
425 Unordered Collection (WebDAV, RFC3648).
UNPROCESSABLE_ENTITY - Static variable in class com.linecorp.armeria.common.http.HttpStatus
422 Unprocessable Entity (WebDAV, RFC4918).
unregister(String) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Unregisters the EndpointGroup with the specified case-insensitive groupName.
UNSUPPORTED_MEDIA_TYPE - Static variable in class com.linecorp.armeria.common.http.HttpStatus
415 Unsupported Media Type.
UPGRADE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"upgrade".
UPGRADE_REQUIRED - Static variable in class com.linecorp.armeria.common.http.HttpStatus
426 Upgrade Required (RFC2817).
upgradeFrom(ChannelHandlerContext) - Method in class com.linecorp.armeria.internal.http.Http1ClientCodec
Upgrades to another protocol from HTTP.
uri() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the endpoint URI of the client.
uri() - Method in class com.linecorp.armeria.client.DefaultClientBuilderParams
 
uri() - Method in class com.linecorp.armeria.client.UserClient
 
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 class com.linecorp.armeria.common.SessionProtocol
Returns the textual representation of this format for use in a Scheme.
USE_HTTP2_PREFACE - Static variable in class com.linecorp.armeria.client.SessionOption
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.http.HttpStatus
305 Use Proxy (since HTTP/1.1).
useHttp2Preface() - Method in class com.linecorp.armeria.client.SessionOptions
Returns whether SessionOption.USE_HTTP2_PREFACE is enabled or not.
USER_AGENT - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"user-agent".
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>, SessionProtocol, Endpoint) - Constructor for class com.linecorp.armeria.client.UserClient
Creates a new instance.
username() - Method in class com.linecorp.armeria.server.http.auth.BasicToken
 

V

validateScheme(URI) - Method in class com.linecorp.armeria.client.AbstractClientFactory
Makes sure the scheme of the specified URI is supported by this ClientFactory.
value() - Method in class com.linecorp.armeria.common.util.AbstractOptionValue
Returns the value of this option value holder has.
value() - Method in class com.linecorp.armeria.server.PathMapped
Returns the value.
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 class com.linecorp.armeria.client.ClientOption
Returns the ClientOption of the specified name.
valueOf(String) - Static method in class com.linecorp.armeria.client.SessionOption
Returns the SessionOption of the specified name.
valueOf(String) - Static method in enum com.linecorp.armeria.common.http.HttpMethod
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in class com.linecorp.armeria.common.http.HttpStatus
Returns the HttpStatus represented by the specified code.
valueOf(String) - Static method in enum com.linecorp.armeria.common.http.HttpStatusClass
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum com.linecorp.armeria.common.http.HttpStatusClass
Returns the class of the specified HTTP status code.
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.RequestLogAvailability
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.docs.Type
Returns the enum constant of this type with the specified name.
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.common.http.HttpMethod
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.http.HttpSessionProtocols
Returns the set of all known HTTP SessionProtocols.
values() - Static method in enum com.linecorp.armeria.common.http.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.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.RequestLogAvailability
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 SessionProtocols.
values() - Static method in class com.linecorp.armeria.common.SessionProtocol
Returns all available SessionProtocols.
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.docs.Type
Returns an array containing the constants of this enum type, in the order they are declared.
valueTypeInfo() - Method in class com.linecorp.armeria.server.docs.MapInfo
Returns the metadata about the value type of the map.
VARIANT_ALSO_NEGOTIATES - Static variable in class com.linecorp.armeria.common.http.HttpStatus
506 Variant Also Negotiates (RFC2295).
VARY - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"vary".
VCARD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
Version - Class in com.linecorp.armeria.common.util
Retrieves the version information of available Armeria artifacts.
version() - Method in class com.linecorp.armeria.server.http.auth.OAuth1aToken
Returns version.
vfs() - Method in class com.linecorp.armeria.server.http.file.HttpFileServiceConfig
Returns the HttpVfs that provides the static files to an HttpFileService.
VIA - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"via".
virtualHost() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
virtualHost(VirtualHost) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the name-based virtual host specified by VirtualHost.
virtualHost() - Method in class com.linecorp.armeria.server.ServiceConfig
Returns the VirtualHost the ServiceConfig.service() belongs to.
virtualHost() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the VirtualHost that is handling the current Request.
virtualHost() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
VirtualHost - Class in com.linecorp.armeria.server
VirtualHostBuilder - Class in com.linecorp.armeria.server
Builds a new VirtualHost.
VirtualHostBuilder() - Constructor for class com.linecorp.armeria.server.VirtualHostBuilder
Creates a new VirtualHostBuilder whose hostname pattern is "*" (match-all).
VirtualHostBuilder(String) - Constructor for class com.linecorp.armeria.server.VirtualHostBuilder
Creates a new VirtualHostBuilder with the specified hostname pattern.
VirtualHostBuilder(String, String) - Constructor for class com.linecorp.armeria.server.VirtualHostBuilder
Creates a new VirtualHostBuilder with the default host name and the specified hostname pattern.
virtualHosts() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the List of available VirtualHosts.
VND_REAL_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Real Audio.
VND_WAVE_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for WAVE format, as defined by RFC 2361.
VOID - Static variable in interface com.linecorp.armeria.server.docs.TypeInfo
The 'void' type.
voidFunction(Consumer<T>) - Static method in class com.linecorp.armeria.common.util.Functions
Converts the specified Consumer into a Function that returns null.
voidFunction(BiConsumer<T, U>) - Static method in class com.linecorp.armeria.common.util.Functions
Converts the specified BiConsumer into a BiFunction that returns null.
VORBIS_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Vorbis Audio, as defined by RFC 5215.
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.

W

WARNING - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"warning".
WAX_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Windows Media metafiles.
WEBM_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
WEBM_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
 
WEBP - Static variable in class com.linecorp.armeria.common.MediaType
 
WEBSOCKET_LOCATION - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"websocket-location".
WEBSOCKET_ORIGIN - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"websocket-origin".
WEBSOCKET_PROTOCOL - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"websocket-protocol".
weight() - Method in class com.linecorp.armeria.client.Endpoint
Returns the weight of this endpoint.
WEIGHTED_ROUND_ROBIN - Static variable in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Weighted round-robin strategy.
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.
withDefaultPort(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified default port number.
withDefaultVirtualHost() - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the name-based virtual host specified by VirtualHost.
withHttpHeader(AsciiString, 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.
withHttpHeaders(Function<HttpHeaders, HttpHeaders>) - Static method in class com.linecorp.armeria.client.Clients
Sets the specified HTTP header manipulating function in a thread-local variable so that the manipulated headers are sent by the client call made from the current thread.
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.
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(Map<String, ? extends Iterable<String>>) - Method in class com.linecorp.armeria.common.MediaType
Replaces all parameters with the given parameters.
withVirtualHost(String) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the name-based virtual host specified by VirtualHost.
withVirtualHost(String, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds the name-based virtual host specified by VirtualHost.
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
Media type for Windows Media Audio.
WML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
WMV - Static variable in class com.linecorp.armeria.common.MediaType
 
WOFF - Static variable in class com.linecorp.armeria.common.MediaType
Media type for the Web Open Font Format (WOFF) defined by the W3C.
WOFF2 - Static variable in class com.linecorp.armeria.common.MediaType
Media type for the Web Open Font Format (WOFF) version 2 defined by the W3C.
write(T) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
write(Supplier<? extends T>) - Method in class com.linecorp.armeria.common.stream.DefaultStreamMessage
 
write(T) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object to the StreamMessage.
write(Supplier<? extends T>) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object Supplier to the StreamMessage.
write(ChannelHandlerContext, Object, ChannelPromise) - Method in class com.linecorp.armeria.internal.TrafficLoggingHandler
 
writeData(ChannelHandlerContext, int, int, HttpData, boolean) - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
Writes an HttpData.
writeHeaders(ChannelHandlerContext, int, int, HttpHeaders, boolean) - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
Writes an HttpHeaders.
writeLog(RequestLog, L) - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
Writes given structuredLog to the underlying system.
writeReset(ChannelHandlerContext, int, int, Http2Error) - Method in class com.linecorp.armeria.internal.http.HttpObjectEncoder
Resets the specified stream.
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 interface com.linecorp.armeria.client.ClientRequestContext
Returns the amount of time allowed until sending out the current Request completely.
writeTimeoutMillis() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
writeTimeoutMillis() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
WWW_AUTHENTICATE - Static variable in class com.linecorp.armeria.common.http.HttpHeaderNames
"www-authenticate".

X

XHTML_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
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." MediaType.APPLICATION_XML_UTF_8 is provided for documents that are intended for applications.
XRD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Extensible Resource Descriptors.

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
 
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 
Skip navigation links