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.EventLoopStreamMessage
 
abort() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
abort() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
abort() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Closes this stream with AbortedStreamException and prevents further subscription.
abort() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
AbortedStreamException - Exception in com.linecorp.armeria.common.stream
A RuntimeException that is raised to signal a Subscriber that the StreamMessage it subscribed to has been aborted by StreamMessage.abort().
AbstractBackoff - Class in com.linecorp.armeria.client.retry
A skeletal Backoff implementation.
AbstractBackoff() - Constructor for class com.linecorp.armeria.client.retry.AbstractBackoff
 
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<I, O>...) - Constructor for class com.linecorp.armeria.server.composition.AbstractCompositeService
Creates a new instance with the specified CompositeServiceEntrys.
AbstractCompositeService(Iterable<CompositeServiceEntry<I, 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.file.HttpVfs.AbstractEntry
Creates a new instance with the specified path.
AbstractEntry(String, MediaType, String) - Constructor for class com.linecorp.armeria.server.file.HttpVfs.AbstractEntry
Creates a new instance with the specified path and mediaType.
AbstractHttpData - Class in com.linecorp.armeria.common
Support APIs for creating well-behaved HttpData objects.
AbstractHttpData() - Constructor for class com.linecorp.armeria.common.AbstractHttpData
 
AbstractHttpService - Class in com.linecorp.armeria.server
A skeletal HttpService for easier HTTP service implementation.
AbstractHttpService() - Constructor for class com.linecorp.armeria.server.AbstractHttpService
 
AbstractHttpVfs - Class in com.linecorp.armeria.server.file
A skeletal HttpVfs implementation.
AbstractHttpVfs() - Constructor for class com.linecorp.armeria.server.file.AbstractHttpVfs
 
AbstractListenable<T> - Class in com.linecorp.armeria.common.util
A skeletal Listenable implementation.
AbstractListenable() - Constructor for class com.linecorp.armeria.common.util.AbstractListenable
 
AbstractOption<T> - 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
 
AbstractStreamMessageDuplicator<T,U extends StreamMessage<T>> - Class in com.linecorp.armeria.common.stream
Allows subscribing to a StreamMessage multiple times by duplicating the stream.
AbstractStreamMessageDuplicator(U, SignalLengthGetter<? super T>, EventExecutor, long) - Constructor for class com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator
Creates a new instance wrapping a publisher and publishing to multiple subscribers.
ACCEPT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"accept".
accept(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.throttling.RateLimitingThrottlingStrategy
 
accept(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns whether a given request should be treated as failed before it is handled actually.
ACCEPT_CHARSET - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"accept-charset".
ACCEPT_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"accept-encoding".
ACCEPT_LANGUAGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"accept-language".
ACCEPT_PATCH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"accept-patch".
ACCEPT_RANGES - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"accept-ranges".
ACCEPTED - Static variable in class com.linecorp.armeria.common.HttpStatus
202 Accepted.
acceptFile(String) - Method in class com.linecorp.armeria.server.docs.DocStringExtractor
Determine whether the file at filename should be processed by the DocStringExtractor.
ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-allow-credentials".
ACCESS_CONTROL_ALLOW_HEADERS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-allow-headers".
ACCESS_CONTROL_ALLOW_METHODS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-allow-methods".
ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-allow-origin".
ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-expose-headers".
ACCESS_CONTROL_MAX_AGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-max-age".
ACCESS_CONTROL_REQUEST_HEADERS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-request-headers".
ACCESS_CONTROL_REQUEST_METHOD - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"access-control-request-method".
accessLogFormat(String) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the format of this Server's access log.
accessLogWriter(Consumer<? super RequestLog>) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets an access log writer of this Server.
accessLogWriter() - Method in class com.linecorp.armeria.server.ServerConfig
Returns an access log writer.
AccessLogWriters - Class in com.linecorp.armeria.server.logging
Access log writers.
accessToken() - Method in class com.linecorp.armeria.server.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.
acquireEventLoop(Endpoint) - Method in interface com.linecorp.armeria.client.ClientFactory
Acquires an EventLoop that is expected to handle a connection to the specified Endpoint.
acquireEventLoop(Endpoint) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
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.
activeRequestPrefix(MeterRegistry, RequestLog) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Creates a MeterIdPrefix for the active request counter gauges from the specified RequestLog.
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(Class<I>, Class<O>, DecoratingClientFunction<I, O>) - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
add(Authorizer<HttpRequest>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an Authorizer.
add(Iterable<? extends Authorizer<HttpRequest>>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds multiple Authorizers.
addAdditionalRequestHeader(AsciiString, String) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Adds a header with the specified name and value.
addAdditionalRequestHeader(AsciiString, String) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
addAdditionalRequestHeader(AsciiString, String) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
addAdditionalRequestHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Adds the specified Headers which is included when a Client sends an HttpRequest.
addAdditionalRequestHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
addAdditionalRequestHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
addAdditionalResponseHeader(AsciiString, String) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
addAdditionalResponseHeader(AsciiString, String) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Adds a header with the specified name and value.
addAdditionalResponseHeader(AsciiString, String) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
addAdditionalResponseHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
addAdditionalResponseHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Adds the specified Headers which is included when a Service sends an HttpResponse.
addAdditionalResponseHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
addBasicAuth(Authorizer<? super BasicToken>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an HTTP basic Authorizer.
addBasicAuth(Authorizer<? super BasicToken>, AsciiString) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an HTTP basic Authorizer for the given header.
addChild(RequestLog) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
addChild(RequestLog) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Adds the specified RequestLog so that the logs are propagated from the child.
addEndpoint(Endpoint) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Adds the specified Endpoint to current Endpoint list.
additionalRequestHeaders() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns an immutable HttpHeaders which is included when a Client sends an HttpRequest.
additionalRequestHeaders() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
additionalRequestHeaders() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
additionalResponseHeaders() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
additionalResponseHeaders() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns an immutable HttpHeaders which is included when a Service sends an HttpResponse.
additionalResponseHeaders() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
additionals() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
Returns additional (or, user-defined) parameters.
addListener(Consumer<? super List<Endpoint>>) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
 
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(Consumer<? super T>) - Method in class com.linecorp.armeria.common.util.AbstractListenable
 
addListener(Consumer<? super T>) - Method in interface com.linecorp.armeria.common.util.Listenable
Adds a Consumer that will be invoked when a Listenable changes its value.
addListener(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.
addOAuth1a(Authorizer<? super OAuth1aToken>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an OAuth1a Authorizer.
addOAuth1a(Authorizer<? super OAuth1aToken>, AsciiString) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an OAuth1a Authorizer for the given header.
addOAuth2(Authorizer<? super OAuth2Token>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an OAuth2 Authorizer.
addOAuth2(Authorizer<? super OAuth2Token>, AsciiString) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds an OAuth2 Authorizer for the given header.
addressResolverGroupFactory(Function<? super EventLoopGroup, ? extends AddressResolverGroup<? extends InetSocketAddress>>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the factory that creates a AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
addStartedCallback(Runnable) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Runnable invoked when the Server is started.
addStartedCallback(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumer invoked when the Server is started.
addStartedCallbacks(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is started.
addStartedCallbacks(Iterable<Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is started.
addStartingCallback(Runnable) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Runnable invoked when the Server is starting.
addStartingCallback(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumer invoked when the Server is starting.
addStartingCallbacks(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is starting.
addStartingCallbacks(Iterable<Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is starting.
addStoppedCallback(Runnable) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Runnable invoked when the Server is stopped.
addStoppedCallback(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumer invoked when the Server is stopped.
addStoppedCallbacks(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopped.
addStoppedCallbacks(Iterable<Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopped.
addStoppingCallback(Runnable) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Runnable invoked when the Server is stopping.
addStoppingCallback(Consumer<? super Server>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumer invoked when the Server is stopping.
addStoppingCallbacks(Consumer<? super Server>...) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopping.
addStoppingCallbacks(Iterable<Consumer<? super Server>>) - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Add Consumers invoked when the Server is stopping.
addTokenAuthorizer(Function<HttpHeaders, T>, Authorizer<? super T>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Adds a token-based Authorizer.
AGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"age".
aggregate() - Method in interface com.linecorp.armeria.common.HttpRequest
Aggregates this request.
aggregate(EventExecutor) - Method in interface com.linecorp.armeria.common.HttpRequest
Aggregates this request.
aggregate() - Method in interface com.linecorp.armeria.common.HttpResponse
Aggregates this response.
aggregate(EventExecutor) - Method in interface com.linecorp.armeria.common.HttpResponse
Aggregates this response.
AggregatedHttpMessage - Interface in com.linecorp.armeria.common
A complete HTTP message whose content is readily available as a single HttpData.
aggregateWithPooledObjects(ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpRequest
Aggregates this request.
aggregateWithPooledObjects(EventExecutor, ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpRequest
Aggregates this request.
aggregateWithPooledObjects(ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpResponse
Aggregates this response.
aggregateWithPooledObjects(EventExecutor, ByteBufAllocator) - Method in interface com.linecorp.armeria.common.HttpResponse
Aggregates this response.
alloc() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
alloc() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the ByteBufAllocator for this RequestContext.
alloc() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
alloc() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
ALLOW - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"allow".
allowCredentials() - Method in class com.linecorp.armeria.server.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.cors.CorsConfig
Returns the allowed set of Request Headers.
allowedRequestMethods() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns the allowed set of Request Methods.
allowNullOrigin() - Method in class com.linecorp.armeria.server.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.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.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.cors.CorsServiceBuilder
Specifies the allowed set of HTTP Request Methods that should be returned in the CORS 'Access-Control-Request-Method' response header.
always() - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns a singleton ThrottlingStrategy that always accepts requests.
and() - Method in class com.linecorp.armeria.server.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.
andThen(BiFunction<MeterRegistry, MeterIdPrefix, MeterIdPrefix>) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns a MeterIdPrefixFunction that applies transformation on the MeterIdPrefix returned by this function.
annotatedService(Object) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the path prefix "/".
annotatedService(Object, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the path prefix "/".
annotatedService(Object, Function<Service<HttpRequest, HttpResponse>, ? extends Service<HttpRequest, HttpResponse>>, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the path prefix "/".
annotatedService(String, Object) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the specified path prefix.
annotatedService(String, Object, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the specified path prefix.
annotatedService(String, Object, Function<Service<HttpRequest, HttpResponse>, ? extends Service<HttpRequest, HttpResponse>>, Object...) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the specified path prefix.
annotatedService(String, Object, Function<Service<HttpRequest, HttpResponse>, ? extends Service<HttpRequest, HttpResponse>>, Iterable<?>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified annotated service object under the specified path prefix.
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
 
append(String) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified suffix.
appendElapsed(StringBuilder, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Appends the human-readable representation of the duration given as elapsed to the specified StringBuilder.
appendElapsed(StringBuilder, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
Appends the human-readable representation of the duration between the specified startTimeNanos and endTimeNanos to the specified StringBuilder.
appendElapsedAndSize(StringBuilder, long, long, long) - Static method in class com.linecorp.armeria.common.util.TextFormatter
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.
appendWithTags(String, String...) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified suffix and tags.
appendWithTags(String, Iterable<Tag>) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified suffix and tags.
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."
apply(MeterRegistry, RequestLog) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Creates a MeterIdPrefix from the specified RequestLog.
apply(PathMappingContext) - Method in class com.linecorp.armeria.server.AbstractPathMapping
Matches the specified path and extracts the path parameters from it.
apply(PathMappingContext) - Method in interface com.linecorp.armeria.server.PathMapping
Matches the specified path and extracts the path parameters from it.
array() - Method in class com.linecorp.armeria.common.DefaultHttpData
 
array() - Method in interface com.linecorp.armeria.common.HttpData
Returns the underlying byte array of this data.
array() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
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 interface com.linecorp.armeria.client.retry.Backoff
Undecorates this Backoff to find the Backoff which is an instance of the specified backoffType.
as(Class<T>) - Method in class com.linecorp.armeria.client.retry.BackoffWrapper
 
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.HttpHeaders
Returns the immutable view of this headers.
asImmutable() - Method in interface com.linecorp.armeria.common.HttpParameters
Returns the immutable view of this parameters map.
asMap() - Method in class com.linecorp.armeria.client.ClientOptions
Converts this ClientOptions to a Map.
asMap0() - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns the Map whose key is AbstractOption and value is AbstractOptionValue.
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
 
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
 
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.AggregatedHttpMessage
Returns the AUTHORITY of this message, in the form of "hostname:port".
authority() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
authority(String) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
AUTHORITY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
":authority".
authority() - Method in interface com.linecorp.armeria.common.HttpHeaders
Gets the HttpHeaderNames.AUTHORITY header or null if there is no such header.
authority(String) - Method in interface com.linecorp.armeria.common.HttpHeaders
Sets the HttpHeaderNames.AUTHORITY header.
authority() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the authority of this request.
authority(String) - Method in interface com.linecorp.armeria.common.HttpRequest
Sets the authority of this request.
authority() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the authority of the Request.
AUTHORIZATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"authorization".
authorize(ServiceRequestContext, T) - Method in interface com.linecorp.armeria.server.auth.Authorizer
Authorizes the given data.
authorize(HttpRequest, ServiceRequestContext) - Method in class com.linecorp.armeria.server.auth.HttpAuthService
Determine if request is authorized for this service.
Authorizer<T> - Interface in com.linecorp.armeria.server.auth
Determines whether a given data is authorized for the service registered in.
AuthTokenExtractors - Class in com.linecorp.armeria.server.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.
awaitInitialEndpoints() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Waits until the initial Endpoints are ready.
awaitInitialEndpoints(long, TimeUnit) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Waits until the initial Endpoints are ready, with timeout.

B

Backoff - Interface in com.linecorp.armeria.client.retry
Controls back off between attempts in a single retry operation.
BackoffWrapper - Class in com.linecorp.armeria.client.retry
Wraps an existing Backoff.
BackoffWrapper(Backoff) - Constructor for class com.linecorp.armeria.client.retry.BackoffWrapper
 
BAD_GATEWAY - Static variable in class com.linecorp.armeria.common.HttpStatus
502 Bad Gateway.
BAD_REQUEST - Static variable in class com.linecorp.armeria.common.HttpStatus
400 Bad Request.
BASIC - Static variable in class com.linecorp.armeria.server.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.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.
belongsTo(MediaType) - Method in class com.linecorp.armeria.common.MediaType
Returns true if this MediaType belongs to the given MediaType.
blockingTaskExecutor() - Static method in class com.linecorp.armeria.common.CommonPools
Returns the common blocking task Executor which is used when ServerBuilder.blockingTaskExecutor(Executor) is not specified.
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
 
build() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Returns a newly-created CircuitBreaker based on the properties of this builder.
build(Class<T>) - Method in class com.linecorp.armeria.client.ClientBuilder
Returns a newly-created client which implements the specified clientType, based on the properties of this builder.
build() - Method in class com.linecorp.armeria.client.ClientDecorationBuilder
Returns a newly-created ClientDecoration based on the decorators added to this builder.
build() - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Returns a newly-created ClientFactory based on the properties of this builder.
build() - Method in class com.linecorp.armeria.client.ClientOptionsBuilder
Returns a newly-created ClientOptions based on the ClientOptionValues of this builder.
build() - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
Returns a newly created DnsAddressEndpointGroup.
build() - Method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
Returns a newly created DnsServiceEndpointGroup.
build() - Method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
Returns a newly created DnsTextEndpointGroup.
build() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroupBuilder
Returns a newly created HttpHealthCheckedEndpointGroup based on the contents of the HttpHealthCheckedEndpointGroupBuilder.
build() - Method in class com.linecorp.armeria.client.HttpClientBuilder
Returns a newly-created HTTP client based on the properties of this builder.
build(Client<I, O>) - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
Returns a newly-created LoggingClient decorating delegate based on the properties of this builder.
build(Client<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.client.retry.RetryingHttpClientBuilder
Returns a newly-created RetryingHttpClient based on the properties of this builder.
build(Client<RpcRequest, RpcResponse>) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
Returns a newly-created RetryingRpcClient based on the properties of this builder.
build(Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Returns a newly-created HttpAuthService based on the Authorizers added to this builder.
build() - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
Returns a newly-created SimpleCompositeService based on the Services adde to this builder.
build(Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Returns a newly-created CorsService based on the properties of this builder.
build() - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Returns a newly-created DocService based on the properties of this builder.
build() - Method in class com.linecorp.armeria.server.file.HttpFileServiceBuilder
Returns a newly-created HttpFileService based on the properties of this builder.
build(Service<I, O>) - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
Returns a newly-created LoggingService decorating delegate based on the properties of this builder.
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
Returns a newly-created Server based on the configuration properties set so far.
build() - Method in class com.linecorp.armeria.server.ServerListenerBuilder
Returns a newly-created ServerListener based on the Runnables added to this builder.
build() - Method in class com.linecorp.armeria.server.VirtualHostBuilder
 
ByteArrayEntry(String, byte[]) - Constructor for class com.linecorp.armeria.server.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.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.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.file.HttpVfs.ByteArrayEntry
Creates a new instance with the specified path, mediaType and byte array.
ByteArrayRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
A default implementation of a RequestConverterFunction which converts a binary body of the AggregatedHttpMessage to one of byte[] or HttpData.
ByteArrayRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.ByteArrayRequestConverterFunction
 
ByteArrayResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A response converter implementation which creates an HttpResponse with content-type: application/binary or content-type: application/octet-stream.
ByteArrayResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.ByteArrayResponseConverterFunction
 
ByteBufHttpData - Class in com.linecorp.armeria.unsafe
A HttpData that is backed by a ByteBuf for optimizing certain internal use cases.
ByteBufHttpData(ByteBuf, boolean) - Constructor for class com.linecorp.armeria.unsafe.ByteBufHttpData
Constructs a new ByteBufHttpData.
BZIP2 - Static variable in class com.linecorp.armeria.common.MediaType
 

C

CACHE_CONTROL - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"cache-control".
CACHE_MANIFEST_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
cachedHeaders() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the cachedHeaders parameter which contains a comma-separated list of headers whose values are cached using headerValueCache.
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.completionFuture() 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 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
 
channelAcquired(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerWrapper
 
channelClosed(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
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
 
channelClosed(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerWrapper
 
channelCreated(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
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
 
channelCreated(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerWrapper
 
channelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the options of sockets created by the ClientFactory.
channelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the ChannelOption of the server socket bound by Server.
channelOptions() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ChannelOptions and their values of Server's server sockets.
channelReleased(PoolKey, Channel) - Method in class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
 
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
 
channelReleased(K, Channel) - Method in class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerWrapper
 
charset() - Method in class com.linecorp.armeria.common.MediaType
Returns an optional charset for the value of the charset parameter if it is specified.
childChannelOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the ChannelOption of sockets accepted by Server.
childChannelOptions() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the ChannelOptions and their values of sockets accepted by Server.
children() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
children() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the list of child RequestLogs, ordered by the time it was added.
CircuitBreaker - Interface in com.linecorp.armeria.client.circuitbreaker
A circuit breaker, which tracks the number of success/failure requests and detects a remote service failure.
CircuitBreakerBuilder - Class in com.linecorp.armeria.client.circuitbreaker
Builds a CircuitBreaker instance using builder pattern.
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.
CircuitBreakerClient(Client<I, O>, CircuitBreakerMapping, CircuitBreakerStrategy<O>) - Constructor for class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Creates a new instance that decorates the specified Client.
CircuitBreakerHttpClient - Class in com.linecorp.armeria.client.circuitbreaker
A Client decorator that handles failures of HTTP requests 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.
CircuitBreakerRpcClient - Class in com.linecorp.armeria.client.circuitbreaker
A Client decorator that handles failures of RPC remote invocation based on circuit breaker pattern.
CircuitBreakerStrategy<T extends Response> - Interface in com.linecorp.armeria.client.circuitbreaker
Determines whether a Response should be reported as a success or a failure to a CircuitBreaker.
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.
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.
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.
clientBuilderParams(T) - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the ClientBuilderParams held in client.
clientBuilderParams(T) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
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.
clientFactory(ClientFactory) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroupBuilder
Sets the ClientFactory to use when making health check requests.
ClientFactoryBuilder - Class in com.linecorp.armeria.client
Builds a new ClientFactory.
ClientFactoryBuilder() - Constructor for class com.linecorp.armeria.client.ClientFactoryBuilder
Creates a new instance.
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.file.HttpFileServiceBuilder
Sets the Clock that provides the current date and time.
clock() - Method in class com.linecorp.armeria.server.file.HttpFileServiceConfig
Returns the Clock the provides the current date and time to an HttpFileService.
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 class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
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.pool.DefaultKeyedChannelPool
 
close() - Method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Closes all Channels managed by this pool.
close(AggregatedHttpMessage) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
Writes the specified HTTP response and closes the stream.
close() - Method in class com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator
Closes this factory and stream messages who are invoked by AbstractStreamMessageDuplicator.duplicateStream().
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 class com.linecorp.armeria.common.stream.EventLoopStreamMessage
 
close(Throwable) - Method in class com.linecorp.armeria.common.stream.EventLoopStreamMessage
 
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(T) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the given object and closes the stream successfully.
close() - Method in interface com.linecorp.armeria.common.util.SafeCloseable
 
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().
ClosedClientFactoryException - Exception in com.linecorp.armeria.client
A RuntimeException raised when a Client is executing and the ClientFactory which the Client is using is closed.
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.HttpResponse
 
closeFuture() - Method in interface com.linecorp.armeria.common.Response
Deprecated.
closeFuture() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Deprecated.
code() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the code of this HttpStatus.
codeAsText() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the status code as String.
codeClass() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the class of this HttpStatus.
com.linecorp.armeria.client - package com.linecorp.armeria.client
Client core.
com.linecorp.armeria.client.circuitbreaker - package com.linecorp.armeria.client.circuitbreaker
Failure detection and fallback mechanism based on circuit breaker pattern.
com.linecorp.armeria.client.encoding - package com.linecorp.armeria.client.encoding
HTTP content decoding client.
com.linecorp.armeria.client.endpoint - package com.linecorp.armeria.client.endpoint
Endpoint groups and their registry.
com.linecorp.armeria.client.endpoint.dns - package com.linecorp.armeria.client.endpoint.dns
DNS-based EndpointGroup implementation.
com.linecorp.armeria.client.endpoint.healthcheck - package com.linecorp.armeria.client.endpoint.healthcheck
com.linecorp.armeria.client.limit - package com.linecorp.armeria.client.limit
Limits the number of executed Requests.
com.linecorp.armeria.client.logging - package com.linecorp.armeria.client.logging
Logging client decorators.
com.linecorp.armeria.client.metric - package com.linecorp.armeria.client.metric
Metric-collecting client decorators.
com.linecorp.armeria.client.pool - package com.linecorp.armeria.client.pool
Asynchronous Channel pool.
com.linecorp.armeria.client.retry - package com.linecorp.armeria.client.retry
A Client decorator that handles failures and retries requests.
com.linecorp.armeria.common - package com.linecorp.armeria.common
Common types.
com.linecorp.armeria.common.logging - package com.linecorp.armeria.common.logging
Common types used for collecting the information about Requests and Responses.
com.linecorp.armeria.common.metric - package com.linecorp.armeria.common.metric
Common metric collection utilities.
com.linecorp.armeria.common.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.server - package com.linecorp.armeria.server
Server core.
com.linecorp.armeria.server.annotation - package com.linecorp.armeria.server.annotation
Annotations for building a RESTful service.
com.linecorp.armeria.server.annotation.decorator - package com.linecorp.armeria.server.annotation.decorator
Decorators for the annotated HTTP service.
com.linecorp.armeria.server.auth - package com.linecorp.armeria.server.auth
HTTP authorization service.
com.linecorp.armeria.server.composition - package com.linecorp.armeria.server.composition
Service composition.
com.linecorp.armeria.server.cors - package com.linecorp.armeria.server.cors
com.linecorp.armeria.server.docs - package com.linecorp.armeria.server.docs
Documentation service.
com.linecorp.armeria.server.encoding - package com.linecorp.armeria.server.encoding
HTTP content encoding service.
com.linecorp.armeria.server.file - package com.linecorp.armeria.server.file
HTTP static file service.
com.linecorp.armeria.server.healthcheck - package com.linecorp.armeria.server.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.
com.linecorp.armeria.server.metric - package com.linecorp.armeria.server.metric
Metric-collecting service decorators and exporters.
com.linecorp.armeria.server.throttling - package com.linecorp.armeria.server.throttling
Request throttling service decorators and strategies.
com.linecorp.armeria.unsafe - package com.linecorp.armeria.unsafe
Utilities for working with ByteBuf in an unsafe way.
combined() - Static method in class com.linecorp.armeria.server.logging.AccessLogWriters
Returns an access log writer with a combined format.
commitTimeMillis() - Method in class com.linecorp.armeria.common.util.Version
 
common() - Static method in class com.linecorp.armeria.server.logging.AccessLogWriters
Returns an access log writer with a common format.
CommonPools - Class in com.linecorp.armeria.common
Provides the common shared thread pools and EventLoopGroups which is used when not overridden.
compareTo(Endpoint) - Method in class com.linecorp.armeria.client.Endpoint
 
compareTo(HttpStatus) - Method in class com.linecorp.armeria.common.HttpStatus
Compares this status to the specified status.
compareTo(Scheme) - Method in class com.linecorp.armeria.common.Scheme
 
compareTo(SerializationFormat) - Method in class com.linecorp.armeria.common.SerializationFormat
 
compareTo(SerializationFormatProvider.Entry) - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
compareTo(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.
completionFuture() - Method in interface com.linecorp.armeria.common.HttpResponse
 
completionFuture() - Method in interface com.linecorp.armeria.common.Response
Returns a CompletableFuture which completes when 1) the response stream has been closed (the StreamMessage has been completed) or 2) the result value is set (the CompletionStage has completed.)
completionFuture() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns a CompletableFuture which completes when this RpcResponse completes.
completionFuture() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
completionFuture() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
completionFuture() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns a CompletableFuture that completes when this stream is complete, either successfully or exceptionally, including cancellation and abortion.
completionFuture() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
complexity() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the complexity of this path mapping.
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).
compositeServiceCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the compositeServiceCache parameter.
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<I, 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<I, 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.cors.CorsService
Returns the CorsConfig.
config() - Method in class com.linecorp.armeria.server.file.HttpFileService
Returns the configuration.
config() - Method in class com.linecorp.armeria.server.Server
Returns the configuration of this Server.
configure() - Static method in class com.linecorp.armeria.common.metric.MoreNamingConventions
Configures all the MeterRegistrys added to the Metrics.globalRegistry to use the NamingConventions provided by this class.
configure(MeterRegistry) - Static method in class com.linecorp.armeria.common.metric.MoreNamingConventions
Configures the specified MeterRegistry to use the NamingConventions provided by this class.
CONFLICT - Static variable in class com.linecorp.armeria.common.HttpStatus
409 Conflict.
CONNECTION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"connection".
connectionPoolListener(KeyedChannelPoolHandler<? super PoolKey>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the listener which is notified on a connection pool event.
connectTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the timeout of a socket connection attempt.
connectTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the timeout of a socket connection attempt in milliseconds.
consumerKey() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
Consumes - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a media type which would be consumed by the service method or class.
ConsumesBinary - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Consumes("application/binary").
ConsumesGroup - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for Consumes.
ConsumesJson - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Consumes("application/json; charset=utf-8").
ConsumesOctetStream - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Consumes("application/octet-stream").
ConsumesText - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Consumes("text/plain; charset=utf-8").
ConsumeType - Annotation Type in com.linecorp.armeria.server.annotation
Deprecated.
consumeType() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns MediaType specified by 'Content-Type' header of the request.
ConsumeTypes - Annotation Type in com.linecorp.armeria.server.annotation
Deprecated.
contains(int) - Method in enum com.linecorp.armeria.common.HttpStatusClass
Returns true if and only if the specified HTTP status code falls into this class.
contains(Object) - Method in class com.linecorp.armeria.common.MediaTypeSet
 
content() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Returns the content of this message.
content() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
CONTENT_BASE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-base".
CONTENT_DISPOSITION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-disposition".
CONTENT_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-encoding".
CONTENT_LANGUAGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-language".
CONTENT_LENGTH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-length".
CONTENT_LOCATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-location".
CONTENT_MD5 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-md5".
CONTENT_RANGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-range".
CONTENT_SECURITY_POLICY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-security-policy".
CONTENT_TRANSFER_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-transfer-encoding".
CONTENT_TYPE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"content-type".
contentEncoding() - Method in class com.linecorp.armeria.server.file.HttpVfs.AbstractEntry
 
contentEncoding() - Method in interface com.linecorp.armeria.server.file.HttpVfs.Entry
The content encoding of the entry.
contentPreviewLength(int) - Method in class com.linecorp.armeria.client.retry.RetryingHttpClientBuilder
Sets the length of content to look up whether retry or not.
ContentTooLargeException - Exception in com.linecorp.armeria.common
A RuntimeException raised when the length of request or response content exceeds its limit.
contentType() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
contentType(MediaType) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
contentType() - Method in interface com.linecorp.armeria.common.HttpHeaders
Returns the value of the 'content-type' header.
contentType(MediaType) - Method in interface com.linecorp.armeria.common.HttpHeaders
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.HttpStatus
100 Continue.
convertRequest(ServiceRequestContext, AggregatedHttpMessage, Class<?>) - Method in class com.linecorp.armeria.server.annotation.ByteArrayRequestConverterFunction
Converts the specified AggregatedHttpMessage to an object of expectedResultType.
convertRequest(ServiceRequestContext, AggregatedHttpMessage, Class<?>) - Method in class com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction
Converts the specified AggregatedHttpMessage to an object of expectedResultType.
convertRequest(ServiceRequestContext, AggregatedHttpMessage, Class<?>) - Method in interface com.linecorp.armeria.server.annotation.RequestConverterFunction
Converts the specified request to an object of expectedResultType.
convertRequest(ServiceRequestContext, AggregatedHttpMessage, Class<?>) - Method in class com.linecorp.armeria.server.annotation.StringRequestConverterFunction
Converts the specified AggregatedHttpMessage to a String.
convertResponse(ServiceRequestContext, Object) - Method in class com.linecorp.armeria.server.annotation.ByteArrayResponseConverterFunction
 
convertResponse(ServiceRequestContext, Object) - Method in class com.linecorp.armeria.server.annotation.JacksonResponseConverterFunction
 
convertResponse(ServiceRequestContext, Object) - Method in interface com.linecorp.armeria.server.annotation.ResponseConverterFunction
Returns HttpResponse instance corresponds to the given result.
convertResponse(ServiceRequestContext, Object) - Method in class com.linecorp.armeria.server.annotation.StringResponseConverterFunction
 
COOKIE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"cookie".
Cookies - Interface in com.linecorp.armeria.server.annotation
An interface which holds decoded Cookie instances for an HTTP request.
copy() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
copyOf(HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns a copy of the specified HttpHeaders.
copyOf(Map<String, ? extends Iterable<String>>) - Static method in interface com.linecorp.armeria.common.HttpParameters
Returns a new HTTP parameters map with the specified {@code Map
copyOf(Headers<String, String, ?>) - Static method in interface com.linecorp.armeria.common.HttpParameters
Returns a copy of the specified {@code Headers
copyOf(Iterable<? extends Cookie>) - Static method in interface com.linecorp.armeria.server.annotation.Cookies
Creates an instance with a copy of the specified Iterable of Cookies.
CorsConfig - Class in com.linecorp.armeria.server.cors
CorsService - Class in com.linecorp.armeria.server.cors
Decorates an HTTP Service to add the Cross-Origin Resource Sharing (CORS) support.
CorsService(Service<HttpRequest, HttpResponse>, CorsConfig) - Constructor for class com.linecorp.armeria.server.cors.CorsService
Creates a new CorsService that decorates the specified delegate to add CORS support.
CorsServiceBuilder - Class in com.linecorp.armeria.server.cors
Builds a new CorsService or its decorator function.
counterSlidingWindow(Duration) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the time length of sliding window to accumulate the count of events.
counterSlidingWindowMillis(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the time length of sliding window to accumulate the count of events.
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.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.
custom(String) - Static method in class com.linecorp.armeria.server.logging.AccessLogWriters
Returns an access log writer with the specified formatStr.

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.HttpHeaderNames
"date".
dec() - Method in class com.linecorp.armeria.server.GracefulShutdownSupport
Decreases the number of pending responses.
decode(HttpData) - Method in interface com.linecorp.armeria.client.encoding.StreamDecoder
Decodes an HttpData and returns the decoded HttpData.
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<I, 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<T_I, T_O>) - Constructor for class com.linecorp.armeria.client.DecoratingClient
Creates a new instance that decorates the specified Client.
DecoratingClientFactory - Class in com.linecorp.armeria.client
A ClientFactory that delegates the creation of Clients to another ClientFactory.
DecoratingClientFactory(ClientFactory) - Constructor for class com.linecorp.armeria.client.DecoratingClientFactory
Creates a new instance.
DecoratingClientFunction<I extends Request,O extends Response> - Interface in com.linecorp.armeria.client
A functional interface that enables building a SimpleDecoratingClient with AbstractClientOptionsBuilder.decorator(Class, Class, DecoratingClientFunction).
DecoratingService<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response> - Class in com.linecorp.armeria.server
A Service that decorates another Service.
DecoratingService(Service<T_I, T_O>) - Constructor for class com.linecorp.armeria.server.DecoratingService
Creates a new instance that decorates the specified Service.
DecoratingServiceFunction<I extends Request,O extends Response> - Interface in com.linecorp.armeria.server
A functional interface that enables building a SimpleDecoratingService 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<? extends Client<HttpRequest, HttpResponse>, ? extends Client<HttpRequest, HttpResponse>>) - Method in class com.linecorp.armeria.client.HttpClientBuilder
Adds the specified decorator.
decorator(DecoratingClientFunction<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.client.HttpClientBuilder
Adds the specified decorator.
Decorator - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a DecoratingServiceFunction class which handles an HttpRequest before invoking an annotated service method.
decorator(Function<T, R>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates all Services with the specified decorator.
DecoratorFactory - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a DecoratorFactoryFunction class which is a factory to create a decorator.
DecoratorFactoryFunction<T extends Annotation> - Interface in com.linecorp.armeria.server.annotation
A decorator factory which is used for a user-defined decorator annotation.
Decorators - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for 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 - Annotation Type in com.linecorp.armeria.server.annotation
Specifies the default value of an optional parameter.
DEFAULT - Static variable in interface com.linecorp.armeria.server.annotation.ExceptionHandlerFunction
A default exception handler function.
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.
defaultBackoff - Static variable in interface com.linecorp.armeria.client.retry.RetryStrategy
 
defaultBackoffSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the backoffSpec parameter when instantiating a Backoff using Backoff.of(String).
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.
defaultClientIdleTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side idle timeout of a connection for keep-alive in milliseconds.
DefaultClientRequestContext - Class in com.linecorp.armeria.client
Default ClientRequestContext implementation.
DefaultClientRequestContext(EventLoop, MeterRegistry, SessionProtocol, Endpoint, HttpMethod, String, String, String, ClientOptions, Request) - Constructor for class com.linecorp.armeria.client.DefaultClientRequestContext
Creates a new instance.
defaultConnectTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side timeout of a socket connection attempt in milliseconds.
defaultHistogramConfig() - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
defaultHostname() - Method in class com.linecorp.armeria.server.Server
Returns the hostname of the default VirtualHost, which is the hostname of the machine 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
Default HttpData implementation.
DefaultHttpData(byte[], int, int, boolean) - Constructor for class com.linecorp.armeria.common.DefaultHttpData
Creates a new instance.
DefaultHttpHeaders - Class in com.linecorp.armeria.common
Default HttpHeaders implementation.
DefaultHttpHeaders() - Constructor for class com.linecorp.armeria.common.DefaultHttpHeaders
Creates a new instance.
DefaultHttpHeaders(boolean) - Constructor for class com.linecorp.armeria.common.DefaultHttpHeaders
Creates a new instance.
DefaultHttpHeaders(boolean, int) - Constructor for class com.linecorp.armeria.common.DefaultHttpHeaders
Creates a new instance.
DefaultHttpHeaders(boolean, int, boolean) - Constructor for class com.linecorp.armeria.common.DefaultHttpHeaders
Creates a new instance.
DefaultHttpParameters - Class in com.linecorp.armeria.common
Default implementation of HttpParameters which uses the HashingStrategy.JAVA_HASHER to support case-sensitive parameter names.
DefaultHttpParameters() - Constructor for class com.linecorp.armeria.common.DefaultHttpParameters
Creates a new instance with a default value converter.
DefaultHttpParameters(int) - Constructor for class com.linecorp.armeria.common.DefaultHttpParameters
Create a new instance with a default value converter and the specified hint of array size.
DefaultHttpRequest - Class in com.linecorp.armeria.common
DefaultHttpRequest(HttpHeaders) - Constructor for class com.linecorp.armeria.common.DefaultHttpRequest
Deprecated.
Creates a new instance with the specified headers.
DefaultHttpResponse - Class in com.linecorp.armeria.common
Deprecated.
DefaultHttpResponse() - Constructor for class com.linecorp.armeria.common.DefaultHttpResponse
Deprecated.
 
DefaultKeyedChannelPool<K> - Class in com.linecorp.armeria.client.pool
Default KeyedChannelPool implementation.
DefaultKeyedChannelPool(EventLoop, Function<K, Future<Channel>>, Predicate<Channel>, KeyedChannelPoolHandler<K>, boolean) - Constructor for class com.linecorp.armeria.client.pool.DefaultKeyedChannelPool
Creates a new instance.
defaultMaxHttp1ChunkSize() - Static method in class com.linecorp.armeria.common.Flags
Returns the default maximum length of each chunk in an HTTP/1 response content.
defaultMaxHttp1ChunkSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default maximum length of each chunk in an HTTP/1 response content.
defaultMaxHttp1HeaderSize() - Static method in class com.linecorp.armeria.common.Flags
Returns the default maximum length of all headers in an HTTP/1 response.
defaultMaxHttp1HeaderSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default maximum length of all headers in an HTTP/1 response.
defaultMaxHttp1InitialLineLength() - Static method in class com.linecorp.armeria.common.Flags
Returns the default maximum length of an HTTP/1 response initial line.
defaultMaxHttp1InitialLineLength() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default maximum length of an HTTP/1 response initial line.
defaultMaxRequestLength() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side maximum length of a request.
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.
defaultMaxResponseLength() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side maximum length of a response.
defaultMaxTotalAttempts() - Static method in class com.linecorp.armeria.common.Flags
Returns the default maximum number of total attempts.
defaultMimeType() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the default MIME type of this endpoint.
defaultPort() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns the default INET port number of this protocol.
defaultRegistry - Static variable in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
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() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side timeout of a request in milliseconds.
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.
defaultResponseTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default client-side timeout of a response in milliseconds.
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.
defaultServerIdleTimeoutMillis() - Static method in class com.linecorp.armeria.common.Flags
Returns the default server-side idle timeout of a connection for keep-alive in milliseconds.
DefaultServiceRequestContext - Class in com.linecorp.armeria.server
Default ServiceRequestContext implementation.
DefaultServiceRequestContext(ServiceConfig, Channel, MeterRegistry, SessionProtocol, PathMappingContext, PathMappingResult, Request, SSLSession, ProxiedAddresses) - 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.
defaultSubscriberExecutor() - Method in class com.linecorp.armeria.common.stream.EventLoopStreamMessage
 
defaultSubscriberExecutor() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
defaultUseHttp1Pipelining() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the ClientFactoryBuilder.useHttp1Pipelining(boolean) option.
defaultUseHttp2Preface() - Static method in class com.linecorp.armeria.common.Flags
Returns the default value of the ClientFactoryBuilder.useHttp2Preface(boolean) option.
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. e.g. the "Host" header in HTTP or host name in TLS SNI extension
defaultVirtualHost() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the default VirtualHost, which is used when no other VirtualHosts match the host name of a client request. e.g. the "Host" header in HTTP or host name in TLS SNI extension
defaultWriteTimeoutMillis() - 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
DeferredHttpResponse() - Constructor for class com.linecorp.armeria.common.DeferredHttpResponse
Deprecated.
 
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
DeflateStreamDecoderFactory - Class in com.linecorp.armeria.client.encoding
A StreamDecoderFactory which supports the 'deflate' encoding.
DeflateStreamDecoderFactory() - Constructor for class com.linecorp.armeria.client.encoding.DeflateStreamDecoderFactory
 
delayedThrowable() - Method in interface com.linecorp.armeria.server.PathMappingContext
delayThrowable(Throwable) - Method in interface com.linecorp.armeria.server.PathMappingContext
Delays throwing a Throwable until reaching the end of the service list.
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.KeyedChannelPoolHandlerWrapper
Returns the KeyedChannelPoolHandler this handler decorates.
delegate() - Method in class com.linecorp.armeria.client.retry.BackoffWrapper
 
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.DeferredHttpResponse
Deprecated.
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 StreamMessage which will actually publish the stream.
delegate() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
Returns the delegate Publisher.
delegate() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
Returns the StreamMessage being decorated.
delegate() - Method in class com.linecorp.armeria.server.DecoratingService
Returns the Service being decorated.
delete(String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP DELETE request.
Delete - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.DELETE onto specific method.
deserialize(JsonParser, DeserializationContext) - Method in class com.linecorp.armeria.common.HttpHeadersJsonDeserializer
 
deserialize(JsonParser, DeserializationContext) - Method in class com.linecorp.armeria.common.MediaTypeJsonDeserializer
 
destinationAddress() - Method in class com.linecorp.armeria.server.ProxiedAddresses
Returns the destination address of the proxied request.
DISABLED - Static variable in class com.linecorp.armeria.server.cors.CorsConfig
CorsConfig with CORS disabled.
disabled() - Static method in class com.linecorp.armeria.server.logging.AccessLogWriters
Returns disabled access log writer.
disablePreflightResponseHeaders() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Specifies that no preflight response headers should be added to a preflight response.
distributionStatisticConfig() - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns the DistributionStatisticConfig to use when the factory methods in MoreMeters create a Timer or a DistributionSummary.
DnsAddressEndpointGroup - Class in com.linecorp.armeria.client.endpoint.dns
DynamicEndpointGroup which resolves targets using DNS address queries (A and AAAA).
DnsAddressEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.dns
Builds a new DnsAddressEndpointGroup that sources its Endpoint list from the A or AAAA DNS records of a certain hostname.
DnsAddressEndpointGroupBuilder(String) - Constructor for class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
Creates a new instance that builds a DnsAddressEndpointGroup for the specified hostname.
DnsServiceEndpointGroup - Class in com.linecorp.armeria.client.endpoint.dns
DynamicEndpointGroup which resolves targets using DNS SRV records.
DnsServiceEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.dns
Builds a new DnsServiceEndpointGroup that sources its Endpoint list from the SRV DNS records of a certain hostname.
DnsServiceEndpointGroupBuilder(String) - Constructor for class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroupBuilder
Creates a new instance that builds a DnsServiceEndpointGroup for the specified hostname.
DnsTextEndpointGroup - Class in com.linecorp.armeria.client.endpoint.dns
DynamicEndpointGroup which resolves targets using DNS TXT records.
DnsTextEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.dns
Builds a new DnsTextEndpointGroup that sources its Endpoint list from the TXT DNS records of a certain hostname.
DnsTextEndpointGroupBuilder(String, Function<byte[], Endpoint>) - Constructor for class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroupBuilder
Creates a new instance that builds a DnsTextEndpointGroup for the specified hostname.
doApply(PathMappingContext) - Method in class com.linecorp.armeria.server.AbstractPathMapping
Invoked by AbstractPathMapping.apply(PathMappingContext) to perform the actual path matching and path parameter extraction.
DocService - Class in com.linecorp.armeria.server.docs
An HttpService that provides information about the Services running in a Server.
DocService() - Constructor for class com.linecorp.armeria.server.docs.DocService
Creates a new instance.
DocServiceBuilder - Class in com.linecorp.armeria.server.docs
Builds a new DocService.
DocServiceBuilder() - Constructor for class com.linecorp.armeria.server.docs.DocServiceBuilder
 
DocServicePlugin - Interface in com.linecorp.armeria.server.docs
Generates the ServiceSpecifications of the supported Services.
docString() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
docString() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
Returns the documentation string that describes the enum value.
docString() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
docString() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the documentation string of the field.
docString() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the documentation string of the function.
docString() - Method in interface com.linecorp.armeria.server.docs.NamedTypeInfo
Returns the documentation string.
docString() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the documentation string.
docString() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
DocStringExtractor - Class in com.linecorp.armeria.server.docs
A supporting base class for implementing the standard pattern of extracting docstrings from arbitrary files in a particular classpath location.
DocStringExtractor(String, String) - Constructor for class com.linecorp.armeria.server.docs.DocStringExtractor
 
doDelete(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a DELETE request.
doDelete(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doDuplicateStream(StreamMessage<HttpObject>) - Method in class com.linecorp.armeria.common.HttpRequestDuplicator
 
doDuplicateStream(StreamMessage<HttpObject>) - Method in class com.linecorp.armeria.common.HttpResponseDuplicator
 
doDuplicateStream(StreamMessage<T>) - Method in class com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator
Creates a new U instance that wraps ChildStreamMessage and forwards its method invocations to it.
doExecute(ClientRequestContext, I, CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Invoked when the CircuitBreaker is in closed state.
doExecute(ClientRequestContext, HttpRequest, CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient
 
doExecute(ClientRequestContext, RpcRequest, CircuitBreaker) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
 
doExecute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.retry.RetryingClient
Invoked by RetryingClient.execute(ClientRequestContext, Request) after the deadline for response timeout is set.
doExecute(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.retry.RetryingHttpClient
 
doExecute(ClientRequestContext, RpcRequest) - Method in class com.linecorp.armeria.client.retry.RetryingRpcClient
 
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a GET request.
doGet(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.file.HttpFileService
 
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.healthcheck.HttpHealthCheckService
 
doGet(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.metric.PrometheusExpositionService
 
doHead(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a HEAD request.
doHead(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doHead(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.healthcheck.HttpHealthCheckService
 
doNextDelayMillis(int) - Method in class com.linecorp.armeria.client.retry.AbstractBackoff
Invoked by AbstractBackoff.nextDelayMillis(int) after numAttemptsSoFar is validated.
doOptions(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles an OPTIONS request.
doOptions(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doPatch(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a PATCH request.
doPatch(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doPost(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a POST request.
doPost(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doPost(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.metric.PrometheusExpositionService
 
doPut(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a PUT request.
doPut(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
doPut(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.healthcheck.ManagedHttpHealthCheckService
 
doTrace(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Handles a TRACE request.
doTrace(ServiceRequestContext, HttpRequest, HttpResponseWriter) - Method in class com.linecorp.armeria.server.AbstractHttpService
dropwizard() - Static method in class com.linecorp.armeria.common.metric.MoreNamingConventions
DropwizardMeterRegistries - Class in com.linecorp.armeria.common.metric
Provides the convenient factory methods for DropwizardMeterRegistry with more sensible defaults for NamingConvention and HierarchicalNameMapper.
dump(OutputStream) - Method in interface com.linecorp.armeria.server.Router
Dumps the content of this Router.
duplicate() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
duplicateStream() - Method in class com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator
Creates a new U instance that publishes data from the publisher you create this factory with.
duplicateStream(boolean) - Method in class com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator
Creates a new U instance that publishes data from the publisher you create this factory with.
duplicatorExecutor() - Method in class com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator
Returns the default EventExecutor which will be used when a user subscribes to a child stream using StreamMessage.subscribe(Subscriber) or StreamMessage.subscribe(Subscriber, boolean).
DynamicEndpointGroup - Class in com.linecorp.armeria.client.endpoint
A dynamic EndpointGroup.
DynamicEndpointGroup() - Constructor for class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 

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
empty() - Static method in class com.linecorp.armeria.server.PathMapped
Returns a singleton instance of a PathMapped that represents a non-existent value.
empty() - Static method in class com.linecorp.armeria.server.PathMappingResult
EMPTY_DATA - Static variable in interface com.linecorp.armeria.common.HttpData
Empty HTTP/2 data.
EMPTY_HEADERS - Static variable in interface com.linecorp.armeria.common.HttpHeaders
An immutable empty HTTP/2 headers.
EMPTY_PARAMETERS - Static variable in interface com.linecorp.armeria.common.HttpParameters
An immutable empty HTTP parameters map.
EmptyFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that publishes no objects, just a close event.
EmptyFixedStreamMessage() - Constructor for class com.linecorp.armeria.common.stream.EmptyFixedStreamMessage
 
encodingHeaderValue() - Method in class com.linecorp.armeria.client.encoding.DeflateStreamDecoderFactory
 
encodingHeaderValue() - Method in class com.linecorp.armeria.client.encoding.GzipStreamDecoderFactory
 
encodingHeaderValue() - Method in interface com.linecorp.armeria.client.encoding.StreamDecoderFactory
Returns the value of the Content-Encoding header which this factory applies to.
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.
EndpointInfo(String, String, String, MediaType, Iterable<MediaType>) - Constructor for class com.linecorp.armeria.server.docs.EndpointInfo
Creates a new instance.
endpoints() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
 
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.PropertiesEndpointGroup
 
endpoints() - Method in class com.linecorp.armeria.client.endpoint.StaticEndpointGroup
 
endpoints() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the endpoints for accessing this method.
EndpointSelectionStrategy - Interface in com.linecorp.armeria.client.endpoint
Endpoint selection strategy that creates a EndpointSelector.
EndpointSelector - Interface in com.linecorp.armeria.client.endpoint
Selects an Endpoint from an EndpointGroup.
endRequest() - Method in 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.
endResponseWithLastChild() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
endResponseWithLastChild() - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Fills the response-side logs from the last added child.
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.SerializationFormatProvider
Entry(String, MediaType, MediaType...) - Constructor for class com.linecorp.armeria.common.SerializationFormatProvider.Entry
Creates a new instance.
EnumInfo - Class in com.linecorp.armeria.server.docs
Metadata about an enum type.
EnumInfo(String, Class<? extends Enum<?>>) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Class<? extends Enum<?>>, String) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Iterable<EnumValueInfo>) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
EnumInfo(String, Iterable<EnumValueInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.EnumInfo
Creates a new instance.
enums() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the enums related with the services in this specification.
EnumValueInfo - Class in com.linecorp.armeria.server.docs
Metadata about an enum value.
EnumValueInfo(String) - Constructor for class com.linecorp.armeria.server.docs.EnumValueInfo
Creates a new instance.
EnumValueInfo(String, String) - Constructor for class com.linecorp.armeria.server.docs.EnumValueInfo
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.AbstractHttpData
 
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.HttpStatus
Returns whether the specified object is "equal to" this status.
equals(Object) - Method in class com.linecorp.armeria.common.MediaType
 
equals(Object) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
 
equals(Object) - Method in class com.linecorp.armeria.common.Scheme
 
equals(Object) - Method in class com.linecorp.armeria.common.SerializationFormat
 
equals(Object) - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
equals(Object) - Method in class com.linecorp.armeria.server.auth.BasicToken
 
equals(Object) - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
equals(Object) - Method in class com.linecorp.armeria.server.auth.OAuth2Token
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.EndpointInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.MethodInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.StructInfo
 
equals(Object) - Method in class com.linecorp.armeria.server.docs.TypeSignature
 
equals(Object) - Method in class com.linecorp.armeria.server.ServerPort
 
ETAG - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"etag".
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 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
 
EventLoopGroups - Class in com.linecorp.armeria.common.util
Provides methods that are useful for creating an EventLoopGroup.
EventLoopStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A StreamMessage optimized for when writes and reads all happen on the provided EventLoop, removing the need for most synchronization from the hot path.
EventLoopStreamMessage() - Constructor for class com.linecorp.armeria.common.stream.EventLoopStreamMessage
Creates a new EventLoopStreamMessage which executes all writes on an arbitrary EventLoop.
EventLoopStreamMessage(EventLoop) - Constructor for class com.linecorp.armeria.common.stream.EventLoopStreamMessage
Creates a new EventLoopStreamMessage which executes all writes on the provided EventLoop.
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
 
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(HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders which are applicable to any services.
exampleHttpHeaders(Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders which are applicable to any services.
exampleHttpHeaders(Class<?>, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified type.
exampleHttpHeaders(Class<?>, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified type.
exampleHttpHeaders(String, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified name.
exampleHttpHeaders(String, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the service with the specified name.
exampleHttpHeaders(Class<?>, String, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified type and method name.
exampleHttpHeaders(Class<?>, String, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified type and method name.
exampleHttpHeaders(String, String, HttpHeaders...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified service and method name.
exampleHttpHeaders(String, String, Iterable<? extends HttpHeaders>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example HttpHeaders for the method with the specified service and method name.
exampleHttpHeaders() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the example HTTP headers of the method.
exampleHttpHeaders() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the example HTTP headers of the service.
exampleHttpHeaders() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the example HTTP headers of the services in this specification.
exampleRequest(Object...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests which are applicable to the method denoted by the specified example requests.
exampleRequest(Iterable<?>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests which are applicable to the method denoted by the specified example requests.
exampleRequestForMethod(Class<?>, String, Object...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service type and method name.
exampleRequestForMethod(Class<?>, String, Iterable<?>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service type and method name.
exampleRequestForMethod(String, String, Object...) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service and method name.
exampleRequestForMethod(String, String, Iterable<?>) - Method in class com.linecorp.armeria.server.docs.DocServiceBuilder
Adds the example requests for the method with the specified service and method name.
exampleRequests() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the list of the example request serialized in a string.
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.
ExceptionHandler - Annotation Type in com.linecorp.armeria.server.annotation
Specifies an ExceptionHandlerFunction class which handles exceptions throwing from an annotated service method.
ExceptionHandlerFunction - Interface in com.linecorp.armeria.server.annotation
An interface for exception handler.
ExceptionHandlers - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for ExceptionHandler.
ExceptionInfo - Class in com.linecorp.armeria.server.docs
Metadata about an exception type.
ExceptionInfo(String, Iterable<FieldInfo>) - Constructor for class com.linecorp.armeria.server.docs.ExceptionInfo
Creates a new instance.
ExceptionInfo(String, Iterable<FieldInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.ExceptionInfo
Creates a new instance.
Exceptions - Class in com.linecorp.armeria.common.util
Provides methods that are useful for handling exceptions.
exceptions() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the exceptions related with the services in this specification.
exceptionTypeSignatures() - Method in class com.linecorp.armeria.server.docs.MethodInfo
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(Client<I, O>, ClientRequestContext, I) - Method in interface com.linecorp.armeria.client.DecoratingClientFunction
Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
execute(ClientRequestContext, HttpRequest) - Method in class com.linecorp.armeria.client.encoding.HttpDecodingClient
 
execute(HttpRequest) - Method in interface com.linecorp.armeria.client.HttpClient
Sends the specified HTTP request.
execute(AggregatedHttpMessage) - Method in interface com.linecorp.armeria.client.HttpClient
Sends the specified HTTP request.
execute(HttpHeaders) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an empty HTTP request with the specified headers.
execute(HttpHeaders, HttpData) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP request with the specified headers and content.
execute(HttpHeaders, byte[]) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP request with the specified headers and content.
execute(HttpHeaders, String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP request with the specified headers and content.
execute(HttpHeaders, String, Charset) - Method in interface com.linecorp.armeria.client.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.LoggingClient
 
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.metric.MetricCollectingClient
 
execute(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.retry.RetryingClient
 
execute(HttpMethod, String, String, String, I, Function<Throwable, O>) - Method in class com.linecorp.armeria.client.UserClient
Executes the specified Request via UserClient.delegate().
execute(EventLoop, HttpMethod, String, String, String, I, Function<Throwable, O>) - Method in class com.linecorp.armeria.client.UserClient
Executes the specified Request via UserClient.delegate().
executeDelegate(ClientRequestContext, I) - Method in class com.linecorp.armeria.client.retry.RetryingClient
Executes the delegate with a new derived ClientRequestContext.
EXPECT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"expect".
EXPECTATION_FAILED - Static variable in class com.linecorp.armeria.common.HttpStatus
417 Expectation Failed.
expected() - Method in exception com.linecorp.armeria.client.SessionProtocolNegotiationException
Returns the expected SessionProtocol.
EXPIRES - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"expires".
exponential(long, long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that waits an exponentially-increasing amount of time between attempts.
exponential(long, long, double) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that waits an exponentially-increasing amount of time between attempts.
exposedHeaders() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns a set of headers to be exposed to calling clients.
exposeHeaders(String...) - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Specifies the headers to be exposed to calling clients.
exposeHeaders(AsciiString...) - Method in class com.linecorp.armeria.server.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(ClientFactory) - Method in class com.linecorp.armeria.client.HttpClientBuilder
Sets the ClientFactory of the client.
factory() - Method in class com.linecorp.armeria.client.UserClient
 
FAILED_DEPENDENCY - Static variable in class com.linecorp.armeria.common.HttpStatus
424 Failed Dependency (WebDAV, RFC4918).
failedResponseLogLevel() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the LogLevel to use when logging failure responses (e.g., failed with an exception).
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.
failureResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
fallthrough() - Static method in interface com.linecorp.armeria.server.annotation.ExceptionHandlerFunction
Throws a FallthroughException in order to try to handle the Throwable by the next handler.
fallthrough() - Static method in interface com.linecorp.armeria.server.annotation.RequestConverterFunction
Throws a FallthroughException in order to try to convert the request to an object by the next converter.
fallthrough() - Static method in interface com.linecorp.armeria.server.annotation.ResponseConverterFunction
Throws a FallthroughException in order to try to convert result to HttpResponse by the next converter.
FieldInfo - Class in com.linecorp.armeria.server.docs
Metadata about a field of a struct or an exception.
FieldInfo(String, FieldRequirement, TypeSignature) - Constructor for class com.linecorp.armeria.server.docs.FieldInfo
Creates a new instance.
FieldInfo(String, FieldRequirement, TypeSignature, 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 class com.linecorp.armeria.server.docs.ExceptionInfo
Returns the metadata about the fields of the type.
fields() - Method in class com.linecorp.armeria.server.docs.StructInfo
Returns the metadata about the fields of the type.
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
 
fillInStackTrace() - Method in exception com.linecorp.armeria.server.HttpResponseException
 
fillInStackTrace() - Method in exception com.linecorp.armeria.server.HttpStatusException
 
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
An HttpResponse that filters objects as they are published.
FilteredHttpResponse(HttpResponse) - Constructor for class com.linecorp.armeria.common.FilteredHttpResponse
Creates a new FilteredHttpResponse that filters objects published by delegate before passing to a subscriber.
FilteredHttpResponse(HttpResponse, boolean) - Constructor for class com.linecorp.armeria.common.FilteredHttpResponse
Creates a new FilteredHttpResponse that filters objects published by delegate before passing to a subscriber.
FilteredStreamMessage<T,U> - Class in com.linecorp.armeria.common.stream
A StreamMessage that filters objects as they are published.
FilteredStreamMessage(StreamMessage<T>) - Constructor for class com.linecorp.armeria.common.stream.FilteredStreamMessage
Creates a new FilteredStreamMessage that filters objects published by delegate before passing to a subscriber.
FilteredStreamMessage(StreamMessage<T>, boolean) - Constructor for class com.linecorp.armeria.common.stream.FilteredStreamMessage
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 any of the specified media ranges.
find(String) - Static method in enum com.linecorp.armeria.common.SessionProtocol
Finds the SessionProtocol with the specified SessionProtocol.uriText().
find(PathMappingContext) - Method in interface com.linecorp.armeria.server.Router
Finds the value of mapping that matches the specified PathMappingContext.
findNamedTypes() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
findNamedTypes() - Method in interface com.linecorp.armeria.server.docs.NamedTypeInfo
Returns all enum, struct and exception types referred by this type.
findNamedTypes() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns all enum, struct and exception TypeSignatures referred to by this service.
findNamedTypes() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
findPool(Channel) - Static method in interface com.linecorp.armeria.client.pool.KeyedChannelPool
Finds the KeyedChannelPool that the specified Channel belongs to.
findService(PathMappingContext) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
Finds the Service whose PathMapping matches the path.
findService(PathMappingContext) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeService
 
findServiceConfig(PathMappingContext) - Method in class com.linecorp.armeria.server.VirtualHost
Finds the Service whose Router matches the PathMappingContext.
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.
finish() - Method in interface com.linecorp.armeria.client.encoding.StreamDecoder
Closes the decoder and returns any decoded data that may be left over.
fixed(long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that waits a fixed delay between attempts.
Flags - Class in com.linecorp.armeria.common
The system properties that affect Armeria's runtime behavior.
FLV_VIDEO - Static variable in class com.linecorp.armeria.common.MediaType
Media type for Flash video.
forAnyOrigin() - Static method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Creates a new builder with its origin set to '*'.
FORBIDDEN - Static variable in class com.linecorp.armeria.common.HttpStatus
403 Forbidden.
forClassPath(String) - Static method in class com.linecorp.armeria.server.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.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.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.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.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.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.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.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.cors.CorsServiceBuilder
Creates a new builder with the specified origin.
forOrigins(String...) - Static method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Creates a new builder with the specified origins.
forVfs(HttpVfs) - Static method in class com.linecorp.armeria.server.file.HttpFileService
Creates a new HttpFileService for the specified HttpVfs.
forVfs(HttpVfs) - Static method in class com.linecorp.armeria.server.file.HttpFileServiceBuilder
Creates a new HttpFileServiceBuilder with the specified HttpVfs.
FOUND - Static variable in class com.linecorp.armeria.common.HttpStatus
302 Found.
fragment() - Method in interface com.linecorp.armeria.client.ClientRequestContext
Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.
fragment() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
fragment() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
fragment() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the URI fragment of this endpoint.
FROM - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"from".
from(CompletionStage<? extends HttpResponse>) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage.
from(CompletionStage<?>) - Static method in interface com.linecorp.armeria.common.RpcResponse
Creates a new RpcResponse that is completed successfully or exceptionally based on the completion of the specified CompletionStage.
fromMediaType(String) - Static method in class com.linecorp.armeria.common.SerializationFormat
Functions - Class in com.linecorp.armeria.common.util
Utility methods related with function composition.

G

GATEWAY_TIMEOUT - Static variable in class com.linecorp.armeria.common.HttpStatus
504 Gateway Timeout.
generate(Iterable<ServiceInfo>, Function<TypeSignature, ? extends NamedTypeInfo>) - Static method in class com.linecorp.armeria.server.docs.ServiceSpecification
Generates a new ServiceSpecification from the specified ServiceInfos and the factory Function that creates NamedTypeInfos for the enum, struct or exception types referred by the specified ServiceInfos.
generateSpecification(Set<ServiceConfig>) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
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() - Static method in exception com.linecorp.armeria.client.ClosedClientFactoryException
Returns a ClosedClientFactoryException which may be a singleton or a new instance, depending on whether the verbose exception mode is enabled.
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.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 exception mode is enabled.
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 exception 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 exception 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 exception mode is enabled.
get() - Static method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
Returns the singleton instance.
get() - Static method in exception com.linecorp.armeria.common.stream.AbortedStreamException
Returns a AbortedStreamException which may be a singleton or a new instance, depending on whether the verbose exception 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 exception 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 exception mode is enabled.
get() - Static method in class com.linecorp.armeria.common.stream.NoopSubscriber
Returns a singleton NoopSubscriber.
get() - Method in interface com.linecorp.armeria.common.util.ReleasableHolder
Returns the resource.
Get - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.GET onto specific method.
get(String, String) - Method in interface com.linecorp.armeria.server.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 exception mode is enabled.
get0(AbstractOption<V>) - Method in class com.linecorp.armeria.common.util.AbstractOptions
Returns the value of the specified option.
getAllDocStrings(ClassLoader) - Method in class com.linecorp.armeria.server.docs.DocStringExtractor
Extract all docstrings from files at the configured path, delegating to DocStringExtractor.getDocStringsFromFiles(Map) for actual processing.
getBaseTimeUnit() - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
getByte(int) - Method in class com.linecorp.armeria.common.AbstractHttpData
Gets the byte value at the given index relative to the HttpData's HttpData.offset().
getByte(int) - Method in class com.linecorp.armeria.common.DefaultHttpData
 
getByte(int) - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
getCircuitBreaker() - Method in exception com.linecorp.armeria.client.circuitbreaker.FailFastException
Returns the CircuitBreaker that has detected the failure.
getDocStringsFromFiles(Map<String, byte[]>) - Method in class com.linecorp.armeria.server.docs.DocStringExtractor
Extracts a Map of docstrings from the given Map of path to file contents.
getNextDelay(ClientRequestContext, Backoff) - Method in class com.linecorp.armeria.client.retry.RetryingClient
Returns the next delay which retry will be made after.
getNextDelay(ClientRequestContext, Backoff, long) - Method in class com.linecorp.armeria.client.retry.RetryingClient
Returns the next delay which retry will be made after.
getNodeSelector(String) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Returns the EndpointSelector for the specified case-insensitive groupName.
getNow(Object) - Method in interface com.linecorp.armeria.common.RpcResponse
Returns the specified valueIfAbsent when not complete, or returns the result value or throws an exception when complete.
getOrElse(ClientOption<T>, T) - Method in class com.linecorp.armeria.client.ClientOptions
Returns the value of the specified ClientOption.
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.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.
guessServiceMethodName(Object) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Guesses the name of the service method who handles the specified example request.
guessServiceName(Object) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Guesses the name of the service who handles the specified example request.
GZIP - Static variable in class com.linecorp.armeria.common.MediaType
 
GzipStreamDecoderFactory - Class in com.linecorp.armeria.client.encoding
A StreamDecoderFactory which supports the 'gzip' encoding.
GzipStreamDecoderFactory() - Constructor for class com.linecorp.armeria.client.encoding.GzipStreamDecoderFactory
 

H

handleException(RequestContext, HttpRequest, Throwable) - Method in interface com.linecorp.armeria.server.annotation.ExceptionHandlerFunction
Returns an HttpResponse which would be sent back to the client who sent the req.
hasAttr(AttributeKey<T>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
hasAttr(AttributeKey<V>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
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.AbstractHttpData
 
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.HttpStatus
 
hashCode() - Method in class com.linecorp.armeria.common.MediaType
 
hashCode() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
 
hashCode() - Method in class com.linecorp.armeria.common.Scheme
 
hashCode() - Method in class com.linecorp.armeria.common.SerializationFormat
 
hashCode() - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
hashCode() - Method in class com.linecorp.armeria.server.auth.BasicToken
 
hashCode() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
hashCode() - Method in class com.linecorp.armeria.server.auth.OAuth2Token
 
hashCode() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.MethodInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
hashCode() - Method in class com.linecorp.armeria.server.docs.TypeSignature
 
hashCode() - Method in class com.linecorp.armeria.server.ServerPort
 
hasHighestScore() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns whether the score of this result is the highest or not.
hasHttp() - Method in class com.linecorp.armeria.server.ServerPort
hasHttps() - Method in class com.linecorp.armeria.server.ServerPort
hasIpAddr() - Method in class com.linecorp.armeria.client.Endpoint
Returns whether this endpoint has an IP address resolved.
hasLowestScore() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns whether the score of this result is the lowest or not.
hasProtocol(SessionProtocol) - Method in class com.linecorp.armeria.server.ServerPort
Returns whether the specified protocol is in the list of SessionProtocols.
hasProxyProtocol() - Method in class com.linecorp.armeria.server.ServerPort
Returns whether the SessionProtocol.PROXY is in the list of SessionProtocols.
hasTls() - Method in class com.linecorp.armeria.server.ServerPort
Returns whether there is a SessionProtocol which is over TLS.
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.HttpClient
Sends an HTTP HEAD request.
Head - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.HEAD onto specific method.
Header - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping an HTTP request header onto the following elements.
headers() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Returns the HTTP headers.
headers() - Method in class com.linecorp.armeria.common.DefaultHttpRequest
Deprecated.
 
headers() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the initial HTTP/2 headers of this request.
headerValueCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the headerValueCache parameter.
HealthCheckedEndpointGroup - Class in com.linecorp.armeria.client.endpoint.healthcheck
An EndpointGroup 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.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, IP address and port number.
host() - Method in class com.linecorp.armeria.client.Endpoint
Returns the host name of this endpoint.
host() - Method in class com.linecorp.armeria.client.pool.PoolKey
Returns the host name of the server associated with this key.
HOST - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"host".
host() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Deprecated.
Do not use this method. Get the remote or local address from RequestLog.context() or get the authority from RequestLog.authority().
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, IP address, port number and method name.
hostname() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns the virtual host name of the request.
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(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTP port that listens on all available network interfaces.
http(InetSocketAddress) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTP port that listens to the specified localAddress.
http2MaxFrameSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
HTTP_HEADERS - Static variable in class com.linecorp.armeria.client.ClientOption
The additional HTTP headers to send with requests.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class com.linecorp.armeria.common.HttpStatus
505 HTTP Version Not Supported.
HttpAuthService - Class in com.linecorp.armeria.server.auth
Decorates a Service to provide HTTP authorization functionality.
HttpAuthService(Service<HttpRequest, HttpResponse>) - Constructor for class com.linecorp.armeria.server.auth.HttpAuthService
Creates a new instance that provides HTTP authorization functionality to delegate.
HttpAuthServiceBuilder - Class in com.linecorp.armeria.server.auth
Builds a new HttpAuthService.
HttpAuthServiceBuilder() - Constructor for class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
 
HttpClient - Interface in com.linecorp.armeria.client
An HTTP client.
HttpClientBuilder - Class in com.linecorp.armeria.client
Creates a new HTTP client that connects to the specified URI using the builder pattern.
HttpClientBuilder(String) - Constructor for class com.linecorp.armeria.client.HttpClientBuilder
Creates a new instance.
HttpClientBuilder(URI) - Constructor for class com.linecorp.armeria.client.HttpClientBuilder
Creates a new instance.
HttpData - Interface in com.linecorp.armeria.common
HTTP/2 data.
HttpDecodingClient - Class in com.linecorp.armeria.client.encoding
A DecoratingClient that requests and decodes HTTP encoding (e.g., gzip) that has been applied to the content of a HttpResponse.
HttpEncodingService - Class in com.linecorp.armeria.server.encoding
Decorates a Service to apply HTTP encoding (e.g., gzip) to an HttpService.
HttpEncodingService(Service<HttpRequest, HttpResponse>) - Constructor for class com.linecorp.armeria.server.encoding.HttpEncodingService
Creates a new DecoratingService that HTTP encodes response data published from delegate.
HttpEncodingService(Service<HttpRequest, HttpResponse>, Predicate<MediaType>, int) - Constructor for class com.linecorp.armeria.server.encoding.HttpEncodingService
Creates a new DecoratingService that HTTP encodes response data published from delegate.
HttpFileService - Class in com.linecorp.armeria.server.file
An HttpService that serves static files from a file system.
HttpFileServiceBuilder - Class in com.linecorp.armeria.server.file
HttpFileServiceConfig - Class in com.linecorp.armeria.server.file
HttpFileService configuration.
HttpHeaderNames - Class in com.linecorp.armeria.common
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/2 headers.
HttpHeadersJsonDeserializer - Class in com.linecorp.armeria.common
HttpHeadersJsonDeserializer() - Constructor for class com.linecorp.armeria.common.HttpHeadersJsonDeserializer
Creates a new instance.
HttpHeadersJsonSerializer - Class in com.linecorp.armeria.common
HttpHeadersJsonSerializer() - Constructor for class com.linecorp.armeria.common.HttpHeadersJsonSerializer
Creates a new instance.
HttpHealthCheckedEndpointGroup - Class in com.linecorp.armeria.client.endpoint.healthcheck
HTTP implementation of HealthCheckedEndpointGroup.
HttpHealthCheckedEndpointGroupBuilder - Class in com.linecorp.armeria.client.endpoint.healthcheck
A builder for creating new HttpHealthCheckedEndpointGroups.
HttpHealthCheckedEndpointGroupBuilder(EndpointGroup, String) - Constructor for class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroupBuilder
HttpHealthCheckService - Class in com.linecorp.armeria.server.healthcheck
An HttpService that responds with HTTP status "200 OK" if the server is healthy and can accept requests and HTTP status "503 Service Not Available" if the server is unhealthy and cannot accept requests.
HttpHealthCheckService(HealthChecker...) - Constructor for class com.linecorp.armeria.server.healthcheck.HttpHealthCheckService
Creates a new instance.
HttpMethod - Enum in com.linecorp.armeria.common
HTTP request method.
HttpObject - Interface in com.linecorp.armeria.common
The common interface for HTTP/2 message objects, HttpHeaders and HttpData.
HttpParameters - Interface in com.linecorp.armeria.common
HTTP parameters map.
HttpRequest - Interface in com.linecorp.armeria.common
A streamed HTTP/2 Request.
HttpRequestDuplicator - Class in com.linecorp.armeria.common
Allows subscribing to a HttpRequest multiple times by duplicating the stream.
HttpRequestDuplicator(HttpRequest) - Constructor for class com.linecorp.armeria.common.HttpRequestDuplicator
Creates a new instance wrapping a HttpRequest and publishing to multiple subscribers.
HttpRequestDuplicator(HttpRequest, long) - Constructor for class com.linecorp.armeria.common.HttpRequestDuplicator
Creates a new instance wrapping a HttpRequest and publishing to multiple subscribers.
HttpRequestDuplicator(HttpRequest, long, EventExecutor) - Constructor for class com.linecorp.armeria.common.HttpRequestDuplicator
Creates a new instance wrapping a HttpRequest and publishing to multiple subscribers.
HttpRequestWriter - Interface in com.linecorp.armeria.common
An HttpRequest that can have HttpObjects written to it.
HttpResponse - Interface in com.linecorp.armeria.common
A streamed HTTP/2 Response.
httpResponse() - Method in exception com.linecorp.armeria.server.HttpResponseException
Returns the HttpResponse which would be sent back to the client who sent the corresponding request.
HttpResponseDuplicator - Class in com.linecorp.armeria.common
Allows subscribing to a HttpResponse multiple times by duplicating the stream.
HttpResponseDuplicator(HttpResponse) - Constructor for class com.linecorp.armeria.common.HttpResponseDuplicator
Creates a new instance wrapping a HttpResponse and publishing to multiple subscribers.
HttpResponseDuplicator(HttpResponse, long) - Constructor for class com.linecorp.armeria.common.HttpResponseDuplicator
Creates a new instance wrapping a HttpResponse and publishing to multiple subscribers.
HttpResponseDuplicator(HttpResponse, long, EventExecutor) - Constructor for class com.linecorp.armeria.common.HttpResponseDuplicator
Creates a new instance wrapping a HttpResponse and publishing to multiple subscribers.
HttpResponseException - Exception in com.linecorp.armeria.server
A RuntimeException that is raised to send an HTTP response with the content specified by a user.
HttpResponseException(HttpResponse) - Constructor for exception com.linecorp.armeria.server.HttpResponseException
Creates a new instance with the specified HttpResponse.
HttpResponseWriter - Interface in com.linecorp.armeria.common
An HttpResponse that can have HttpObjects written to it.
https(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTPS port that listens on all available network interfaces.
https(InetSocketAddress) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds an HTTPS port that listens to the specified localAddress.
HttpService - Interface in com.linecorp.armeria.server
An HTTP/2 Service.
HttpStatus - Class in com.linecorp.armeria.common
HTTP response code and its description.
HttpStatus(int, String) - Constructor for class com.linecorp.armeria.common.HttpStatus
Creates a new instance with the specified code and its reasonPhrase.
httpStatus() - Method in exception com.linecorp.armeria.server.HttpStatusException
Returns the HttpStatus which would be sent back to the client who sent the corresponding request.
HttpStatusClass - Enum in com.linecorp.armeria.common
The class of HTTP status.
HttpStatusException - Exception in com.linecorp.armeria.server
A RuntimeException that is raised to send a simplistic HTTP response with minimal content by a Service.
HttpVfs - Interface in com.linecorp.armeria.server.file
A virtual file system that provides the files requested by HttpFileService.
HttpVfs.AbstractEntry - Class in com.linecorp.armeria.server.file
A skeletal HttpVfs.Entry implementation.
HttpVfs.ByteArrayEntry - Class in com.linecorp.armeria.server.file
An HttpVfs.Entry whose content is backed by a byte array.
HttpVfs.Entry - Interface in com.linecorp.armeria.server.file
A file entry in an HttpVfs.

I

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.
identity() - Static method in class com.linecorp.armeria.common.metric.MoreNamingConventions
Returns the NamingConvention that uses the user-provided names and tags as they are.
idleTimeout(Duration) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the idle timeout of a socket connection.
idleTimeout(Duration) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the idle timeout of a connection for keep-alive.
idleTimeoutMillis(long) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the idle timeout of a socket connection in milliseconds.
idleTimeoutMillis(long) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the idle timeout of a connection in milliseconds for keep-alive.
idleTimeoutMillis() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the idle timeout of a connection in milliseconds for keep-alive.
IF_MATCH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"if-match".
IF_MODIFIED_SINCE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"if-modified-since".
IF_NONE_MATCH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"if-none-match".
IF_RANGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"if-range".
IF_UNMODIFIED_SINCE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"if-unmodified-since".
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.AggregatedHttpMessage
Returns the informational class (1xx) HTTP headers.
init() - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Update healthy servers and start to schedule healthcheck.
initialEndpointsFuture() - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Returns the CompletableFuture which is completed when the initial Endpoints are ready.
initialHttp2ConnectionWindowSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
initialHttp2StreamWindowSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
INSUFFICIENT_STORAGE - Static variable in class com.linecorp.armeria.common.HttpStatus
507 Insufficient Storage (WebDAV, RFC4918).
INTERNAL_SERVER_ERROR - Static variable in class com.linecorp.armeria.common.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.
invokeOnChildCallbacks(RequestContext) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
invokeOnChildCallbacks(RequestContext) - Method in interface com.linecorp.armeria.common.RequestContext
Invokes all RequestContext.onChild(BiConsumer) callbacks.
invokeOnChildCallbacks(RequestContext) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
invokeOnEnterCallbacks() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
invokeOnEnterCallbacks() - Method in interface com.linecorp.armeria.common.RequestContext
Invokes all RequestContext.onEnter(Consumer) 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(Consumer) 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
ipAddr() - Method in class com.linecorp.armeria.client.Endpoint
Returns the IP address of this endpoint.
ipAddr() - Method in class com.linecorp.armeria.client.pool.PoolKey
Returns the IP address of the server associated with this key.
ipFamily() - Method in class com.linecorp.armeria.client.Endpoint
Returns the StandardProtocolFamily of this endpoint's IP address.
is(MediaType) - Method in class com.linecorp.armeria.common.MediaType
Returns true if this instance falls within the range (as defined by the HTTP Accept header) given by the argument according to three criteria: The type of the argument is the wildcard or equal to the type of this instance.
isAccepted(MediaType...) - Method in class com.linecorp.armeria.common.SerializationFormat
Returns whether any of the specified media ranges is accepted by any of the SerializationFormat.mediaTypes() defined by this format.
isAnyOriginSupported() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Determines whether a wildcard origin, '*', is supported.
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.
isBase() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns if this type signature represents a base type.
isClean() - Method in class com.linecorp.armeria.common.util.Version
Returns true if repository status is not dirty.
isComplete() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream is complete, either successfully or exceptionally, including cancellation and abortion.
isCompletedExceptionally() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns true if this RpcResponse completed exceptionally.
isContainer() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns if this type signature represents a container type.
isCredentialsAllowed() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Determines if cookies are supported for CORS requests.
isEmpty() - Method in interface com.linecorp.armeria.common.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.EmptyFixedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.EventLoopStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
 
isEmpty() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream has been closed and did not publish any elements.
isEmpty() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
isEmpty() - Method in class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
 
isEmpty() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
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.cors.CorsConfig
Determines if support for CORS is enabled.
isEndOfStream() - Method in class com.linecorp.armeria.common.DefaultHttpData
 
isEndOfStream() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
isEndOfStream() - Method in interface com.linecorp.armeria.common.HttpObject
Gets whether the stream should be ended when writing this object.
isEndOfStream() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
isEpollAvailable() - Static method in class com.linecorp.armeria.common.util.NativeLibraries
Deprecated.
Use Flags.useEpoll() instead.
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.healthcheck.HealthChecker
Returns true if and only if the Server is healthy.
isHealthy() - Method in class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
 
isImmutable() - Method in interface com.linecorp.armeria.common.HttpHeaders
Returns whether this is immutable or not.
isIpAddrOnly() - Method in class com.linecorp.armeria.client.Endpoint
Returns whether this endpoint's host name is an IP address.
isMultiplex() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns true if and only if this protocol can multiplex a single transport-layer connection into more than one stream.
isNamed() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns if this type signature represents a named type.
isNullOriginAllowed() - Method in class com.linecorp.armeria.server.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.EventLoopStreamMessage
 
isOpen() - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
isOpen() - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
isOpen() - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Returns true if this stream is not closed yet.
isOpen() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
isOpen() - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Returns true if the StreamMessage is open.
isOpenSslAvailable() - Static method in class com.linecorp.armeria.common.util.NativeLibraries
Deprecated.
Use Flags.useOpenSsl() instead.
isPresent() - Method in class com.linecorp.armeria.server.PathMapped
Returns true if and only if Router found a matching value.
isPresent() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns true if this result is not PathMappingResult.empty().
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.cors.CorsConfig
Determines whether a CORS request should be rejected if it's invalid before being further processing.
isSupported(String) - Static method in enum com.linecorp.armeria.common.HttpMethod
Returns whether the specified String is one of the supported method names.
isTimedOut() - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
isTimedOut() - Method in interface com.linecorp.armeria.common.RequestContext
Returns whether this RequestContext has been timed-out (e.g., when the corresponding request passes a deadline).
isTls() - Method in enum com.linecorp.armeria.common.SessionProtocol
Returns true if and only if this protocol uses TLS as its transport-level security layer.
isUnresolved() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns if this type signature represents an unresolved type.
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
Deprecated.
iterator() - Method in interface com.linecorp.armeria.common.HttpHeaders
Returns an iterator over all HTTP/2 headers.
iterator() - Method in class com.linecorp.armeria.common.MediaTypeSet
 

J

JacksonRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
A default implementation of a RequestConverterFunction which converts a JSON body of the AggregatedHttpMessage to an object by ObjectMapper.
JacksonRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction
Creates an instance with the default ObjectMapper.
JacksonRequestConverterFunction(ObjectMapper) - Constructor for class com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction
Creates an instance with the specified ObjectMapper.
JacksonResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A response converter implementation which creates an HttpResponse with content-type: application/json; charset=utf-8.
JacksonResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.JacksonResponseConverterFunction
Creates an instance with the default ObjectMapper.
JacksonResponseConverterFunction(ObjectMapper) - Constructor for class com.linecorp.armeria.server.annotation.JacksonResponseConverterFunction
Creates an instance with the specified ObjectMapper.
JAVASCRIPT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
RFC 4329 declares this to be the correct media type for JavaScript, but text/javascript may be necessary in certain situations for compatibility.
join() - Method in interface com.linecorp.armeria.common.RpcResponse
Returns the result value if completed successfully or throws an unchecked exception if completed exceptionally.
JPEG - Static variable in class com.linecorp.armeria.common.MediaType
 
JSON - Static variable in class com.linecorp.armeria.common.MediaType
 
JSON_PATCH - Static variable in class com.linecorp.armeria.common.MediaType
As described in RFC 6902, this constant (application/json-patch+json) is used for expressing a sequence of operations to apply to a JavaScript Object Notation(JSON) document.
JSON_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 

K

KEEP_ALIVE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
Deprecated.
KEY_ARCHIVE - Static variable in class com.linecorp.armeria.common.MediaType
As described in 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
Creates a new instance.
KeyedChannelPoolHandlerWrapper<K> - Class in com.linecorp.armeria.client.pool
KeyedChannelPoolHandlerWrapper(KeyedChannelPoolHandler<K>) - Constructor for class com.linecorp.armeria.client.pool.KeyedChannelPoolHandlerWrapper
Creates a new instance with the specified delegate.
KeyedChannelPoolLoggingHandler - Class in com.linecorp.armeria.client.logging
Decorates a KeyedChannelPoolHandler to log the connection pool events.
KeyedChannelPoolLoggingHandler() - Constructor for class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
Creates a new instance with a system ticker.
KeyedChannelPoolLoggingHandler(Ticker) - Constructor for class com.linecorp.armeria.client.logging.KeyedChannelPoolLoggingHandler
Creates a new instance with an alternative Ticker.
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.
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.HttpHeaderNames
"last-modified".
lastModifiedMillis() - Method in class com.linecorp.armeria.server.file.HttpVfs.ByteArrayEntry
 
lastModifiedMillis() - Method in interface com.linecorp.armeria.server.file.HttpVfs.Entry
Returns the modification time of the entry.
length() - Method in class com.linecorp.armeria.common.DefaultHttpData
 
length() - Method in interface com.linecorp.armeria.common.HttpData
Returns the length of this data.
length(T) - Method in interface com.linecorp.armeria.common.stream.SignalLengthGetter
Returns the length of obj.
length() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
LENGTH_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
411 Length Required.
LINK - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"link".
Listenable<T> - Interface in com.linecorp.armeria.common.util
An interface that accepts item change listeners.
listener(CircuitBreakerListener) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
loadDocStrings(Set<ServiceConfig>) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Loads the documentation strings that describes services and their methods, enums and their values and structs/exceptions and their fields.
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.
localAddress() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the local address of this request.
LOCATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"location".
LOCKED - Static variable in class com.linecorp.armeria.common.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<I, O>) - Constructor for class com.linecorp.armeria.client.logging.LoggingClient
LoggingClient(Client<I, O>, LogLevel) - Constructor for class com.linecorp.armeria.client.logging.LoggingClient
Deprecated.
LoggingClientBuilder - Class in com.linecorp.armeria.client.logging
Builds a new LoggingClient.
LoggingClientBuilder() - Constructor for class com.linecorp.armeria.client.logging.LoggingClientBuilder
 
LoggingDecorator - Annotation Type in com.linecorp.armeria.server.annotation.decorator
A LoggingService decorator for annotated HTTP services.
LoggingDecoratorBuilder<T extends LoggingDecoratorBuilder<T>> - Class in com.linecorp.armeria.common.logging
Builds a new logging decorator.
LoggingDecoratorBuilder() - Constructor for class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
 
LoggingDecoratorFactoryFunction - Class in com.linecorp.armeria.server.annotation.decorator
A factory which creates a LoggingService decorator.
LoggingDecoratorFactoryFunction() - Constructor for class com.linecorp.armeria.server.annotation.decorator.LoggingDecoratorFactoryFunction
 
LoggingDecorators - Annotation Type in com.linecorp.armeria.server.annotation.decorator
The containing annotation type for LoggingDecorator.
LoggingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.logging
Decorates a Service to log Requests and Responses.
LoggingService(Service<I, O>) - Constructor for class com.linecorp.armeria.server.logging.LoggingService
LoggingService(Service<I, O>, LogLevel) - Constructor for class com.linecorp.armeria.server.logging.LoggingService
Deprecated.
LoggingServiceBuilder - Class in com.linecorp.armeria.server.logging
Builds a new LoggingService.
LoggingServiceBuilder() - Constructor for class com.linecorp.armeria.server.logging.LoggingServiceBuilder
 
logIfUnexpected(Logger, Channel, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
logIfUnexpected(Logger, Channel, String, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
logIfUnexpected(Logger, Channel, SessionProtocol, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
logIfUnexpected(Logger, Channel, SessionProtocol, String, Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Logs the specified exception if it is unexpected.
LogLevel - Enum in com.linecorp.armeria.common.logging
Log level.
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.
ManagedHttpHealthCheckService - Class in com.linecorp.armeria.server.healthcheck
A HttpHealthCheckService which allows overriding its status via a PUT request.
ManagedHttpHealthCheckService() - Constructor for class com.linecorp.armeria.server.healthcheck.ManagedHttpHealthCheckService
 
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.
mappedPath() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
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
 
mapping() - Method in class com.linecorp.armeria.server.PathMapped
Returns the PathMapping which matched the path.
mappingResult() - Method in class com.linecorp.armeria.server.PathMapped
Returns the PathMappingResult.
match(MediaType...) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the specified media ranges.
match(Iterable<MediaType>) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the specified media ranges.
matchHeaders(Iterable<? extends CharSequence>) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the media ranges specified in the specified string.
matchHeaders(CharSequence...) - Method in class com.linecorp.armeria.common.MediaTypeSet
Finds the MediaType in this List that matches one of the media ranges specified in the specified string.
MAX_FORWARDS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"max-forwards".
maxAge() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Gets the maxAge setting.
maxAge(long) - Method in class com.linecorp.armeria.server.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.file.HttpFileServiceBuilder
Sets the maximum allowed number of cached file entries.
maxCacheEntries() - Method in class com.linecorp.armeria.server.file.HttpFileServiceConfig
Returns the maximum allowed number of cached file entries.
maxCacheEntrySizeBytes(int) - Method in class com.linecorp.armeria.server.file.HttpFileServiceBuilder
Returns the maximum allowed size of a cached file entry.
maxCacheEntrySizeBytes() - Method in class com.linecorp.armeria.server.file.HttpFileServiceConfig
Returns the maximum allowed size of a cached file entry.
maxHttp1ChunkSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum length of each chunk in an HTTP/1 response content.
maxHttp1ChunkSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum length of each chunk in an HTTP/1 response content.
maxHttp1HeaderSize(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum length of all headers in an HTTP/1 response.
maxHttp1HeaderSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum length of all headers in an HTTP/1 response.
maxHttp1InitialLineLength(int) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the maximum length of an HTTP/1 response initial line.
maxHttp1InitialLineLength(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum length of an HTTP/1 response initial line.
maxNumConnections(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum allowed number of open connections.
maxNumConnections() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum allowed number of open connections.
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
 
maxTotalAttempts(int) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
Sets the maximum number of total attempts.
MBOX - Static variable in class com.linecorp.armeria.common.MediaType
 
measureAll(MeterRegistry) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns a newly-created immutable Map which contains all values of Meters in the specified MeterRegistry.
MediaType - 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.file.HttpVfs.AbstractEntry
 
mediaType() - Method in interface com.linecorp.armeria.server.file.HttpVfs.Entry
Returns the MIME type of the entry.
MediaTypeJsonDeserializer - Class in com.linecorp.armeria.common
MediaTypeJsonDeserializer() - Constructor for class com.linecorp.armeria.common.MediaTypeJsonDeserializer
Creates a new instance.
MediaTypeJsonSerializer - Class in com.linecorp.armeria.common
MediaTypeJsonSerializer() - Constructor for class com.linecorp.armeria.common.MediaTypeJsonSerializer
Creates a new instance.
mediaTypes() - Method in class com.linecorp.armeria.common.SerializationFormat
Returns the media types accepted by this format.
MediaTypeSet - Class in com.linecorp.armeria.common
An immutable Set of MediaTypes which provides useful methods for content negotiation.
MediaTypeSet(MediaType...) - Constructor for class com.linecorp.armeria.common.MediaTypeSet
Creates a new instance.
MediaTypeSet(Iterable<MediaType>) - Constructor for class com.linecorp.armeria.common.MediaTypeSet
Creates a new instance.
merge(Iterable<ServiceSpecification>) - Static method in class com.linecorp.armeria.server.docs.ServiceSpecification
Merges the specified ServiceSpecifications into one.
MeterIdPrefix - Class in com.linecorp.armeria.common.metric
A common prefix of Meter.Id which consists of Meter name and Tags.
MeterIdPrefix(String) - Constructor for class com.linecorp.armeria.common.metric.MeterIdPrefix
Creates a new instance with no Tags.
MeterIdPrefix(String, String...) - Constructor for class com.linecorp.armeria.common.metric.MeterIdPrefix
Creates a new instance.
MeterIdPrefix(String, Iterable<Tag>) - Constructor for class com.linecorp.armeria.common.metric.MeterIdPrefix
Creates a new instance.
MeterIdPrefixFunction - Interface in com.linecorp.armeria.common.metric
Creates a MeterIdPrefix from a RequestLog.
meterRegistry() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the MeterRegistry that collects various stats.
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the MeterRegistry which collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
meterRegistry() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
meterRegistry() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the MeterRegistry that collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
meterRegistry() - Method in class com.linecorp.armeria.server.Server
Returns the MeterRegistry that collects various stats.
meterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the MeterRegistry that collects various stats.
meterRegistry() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the MeterRegistry that collects various stats.
meterTag() - Method in class com.linecorp.armeria.server.AbstractPathMapping
 
meterTag() - Method in interface com.linecorp.armeria.server.file.HttpVfs
Returns the value of the "vfs" Tag in a Meter.
meterTag() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the value of the "pathMapping" Tag in a Meter.
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 interface com.linecorp.armeria.common.AggregatedHttpMessage
Returns the METHOD of this message.
method() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
method(HttpMethod) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
method() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
METHOD - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
":method".
method() - Method in interface com.linecorp.armeria.common.HttpHeaders
Gets the HttpHeaderNames.METHOD header or null if there is no such header.
method(HttpMethod) - Method in interface com.linecorp.armeria.common.HttpHeaders
Sets the HttpHeaderNames.METHOD header.
method() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the method of this request.
method(HttpMethod) - Method in interface com.linecorp.armeria.common.HttpRequest
Sets the method of this request.
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 HTTP method of the current Request.
method() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
method() - Method in interface com.linecorp.armeria.common.RpcRequest
Returns the method name.
method() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns HttpMethod of the request.
METHOD_NOT_ALLOWED - Static variable in class com.linecorp.armeria.common.HttpStatus
405 Method Not Allowed.
MethodInfo - Class in com.linecorp.armeria.server.docs
Metadata about a function of a Service.
MethodInfo(String, TypeSignature, Iterable<FieldInfo>, Iterable<TypeSignature>, Iterable<EndpointInfo>) - Constructor for class com.linecorp.armeria.server.docs.MethodInfo
Creates a new instance.
MethodInfo(String, TypeSignature, Iterable<FieldInfo>, Iterable<TypeSignature>, Iterable<EndpointInfo>, Iterable<HttpHeaders>, Iterable<String>, String) - Constructor for class com.linecorp.armeria.server.docs.MethodInfo
Creates a new instance.
methods() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the metadata about the methods available in the service.
MetricCollectingCircuitBreakerListener - Class in com.linecorp.armeria.client.circuitbreaker
A CircuitBreakerListener which exports the status of CircuitBreakers to MeterRegistry.
MetricCollectingCircuitBreakerListener(MeterRegistry) - Constructor for class com.linecorp.armeria.client.circuitbreaker.MetricCollectingCircuitBreakerListener
Creates a new instance with the default name .
MetricCollectingCircuitBreakerListener(MeterRegistry, String) - Constructor for class com.linecorp.armeria.client.circuitbreaker.MetricCollectingCircuitBreakerListener
Creates a new instance with the specified Meter name.
MetricCollectingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.metric
Decorates a Client to collect metrics into MeterRegistry.
MetricCollectingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.metric
Decorates a Service to collect metrics into MeterRegistry.
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.HttpStatus
421 Misdirected Request.
mode(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.healthcheck.ManagedHttpHealthCheckService
Judge the turning mode.
MoreMeters - Class in com.linecorp.armeria.common.metric
Provides utilities for accessing MeterRegistry.
MoreNamingConventions - Class in com.linecorp.armeria.common.metric
Provides commonly-used NamingConventions.
MOVED_PERMANENTLY - Static variable in class com.linecorp.armeria.common.HttpStatus
301 Moved Permanently.
MP4_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
MP4_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.HttpStatus
207 Multi-Status (WebDAV, RFC2518).
MULTIPLE_CHOICES - Static variable in class com.linecorp.armeria.common.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 class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the name.
name(String) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the name concatenated by the specified suffix.
name() - Method in class com.linecorp.armeria.server.docs.EnumInfo
 
name() - Method in class com.linecorp.armeria.server.docs.EnumValueInfo
Returns the name of the enum value.
name() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
name() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the fully qualified type name of the field.
name() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the name of the function.
name() - Method in interface com.linecorp.armeria.server.docs.NamedTypeInfo
Returns the fully qualified type name.
name() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
Returns the fully qualified type name of the service.
name() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
name() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the name of the type.
name() - Method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns the name of this ThrottlingStrategy.
namedTypeDescriptor() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the descriptor of the type if and only if this type signature represents a named type.
NamedTypeInfo - Interface in com.linecorp.armeria.server.docs
Metadata about a named type.
nameWithoutParameters() - Method in class com.linecorp.armeria.common.MediaType
Returns a name of this MediaType only consisting of the type and the sub type.
NativeLibraries - Class in com.linecorp.armeria.common.util
Deprecated.
Use Flags instead.
negotiatedProduceType() - Method in class com.linecorp.armeria.server.PathMappingResult
negotiatedProduceType() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
negotiatedResponseMediaType() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
negotiatedResponseMediaType() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns the negotiated producible media type.
negotiatedResponseMediaType() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the negotiated producible media type.
negotiatedResponseMediaType() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
NETWORK_AUTHENTICATION_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
511 Network Authentication Required (RFC6585).
never() - Static method in interface com.linecorp.armeria.client.retry.RetryStrategy
A RetryStrategy that defines a retry should not be performed.
never() - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Returns a singleton ThrottlingStrategy that never accepts requests.
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(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
 
newCounter(Meter.Id) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newDecoder() - Method in class com.linecorp.armeria.client.encoding.DeflateStreamDecoderFactory
 
newDecoder() - Method in class com.linecorp.armeria.client.encoding.GzipStreamDecoderFactory
 
newDecoder() - Method in interface com.linecorp.armeria.client.encoding.StreamDecoderFactory
Construct a new StreamDecoder to use to decode an HttpResponse.
newDecorator(CircuitBreaker, CircuitBreakerStrategy<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient
Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerStrategy.
newDecorator(CircuitBreakerMapping, CircuitBreakerStrategy<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient
Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerStrategy.
newDecorator(CircuitBreaker, CircuitBreakerStrategy<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerStrategy.
newDecorator(CircuitBreakerMapping, CircuitBreakerStrategy<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerStrategy.
newDecorator() - Static method in class com.linecorp.armeria.client.encoding.HttpDecodingClient
Creates a new HttpDecodingClient decorator with the default encodings of 'gzip' and 'deflate'.
newDecorator(StreamDecoderFactory...) - Static method in class com.linecorp.armeria.client.encoding.HttpDecodingClient
Creates a new HttpDecodingClient decorator with the specified StreamDecoderFactorys.
newDecorator(Iterable<? extends StreamDecoderFactory>) - Static method in class com.linecorp.armeria.client.encoding.HttpDecodingClient
Creates a new HttpDecodingClient decorator with the specified StreamDecoderFactorys.
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() - Static method in class com.linecorp.armeria.client.logging.LoggingClient
Returns a new Client decorator that logs Requests and Responses at LogLevel.INFO for success, LogLevel.WARN for failure.
newDecorator(LogLevel) - Static method in class com.linecorp.armeria.client.logging.LoggingClient
Deprecated.
newDecorator() - Method in class com.linecorp.armeria.client.logging.LoggingClientBuilder
Returns a newly-created LoggingClient decorator based on the properties of this builder.
newDecorator(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.client.metric.MetricCollectingClient
Returns a Client decorator that tracks request stats using MeterRegistry.
newDecorator(RetryStrategy<HttpRequest, HttpResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingHttpClient
Creates a new Client decorator that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryStrategy<HttpRequest, HttpResponse>, int) - Static method in class com.linecorp.armeria.client.retry.RetryingHttpClient
Creates a new Client decorator that handles failures of an invocation and retries HTTP requests.
newDecorator(RetryStrategy<HttpRequest, HttpResponse>, int, long) - Static method in class com.linecorp.armeria.client.retry.RetryingHttpClient
Creates a new Client decorator that handles failures of an invocation and retries HTTP requests.
newDecorator() - Method in class com.linecorp.armeria.client.retry.RetryingHttpClientBuilder
Returns a newly-created decorator that decorates a Client with a new RetryingHttpClient based on the properties of this builder.
newDecorator(RetryStrategy<RpcRequest, RpcResponse>) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Creates a new Client decorator that handles failures of an invocation and retries RPC requests.
newDecorator(RetryStrategy<RpcRequest, RpcResponse>, int) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Creates a new Client decorator that handles failures of an invocation and retries RPC requests.
newDecorator(RetryStrategy<RpcRequest, RpcResponse>, int, long) - Static method in class com.linecorp.armeria.client.retry.RetryingRpcClient
Creates a new Client decorator that handles failures of an invocation and retries RPC requests.
newDecorator() - Method in class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
Returns a newly-created decorator that decorates a Client with a new RetryingRpcClient based on the properties of this builder.
newDecorator(LoggingDecorator) - Method in class com.linecorp.armeria.server.annotation.decorator.LoggingDecoratorFactoryFunction
Creates a new decorator with the specified parameter.
newDecorator(RateLimitingDecorator) - Method in class com.linecorp.armeria.server.annotation.decorator.RateLimitingDecoratorFactoryFunction
Creates a new decorator with the specified parameter.
newDecorator(T) - Method in interface com.linecorp.armeria.server.annotation.DecoratorFactoryFunction
Creates a new decorator with the specified parameter.
newDecorator(Iterable<? extends Authorizer<HttpRequest>>) - Static method in class com.linecorp.armeria.server.auth.HttpAuthService
Creates a new HTTP authorization Service decorator using the specified Authorizers.
newDecorator(Authorizer<HttpRequest>...) - Static method in class com.linecorp.armeria.server.auth.HttpAuthService
Creates a new HTTP authorization Service decorator using the specified Authorizers.
newDecorator() - Method in class com.linecorp.armeria.server.auth.HttpAuthServiceBuilder
Returns a newly-created decorator that decorates a Service with a new HttpAuthService based on the Authorizers added to this builder.
newDecorator() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
Returns a newly-created decorator that decorates a Service with a new CorsService based on the properties of this builder.
newDecorator() - Static method in class com.linecorp.armeria.server.logging.LoggingService
Returns a new Service decorator that logs Requests and Responses at LogLevel.INFO for success, LogLevel.WARN for failure.
newDecorator(LogLevel) - Static method in class com.linecorp.armeria.server.logging.LoggingService
Deprecated.
newDecorator() - Method in class com.linecorp.armeria.server.logging.LoggingServiceBuilder
Returns a newly-created LoggingService decorator based on the properties of this builder.
newDecorator(MeterIdPrefixFunction) - Static method in class com.linecorp.armeria.server.metric.MetricCollectingService
Returns a new Service decorator that tracks request stats using MeterRegistry.
newDecorator(ThrottlingStrategy<HttpRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingHttpService
Creates a new decorator using the specified ThrottlingStrategy instance.
newDecorator(ThrottlingStrategy<RpcRequest>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingRpcService
Creates a new decorator using the specified ThrottlingStrategy instance.
newDerivedClient(T, ClientOptionValue<?>...) - Static method in class com.linecorp.armeria.client.Clients
Creates a new derived client that connects to the same URI with the specified client and the specified additionalOptions.
newDerivedClient(T, Iterable<ClientOptionValue<?>>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new derived client that connects to the same URI with the specified client and the specified additionalOptions.
newDerivedClient(T, Function<? super ClientOptions, ClientOptions>) - Static method in class com.linecorp.armeria.client.Clients
Creates a new derived client that connects to the same URI with the specified client but with different ClientOptions.
newDerivedContext() - Method in interface com.linecorp.armeria.client.ClientRequestContext
 
newDerivedContext(Request) - Method in interface com.linecorp.armeria.client.ClientRequestContext
 
newDerivedContext() - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
newDerivedContext(Request) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
newDerivedContext() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
newDerivedContext(Request) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
newDerivedContext() - Method in interface com.linecorp.armeria.common.RequestContext
Creates a new derived RequestContext which only the RequestLog is different from the deriving context.
newDerivedContext(Request) - Method in interface com.linecorp.armeria.common.RequestContext
Creates a new derived RequestContext with the specified Request which the RequestLog is different from the deriving context.
newDerivedContext() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
newDerivedContext(Request) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
newDerivedContext() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
 
newDerivedContext(Request) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
 
newDerivedContext() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
newDerivedContext(Request) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
newDistributionSummary(MeterRegistry, String, Iterable<Tag>) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns a newly-registered DistributionSummary configured by MoreMeters.distributionStatisticConfig().
newDistributionSummary(Meter.Id, DistributionStatisticConfig, double) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newEndpoint(URI) - Static method in class com.linecorp.armeria.client.AbstractClientFactory
Creates a new Endpoint from the authority part of the specified URI.
newEventLoopGroup(int) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, boolean) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, String) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, String, boolean) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newEventLoopGroup(int, ThreadFactory) - Static method in class com.linecorp.armeria.common.util.EventLoopGroups
Returns a newly-created EventLoopGroup.
newFactory(ClientFactory) - Method in interface com.linecorp.armeria.client.ClientFactoryProvider
Creates a new ClientFactory.
newFunctionCounter(Meter.Id, T, ToDoubleFunction<T>) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newFunctionTimer(Meter.Id, T, ToLongFunction<T>, ToDoubleFunction<T>, TimeUnit) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newGauge(Meter.Id, T, ToDoubleFunction<T>) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newHeaderEntry(int, AsciiString, String, DefaultHeaders.HeaderEntry<AsciiString, String>) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
newHealthyResponse(ServiceRequestContext) - Method in class com.linecorp.armeria.server.healthcheck.HttpHealthCheckService
Creates a new response which is sent when the Server is healthy.
newLongTaskTimer(Meter.Id) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newMeter(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newMeterBinder(String) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup with the default meter names.
newMeterBinder(MeterIdPrefix) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup
Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup.
newPerHostAndMethodDecorator(Function<String, CircuitBreaker>, CircuitBreakerStrategy<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient
Creates a new decorator that binds one CircuitBreaker per host and HttpMethod with the specified CircuitBreakerStrategy.
newPerHostAndMethodDecorator(Function<String, CircuitBreaker>, CircuitBreakerStrategy<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator that binds one CircuitBreaker per host and RPC method name with the specified CircuitBreakerStrategy.
newPerHostDecorator(Function<String, CircuitBreaker>, CircuitBreakerStrategy<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient
Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerStrategy.
newPerHostDecorator(Function<String, CircuitBreaker>, CircuitBreakerStrategy<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerStrategy.
newPerMethodDecorator(Function<String, CircuitBreaker>, CircuitBreakerStrategy<HttpResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient
Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerStrategy.
newPerMethodDecorator(Function<String, CircuitBreaker>, CircuitBreakerStrategy<RpcResponse>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClient
Creates a new decorator that binds one CircuitBreaker per RPC method name with the specified CircuitBreakerStrategy.
newRegistry() - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the default HierarchicalNameMapper.
newRegistry(MetricRegistry) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified MetricRegistry and the default HierarchicalNameMapper.
newRegistry(HierarchicalNameMapper) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified HierarchicalNameMapper.
newRegistry(MetricRegistry, HierarchicalNameMapper) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified MetricRegistry and HierarchicalNameMapper.
newRegistry(HierarchicalNameMapper, Clock) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified HierarchicalNameMapper and Clock.
newRegistry(MetricRegistry, HierarchicalNameMapper, Clock) - Static method in class com.linecorp.armeria.common.metric.DropwizardMeterRegistries
Returns a newly-created DropwizardMeterRegistry instance with the specified MetricRegistry, HierarchicalNameMapper and Clock.
newRegistry() - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
Returns a newly-created PrometheusMeterRegistry instance with a new CollectorRegistry.
newRegistry(CollectorRegistry) - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
Returns a newly-created PrometheusMeterRegistry instance with the specified CollectorRegistry.
newRegistry(CollectorRegistry, Clock) - Static method in class com.linecorp.armeria.common.metric.PrometheusMeterRegistries
Returns a newly-created PrometheusMeterRegistry instance with the specified CollectorRegistry and Clock.
newSelector(EndpointGroup) - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Creates a new EndpointSelector that selects an Endpoint from the specified EndpointGroup.
newSelector(EndpointGroup) - Method in class com.linecorp.armeria.client.endpoint.StickyEndpointSelectionStrategy
Creates a new StickyEndpointSelector.
newTimer(MeterRegistry, String, Iterable<Tag>) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Returns a newly-registered Timer configured by MoreMeters.distributionStatisticConfig().
newTimer(Meter.Id, DistributionStatisticConfig, PauseDetector) - Method in class com.linecorp.armeria.common.metric.NoopMeterRegistry
 
newUnhealthyResponse(ServiceRequestContext) - Method in class com.linecorp.armeria.server.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.
nextDelayMillis(int) - Method in class com.linecorp.armeria.client.retry.AbstractBackoff
 
nextDelayMillis(int) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns the number of milliseconds to wait for before attempting a retry.
nextDelayMillis(int) - Method in class com.linecorp.armeria.client.retry.BackoffWrapper
 
nextEventLoop() - Method in class com.linecorp.armeria.server.Server
Returns a EventLoop from the worker group.
NO_CONTENT - Static variable in class com.linecorp.armeria.common.HttpStatus
204 No Content.
NON_AUTHORITATIVE_INFORMATION - Static variable in class com.linecorp.armeria.common.HttpStatus
203 Non-Authoritative Information (since HTTP/1.1).
nonce() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
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.file.HttpVfs.Entry
A non-existent entry.
NonNullByDefault - Annotation Type in com.linecorp.armeria.common.util
An annotation that signifies the return values, parameters and fields are non-nullable by default leveraging the JSR-305 Nonnull annotation.
NonWrappingRequestContext - Class in com.linecorp.armeria.common
Default RequestContext implementation.
NonWrappingRequestContext(MeterRegistry, SessionProtocol, HttpMethod, String, String, Request) - Constructor for class com.linecorp.armeria.common.NonWrappingRequestContext
Creates a new instance.
noop() - Static method in interface com.linecorp.armeria.client.pool.KeyedChannelPoolHandler
Returns an instance that does nothing.
NOOP - Static variable in interface com.linecorp.armeria.common.logging.RequestLogBuilder
A dummy RequestLogBuilder that discards everything it collected.
NoopMeterRegistry - Class in com.linecorp.armeria.common.metric
A MeterRegistry which does not record any values.
NoopSubscriber<T> - Class in com.linecorp.armeria.common.stream
A Subscriber that discards all elements silently.
NoopSubscriber() - Constructor for class com.linecorp.armeria.common.stream.NoopSubscriber
 
NOT_ACCEPTABLE - Static variable in class com.linecorp.armeria.common.HttpStatus
406 Not Acceptable.
NOT_EXTENDED - Static variable in class com.linecorp.armeria.common.HttpStatus
510 Not Extended (RFC2774).
NOT_FOUND - Static variable in class com.linecorp.armeria.common.HttpStatus
404 Not Found.
NOT_IMPLEMENTED - Static variable in class com.linecorp.armeria.common.HttpStatus
501 Not Implemented.
NOT_MODIFIED - Static variable in class com.linecorp.armeria.common.HttpStatus
304 Not Modified.
notifyListeners(T) - Method in class com.linecorp.armeria.common.util.AbstractListenable
Notify the new value changes to the listeners added via AbstractListenable.addListener(Consumer).
numActiveRequests() - Method in class com.linecorp.armeria.client.limit.ConcurrencyLimitingClient
Returns the number of the Requests that are being executed.
numCommonBlockingTaskThreads() - Static method in class com.linecorp.armeria.common.Flags
Returns the default number of blocking task executor threads.
numCommonWorkers() - Static method in class com.linecorp.armeria.common.Flags
Returns the default number of common worker group threads.
numConnections() - Method in class com.linecorp.armeria.server.Server
Returns the number of open connections on this Server.
numWildcards() - Method in class com.linecorp.armeria.common.MediaType
Returns the number of wildcards of this MediaType.

O

OAUTH1A - Static variable in class com.linecorp.armeria.server.auth.AuthTokenExtractors
An OAuth1aToken extractor function instance.
OAuth1aToken - Class in com.linecorp.armeria.server.auth
The bearer token of OAuth 1.0a authentication.
OAUTH2 - Static variable in class com.linecorp.armeria.server.auth.AuthTokenExtractors
An OAuth2Token extractor function instance.
OAuth2Token - Class in com.linecorp.armeria.server.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(String) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroup
Creates a DnsAddressEndpointGroup with an unspecified port that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(String, int) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroup
Creates a DnsAddressEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(String) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroup
Creates a DnsServiceEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(String, Function<byte[], Endpoint>) - Static method in class com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroup
Creates a DnsTextEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
of(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
of(ClientFactory, EndpointGroup, String, Duration) - Static method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroup
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
Deprecated.
Use Endpoint.of(String, int) and Endpoint.withWeight(int), e.g. Endpoint.of("foo.com", 80).withWeight(500).
of(ClassLoader, String, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the resourceName resource file.
of(ClassLoader, String, String, int) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the resourceName resource file.
of(Properties, String) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the Properties.
of(Properties, String, int) - Static method in class com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup
Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the Properties.
of(String, ClientOptionValue<?>...) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified uri using the default ClientFactory.
of(String, ClientOptions) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified uri using the default ClientFactory.
of(ClientFactory, String, ClientOptionValue<?>...) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified uri using an alternative ClientFactory.
of(ClientFactory, String, ClientOptions) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified uri using an alternative ClientFactory.
of(URI, ClientOptionValue<?>...) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified URI using the default ClientFactory.
of(URI, ClientOptions) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified URI using the default ClientFactory.
of(ClientFactory, URI, ClientOptionValue<?>...) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified URI using an alternative ClientFactory.
of(ClientFactory, URI, ClientOptions) - Static method in interface com.linecorp.armeria.client.HttpClient
Creates a new HTTP client that connects to the specified URI using an alternative ClientFactory.
of(String) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Creates a new Backoff that computes backoff delay using one of Backoff.exponential(long, long, double), Backoff.fixed(long) and Backoff.random(long, long) chaining with Backoff.withJitter(double, double) and Backoff.withMaxAttempts(int) from the specification.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request with empty content.
of(HttpMethod, String, MediaType, String) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request.
of(HttpMethod, String, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request.
of(HttpMethod, String, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request.
of(HttpMethod, String, MediaType, byte[], int, int) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request.
of(HttpMethod, String, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request.
of(HttpMethod, String, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP request.
of(int) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response.
of(HttpStatus, MediaType, String) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, byte[], int, int) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response of the specified HttpStatus.
of(HttpStatus, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP response of the specified HttpStatus.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP message with empty content.
of(HttpHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP message.
of(HttpHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP message.
of(Iterable<HttpHeaders>, HttpHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Creates a new HTTP message.
of(byte[]) - Static method in interface com.linecorp.armeria.common.HttpData
Creates a new instance from the specified byte array.
of(byte[], int, int) - Static method in interface com.linecorp.armeria.common.HttpData
Creates a new instance from the specified byte array, offset and length.
of(Charset, String) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into an HttpData.
of(ByteBuf) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified Netty ByteBuf into an HttpData.
of(Charset, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified formatted string into an HttpData.
of(String) - Static method in class com.linecorp.armeria.common.HttpHeaderNames
Lower-cases and converts the specified header name into an AsciiString.
of() - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns new empty HTTP headers.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns new HTTP request headers.
of(int) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns new HTTP response headers.
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns new HTTP response headers.
of(AsciiString, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns new HTTP headers with a single entry.
of(AsciiString, String, AsciiString, String) - Static method in interface com.linecorp.armeria.common.HttpHeaders
Returns new HTTP headers with two entries.
of(AsciiString, String, AsciiString, String, AsciiString, String) - Static method in interface com.linecorp.armeria.common.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.HttpHeaders
Returns new HTTP headers with four entries.
of() - Static method in interface com.linecorp.armeria.common.HttpParameters
Returns a new empty HTTP parameters map.
of(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request with empty content and closes the stream.
of(HttpMethod, String, MediaType, String) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, byte[], int, int) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpMethod, String, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request and closes the stream.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest with empty content and closes the stream.
of(HttpHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest and closes the stream.
of(HttpHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest and closes the stream.
of(HttpHeaders, HttpObject...) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HttpRequest that publishes the given HttpObjects and closes the stream.
of(AggregatedHttpMessage) - Static method in interface com.linecorp.armeria.common.HttpRequest
Converts the AggregatedHttpMessage into a new HttpRequest and closes the stream.
of(HttpHeaders, Publisher<? extends HttpObject>) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new instance from an existing HttpHeaders and Publisher.
of(int) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified statusCode and closes the stream if the HttpStatusClass is not informational (1xx).
of(HttpStatus) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
of(HttpStatus, MediaType, String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream.
of(String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content as UTF_8 and closes the stream.
of(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content as UTF_8 and closes the stream.
of(MediaType, String) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content and closes the stream.
of(MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of OK status with the content and closes the stream.
of(HttpStatus, MediaType, String, Object...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream.
of(HttpStatus, MediaType, byte[]) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream.
of(HttpStatus, MediaType, byte[], int, int) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream.
of(HttpStatus, MediaType, HttpData) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream.
of(HttpStatus, MediaType, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified HttpStatus and closes the stream.
of(HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified headers.
of(HttpHeaders, HttpData) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified headers and content.
of(HttpHeaders, HttpData, HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified objects and closes the stream.
of(HttpObject...) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response of the specified objects and closes the stream.
of(AggregatedHttpMessage) - Static method in interface com.linecorp.armeria.common.HttpResponse
Converts the AggregatedHttpMessage into a new complete HttpResponse.
of(Publisher<? extends HttpObject>) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response whose stream is produced from an existing Publisher.
of(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 enum com.linecorp.armeria.common.SessionProtocol
Returns the SessionProtocol with the specified SessionProtocol.uriText().
of() - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish no objects, just a close event.
of(T) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish the single obj.
of(T, T) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish the two obj1 and obj2.
of(T...) - Static method in interface com.linecorp.armeria.common.stream.StreamMessage
Creates a new StreamMessage that will publish the given objs.
of(Cookie...) - Static method in interface com.linecorp.armeria.server.annotation.Cookies
Creates an instance with a copy of the specified set of Cookies.
of(String, String) - Static method in class com.linecorp.armeria.server.auth.BasicToken
Creates a new BasicToken from the given username and password.
of(Map<String, String>) - Static method in class com.linecorp.armeria.server.auth.OAuth1aToken
Creates a new OAuth1aToken from the given arguments.
of(String) - Static method in class com.linecorp.armeria.server.auth.OAuth2Token
Creates a new OAuth2Token from the given accessToken.
of(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 path pattern.
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(int) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified HTTP status code.
of(HttpStatus) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified HttpStatus.
of(AggregatedHttpMessage) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified AggregatedHttpMessage.
of(HttpResponse) - Static method in exception com.linecorp.armeria.server.HttpResponseException
Returns a new HttpResponseException instance with the specified HttpResponse.
of(int) - Static method in exception com.linecorp.armeria.server.HttpStatusException
Returns a new HttpStatusException instance with the specified HTTP status code.
of(HttpStatus) - Static method in exception com.linecorp.armeria.server.HttpStatusException
Returns a new HttpStatusException instance with the specified HttpStatus.
of(String) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches the specified pathPattern. e.g.
of(String, String) - Static method in class com.linecorp.armeria.server.PathMappingResult
Creates a new instance with the specified path and query, without any path parameters.
of(String, String, Map<String, String>) - Static method in class com.linecorp.armeria.server.PathMappingResult
Creates a new instance with the specified path, query and the extracted path parameters.
of(String, String, Map<String, String>, int) - Static method in class com.linecorp.armeria.server.PathMappingResult
Creates a new instance with the specified path, query, the extracted path parameters and the score.
of(SocketAddress, SocketAddress) - Static method in class com.linecorp.armeria.server.ProxiedAddresses
Creates a new instance.
of(BiFunction<ServiceRequestContext, T, CompletionStage<Boolean>>, String) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
of(BiFunction<ServiceRequestContext, T, CompletionStage<Boolean>>) - Static method in class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
ofAscii(String) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into a US-ASCII HttpData.
ofAscii(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified formatted string into a US-ASCII HttpData.
ofBase(String) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for a base type.
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.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.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in the current class path.
ofCompositeService(List<CompositeServiceEntry<I, O>>) - Static method in class com.linecorp.armeria.server.Routers
Returns the default implementation of the Router to find a CompositeServiceEntry.
ofContainer(String, TypeSignature...) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new container type with the specified container type name and the type signatures of the elements it contains.
ofContainer(String, Iterable<TypeSignature>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new container type with the specified container type name and the type signatures of the elements it contains.
ofDefault(String) - Static method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns the default function that creates a MeterIdPrefix with the specified name and the Tags derived from the RequestLog properties.
ofDefaultName() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreaker
Creates a new CircuitBreaker that has a default name and the default configurations.
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.
ofFailed(Throwable) - Static method in interface com.linecorp.armeria.common.HttpResponse
Deprecated.
ofFailure(Throwable) - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new failed HTTP response.
ofFailure(Throwable) - Static method in interface com.linecorp.armeria.common.RpcResponse
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.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.file.HttpVfs
Creates a new HttpVfs with the specified rootDir in an O/S file system.
offset() - Method in class com.linecorp.armeria.common.DefaultHttpData
 
offset() - Method in interface com.linecorp.armeria.common.HttpData
Returns the start offset of the HttpData.array().
offset() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
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.
ofList(TypeSignature) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the list with the specified element type signature.
ofList(Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the list with the specified named element type.
ofMap(TypeSignature, TypeSignature) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the map with the specified key and value type signatures.
ofMap(Class<?>, Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the map with the specified named key and value types.
ofNamed(Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new named type signature for the specified type.
ofNamed(String, Object) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new named type signature for the provided name and arbitrary descriptor.
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) - 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 and extracts the values of the named groups.
ofRegex(String) - Static method in interface com.linecorp.armeria.server.PathMapping
Creates a new PathMapping that matches a path with the specified regular expression and extracts the values of the named groups.
ofSet(TypeSignature) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the set with the specified element type signature.
ofSet(Class<?>) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new type signature for the set with the specified named element type.
ofThrift() - Static method in class com.linecorp.armeria.common.SerializationFormat
Deprecated.
Use ThriftSerializationFormats.values().
ofUnresolved(String) - Static method in class com.linecorp.armeria.server.docs.TypeSignature
Creates a new unresolved type signature with the specified type name.
ofUtf8(String) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified text into a UTF-8 HttpData.
ofUtf8(String, Object...) - Static method in interface com.linecorp.armeria.common.HttpData
Converts the specified formatted string into a UTF-8 HttpData.
ofVirtualHost(Iterable<ServiceConfig>) - Static method in class com.linecorp.armeria.server.Routers
Returns the default implementation of the Router to find a ServiceConfig.
OGG_AUDIO - Static variable in class com.linecorp.armeria.common.MediaType
 
OGG_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.HttpStatus
200 OK.
onChild(BiConsumer<? super RequestContext, ? super RequestContext>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
onChild(BiConsumer<? super RequestContext, ? super RequestContext>) - Method in interface com.linecorp.armeria.common.RequestContext
Registers callback to be run when this context is replaced by a child context.
onChild(BiConsumer<? super RequestContext, ? super RequestContext>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
onComplete() - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
onDemand(Runnable) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Performs the specified task when there are enough demands from the Subscriber.
OneElementFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that only publishes one object.
OneElementFixedStreamMessage(T) - Constructor for class com.linecorp.armeria.common.stream.OneElementFixedStreamMessage
 
onEnter(Runnable) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
onEnter(Consumer<? super RequestContext>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
onEnter(Consumer<? super RequestContext>) - 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 interface com.linecorp.armeria.common.RequestContext
Deprecated.
onEnter(Consumer<? super RequestContext>) - 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.MetricCollectingCircuitBreakerListener
 
onExit(Runnable) - Method in class com.linecorp.armeria.common.AbstractRequestContext
 
onExit(Consumer<? super RequestContext>) - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
onExit(Consumer<? super RequestContext>) - 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 interface com.linecorp.armeria.common.RequestContext
Deprecated.
onExit(Consumer<? super RequestContext>) - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
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.auth.HttpAuthService
Invoked when req is failed.
onFailure(ServiceRequestContext, HttpRequest, Throwable) - Method in class com.linecorp.armeria.server.throttling.ThrottlingHttpService
Invoked when req is throttled.
onFailure(ServiceRequestContext, RpcRequest, Throwable) - Method in class com.linecorp.armeria.server.throttling.ThrottlingRpcService
Invoked when req is throttled.
onFailure(ServiceRequestContext, I, Throwable) - Method in class com.linecorp.armeria.server.throttling.ThrottlingService
Invoked when req is throttled.
onNext(T) - Method in class com.linecorp.armeria.common.stream.NoopSubscriber
 
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.MetricCollectingCircuitBreakerListener
 
onRequestTimeoutChange(long) - Method in interface com.linecorp.armeria.server.RequestTimeoutChangeListener
Invoked when the request timeout of the current request has been changed.
onRetryingComplete(ClientRequestContext) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
This should be called when retrying is finished.
onServerErrorStatus() - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerStrategy
Returns the CircuitBreakerStrategy that determines a Response as successful when its HttpStatus is not HttpStatusClass.SERVER_ERROR and there was no Exception raised.
onServerErrorStatus() - Static method in interface com.linecorp.armeria.client.retry.RetryStrategy
Returns the RetryStrategy that retries the request with the RetryStrategy.defaultBackoff when the response matches HttpStatusClass.SERVER_ERROR or an Exception is raised.
onServerErrorStatus(Backoff) - Static method in interface com.linecorp.armeria.client.retry.RetryStrategy
Returns the RetryStrategy that retries the request with the specified backoff when the response matches HttpStatusClass.SERVER_ERROR or an Exception is raised.
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.MetricCollectingCircuitBreakerListener
 
onStatus(BiFunction<HttpStatus, Throwable, Boolean>) - Static method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerStrategy
Returns the CircuitBreakerStrategy that determines a Response as successful using the specified BiFunction.
onStatus(BiFunction<HttpStatus, Throwable, Backoff>) - Static method in interface com.linecorp.armeria.client.retry.RetryStrategy
Returns the RetryStrategy that decides to retry the request using the specified backoffFunction.
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.auth.HttpAuthService
Invoked when req is successful.
onSuccess(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.throttling.ThrottlingService
Invoked when req is not throttled.
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.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.DefaultClientBuilderParams
 
options() - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
options(String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP OPTIONS request.
options() - Method in class com.linecorp.armeria.client.UserClient
 
Options - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.OPTIONS onto specific method.
Order - Annotation Type in com.linecorp.armeria.server.annotation
Specifies an order which is used to sort the annotated service methods.
orElse(EndpointGroup) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
 
orElse(Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.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.HttpHeaderNames
"origin".
origin() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns the allowed origin.
origins() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns the set of allowed origins.
overridePath(String) - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns a wrapped PathMappingContext which holds the specified path.

P

Param - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping a parameter of a request onto the following elements.
parameters() - Method in class com.linecorp.armeria.common.MediaType
Returns a multimap containing the parameters of this media type.
parameters() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the metadata about the parameters of the function.
paramNames() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the names of the path parameters extracted by this mapping.
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.
parsedPathCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the parsedPathCache parameter.
PARTIAL_CONTENT - Static variable in class com.linecorp.armeria.common.HttpStatus
206 Partial Content.
password() - Method in class com.linecorp.armeria.server.auth.BasicToken
 
patch(String, HttpData) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PATCH request with the specified content.
patch(String, byte[]) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PATCH request with the specified content.
patch(String, String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PATCH request with the specified content.
patch(String, String, Charset) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PATCH request with the specified content.
Patch - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.PATCH onto specific method.
path() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Returns the PATH of this message.
path() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
path(String) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
PATH - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
":path".
path() - Method in interface com.linecorp.armeria.common.HttpHeaders
Gets the HttpHeaderNames.PATH header or null if there is no such header.
path(String) - Method in interface com.linecorp.armeria.common.HttpHeaders
Sets the HttpHeaderNames.PATH header.
path() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the path of this request.
path(String) - Method in interface com.linecorp.armeria.common.HttpRequest
Sets the path of this request.
path() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the absolute path part of the Request URI, excluding the query part, as defined in RFC3986.
path() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
path() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the absolute path part of the current Request URI, excluding the query part, as defined in RFC3986.
path() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
Path - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping dynamic web requests onto specific method.
path() - Method in class com.linecorp.armeria.server.docs.EndpointInfo
Returns the path of this endpoint.
path() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns the absolute path retrieved from the request, as defined in RFC3986.
path() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns the path mapped by the PathMapping.
PathMapped<T> - Class in com.linecorp.armeria.server
A value mapped by Router.
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 extracts path parameters from it.
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
 
pathMappingContext() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
PathMappingContext - Interface in com.linecorp.armeria.server
Holds the parameters which are required to find a service available to handle the request.
pathMappingContext() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the PathMappingContext used to find the Service.
pathMappingContext() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
PathMappingResult - Class in com.linecorp.armeria.server
pathMappings() - Method in interface com.linecorp.armeria.server.ServiceWithPathMappings
Returns the set of PathMapping to which this Service is bound.
pathParam(String) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the value of the specified path parameter.
pathParams() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
pathParams() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns the path parameters extracted by the PathMapping.
pathParams() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the path parameters mapped by the PathMapping associated with the Service that is handling the current Request.
pathParams() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
PAYMENT_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
402 Payment Required.
PDF - Static variable in class com.linecorp.armeria.common.MediaType
 
peel(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Returns the cause of the specified throwable peeling it recursively, if it is one of the CompletionException, ExecutionException, InvocationTargetException or ExceptionInInitializerError.
pendingResponses() - Method in class com.linecorp.armeria.server.GracefulShutdownSupport
Returns the number of pending responses.
PLAIN_TEXT_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
PNG - Static variable in class com.linecorp.armeria.common.MediaType
 
PoolKey - Class in com.linecorp.armeria.client.pool
The default key of KeyedChannelPool.
PoolKey(String, String, int, SessionProtocol) - Constructor for class com.linecorp.armeria.client.pool.PoolKey
Creates a new key with the specified host, ipAddr, port and sessionProtocol.
port(int) - Method in class com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder
Sets the port number of the Endpoints created by DnsAddressEndpointGroup.
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() - Method in class com.linecorp.armeria.client.pool.PoolKey
Returns the port number of the server associated with this key.
port(int, String) - Method in class com.linecorp.armeria.server.ServerBuilder
port(int, SessionProtocol...) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
port(int, Iterable<SessionProtocol>) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
port(InetSocketAddress, String) - Method in class com.linecorp.armeria.server.ServerBuilder
port(InetSocketAddress, SessionProtocol...) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
port(InetSocketAddress, Iterable<SessionProtocol>) - Method in class com.linecorp.armeria.server.ServerBuilder
Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
port(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.HttpClient
Sends an HTTP POST request with the specified content.
post(String, byte[]) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP POST request with the specified content.
post(String, String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP POST request with the specified content.
post(String, String, Charset) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP POST request with the specified content.
Post - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.POST onto specific method.
POSTSCRIPT - Static variable in class com.linecorp.armeria.common.MediaType
 
PRAGMA - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"pragma".
PRECONDITION_FAILED - Static variable in class com.linecorp.armeria.common.HttpStatus
412 Precondition Failed.
PRECONDITION_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
428 Precondition Required (RFC6585).
PREFER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"prefer".
prefix() - Method in class com.linecorp.armeria.server.AbstractPathMapping
 
prefix() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the prefix of this path mapping if it is a prefix mapping, or Optional.empty() otherwise.
preflightResponseHeader(String, Object...) - Method in class com.linecorp.armeria.server.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.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.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.cors.CorsServiceBuilder
Returns HTTP response headers that should be added to a CORS preflight response.
preflightResponseHeaders() - Method in class com.linecorp.armeria.server.cors.CorsConfig
Returns HTTP response headers that should be added to a CORS preflight response.
PROCESSING - Static variable in class com.linecorp.armeria.common.HttpStatus
102 Processing (WebDAV, RFC2518).
Produces - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a media type which would be produced by the service method or class.
ProducesBinary - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces("application/binary").
ProducesGroup - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for Produces.
ProducesJson - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces("application/json; charset=utf-8").
ProducesOctetStream - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces("application/octet-stream").
ProducesText - Annotation Type in com.linecorp.armeria.server.annotation
An alias for @Produces("text/plain; charset=utf-8").
ProduceType - Annotation Type in com.linecorp.armeria.server.annotation
Deprecated.
ProduceTypes - Annotation Type in com.linecorp.armeria.server.annotation
Deprecated.
produceTypes() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns a list of MediaType that is ordered by client-side preferences.
producibleMediaTypes() - Method in class com.linecorp.armeria.server.VirtualHost
Returns MediaTypeSet that consists of media types producible by this virtual host.
prometheus() - Static method in class com.linecorp.armeria.common.metric.MoreNamingConventions
PrometheusExpositionService - Class in com.linecorp.armeria.server.metric
Exposes Prometheus metrics in text format 0.0.4.
PrometheusExpositionService(CollectorRegistry) - Constructor for class com.linecorp.armeria.server.metric.PrometheusExpositionService
Creates a new instance.
PrometheusMeterRegistries - Class in com.linecorp.armeria.common.metric
Provides the convenient factory methods for PrometheusMeterRegistry with more sensible defaults for NamingConvention.
PropertiesEndpointGroup - Class in com.linecorp.armeria.client.endpoint
PROTOBUF - Static variable in class com.linecorp.armeria.common.MediaType
protocol(SessionProtocol) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroupBuilder
Sets the SessionProtocol to be used when making health check requests.
protocol() - Method in class com.linecorp.armeria.server.ServerPort
Deprecated.
protocols() - Method in class com.linecorp.armeria.server.ServerPort
Returns the SessionProtocols this ServerPort uses.
ProtocolViolationException - Exception in com.linecorp.armeria.common
A RuntimeException raised when a remote peer violated the current SessionProtocol.
ProtocolViolationException() - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new exception.
ProtocolViolationException(String) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified message.
ProtocolViolationException(String, Throwable) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified message and cause.
ProtocolViolationException(Throwable) - Constructor for exception com.linecorp.armeria.common.ProtocolViolationException
Creates a new instance with the specified cause.
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.
proxiedAddresses() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
ProxiedAddresses - Class in com.linecorp.armeria.server
An interface to provide source and destination addresses delivered from a proxy server.
proxiedAddresses() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the proxied addresses if the current Request is received through a proxy.
proxiedAddresses() - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
PROXY_AUTHENTICATE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"proxy-authenticate".
PROXY_AUTHENTICATION_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
407 Proxy Authentication Required.
PROXY_AUTHORIZATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"proxy-authorization".
PROXY_CONNECTION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
Deprecated.
proxyProtocolMaxTlvSize(int) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the maximum size of additional data for PROXY protocol.
proxyProtocolMaxTlvSize() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the maximum size of additional data (TLV, Tag-Length-Value).
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
Deprecated.
push(RequestContext, boolean) - Static method in interface com.linecorp.armeria.common.RequestContext
push() - Method in interface com.linecorp.armeria.common.RequestContext
Pushes the specified context to the thread-local stack.
push(boolean) - Method in interface com.linecorp.armeria.common.RequestContext
Pushes the specified context to the thread-local stack.
pushIfAbsent() - Method in interface com.linecorp.armeria.common.RequestContext
Pushes this context to the thread-local stack if there is no current context.
put(String, HttpData) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PUT request with the specified content.
put(String, byte[]) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PUT request with the specified content.
put(String, String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PUT request with the specified content.
put(String, String, Charset) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP PUT request with the specified content.
Put - Annotation Type in com.linecorp.armeria.server.annotation
Annotation for mapping HttpMethod.PUT onto specific method.

Q

qualityFactor(float) - Method in class com.linecorp.armeria.common.MediaType
Returns the quality factor of this MediaType.
qualityFactor() - Method in class com.linecorp.armeria.common.MediaType
Returns the quality factor of this MediaType.
query() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the query part of the Request URI, without the leading '?'
query() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
query() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the query part of the current Request URI, without the leading '?'
query() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
query() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns the query retrieved from the request, as defined in RFC3986.
query() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns the query mapped by the PathMapping.
QUICKTIME - Static variable in class com.linecorp.armeria.common.MediaType
 

R

random(long, long) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that computes backoff delay which is a random value between minDelayMillis and maxDelayMillis chosen by ThreadLocalRandom.
random(long, long, Supplier<Random>) - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that computes backoff delay which is a random value between minDelayMillis and maxDelayMillis.
RANGE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"range".
RateLimitingDecorator - Annotation Type in com.linecorp.armeria.server.annotation.decorator
A ThrottlingHttpService decorator for annotated HTTP services.
RateLimitingDecoratorFactoryFunction - Class in com.linecorp.armeria.server.annotation.decorator
A factory which creates a ThrottlingHttpService decorator with a RateLimitingThrottlingStrategy.
RateLimitingDecoratorFactoryFunction() - Constructor for class com.linecorp.armeria.server.annotation.decorator.RateLimitingDecoratorFactoryFunction
 
RateLimitingDecorators - Annotation Type in com.linecorp.armeria.server.annotation.decorator
The containing annotation type for RateLimitingDecorator.
RateLimitingThrottlingStrategy<T extends Request> - Class in com.linecorp.armeria.server.throttling
A ThrottlingStrategy that provides a throttling strategy based on QPS.
RateLimitingThrottlingStrategy(double, String) - Constructor for class com.linecorp.armeria.server.throttling.RateLimitingThrottlingStrategy
Creates a new strategy with specified name.
RateLimitingThrottlingStrategy(double) - Constructor for class com.linecorp.armeria.server.throttling.RateLimitingThrottlingStrategy
Creates a new strategy.
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.
readContent(InputStream) - Method in class com.linecorp.armeria.server.file.HttpVfs.AbstractEntry
Reads the content of the entry into a new buffer.
readContent(InputStream, int) - Method in class com.linecorp.armeria.server.file.HttpVfs.AbstractEntry
Reads the content of the entry into a new buffer.
readContent() - Method in class com.linecorp.armeria.server.file.HttpVfs.ByteArrayEntry
 
readContent() - Method in interface com.linecorp.armeria.server.file.HttpVfs.Entry
Reads the content of the entry into a new buffer.
realm() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
reasonPhrase() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the reason phrase of this HttpStatus.
RedirectService - Class in com.linecorp.armeria.server
An HttpService that implements an HTTP redirection.
RedirectService(String) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location constructed with the specified locationPattern.
RedirectService(Function<? super ServiceRequestContext, String>) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location returned by locationFunction.
RedirectService(HttpStatus, String) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location constructed with the specified locationPattern.
RedirectService(HttpStatus, Function<? super ServiceRequestContext, String>) - Constructor for class com.linecorp.armeria.server.RedirectService
Creates a new instance that redirects to the location returned by locationFunction.
refCnt() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
REFERER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"referer".
register(String, EndpointGroup, EndpointSelectionStrategy) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Registers the specified EndpointGroup.
registerMetrics(MeterRegistry, MeterIdPrefix) - Method in interface com.linecorp.armeria.server.Router
Registers the stats of this Router to the specified MeterRegistry.
RegularFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that publishes an arbitrary number of objects.
RegularFixedStreamMessage(T[]) - Constructor for class com.linecorp.armeria.common.stream.RegularFixedStreamMessage
 
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.
ReleasableHolder<T> - Interface in com.linecorp.armeria.common.util
A holder of releasable resource T.
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.
release() - Method in interface com.linecorp.armeria.common.util.ReleasableHolder
Releases the resource.
release() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
release(int) - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
remoteAddress() - Method in class com.linecorp.armeria.common.NonWrappingRequestContext
 
remoteAddress() - Method in interface com.linecorp.armeria.common.RequestContext
Returns the remote address of this request, or null if the connection is not established yet.
remoteAddress() - Method in class com.linecorp.armeria.common.RequestContextWrapper
 
remoteAddress() - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Returns the remote address of this request.
removeAdditionalRequestHeader(AsciiString) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Removes all headers with the specified name.
removeAdditionalRequestHeader(AsciiString) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
removeAdditionalRequestHeader(AsciiString) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
removeAdditionalResponseHeader(AsciiString) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
removeAdditionalResponseHeader(AsciiString) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Removes all headers with the specified name.
removeAdditionalResponseHeader(AsciiString) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
removeEldestEntry(Map.Entry<T, U>) - Method in class com.linecorp.armeria.common.util.LruMap
Returns true if the HashMap.size() of this map exceeds the maximum number of allowed entries.
removeEndpoint(Endpoint) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Removes the specified Endpoint from current Endpoint list.
removeListener(Consumer<?>) - Method in interface com.linecorp.armeria.client.endpoint.EndpointGroup
 
removeListener(Consumer<?>) - Method in class com.linecorp.armeria.common.util.AbstractListenable
 
removeListener(Consumer<?>) - Method in interface com.linecorp.armeria.common.util.Listenable
Remove a listener.
removeListener(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.
replace(ByteBuf) - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
report() - Static method in class com.linecorp.armeria.common.util.NativeLibraries
Deprecated.
This method will be removed without a replacement, because the information about the availability of the native libraries are now logged automatically by Flags.
reportSuccessOrFailure(CircuitBreaker, CompletionStage<Boolean>) - Static method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
Reports a success or a failure to the specified CircuitBreaker according to the completed value of the specified future.
repositoryStatus() - Method in class com.linecorp.armeria.common.util.Version
 
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.HttpStatus
413 Request Entity Too Large.
REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in class com.linecorp.armeria.common.HttpStatus
431 Request Header Fields Too Large (RFC6585).
REQUEST_TIMEOUT - Static variable in class com.linecorp.armeria.common.HttpStatus
408 Request Timeout.
REQUEST_URI_TOO_LONG - Static variable in class com.linecorp.armeria.common.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
requestContentSanitizer(Function<Object, Object>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Function to use to sanitize request content before logging.
requestContentSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the Function to use to sanitize request content before logging.
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.
RequestConverter - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a RequestConverterFunction class which converts an AggregatedHttpMessage to an object.
RequestConverterFunction - Interface in com.linecorp.armeria.server.annotation
Converts an AggregatedHttpMessage to an object.
RequestConverters - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for RequestConverter.
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.HttpStatus
416 Requested Range Not Satisfiable.
requestEndTimeNanos() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestEndTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the request finished, in nanoseconds.
requestHeaders() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestHeaders(HttpHeaders) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestHeaders() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the HttpHeaders of the Request.
requestHeaders(HttpHeaders) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
requestHeadersSanitizer(Function<HttpHeaders, HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Function to use to sanitize request headers before logging.
requestHeadersSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the Function to use to sanitize request headers before logging.
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.
requestLogLevel(LogLevel) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the LogLevel to use when logging requests.
requestLogLevel() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the LogLevel to use when logging requests.
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.
RequestObject - Annotation Type in com.linecorp.armeria.server.annotation
Specifies which parameter should be converted by RequestConverterFunction.
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.
requestStartTimeNanos() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
requestStartTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the request started, in nanoseconds.
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.
requestTimeoutHandler() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
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.HttpStatus
205 Reset Content.
resolve(ClientRequestContext) - Method in class com.linecorp.armeria.client.Endpoint
Resolves this endpoint into a host endpoint associated with the specified ClientRequestContext.
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.
respond(int) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
Deprecated.
respond(HttpStatus) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
Deprecated.
respond(HttpStatus, MediaType, String) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
respond(HttpStatus, MediaType, String, Object...) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
respond(HttpStatus, MediaType, byte[]) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
respond(HttpStatus, MediaType, byte[], int, int) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
respond(HttpStatus, MediaType, HttpData) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
respond(HttpStatus, MediaType, HttpData, HttpHeaders) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
respond(AggregatedHttpMessage) - Method in interface com.linecorp.armeria.common.HttpResponseWriter
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
responseContentSanitizer(Function<Object, Object>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Function to use to sanitize response content before logging.
responseContentSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the Function to use to sanitize response content before logging.
ResponseConverter - Annotation Type in com.linecorp.armeria.server.annotation
Specifies a ResponseConverterFunction class which converts the result to HttpResponse.
ResponseConverterFunction - Interface in com.linecorp.armeria.server.annotation
Converts a result object to HttpResponse.
ResponseConverters - Annotation Type in com.linecorp.armeria.server.annotation
The containing annotation type for ResponseConverter.
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.
responseEndTimeNanos() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseEndTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response finished, in nanoseconds.
responseHeaders() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseHeaders(HttpHeaders) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseHeaders() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the non-informational status HttpHeaders of the Response.
responseHeaders(HttpHeaders) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
responseHeadersSanitizer(Function<HttpHeaders, HttpHeaders>) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the Function to use to sanitize response headers before logging.
responseHeadersSanitizer() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the Function to use to sanitize response headers before logging.
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.
responseStartTimeNanos() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
responseStartTimeNanos() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the time when the processing of the response started, in nanoseconds.
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.
responseTimeoutForEachAttempt(Duration) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
Sets the response timeout for each attempt.
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
 
responseTimeoutMillisForEachAttempt(long) - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
Sets the response timeout for each attempt in milliseconds.
retain() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
retain(int) - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
retainedDuplicate() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
RETRY_AFTER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"retry-after".
RetryingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client.retry
A Client decorator that handles failures of remote invocation and retries requests.
RetryingClient(Client<I, O>, RetryStrategy<I, O>, int, long) - Constructor for class com.linecorp.armeria.client.retry.RetryingClient
Creates a new instance that decorates the specified Client.
RetryingClientBuilder<T extends RetryingClientBuilder<T,U,I,O>,U extends RetryingClient<I,O>,I extends Request,O extends Response> - Class in com.linecorp.armeria.client.retry
Builds a new RetryingClient or its decorator function.
RetryingClientBuilder(RetryStrategy<I, O>) - Constructor for class com.linecorp.armeria.client.retry.RetryingClientBuilder
Creates a new builder with the specified retry strategy.
RetryingHttpClient - Class in com.linecorp.armeria.client.retry
A Client decorator that handles failures of an invocation and retries HTTP requests.
RetryingHttpClientBuilder - Class in com.linecorp.armeria.client.retry
Builds a new RetryingHttpClient or its decorator function.
RetryingHttpClientBuilder(RetryStrategy<HttpRequest, HttpResponse>) - Constructor for class com.linecorp.armeria.client.retry.RetryingHttpClientBuilder
Creates a new builder with the specified retry strategy.
RetryingRpcClient - Class in com.linecorp.armeria.client.retry
A Client decorator that handles failures of an invocation and retries RPC requests.
RetryingRpcClientBuilder - Class in com.linecorp.armeria.client.retry
Builds a new RetryingRpcClient or its decorator function.
RetryingRpcClientBuilder(RetryStrategy<RpcRequest, RpcResponse>) - Constructor for class com.linecorp.armeria.client.retry.RetryingRpcClientBuilder
Creates a new builder with the specified retry strategy.
retryInterval(Duration) - Method in class com.linecorp.armeria.client.endpoint.healthcheck.HttpHealthCheckedEndpointGroupBuilder
Sets the interval between health check requests.
retryStrategy() - Method in class com.linecorp.armeria.client.retry.RetryingClient
 
RetryStrategy<I extends Request,O extends Response> - Interface in com.linecorp.armeria.client.retry
Determines whether a failed request should be retried.
returnTypeSignature() - Method in class com.linecorp.armeria.server.docs.MethodInfo
Returns the signature of the return type of the function.
ROUND_ROBIN - Static variable in interface com.linecorp.armeria.client.endpoint.EndpointSelectionStrategy
Simple round-robin strategy.
routeCacheSpec() - Static method in class com.linecorp.armeria.common.Flags
Returns the value of the routeCache parameter.
Router<V> - Interface in com.linecorp.armeria.server
Finds a mapping that matches a given PathMappingContext.
Routers - Class in com.linecorp.armeria.server
A factory that creates a Router instance.
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.
samplingRate(float) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the rate at which to sample requests to log.
samplingRate() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the rate at which to sample requests to log.
scheduleNextRetry(ClientRequestContext, Consumer<? super Throwable>, Runnable, long) - Static method in class com.linecorp.armeria.client.retry.RetryingClient
Schedules next retry.
scheme() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Returns the SCHEME of this message.
scheme() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
scheme(String) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
SCHEME - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
":scheme".
scheme() - Method in interface com.linecorp.armeria.common.HttpHeaders
Gets the HttpHeaderNames.SCHEME header or null if there is no such header.
scheme(String) - Method in interface com.linecorp.armeria.common.HttpHeaders
Sets the HttpHeaderNames.SCHEME header.
scheme() - Method in interface com.linecorp.armeria.common.HttpRequest
Returns the scheme of this request.
scheme(String) - Method in interface com.linecorp.armeria.common.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
score() - Method in class com.linecorp.armeria.server.PathMappingResult
Returns the score of this result.
SEC_WEBSOCKET_ACCEPT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-accept".
SEC_WEBSOCKET_EXTENSIONS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-protocol".
SEC_WEBSOCKET_KEY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-key".
SEC_WEBSOCKET_KEY1 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-key1".
SEC_WEBSOCKET_KEY2 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-key2".
SEC_WEBSOCKET_LOCATION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-location".
SEC_WEBSOCKET_ORIGIN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-origin".
SEC_WEBSOCKET_PROTOCOL - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-protocol".
SEC_WEBSOCKET_VERSION - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"sec-websocket-version".
SEE_OTHER - Static variable in class com.linecorp.armeria.common.HttpStatus
303 See Other (since HTTP/1.1).
select(ClientRequestContext) - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext.
selectNode(ClientRequestContext, String) - Static method in class com.linecorp.armeria.client.endpoint.EndpointGroupRegistry
Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext and 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.HttpHeadersJsonSerializer
 
serialize(MediaType, JsonGenerator, SerializerProvider) - Method in class com.linecorp.armeria.common.MediaTypeJsonSerializer
 
serialize(TypeSignature, JsonGenerator, SerializerProvider) - Method in class com.linecorp.armeria.server.docs.TypeSignatureJsonSerializer
 
serializeExampleRequest(String, String, Object) - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Serializes the specified example request into a string.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.AbstractHttpService
Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method.
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.auth.HttpAuthService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.cors.CorsService
 
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.encoding.HttpEncodingService
 
serve(ServiceRequestContext, HttpRequest) - Method in interface com.linecorp.armeria.server.HttpService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.logging.LoggingService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
 
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.metric.MetricCollectingService
 
serve(ServiceRequestContext, HttpRequest) - Method in class com.linecorp.armeria.server.RedirectService
NB: For now we redirect all methods.
serve(ServiceRequestContext, I) - Method in interface com.linecorp.armeria.server.Service
Serves an incoming Request.
serve(ServiceRequestContext, I) - Method in class com.linecorp.armeria.server.throttling.ThrottlingService
 
serveCompressedFiles(boolean) - Method in class com.linecorp.armeria.server.file.HttpFileServiceBuilder
Whether pre-compressed files should be served.
serveCompressedFiles() - Method in class com.linecorp.armeria.server.file.HttpFileServiceConfig
Whether pre-compressed files should be served.
SERVER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"server".
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
 
ServerListenerBuilder - Class in com.linecorp.armeria.server
Builds a new ServerListener.
ServerListenerBuilder() - Constructor for class com.linecorp.armeria.server.ServerListenerBuilder
 
ServerPort - Class in com.linecorp.armeria.server
A pair of server-side bind address and SessionProtocol.
ServerPort(int, SessionProtocol...) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
ServerPort(InetSocketAddress, SessionProtocol...) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
ServerPort(int, Iterable<SessionProtocol>) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols.
ServerPort(InetSocketAddress, Iterable<SessionProtocol>) - Constructor for class com.linecorp.armeria.server.ServerPort
Creates a new ServerPort that listens to the specified localAddress using the specified SessionProtocols.
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(String, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified Service at the specified path pattern. e.g.
service(PathMapping, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified Service at the specified PathMapping.
service(CompositeServiceEntry<I, 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(String, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
service(PathMapping, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
service() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
service(String, Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified Service at the specified path pattern of the default VirtualHost.
service(PathMapping, Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified Service at the specified PathMapping of the default VirtualHost.
service(PathMapping, Service<HttpRequest, HttpResponse>, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Deprecated.
Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
service(T) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified ServiceWithPathMappings at multiple PathMappings of the default VirtualHost.
service(T, Function<? super T, R>) - Method in class com.linecorp.armeria.server.ServerBuilder
Decorates and binds the specified ServiceWithPathMappings at multiple PathMappings of the default VirtualHost.
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.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.file.HttpFileService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.healthcheck.HttpHealthCheckService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
 
serviceAdded(ServiceConfig) - Method in class com.linecorp.armeria.server.RedirectService
 
serviceAdded(ServiceConfig) - Method in interface com.linecorp.armeria.server.Service
Invoked when this Service has been added to a Server with the specified configuration.
serviceAt(int) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeService
Returns the index-th Service in this composite Service.
serviceAt(String, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
serviceAt(int) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeService
 
serviceAt(String, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
serviceAt(String, Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.ServerBuilder
Deprecated.
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<HttpRequest, HttpResponse>) - Constructor for class com.linecorp.armeria.server.ServiceConfig
Creates a new instance.
ServiceConfig(VirtualHost, PathMapping, Service<HttpRequest, HttpResponse>, 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<MethodInfo>) - Constructor for class com.linecorp.armeria.server.docs.ServiceInfo
Creates a new instance.
ServiceInfo(String, Iterable<MethodInfo>, Iterable<HttpHeaders>, String) - Constructor for class com.linecorp.armeria.server.docs.ServiceInfo
Creates a new instance.
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 NamedTypeInfos.
ServiceSpecification(Iterable<ServiceInfo>, Iterable<EnumInfo>, Iterable<StructInfo>, Iterable<ExceptionInfo>) - Constructor for class com.linecorp.armeria.server.docs.ServiceSpecification
Creates a new instance.
ServiceSpecification(Iterable<ServiceInfo>, Iterable<EnumInfo>, Iterable<StructInfo>, Iterable<ExceptionInfo>, Iterable<HttpHeaders>) - Constructor for class com.linecorp.armeria.server.docs.ServiceSpecification
Creates a new instance.
serviceType() - Method in 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.
serviceUnder(String, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.AbstractCompositeServiceBuilder
Binds the specified Service under the specified directory..
serviceUnder(String, Service<I, O>) - Method in class com.linecorp.armeria.server.composition.SimpleCompositeServiceBuilder
 
serviceUnder(String, Service<HttpRequest, HttpResponse>) - Method in class com.linecorp.armeria.server.ServerBuilder
Binds the specified Service under the specified directory of the default VirtualHost.
ServiceWithPathMappings<I extends Request,O extends Response> - Interface in com.linecorp.armeria.server
An interface that enables getting all the PathMapping where a Service should be bound.
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 - Enum in com.linecorp.armeria.common
Session-level protocol that provides facilities such as framing and flow control.
SessionProtocolNegotiationCache - Class in com.linecorp.armeria.client
Keeps the recent SessionProtocol negotiation failures.
SessionProtocolNegotiationException - Exception in com.linecorp.armeria.client
An exception triggered when failed to negotiate the desired SessionProtocol with a server.
SessionProtocolNegotiationException(SessionProtocol, 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.
SET_COOKIE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"set-cookie".
SET_COOKIE2 - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"set-cookie2".
setAdditionalRequestHeader(AsciiString, String) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Sets a header with the specified name and value.
setAdditionalRequestHeader(AsciiString, String) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setAdditionalRequestHeader(AsciiString, String) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setAdditionalRequestHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in interface com.linecorp.armeria.client.ClientRequestContext
Clears the current header and sets the specified Headers which is included when a Client sends an HttpRequest.
setAdditionalRequestHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.client.ClientRequestContextWrapper
 
setAdditionalRequestHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.client.DefaultClientRequestContext
 
setAdditionalResponseHeader(AsciiString, String) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setAdditionalResponseHeader(AsciiString, String) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets a header with the specified name and value.
setAdditionalResponseHeader(AsciiString, String) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setAdditionalResponseHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setAdditionalResponseHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Clears the current header and sets the specified Headers which is included when a Service sends an HttpResponse.
setAdditionalResponseHeaders(Headers<? extends AsciiString, ? extends String, ?>) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
setAllIfAbsent(Headers<? extends AsciiString, ? extends String, ?>) - Method in interface com.linecorp.armeria.common.HttpHeaders
Copies the entries missing in this headers from the specified Headers.
setDistributionStatisticConfig(DistributionStatisticConfig) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
Sets the DistributionStatisticConfig to use when the factory methods in MoreMeters create a Timer or a DistributionSummary.
setEndpoints(Iterable<Endpoint>) - Method in class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
Sets the specified Endpoints as current Endpoint list.
setHealthy(boolean) - Method in class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
Sets if the Server is healthy or not.
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
 
setMeterRegistry(MeterRegistry) - Method in interface com.linecorp.armeria.client.ClientFactory
Sets the MeterRegistry that collects various stats.
setMeterRegistry(MeterRegistry) - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
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.
setRequestTimeoutHandler(Runnable) - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
setRequestTimeoutHandler(Runnable) - Method in interface com.linecorp.armeria.server.ServiceRequestContext
Sets a handler to run when the request times out.
setRequestTimeoutHandler(Runnable) - Method in class com.linecorp.armeria.server.ServiceRequestContextWrapper
 
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
 
setResponseTimeout(ClientRequestContext) - Method in class com.linecorp.armeria.client.retry.RetryingClient
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
 
SettableHealthChecker - Class in com.linecorp.armeria.server.healthcheck
A simple HealthChecker whose state can be set by a caller.
SettableHealthChecker() - Constructor for class com.linecorp.armeria.server.healthcheck.SettableHealthChecker
 
setTimedOut() - Method in class com.linecorp.armeria.common.AbstractRequestContext
Marks this RequestContext as having been timed out.
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.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
 
shouldCachePath(String, String, PathMapping) - Method in class com.linecorp.armeria.server.DecoratingService
 
shouldCachePath(String, String, PathMapping) - Method in class com.linecorp.armeria.server.file.HttpFileService
 
shouldCachePath(String, String, PathMapping) - Method in interface com.linecorp.armeria.server.Service
Returns whether the given path and query should be cached if the service's result is successful.
shouldDealWith(Throwable) - Method in interface com.linecorp.armeria.client.circuitbreaker.ExceptionFilter
Decides whether the given error should be dealt with circuit breaker.
shouldReportAsSuccess(T) - Method in interface com.linecorp.armeria.client.circuitbreaker.CircuitBreakerStrategy
Returns a CompletionStage that contains true, false or null according to the specified Response.
shouldRetry(I, O) - Method in interface com.linecorp.armeria.client.retry.RetryStrategy
Returns a CompletionStage that contains Backoff which will be used for retry.
shutdownWorkerGroupOnStop() - Method in class com.linecorp.armeria.server.ServerConfig
Returns whether the worker EventLoopGroup is shut down when the Server stops.
SignalLengthGetter<T> - Interface in com.linecorp.armeria.common.stream
A function that accepts one signal and produces the length of the signal.
signature() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
signature() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the String representation of this type signature, as described in the class documentation.
signatureMethod() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
SimpleCompositeService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.composition
A general purpose AbstractCompositeService implementation.
SimpleCompositeService(CompositeServiceEntry<I, O>...) - Constructor for class com.linecorp.armeria.server.composition.SimpleCompositeService
Creates a new instance that is composed of the specified entries.
SimpleCompositeService(Iterable<CompositeServiceEntry<I, 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
 
SimpleDecoratingClient<I extends Request,O extends Response> - Class in com.linecorp.armeria.client
Decorates a Client.
SimpleDecoratingClient(Client<I, O>) - Constructor for class com.linecorp.armeria.client.SimpleDecoratingClient
Creates a new instance that decorates the specified Client.
SimpleDecoratingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server
A Service that decorates another Service.
SimpleDecoratingService(Service<I, O>) - Constructor for class com.linecorp.armeria.server.SimpleDecoratingService
Creates a new instance that decorates the specified Service.
simpleServiceName() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
Returns the simplified name of the DefaultRpcRequest.serviceType().
size() - Method in class com.linecorp.armeria.common.MediaTypeSet
 
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.
socketOption(ChannelOption<T>, T) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
sourceAddress() - Method in class com.linecorp.armeria.server.ProxiedAddresses
Returns the source address of the proxied request.
sslContext(SslContext) - Method in class com.linecorp.armeria.server.ServerBuilder
sslContext(SessionProtocol, File, File) - Method in class com.linecorp.armeria.server.ServerBuilder
sslContext(SessionProtocol, File, File, String) - Method in class com.linecorp.armeria.server.ServerBuilder
sslContext() - Method in class com.linecorp.armeria.server.VirtualHost
Returns the SslContext of this virtual host.
sslContextCustomizer(Consumer<? super SslContextBuilder>) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
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) - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
startRequest(Channel, SessionProtocol) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
Starts the collection of information for the Request.
startRequest(Channel, SessionProtocol, String) - Method in interface com.linecorp.armeria.common.logging.RequestLogBuilder
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.AggregatedHttpMessage
Returns the STATUS of this message.
status() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
status(int) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
status(HttpStatus) - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
STATUS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
":status".
status() - Method in interface com.linecorp.armeria.common.HttpHeaders
Gets the HttpHeaderNames.STATUS header or null if there is no such header.
status(int) - Method in interface com.linecorp.armeria.common.HttpHeaders
Sets the HttpHeaderNames.STATUS header.
status(HttpStatus) - Method in interface com.linecorp.armeria.common.HttpHeaders
Sets the HttpHeaderNames.STATUS header.
status() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the status of the Response.
statusCode() - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the status code of the Response.
StickyEndpointSelectionStrategy - Class in com.linecorp.armeria.client.endpoint
An EndpointSelector strategy which implements sticky load-balancing using user passed ToLongFunction to compute hashes for consistent hashing.
StickyEndpointSelectionStrategy(ToLongFunction<ClientRequestContext>) - Constructor for class com.linecorp.armeria.client.endpoint.StickyEndpointSelectionStrategy
Creates a new StickyEndpointSelectionStrategy with provided hash function to hash a ClientRequestContext to a long.
stop() - Method in class com.linecorp.armeria.server.Server
Stops this Server to close all active ServerPorts.
strategy() - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient
 
strategy() - Method in interface com.linecorp.armeria.client.endpoint.EndpointSelector
Returns the EndpointSelectionStrategy used by this selector to select an Endpoint.
StreamDecoder - Interface in com.linecorp.armeria.client.encoding
An interface for objects that apply HTTP content decoding to incoming HttpData.
StreamDecoderFactory - Interface in com.linecorp.armeria.client.encoding
An interface that constructs a new StreamDecoder for a given Content-Encoding header value.
streaming(HttpMethod, String) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request that can be used to stream an arbitrary number of HttpObject with the initial HttpHeaders of the specified HttpMethod and path.
streaming(HttpHeaders) - Static method in interface com.linecorp.armeria.common.HttpRequest
Creates a new HTTP request that can be used to stream an arbitrary number of HttpObject with the specified initial HttpHeaders.
streaming() - Static method in interface com.linecorp.armeria.common.HttpResponse
Creates a new HTTP response that can stream an arbitrary number of HttpObject to the client.
StreamMessage<T> - Interface in com.linecorp.armeria.common.stream
A variant of Reactive Streams Publisher, which allows only one Subscriber.
StreamMessageWrapper<T> - Class in com.linecorp.armeria.common.stream
Wraps a StreamMessage and forwards its method invocations to delegate.
StreamMessageWrapper(StreamMessage<? extends T>) - Constructor for class com.linecorp.armeria.common.stream.StreamMessageWrapper
Creates a new instance that wraps a delegate.
StreamWriter<T> - Interface in com.linecorp.armeria.common.stream
Produces the objects to be published by a StreamMessage.
StringRequestConverterFunction - Class in com.linecorp.armeria.server.annotation
A default implementation of a RequestConverterFunction which converts a text body of the AggregatedHttpMessage to a String.
StringRequestConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.StringRequestConverterFunction
 
StringResponseConverterFunction - Class in com.linecorp.armeria.server.annotation
A response converter implementation which creates an HttpResponse with content-type: text/plain.
StringResponseConverterFunction() - Constructor for class com.linecorp.armeria.server.annotation.StringResponseConverterFunction
 
StructInfo - Class in com.linecorp.armeria.server.docs
Metadata about a struct type.
StructInfo(String, Iterable<FieldInfo>) - Constructor for class com.linecorp.armeria.server.docs.StructInfo
Creates a new instance.
StructInfo(String, Iterable<FieldInfo>, String) - Constructor for class com.linecorp.armeria.server.docs.StructInfo
Creates a new instance.
structs() - Method in class com.linecorp.armeria.server.docs.ServiceSpecification
Returns the metadata about the structs related with the services in this specification.
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<I, O>, StructuredLogBuilder<L>) - Constructor for class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
subscribe(Subscriber<? super U>) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
subscribe(Subscriber<? super U>, boolean) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
subscribe(Subscriber<? super U>, EventExecutor) - Method in class com.linecorp.armeria.common.stream.FilteredStreamMessage
 
subscribe(Subscriber<? super U>, EventExecutor, boolean) - 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>, boolean) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
subscribe(Subscriber<? super T>, EventExecutor) - Method in class com.linecorp.armeria.common.stream.PublisherBasedStreamMessage
 
subscribe(Subscriber<? super T>, EventExecutor, boolean) - 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>, boolean) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data to the specified Subscriber.
subscribe(Subscriber<? super T>, EventExecutor) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data, invoking the specified Subscriber from the specified Executor.
subscribe(Subscriber<? super T>, EventExecutor, boolean) - Method in interface com.linecorp.armeria.common.stream.StreamMessage
Requests to start streaming data, invoking the specified Subscriber from the specified Executor.
subscribe(Subscriber<? super T>) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
subscribe(Subscriber<? super T>, boolean) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
subscribe(Subscriber<? super T>, EventExecutor) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
subscribe(Subscriber<? super T>, EventExecutor, boolean) - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
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.
successfulResponseLogLevel(LogLevel) - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception).
successfulResponseLogLevel() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
Returns the LogLevel to use when logging successful responses (e.g., no unhandled exception).
successRate() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the success rate (success/total), or throws an ArithmeticException if total is 0.
summary() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns an identifier of this PathMappingContext instance.
summaryWithDefaultQuantiles(MeterRegistry, String, Iterable<Tag>) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
supportedExampleRequestTypes() - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Returns the Set of the example request types supported by this plugin.
supportedSchemes() - Method in interface com.linecorp.armeria.client.ClientFactory
Returns the Schemes supported by this ClientFactory.
supportedSchemes() - Method in class com.linecorp.armeria.client.DecoratingClientFactory
 
supportedServiceTypes() - Method in interface com.linecorp.armeria.server.docs.DocServicePlugin
Returns the Set of the Service types supported by this plugin.
SVG_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
SWITCHING_PROTOCOLS - Static variable in class com.linecorp.armeria.common.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

tags() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the Tags.
tags(String...) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the Tags concatenated by the specified tags.
tags(Iterable<Tag>) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns the Tags concatenated by the specified tags.
TAR - Static variable in class com.linecorp.armeria.common.MediaType
 
TE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"te".
TEMPORARY_REDIRECT - Static variable in class com.linecorp.armeria.common.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.
ThrottlingHttpService - Class in com.linecorp.armeria.server.throttling
Decorates a HTTP Service to throttle incoming requests.
ThrottlingHttpService(Service<HttpRequest, HttpResponse>, ThrottlingStrategy<HttpRequest>) - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingHttpService
Creates a new instance that decorates the specified Service.
ThrottlingRpcService - Class in com.linecorp.armeria.server.throttling
Decorates an RPC Service to throttle incoming requests.
ThrottlingRpcService(Service<RpcRequest, RpcResponse>, ThrottlingStrategy<RpcRequest>) - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingRpcService
Creates a new instance that decorates the specified Service.
ThrottlingService<I extends Request,O extends Response> - Class in com.linecorp.armeria.server.throttling
Decorates a Service to throttle incoming requests.
ThrottlingService(Service<I, O>, ThrottlingStrategy<I>, Function<CompletionStage<? extends O>, O>) - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingService
Creates a new instance that decorates the specified Service.
ThrottlingStrategy<T extends Request> - Class in com.linecorp.armeria.server.throttling
Determines whether a request should be throttled.
ThrottlingStrategy() - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy with a default name.
ThrottlingStrategy(String) - Constructor for class com.linecorp.armeria.server.throttling.ThrottlingStrategy
Creates a new ThrottlingStrategy with specified name.
throwUnsafely(Throwable) - Static method in class com.linecorp.armeria.common.util.Exceptions
Throws the specified exception violating the throws clause of the enclosing method.
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.
timerWithDefaultQuantiles(MeterRegistry, String, Iterable<Tag>) - Static method in class com.linecorp.armeria.common.metric.MoreMeters
timestamp() - Method in class com.linecorp.armeria.server.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.
tls(SslContext) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the SslContext of the default VirtualHost.
tls(File, File) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the default VirtualHost from the specified keyCertChainFile and cleartext keyFile.
tls(File, File, String) - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the default VirtualHost from the specified keyCertChainFile, keyFile and keyPassword.
tlsSelfSigned() - Method in class com.linecorp.armeria.server.ServerBuilder
Configures SSL or TLS of the default VirtualHost with an auto-generated self-signed certificate.
toHttpData() - Method in class com.linecorp.armeria.common.HttpStatus
Returns the HttpData whose content is "<code> <reasonPhrase>" encoded in UTF-8.
toHttpRequest() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
toHttpResponse() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
toInputStream() - Method in interface com.linecorp.armeria.common.HttpData
Returns a new InputStream that is sourced from this data.
token() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
TOO_MANY_REQUESTS - Static variable in class com.linecorp.armeria.common.HttpStatus
429 Too Many Requests (RFC6585).
toReader(Charset) - Method in interface com.linecorp.armeria.common.HttpData
Returns a new Reader that is sourced from this data and decoded using the specified Charset.
toReaderAscii() - Method in interface com.linecorp.armeria.common.HttpData
Returns a new Reader that is sourced from this data and decoded using StandardCharsets.US_ASCII.
toReaderUtf8() - Method in interface com.linecorp.armeria.common.HttpData
Returns a new Reader that is sourced from this data and decoded using StandardCharsets.UTF_8.
toString() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
 
toString() - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
 
toString() - Method in class com.linecorp.armeria.client.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.client.retry.BackoffWrapper
 
toString() - Method in class com.linecorp.armeria.client.retry.RetryingClientBuilder
 
toString() - Method in class com.linecorp.armeria.client.retry.RetryingHttpClientBuilder
 
toString() - Method in class com.linecorp.armeria.common.DefaultHttpData
 
toString() - Method in class com.linecorp.armeria.common.DefaultHttpHeaders
 
toString() - Method in class com.linecorp.armeria.common.DefaultHttpRequest
Deprecated.
 
toString() - Method in class com.linecorp.armeria.common.DefaultHttpResponse
Deprecated.
 
toString() - Method in class com.linecorp.armeria.common.DefaultRpcRequest
 
toString() - Method in class com.linecorp.armeria.common.DefaultRpcResponse
 
toString(Charset) - Method in interface com.linecorp.armeria.common.HttpData
Decodes this data into a String.
toString() - Method in class com.linecorp.armeria.common.HttpStatus
 
toString() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
toString() - Method in class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
 
toString() - Method in class com.linecorp.armeria.common.MediaType
Returns the string representation of this media type in the format described in RFC 2045.
toString() - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
 
toString() - Method in class com.linecorp.armeria.common.Scheme
 
toString() - Method in class com.linecorp.armeria.common.SerializationFormat
 
toString() - Method in class com.linecorp.armeria.common.SerializationFormatProvider.Entry
 
toString() - Method in enum com.linecorp.armeria.common.SessionProtocol
 
toString() - Method in class com.linecorp.armeria.common.stream.StreamMessageWrapper
 
toString() - Method in class com.linecorp.armeria.common.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.server.auth.BasicToken
 
toString() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
 
toString() - Method in class com.linecorp.armeria.server.auth.OAuth2Token
 
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.cors.CorsConfig
 
toString() - Method in class com.linecorp.armeria.server.cors.CorsServiceBuilder
 
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.EnumValueInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.ExceptionInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.FieldInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.MethodInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.ServiceInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.StructInfo
 
toString() - Method in class com.linecorp.armeria.server.docs.TypeSignature
 
toString() - Method in class com.linecorp.armeria.server.file.AbstractHttpVfs
Returns the HttpVfs.meterTag() of this HttpVfs.
toString() - Method in class com.linecorp.armeria.server.file.HttpFileServiceBuilder
 
toString() - Method in class com.linecorp.armeria.server.file.HttpFileServiceConfig
 
toString() - Method in class com.linecorp.armeria.server.file.HttpVfs.AbstractEntry
 
toString() - Method in class com.linecorp.armeria.server.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.PathMappingResult
 
toString() - Method in class com.linecorp.armeria.server.ProxiedAddresses
 
toString() - Method in class com.linecorp.armeria.server.Server
 
toString() - Method in class com.linecorp.armeria.server.ServerBuilder
 
toString() - Method in class com.linecorp.armeria.server.ServerConfig
 
toString() - Method in class com.linecorp.armeria.server.ServerPort
 
toString() - Method in class com.linecorp.armeria.server.ServiceConfig
 
toString() - Method in class com.linecorp.armeria.server.VirtualHost
 
toString(Charset) - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
toString() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
toStringAscii() - Method in interface com.linecorp.armeria.common.HttpData
Decodes this data into a String using US-ASCII encoding.
toStringRequestOnly() - Method in class com.linecorp.armeria.common.logging.DefaultRequestLog
 
toStringRequestOnly(Function<HttpHeaders, HttpHeaders>, Function<Object, Object>) - 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, with no sanitization of headers or content.
toStringRequestOnly(Function<HttpHeaders, HttpHeaders>, Function<Object, Object>) - 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(Function<HttpHeaders, HttpHeaders>, Function<Object, Object>) - 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, with no sanitization of headers or content.
toStringResponseOnly(Function<HttpHeaders, HttpHeaders>, Function<Object, Object>) - Method in interface com.linecorp.armeria.common.logging.RequestLog
Returns the string representation of the Response.
toStringUtf8() - Method in interface com.linecorp.armeria.common.HttpData
Decodes this data into a String using UTF-8 encoding.
total() - Method in class com.linecorp.armeria.client.circuitbreaker.EventCount
Returns the total number of events.
totalDurationNanos() - Method in 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.
touch() - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
touch(Object) - Method in class com.linecorp.armeria.unsafe.ByteBufHttpData
 
trace(String) - Method in interface com.linecorp.armeria.client.HttpClient
Sends an HTTP TRACE request.
Trace - Annotation Type in com.linecorp.armeria.server.annotation
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).
TRAILER - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"trailer".
trailingHeaders() - Method in interface com.linecorp.armeria.common.AggregatedHttpMessage
Returns the trailing HTTP headers.
TRANSFER_ENCODING - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"transfer-encoding".
TransientService<I extends Request,O extends Response> - Interface in com.linecorp.armeria.server
A Service that handles transient requests, for example, health check requests.
trialRequestInterval(Duration) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the trial request interval in HALF_OPEN state.
trialRequestIntervalMillis(long) - Method in class com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder
Sets the trial request interval in HALF_OPEN state.
triePath() - Method in interface com.linecorp.armeria.server.PathMapping
Returns the path of this path mapping if it is able to be added to a trie.
tryParse(String) - Static method in class com.linecorp.armeria.common.Scheme
Parses the specified String into a Scheme.
tryWrite(T) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object to the StreamMessage.
tryWrite(Supplier<? extends T>) - Method in interface com.linecorp.armeria.common.stream.StreamWriter
Writes the specified object Supplier to the StreamMessage.
TSV_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
TwoElementFixedStreamMessage<T> - Class in com.linecorp.armeria.common.stream
A FixedStreamMessage that publishes two objects.
TwoElementFixedStreamMessage(T, T) - Constructor for class com.linecorp.armeria.common.stream.TwoElementFixedStreamMessage
Constructs a new TwoElementFixedStreamMessage for the given objects.
type() - Method in class com.linecorp.armeria.common.MediaType
Returns the top-level media type.
typeParameters() - Method in class com.linecorp.armeria.server.docs.TypeSignature
Returns the list of the type parameters of this type signature.
typeSignature() - Method in class com.linecorp.armeria.server.docs.FieldInfo
Returns the metadata about the type of the field.
TypeSignature - Class in com.linecorp.armeria.server.docs
Type signature of a method parameter, a method return value or a struct/exception field.
TypeSignatureJsonSerializer - Class in com.linecorp.armeria.server.docs
TypeSignatureJsonSerializer() - Constructor for class com.linecorp.armeria.server.docs.TypeSignatureJsonSerializer
Creates a new instance.

U

UNAUTHORIZED - Static variable in class com.linecorp.armeria.common.HttpStatus
401 Unauthorized.
UNKNOWN - Static variable in class com.linecorp.armeria.common.HttpStatus
A special status code '0' which represents that the response status is unknown.
UNKNOWN - Static variable in class com.linecorp.armeria.common.SerializationFormat
Unknown serialization format.
UNORDERED_COLLECTION - Static variable in class com.linecorp.armeria.common.HttpStatus
425 Unordered Collection (WebDAV, RFC3648).
UNPROCESSABLE_ENTITY - Static variable in class com.linecorp.armeria.common.HttpStatus
422 Unprocessable Entity (WebDAV, RFC4918).
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.HttpStatus
415 Unsupported Media Type.
UPGRADE - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"upgrade".
UPGRADE_REQUIRED - Static variable in class com.linecorp.armeria.common.HttpStatus
426 Upgrade Required (RFC2817).
uri() - Method in interface com.linecorp.armeria.client.ClientBuilderParams
Returns the endpoint URI of the client.
uri() - Method in class com.linecorp.armeria.client.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 enum com.linecorp.armeria.common.SessionProtocol
Returns the textual representation of this format for use in a Scheme.
USE_PROXY - Static variable in class com.linecorp.armeria.common.HttpStatus
305 Use Proxy (since HTTP/1.1).
useEpoll() - Static method in class com.linecorp.armeria.common.Flags
Returns whether the JNI-based /dev/epoll socket I/O is enabled.
useHttp1Pipelining(boolean) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets whether to use HTTP pipelining for HTTP/1 connections.
useHttp2Preface(boolean) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
useOpenSsl() - Static method in class com.linecorp.armeria.common.Flags
Returns whether the JNI-based TLS support with OpenSSL is enabled.
USER_AGENT - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"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>, MeterRegistry, SessionProtocol, Endpoint) - Constructor for class com.linecorp.armeria.client.UserClient
Creates a new instance.
useRetryAfter(boolean) - Method in class com.linecorp.armeria.client.retry.RetryingHttpClientBuilder
Whether retry should be attempted according to the retryHeader from the server or not.
username() - Method in class com.linecorp.armeria.server.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 enum com.linecorp.armeria.common.HttpMethod
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in class com.linecorp.armeria.common.HttpStatus
Returns the HttpStatus represented by the specified code.
valueOf(String) - Static method in enum com.linecorp.armeria.common.HttpStatusClass
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum com.linecorp.armeria.common.HttpStatusClass
Returns the class of the specified HTTP status code.
valueOf(String) - Static method in enum com.linecorp.armeria.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.common.SessionProtocol
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.
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.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.HttpStatusClass
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.linecorp.armeria.common.logging.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 SerializationFormats.
values() - Static method in enum com.linecorp.armeria.common.SessionProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.linecorp.armeria.server.docs.EnumInfo
Returns the constant values defined by the type.
values() - Static method in enum com.linecorp.armeria.server.docs.FieldRequirement
Returns an array containing the constants of this enum type, in the order they are declared.
VARIANT_ALSO_NEGOTIATES - Static variable in class com.linecorp.armeria.common.HttpStatus
506 Variant Also Negotiates (RFC2295).
VARY - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"vary".
VCARD_UTF_8 - Static variable in class com.linecorp.armeria.common.MediaType
 
verboseExceptions() - Static method in class com.linecorp.armeria.common.Flags
Returns whether the verbose exception mode is enabled.
Version - Class in com.linecorp.armeria.common.util
Retrieves the version information of available Armeria artifacts.
version() - Method in class com.linecorp.armeria.server.auth.OAuth1aToken
Returns version.
vfs() - Method in class com.linecorp.armeria.server.file.HttpFileServiceConfig
Returns the HttpVfs that provides the static files to an HttpFileService.
VIA - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"via".
virtualHost() - Method in class com.linecorp.armeria.server.DefaultServiceRequestContext
 
virtualHost() - Method in interface com.linecorp.armeria.server.PathMappingContext
Returns the VirtualHost instance which belongs to this PathMappingContext.
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.
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.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.HttpHeaderNames
"websocket-location".
WEBSOCKET_ORIGIN - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"websocket-origin".
WEBSOCKET_PROTOCOL - Static variable in class com.linecorp.armeria.common.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.
withContextCustomizer(Consumer<ClientRequestContext>) - Static method in class com.linecorp.armeria.client.Clients
Sets the specified ClientRequestContext customization function in a thread-local variable so that the customized context is used when the client invokes a request from the current thread.
withDefaultPort(int) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified default port number.
withDefaultVirtualHost() - 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.
withIpAddr(String) - Method in class com.linecorp.armeria.client.Endpoint
Returns a new host endpoint with the specified IP address.
withJitter(double) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that adds a random jitter value to the original delay using full jitter strategy.
withJitter(double, double) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that adds a random jitter value to the original delay using full jitter strategy.
withJitter(double, double, Supplier<Random>) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that adds a random jitter value to the original delay using full jitter strategy.
withMaxAttempts(int) - Method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff which limits the number of attempts up to the specified value.
withoutDelay() - Static method in interface com.linecorp.armeria.client.retry.Backoff
Returns a Backoff that will never wait between attempts.
withoutParameters() - Method in class com.linecorp.armeria.common.MediaType
Returns a new instance with the same type and subtype as this instance, but without any parameters.
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.
withParameters(String, Iterable<String>) - Method in class com.linecorp.armeria.common.MediaType
Replaces all parameters with the given attribute with parameters using the given values.
withTags(String...) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified tags.
withTags(Iterable<Tag>) - Method in class com.linecorp.armeria.common.metric.MeterIdPrefix
Returns a newly-created instance whose name is concatenated by the specified tags.
withTags(String...) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified label added.
withTags(Iterable<Tag>) - Method in interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction
Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified labels added.
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.
workerGroup(EventLoopGroup, boolean) - Method in class com.linecorp.armeria.client.ClientFactoryBuilder
Sets the worker EventLoopGroup which is responsible for performing socket I/O and running Client.execute(ClientRequestContext, Request).
workerGroup() - Static method in class com.linecorp.armeria.common.CommonPools
workerGroup(EventLoopGroup, boolean) - Method in class com.linecorp.armeria.server.ServerBuilder
Sets the worker EventLoopGroup which is responsible for performing socket I/O and running Service.serve(ServiceRequestContext, Request).
workerGroup() - Method in class com.linecorp.armeria.server.ServerConfig
Returns the worker EventLoopGroup which is responsible for performing socket I/O and running Service.serve(ServiceRequestContext, Request).
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.
writeLog(RequestLog, L) - Method in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService
Writes given structuredLog to the underlying system.
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.HttpHeaderNames
"www-authenticate".

X

X_FRAME_OPTIONS - Static variable in class com.linecorp.armeria.common.HttpHeaderNames
"x-frame-options".
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."
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

© Copyright 2015–2018 LINE Corporation. All rights reserved.