@NonNullByDefault

Package com.linecorp.armeria.server

Server core.

Starting points

• ServerBuilder
• VirtualHostBuilder
• Service

Interface Summary

Interface	Description
DecoratingHttpServiceFunction	A functional interface that enables building a SimpleDecoratingHttpService with HttpService.decorate(DecoratingHttpServiceFunction).
DecoratingRpcServiceFunction	A functional interface that enables building a SimpleDecoratingRpcService with RpcService.decorate(DecoratingRpcServiceFunction).
HttpService	An HTTP/2 Service.
HttpServiceWithRoutes	An interface that enables getting all the Routes where an HttpService should be bound.
RejectedRouteHandler	A handler that is invoked when a ServerBuilder rejects to bind an HttpService at a certain Route.
Route	Route maps from an incoming HTTP request to an HttpService based on its path, method, content type and accepted types.
Router<V>	Finds a mapping that matches a given RoutingContext.
RoutingContext	Holds the parameters which are required to find a service available to handle the request.
RpcService	An RPC Service.
RpcServiceWithRoutes	An interface that enables getting all the Routes where an RpcService should be bound.
ServerListener	Listens to life cycle events of a Server.
Service<I extends Request,O extends Response>	Handles a Request received by a Server.
ServiceRequestContext	Provides information about an invocation and related utilities.
ServiceWithRoutes<I extends Request,O extends Response>	An interface that enables getting all the Routes where a Service should be bound.
TransientHttpService	An HttpService that handles transient requests, for example, health check requests.
TransientRpcService	An RpcService that handles transient requests, for example, health check requests.
TransientService<I extends Request,O extends Response>	A Service that handles transient requests, for example, health check requests.

Class Summary

Class	Description
AbstractHttpService	A skeletal HttpService for easier HTTP service implementation.
AnnotatedServiceBindingBuilder	A builder class for binding an HttpService fluently.
ClientAddressSource	A source which is used to get a client address.
DecoratingService<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response>	A Service that decorates another Service.
DecoratingServiceBindingBuilder	A builder class for binding a decorator with Route fluently.
DefaultServiceRequestContext	Default ServiceRequestContext implementation.
ProxiedAddresses	An interface to provide source and destination addresses delivered from a proxy server.
RedirectService	An HttpService that sends a redirect response such as "307 Temporary Redirect".
RouteBuilder	Builds a new Route.
Routed<T>	A value mapped by Router.
Routers	A factory that creates a Router instance.
RoutingResult	The result returned by Route.apply(RoutingContext).
RoutingResultBuilder	Builds a new RoutingResult.
Server	Listens to ServerPorts and delegates client requests to Services.
ServerBuilder	Builds a new Server and its ServerConfig.
ServerConfig	Server configuration.
ServerListenerAdapter	A skeletal ServerListener implementation in order for a user to implement only the methods what he or she really needs.
ServerListenerBuilder	Builds a new ServerListener.
ServerPort	A pair of server-side bind address and SessionProtocol.
ServiceBindingBuilder	A builder class for binding an HttpService fluently.
ServiceCallbackInvoker	A helper class that invokes the callback methods in Service.
ServiceConfig	An HttpService configuration.
ServiceRequestContextBuilder	Builds a new ServiceRequestContext.
ServiceRequestContextWrapper	Wraps an existing ServiceRequestContext.
SimpleDecoratingHttpService	An HttpService that decorates another HttpService.
SimpleDecoratingRpcService	An RpcService that decorates another RpcService.
SimpleDecoratingService<I extends Request,O extends Response>	A Service that decorates another Service.
VirtualHost	A name-based virtual host.
VirtualHostAnnotatedServiceBindingBuilder	A builder class for binding an HttpService to a virtual host fluently.
VirtualHostBuilder	Builds a new VirtualHost.
VirtualHostDecoratingServiceBindingBuilder	A builder class for binding a decorator to a Route fluently.
VirtualHostServiceBindingBuilder	A builder class for binding an HttpService fluently.

Enum Summary

Enum	Description
RoutePathType	The type of the path which was specified when a Route is created.
RoutingResultType	The type of RoutingResult.

Exception Summary

Exception	Description
HttpResponseException	A RuntimeException that is raised to send an HTTP response with the content specified by a user.
HttpStatusException	A RuntimeException that is raised to send a simplistic HTTP response with minimal content by a Service.
RequestTimeoutException	A TimeoutException raised when a request has not been received from a client within timeout.