Package com.linecorp.armeria.server

Interface HttpService

All Superinterfaces:

Service<HttpRequest,HttpResponse>, Unwrappable

All Known Subinterfaces:

AnnotatedService, GraphqlService, GrpcService, HttpServiceWithRoutes, TransientHttpService, WebSocketService

All Known Implementing Classes:

AbstractGraphqlService, AbstractHttpService, AbstractUnaryGrpcService, AbstractUnsafeUnaryGrpcService, AuthService, BraveService, ContentPreviewingService, CoroutineContextService, CorsService, DecodingService, DocService, EncodingService, FileService, HealthCheckService, JettyService, LoggingService, ManagementService, MetricCollectingService, ObservationService, PrometheusExpositionService, PrometheusExpositionService, RedirectService, ResteasyService, SimpleDecoratingHttpService, ThrottlingService, THttpService, TomcatService

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 HttpService
extends Service<HttpRequest,HttpResponse>

An HTTP/2 Service.

Method Summary

Modifier and Type	Method	Description
default HttpService	decorate(DecoratingHttpServiceFunction function)	Creates a new HttpService that decorates this HttpService with the specified DecoratingHttpServiceFunction.
default <R extends Service<R_I, R_O>, R_I extends Request, R_O extends Response> R	decorate(Function<? super HttpService,R> decorator)	Creates a new Service that decorates this HttpService with the specified decorator.
default ExchangeType	exchangeType(RoutingContext routingContext)	Determines an ExchangeType for this HttpService from the given RoutingContext.
default ServiceOptions	options()	Returns the ServiceOptions of this HttpService.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.

Methods inherited from interface com.linecorp.armeria.server.Service

as, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

serve

@CheckReturnValue
HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
            throws Exception

Description copied from interface: Service

Serves an incoming Request.

Specified by:

serve in interface Service<HttpRequest,HttpResponse>

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception

decorate

default <R extends Service<R_I,
R_O>,
R_I extends Request,
R_O extends Response>
R decorate(Function<? super HttpService,R> decorator)

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

decorate

default HttpService decorate(DecoratingHttpServiceFunction function)

Creates a new HttpService that decorates this HttpService with the specified DecoratingHttpServiceFunction.

exchangeType

@UnstableApi
default ExchangeType exchangeType(RoutingContext routingContext)

Determines an ExchangeType for this HttpService from the given RoutingContext. By default, ExchangeType.BIDI_STREAMING is set.

Note that an HttpRequest will be aggregated before serving the HttpService if ExchangeType.UNARY or ExchangeType.RESPONSE_STREAMING is set.

options

@UnstableApi
default ServiceOptions options()

Returns the ServiceOptions of this HttpService.