Package com.linecorp.armeria.server.encoding

Class EncodingServiceBuilder

java.lang.Object

com.linecorp.armeria.server.encoding.EncodingServiceBuilder

public final class EncodingServiceBuilder
extends Object

Builds a new EncodingService or its decorator function.

Method Summary

Modifier and Type	Method	Description
EncodingService	build(HttpService delegate)	Returns a newly-created EncodingService based on the properties of this builder.
EncodingServiceBuilder	encodableContentTypes(MediaType... contentTypes)	Sets the specified MediaTypes to evaluate whether the content type of the HttpResponse is encodable or not.
EncodingServiceBuilder	encodableContentTypes(Iterable<MediaType> contentTypes)	Sets the specified MediaTypes to evaluate whether the content type of the HttpResponse is encodable or not.
EncodingServiceBuilder	encodableContentTypes(Predicate<MediaType> encodableContentTypePredicate)	Sets the specified Predicate to evaluate whether the content type of the HttpResponse is encodable or not.
EncodingServiceBuilder	encodableRequestHeaders(Predicate<? super RequestHeaders> encodableRequestHeadersPredicate)	Sets the specified Predicate to evaluate whether the corresponding HttpResponse of the HttpRequest whose RequestHeaders is the input of the Predicate is encodable or not.
EncodingServiceBuilder	minBytesToForceChunkedEncoding(int minBytesToForceChunkedAndEncoding)	Sets the specified minimum length to force chunked encoding.
Function<? super HttpService,EncodingService>	newDecorator()	Returns a newly-created decorator that decorates an HttpService with a new EncodingService based on the properties of this builder.

Methods inherited from class java.lang.Object

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

Method Details

encodableContentTypes

public EncodingServiceBuilder encodableContentTypes(MediaType... contentTypes)

Sets the specified MediaTypes to evaluate whether the content type of the HttpResponse is encodable or not. It's encodable when the content type is one of the MediaTypes.

encodableContentTypes

public EncodingServiceBuilder encodableContentTypes(Iterable<MediaType> contentTypes)

Sets the specified MediaTypes to evaluate whether the content type of the HttpResponse is encodable or not. It's encodable when the content type is one of the MediaTypes.

encodableContentTypes

public EncodingServiceBuilder encodableContentTypes(Predicate<MediaType> encodableContentTypePredicate)

Sets the specified Predicate to evaluate whether the content type of the HttpResponse is encodable or not.

encodableRequestHeaders

public EncodingServiceBuilder encodableRequestHeaders(Predicate<? super RequestHeaders> encodableRequestHeadersPredicate)

Sets the specified Predicate to evaluate whether the corresponding HttpResponse of the HttpRequest whose RequestHeaders is the input of the Predicate is encodable or not.

minBytesToForceChunkedEncoding

public EncodingServiceBuilder minBytesToForceChunkedEncoding(int minBytesToForceChunkedAndEncoding)

Sets the specified minimum length to force chunked encoding. The HttpResponse is encoded only when the content is variable, which means the ResponseHeaders does not have "Content-Length" header, or the length of the content exceeds the specified length. The default is 1024.

build

public EncodingService build(HttpService delegate)

Returns a newly-created EncodingService based on the properties of this builder.

newDecorator

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

Returns a newly-created decorator that decorates an HttpService with a new EncodingService based on the properties of this builder.