Package com.linecorp.armeria.server

Interface Service<I extends Request,O extends Response>

Type Parameters:

I - the type of incoming Request. Must be HttpRequest or RpcRequest.

O - the type of outgoing Response. Must be HttpResponse or RpcResponse.

All Known Subinterfaces:

HttpService, RpcService, ServiceWithRoutes<I,O>, TransientService<I,O>

All Known Implementing Classes:

AbstractCompositeService, AbstractHttpService, CorsService, DecoratingService, DocService, HealthCheckService, HttpAuthService, HttpEncodingService, HttpFileService, HttpHealthCheckService, LoggingService, ManagedHttpHealthCheckService, MetricCollectingService, PrometheusExpositionService, RedirectService, SimpleCompositeService, SimpleDecoratingHttpService, SimpleDecoratingRpcService, SimpleDecoratingService, StructuredLoggingService, ThrottlingHttpService, ThrottlingRpcService, ThrottlingService

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Service<I extends Request,O extends Response>

Handles a Request received by a Server.

Method Summary

Modifier and Type	Method	Description
default <T> Optional<T>	as(Class<T> serviceType)	Undecorates this Service to find the Service which is an instance of the specified serviceType.
default Service<I,O>	decorate(DecoratingServiceFunction<I,O> function)	Creates a new Service that decorates this Service with the specified DecoratingServiceFunction.
default <R extends Service<?,?>> R	decorate(Class<R> serviceType)	Creates a new Service that decorates this Service with a new Service instance of the specified serviceType.
default <T extends Service<I,O>,R extends Service<R_I,R_O>,R_I extends Request,R_O extends Response> R	decorate(Function<T,R> decorator)	Creates a new Service that decorates this Service with the specified decorator.
O	serve(ServiceRequestContext ctx, I req)	Serves an incoming Request.
default void	serviceAdded(ServiceConfig cfg)	Invoked when this Service has been added to a Server with the specified configuration.
default boolean	shouldCachePath(String path, String query, Route route)	Returns whether the given path and query should be cached if the service's result is successful.

Method Detail

serviceAdded

default void serviceAdded(ServiceConfig cfg)
                   throws Exception

Invoked when this Service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this Service has been added more than once.

Throws:

Exception

serve

O serve(ServiceRequestContext ctx,
        I req)
 throws Exception

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception

as

default <T> Optional<T> as(Class<T> serviceType)

Undecorates this Service to find the Service which is an instance of the specified serviceType. Use this method instead of an explicit downcast since most Services are decorated via decorate(Function) and thus cannot be downcast. For example:

 Service s = new MyService().decorate(LoggingService.newDecorator())
                            .decorate(AuthService.newDecorator());
 MyService s1 = s.as(MyService.class);
 LoggingService s2 = s.as(LoggingService.class);
 AuthService s3 = s.as(AuthService.class);
 

Parameters:

serviceType - the type of the desired Service

Returns:

the Service which is an instance of serviceType if this Service decorated such a Service. Optional.empty() otherwise.

decorate

default <R extends Service<?,?>> R decorate(Class<R> serviceType)

Creates a new Service that decorates this Service with a new Service instance of the specified serviceType. The specified Class must have a single-parameter constructor which accepts this Service.

decorate

default <T extends Service<I,O>,R extends Service<R_I,R_O>,R_I extends Request,R_O extends Response> R decorate(Function<T,R> decorator)

Creates a new Service that decorates this Service with the specified decorator.

decorate

default Service<I,O> decorate(DecoratingServiceFunction<I,O> function)

Creates a new Service that decorates this Service with the specified DecoratingServiceFunction.

shouldCachePath

default boolean shouldCachePath(String path,
                                @Nullable
                                String query,
                                Route route)

Returns whether the given path and query should be cached if the service's result is successful. By default, exact path mappings with no input query are cached.