Class HttpContentCompressor

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<HttpRequest, HttpObject>

io.netty.handler.codec.http.HttpContentEncoder

io.netty.handler.codec.http.HttpContentCompressor

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class HttpContentCompressor
extends HttpContentEncoder

Compresses an HttpMessage and an HttpContent in gzip or deflate encoding while respecting the "Accept-Encoding" header. If there is no matching encoding, no compression is done. For more information on how this handler modifies the message, please refer to HttpContentEncoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	HttpContentCompressor.DeflateEncoderFactory	Compression Encoder Factory that creates ZlibEncoders used to compress http content for deflate content encoding
private final class	HttpContentCompressor.GzipEncoderFactory	Compression Encoder Factory that creates ZlibEncoders used to compress http content for gzip content encoding
private static final class	HttpContentCompressor.SnappyEncoderFactory	Compression Encoder Factory for create SnappyFrameEncoder used to compress http content for snappy content encoding

Nested classes/interfaces inherited from class HttpContentEncoder

HttpContentEncoder.Result

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private final int	contentSizeThreshold
private ChannelHandlerContext	ctx
private final DeflateOptions	deflateOptions
private final Map<String, CompressionEncoderFactory>	factories
private final GzipOptions	gzipOptions
private final SnappyOptions	snappyOptions

Constructor Summary

Constructors

Constructor	Description
HttpContentCompressor()	Creates a new handler with invalid reference StandardCompressionOptions#brotli() (if supported) , invalid reference StandardCompressionOptions#zstd() (if supported), StandardCompressionOptions.snappy(), StandardCompressionOptions.gzip() and StandardCompressionOptions.deflate().
HttpContentCompressor(int compressionLevel)	Deprecated.
HttpContentCompressor(int compressionLevel, int windowBits, int memLevel)	Deprecated.
HttpContentCompressor(int compressionLevel, int windowBits, int memLevel, int contentSizeThreshold)	Deprecated.
HttpContentCompressor(int contentSizeThreshold, CompressionOptions... compressionOptions)	Create a new HttpContentCompressor instance with specified CompressionOptionss
HttpContentCompressor(CompressionOptions... compressionOptions)	Create a new HttpContentCompressor Instance with specified CompressionOptionss and contentSizeThreshold set to 0

Method Summary

Modifier and Type	Method	Description
protected HttpContentEncoder.Result	beginEncode(HttpResponse httpResponse, String acceptEncoding)	Prepare to encode the HTTP message content.
private static CompressionOptions[]	defaultCompressionOptions(GzipOptions gzipOptions, DeflateOptions deflateOptions)
protected String	determineEncoding(String acceptEncoding)
protected ZlibWrapper	determineWrapper(String acceptEncoding)	Deprecated.
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.

Methods inherited from class HttpContentEncoder

acceptOutboundMessage, channelInactive, decode, encode, handlerRemoved

Methods inherited from class MessageToMessageCodec

acceptInboundMessage, channelRead, channelReadComplete, write

Methods inherited from class ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class Object

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

Field Details

gzipOptions

private final GzipOptions gzipOptions

deflateOptions

private final DeflateOptions deflateOptions

snappyOptions

private final SnappyOptions snappyOptions

contentSizeThreshold

private final int contentSizeThreshold

ctx

private ChannelHandlerContext ctx

factories

private final Map<String, CompressionEncoderFactory> factories

Constructor Details

HttpContentCompressor

public HttpContentCompressor()

Creates a new handler with

invalid reference

StandardCompressionOptions#brotli()

(if supported) ,

invalid reference

StandardCompressionOptions#zstd()

(if supported), StandardCompressionOptions.snappy(), StandardCompressionOptions.gzip() and StandardCompressionOptions.deflate().

HttpContentCompressor

@Deprecated
public HttpContentCompressor(int compressionLevel)

Deprecated.

Creates a new handler with the specified compression level, default window size (15) and default memory level (8).

Parameters:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

HttpContentCompressor

@Deprecated
public HttpContentCompressor(int compressionLevel,
 int windowBits,
 int memLevel)

Deprecated.

Creates a new handler with the specified compression level, window size, and memory level.

Parameters:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

windowBits - The base two logarithm of the size of the history buffer. The value should be in the range 9 to 15 inclusive. Larger values result in better compression at the expense of memory usage. The default value is 15.

memLevel - How much memory should be allocated for the internal compression state. 1 uses minimum memory and 9 uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is 8

HttpContentCompressor

@Deprecated
public HttpContentCompressor(int compressionLevel,
 int windowBits,
 int memLevel,
 int contentSizeThreshold)

Deprecated.

Creates a new handler with the specified compression level, window size, and memory level.

Parameters:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

windowBits - The base two logarithm of the size of the history buffer. The value should be in the range 9 to 15 inclusive. Larger values result in better compression at the expense of memory usage. The default value is 15.

memLevel - How much memory should be allocated for the internal compression state. 1 uses minimum memory and 9 uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is 8

contentSizeThreshold - The response body is compressed when the size of the response body exceeds the threshold. The value should be a non negative number. 0 will enable compression for all responses.

HttpContentCompressor

public HttpContentCompressor(CompressionOptions... compressionOptions)

Create a new HttpContentCompressor Instance with specified CompressionOptionss and contentSizeThreshold set to 0

Parameters:

compressionOptions - CompressionOptions or null if the default should be used.

HttpContentCompressor

public HttpContentCompressor(int contentSizeThreshold,
 CompressionOptions... compressionOptions)

Create a new HttpContentCompressor instance with specified CompressionOptionss

Parameters:

contentSizeThreshold - The response body is compressed when the size of the response body exceeds the threshold. The value should be a non negative number. 0 will enable compression for all responses.

compressionOptions - CompressionOptions or null if the default should be used.

Method Details

defaultCompressionOptions

private static CompressionOptions[] defaultCompressionOptions(GzipOptions gzipOptions,
 DeflateOptions deflateOptions)

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

beginEncode

protected HttpContentEncoder.Result beginEncode(HttpResponse httpResponse,
 String acceptEncoding)
                                         throws Exception

Description copied from class: HttpContentEncoder

Prepare to encode the HTTP message content.

Specified by:

beginEncode in class HttpContentEncoder

Parameters:

httpResponse - the http response

acceptEncoding - the value of the "Accept-Encoding" header

Returns:

the result of preparation, which is composed of the determined target content encoding and a new EmbeddedChannel that encodes the content into the target content encoding. null if acceptEncoding is unsupported or rejected and thus the content should be handled as-is (i.e. no encoding).

Throws:

Exception

determineEncoding

protected String determineEncoding(String acceptEncoding)

determineWrapper

@Deprecated
protected ZlibWrapper determineWrapper(String acceptEncoding)

Deprecated.