Package com.linecorp.armeria.common.encoding

Interface StreamDecoderFactory

All Superinterfaces:

StreamDecoderFactory

public interface StreamDecoderFactory
extends StreamDecoderFactory

An interface that constructs a new StreamDecoder for a given Content-Encoding header value. A new decoder is valid for the lifetime of an HttpMessage.

Method Summary

Modifier and Type	Method	Description
static StreamDecoderFactory	brotli()	Returns the StreamDecoderFactory for "br" content encoding.
static StreamDecoderFactory	deflate()	Returns the StreamDecoderFactory for "deflate" content encoding.
String	encodingHeaderValue()	Returns the value of the Content-Encoding header which this factory applies to.
static StreamDecoderFactory	gzip()	Returns the StreamDecoderFactory for "gzip" content encoding.
default StreamDecoder	newDecoder(ByteBufAllocator alloc)	Construct a new StreamDecoder to use to decode an HttpMessage.
StreamDecoder	newDecoder(ByteBufAllocator alloc, int maxLength)	Construct a new StreamDecoder to use to decode an HttpMessage.

Method Details

deflate

static StreamDecoderFactory deflate()

Returns the StreamDecoderFactory for "deflate" content encoding.

gzip

static StreamDecoderFactory gzip()

Returns the StreamDecoderFactory for "gzip" content encoding.

brotli

static StreamDecoderFactory brotli()

Returns the StreamDecoderFactory for "br" content encoding.

encodingHeaderValue

String encodingHeaderValue()

Returns the value of the Content-Encoding header which this factory applies to.

Specified by:

encodingHeaderValue in interface StreamDecoderFactory

newDecoder

default StreamDecoder newDecoder(ByteBufAllocator alloc)

Construct a new StreamDecoder to use to decode an HttpMessage.

Specified by:

newDecoder in interface StreamDecoderFactory

Parameters:

alloc - the ByteBufAllocator to allocate a new ByteBuf for the decoded HttpMessage.

newDecoder

@UnstableApi
StreamDecoder newDecoder(ByteBufAllocator alloc,
 int maxLength)

Construct a new StreamDecoder to use to decode an HttpMessage.

Specified by:

newDecoder in interface StreamDecoderFactory

Parameters:

alloc - the ByteBufAllocator to allocate a new ByteBuf for the decoded HttpMessage.

maxLength - the maximum allowed length of a decoded content. If the total length of the decoded content exceeds maxLength, a ContentTooLargeException will be raised.