Package com.linecorp.armeria.server.encoding

Class EncodingService

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<T_I,T_O>>

com.linecorp.armeria.server.DecoratingService<I,O,I,O>

com.linecorp.armeria.server.SimpleDecoratingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingHttpService

com.linecorp.armeria.server.encoding.EncodingService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public final class EncodingService
extends SimpleDecoratingHttpService

Decorates an HttpService to apply HTTP encoding (e.g., gzip) to an HttpService. HTTP encoding will be applied if:

• the client specifies it
• the response content type is encodable
• the request headers are acceptable
• the response either has no fixed content length or the length is larger than 1KB

Method Summary

Modifier and Type	Method	Description
static EncodingServiceBuilder	builder()	Returns a new EncodingServiceBuilder.
ExchangeType	exchangeType(RoutingContext routingContext)	Determines an ExchangeType for this HttpService from the given RoutingContext.
static Function<? super HttpService,EncodingService>	newDecorator()	Returns a new HttpService decorator.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.

Methods inherited from class com.linecorp.armeria.server.DecoratingService

serviceAdded, shouldCachePath

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

decorate, decorate

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

builder

public static EncodingServiceBuilder builder()

Returns a new EncodingServiceBuilder.

newDecorator

public static Function<? super HttpService,EncodingService> newDecorator()

Returns a new HttpService decorator.

exchangeType

public ExchangeType exchangeType(RoutingContext routingContext)

Description copied from interface: HttpService

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.

Specified by:

exchangeType in interface HttpService

Overrides:

exchangeType in class SimpleDecoratingHttpService

serve

public HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
                   throws Exception

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception