com.linecorp.armeria.server.encoding

Class HttpEncodingService

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.HttpEncodingService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public class HttpEncodingService
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

Constructor Summary

Constructors

Constructor and Description
HttpEncodingService(HttpService delegate) Creates a new SimpleDecoratingHttpService that HTTP-encodes the response data published from delegate.
HttpEncodingService(HttpService delegate, Predicate<MediaType> encodableContentTypePredicate, int minBytesToForceChunkedAndEncoding) Creates a new SimpleDecoratingHttpService that HTTP-encodes the response data published from delegate.
HttpEncodingService(HttpService delegate, Predicate<MediaType> encodableContentTypePredicate, Predicate<HttpHeaders> encodableRequestHeadersPredicate, long minBytesToForceChunkedAndEncoding) Creates a new SimpleDecoratingHttpService that HTTP-encodes the response data published from delegate.

Method Summary

Modifier and Type	Method and Description
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, delegate, toString

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, decorate, serviceAdded, shouldCachePath

Constructor Detail

HttpEncodingService

public HttpEncodingService(HttpService delegate)

Creates a new SimpleDecoratingHttpService that HTTP-encodes the response data published from delegate. Encoding will be applied when the client supports it, the response content type is a common web text format, and the response either has variable content length or a length greater than 1024.

HttpEncodingService

public HttpEncodingService(HttpService delegate,
                           Predicate<MediaType> encodableContentTypePredicate,
                           int minBytesToForceChunkedAndEncoding)

Creates a new SimpleDecoratingHttpService that HTTP-encodes the response data published from delegate. Encoding will be applied when the client supports it, the response content type passes the supplied encodableContentTypePredicate and the response either has variable content length or a length greater than minBytesToForceChunkedAndEncoding.

HttpEncodingService

public HttpEncodingService(HttpService delegate,
                           Predicate<MediaType> encodableContentTypePredicate,
                           Predicate<HttpHeaders> encodableRequestHeadersPredicate,
                           long minBytesToForceChunkedAndEncoding)

Creates a new SimpleDecoratingHttpService that HTTP-encodes the response data published from delegate. Encoding will be applied when the client supports it, the response content type passes the supplied encodableContentTypePredicate, the request headers passes the supplied encodableRequestHeadersPredicate and the response either has variable content length or a length greater than minBytesToForceChunkedAndEncoding.

Method Detail

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