Top Description Inners Fields Constructors Methods

io.netty.handler.codec.http

public Class HttpContentCompressor

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 and Inner Type Summary

Modifier and Type	Class and Description
private class	HttpContentCompressor.BrEncoderFactory Compression Encoder Factory that creates `BrotliEncoder`s used to compress http content for br content encoding
private class	HttpContentCompressor.DeflateEncoderFactory Compression Encoder Factory that creates `ZlibEncoder`s used to compress http content for deflate content encoding
private class	HttpContentCompressor.GzipEncoderFactory Compression Encoder Factory that creates `ZlibEncoder`s used to compress http content for gzip content encoding
private static class	HttpContentCompressor.SnappyEncoderFactory Compression Encoder Factory for create `SnappyFrameEncoder` used to compress http content for snappy content encoding
private class	HttpContentCompressor.ZstdEncoderFactory Compression Encoder Factory for create `ZstdEncoder` used to compress http content for zstd content encoding

Field Summary

Modifier and Type	Field and Description
private final BrotliOptions	brotliOptions
private final int	compressionLevel
private final int	contentSizeThreshold
private ChannelHandlerContext	ctx
private final DeflateOptions	deflateOptions
private final Map<String, CompressionEncoderFactory>	factories
private final GzipOptions	gzipOptions
private final int	memLevel
private final SnappyOptions	snappyOptions
private final boolean	supportsCompressionOptions
private final int	windowBits
private final ZstdOptions	zstdOptions

Constructor Summary

Access	Constructor and Description
public	HttpContentCompressor() Creates a new handler with the default compression level (`6`), default window size (`15`) and default memory level (`8`).
public	HttpContentCompressor(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel) Deprecated Creates a new handler with the specified compression level, default window size (`15`) and default memory level (`8`).
public	HttpContentCompressor(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel, int 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`. windowBits, int 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` memLevel) Deprecated Creates a new handler with the specified compression level, window size, and memory level..
public	HttpContentCompressor(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel, int 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`. windowBits, int 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` memLevel, int 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. contentSizeThreshold) Deprecated Creates a new handler with the specified compression level, window size, and memory level..
public	HttpContentCompressor(CompressionOptions... `CompressionOptions` or `null` if the default should be used. compressionOptions) Create a new `HttpContentCompressor` Instance with specified `CompressionOptions`s and contentSizeThreshold set to `0`
public	HttpContentCompressor(int 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. contentSizeThreshold, CompressionOptions... `CompressionOptions` or `null` if the default should be used. compressionOptions) Create a new `HttpContentCompressor` instance with specified `CompressionOptions`s

Method Summary

Modifier and Type	Method and Description
protected HttpContentEncoder.Result	beginEncode(HttpResponse the http response httpResponse, String the value of the `"Accept-Encoding"` header acceptEncoding) Implements abstract io.netty.handler.codec.http.HttpContentEncoder.beginEncode. Prepare to encode the HTTP message content.
protected String	determineEncoding(String acceptEncoding)
protected ZlibWrapper	determineWrapper(String acceptEncoding) Deprecated
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.

Inherited from io.netty.handler.codec.http.HttpContentEncoder:: acceptOutboundMessage channelInactive decode encode handlerRemoved

Field Detail

brotliOptions	back to summary
private final BrotliOptions brotliOptions

compressionLevel	back to summary
private final int compressionLevel

contentSizeThreshold	back to summary
private final int contentSizeThreshold

ctx	back to summary
private ChannelHandlerContext ctx

deflateOptions	back to summary
private final DeflateOptions deflateOptions

factories	back to summary
private final Map<String, CompressionEncoderFactory> factories

gzipOptions	back to summary
private final GzipOptions gzipOptions

memLevel	back to summary
private final int memLevel

snappyOptions	back to summary
private final SnappyOptions snappyOptions

supportsCompressionOptions	back to summary
private final boolean supportsCompressionOptions

windowBits	back to summary
private final int windowBits

zstdOptions	back to summary
private final ZstdOptions zstdOptions

Constructor Detail

HttpContentCompressor	back to summary
public HttpContentCompressor() Creates a new handler with the default compression level (`6`), default window size (`15`) and default memory level (`8`).

HttpContentCompressor back to summary

HttpContentCompressor	back to summary
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:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. Annotations @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:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

Annotations

@Deprecated

HttpContentCompressor back to summary

HttpContentCompressor	back to summary
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:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. windowBits:int 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:int 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` Annotations @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:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.
windowBits:int: 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:int: 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

Annotations

@Deprecated

HttpContentCompressor back to summary

HttpContentCompressor	back to summary
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:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. windowBits:int 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:int 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:int 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. Annotations @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:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.
windowBits:int: 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:int: 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:int: 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.

Annotations

@Deprecated

HttpContentCompressor back to summary

HttpContentCompressor	back to summary
public HttpContentCompressor(CompressionOptions... compressionOptions) Create a new `HttpContentCompressor` Instance with specified `CompressionOptions`s and contentSizeThreshold set to `0` Parameters compressionOptions:CompressionOptions[] `CompressionOptions` or `null` if the default should be used.

public HttpContentCompressor(CompressionOptions... compressionOptions)

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

Parameters

compressionOptions:CompressionOptions[]: CompressionOptions or null if the default should be used.

HttpContentCompressor back to summary

HttpContentCompressor	back to summary
public HttpContentCompressor(int contentSizeThreshold, CompressionOptions... compressionOptions) Create a new `HttpContentCompressor` instance with specified `CompressionOptions`s Parameters contentSizeThreshold:int 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[] `CompressionOptions` or `null` if the default should be used.

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

Create a new HttpContentCompressor instance with specified CompressionOptionss

Parameters

contentSizeThreshold:int: 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[]: CompressionOptions or null if the default should be used.

Method Detail

beginEncode back to summary

beginEncode	back to summary
protected HttpContentEncoder.Result beginEncode(HttpResponse httpResponse, String acceptEncoding) throws Exception Implements abstract io.netty.handler.codec.http.HttpContentEncoder.beginEncode. Doc from io.netty.handler.codec.http.HttpContentEncoder.beginEncode. Prepare to encode the HTTP message content. Parameters httpResponse:HttpResponse the http response acceptEncoding:String the value of the `"Accept-Encoding"` header Returns:HttpContentEncoder.Result 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). Annotations @Override

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

Implements abstract io.netty.handler.codec.http.HttpContentEncoder.beginEncode.

Doc from io.netty.handler.codec.http.HttpContentEncoder.beginEncode.

Prepare to encode the HTTP message content.

Parameters

httpResponse:HttpResponse: the http response
acceptEncoding:String: the value of the "Accept-Encoding" header

Returns:HttpContentEncoder.Result

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

Annotations

@Override

determineEncoding	back to summary
protected String determineEncoding(String acceptEncoding) Annotations @SuppressWarnings:FloatingPointEquality

determineWrapper	back to summary
protected ZlibWrapper determineWrapper(String acceptEncoding) Deprecated Annotations @Deprecated @SuppressWarnings:FloatingPointEquality

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Doc from io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

io.netty.handler.codec.http back to summary

private final Class HttpContentCompressor.BrEncoderFactory

Class Inheritance

extends Object
implements CompressionEncoderFactory

java.lang.Object
io.netty.handler.codec.http.HttpContentCompressor.BrEncoderFactory

All Implemented Interfaces

io.netty.handler.codec.http.CompressionEncoderFactory

Compression Encoder Factory that creates BrotliEncoders used to compress http content for br content encoding

Constructor Summary

Access	Constructor and Description
private	BrEncoderFactory()

Method Summary

Modifier and Type	Method and Description
public MessageToByteEncoder<ByteBuf>	createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

BrEncoderFactory	back to summary
private BrEncoderFactory()

Method Detail

createEncoder	back to summary
public MessageToByteEncoder<ByteBuf> createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder. Annotations @Override

createEncoder

back to summary

public MessageToByteEncoder<ByteBuf> createEncoder()

Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Annotations

@Override

io.netty.handler.codec.http back to summary

private final Class HttpContentCompressor.DeflateEncoderFactory

Class Inheritance

extends Object
implements CompressionEncoderFactory

java.lang.Object
io.netty.handler.codec.http.HttpContentCompressor.DeflateEncoderFactory

All Implemented Interfaces

io.netty.handler.codec.http.CompressionEncoderFactory

Compression Encoder Factory that creates ZlibEncoders used to compress http content for deflate content encoding

Constructor Summary

Access	Constructor and Description
private	DeflateEncoderFactory()

Method Summary

Modifier and Type	Method and Description
public MessageToByteEncoder<ByteBuf>	createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DeflateEncoderFactory	back to summary
private DeflateEncoderFactory()

Method Detail

createEncoder	back to summary
public MessageToByteEncoder<ByteBuf> createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder. Annotations @Override

createEncoder

back to summary

public MessageToByteEncoder<ByteBuf> createEncoder()

Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Annotations

@Override

io.netty.handler.codec.http back to summary

private final Class HttpContentCompressor.GzipEncoderFactory

Class Inheritance

extends Object
implements CompressionEncoderFactory

java.lang.Object
io.netty.handler.codec.http.HttpContentCompressor.GzipEncoderFactory

All Implemented Interfaces

io.netty.handler.codec.http.CompressionEncoderFactory

Compression Encoder Factory that creates ZlibEncoders used to compress http content for gzip content encoding

Constructor Summary

Access	Constructor and Description
private	GzipEncoderFactory()

Method Summary

Modifier and Type	Method and Description
public MessageToByteEncoder<ByteBuf>	createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

GzipEncoderFactory	back to summary
private GzipEncoderFactory()

Method Detail

createEncoder	back to summary
public MessageToByteEncoder<ByteBuf> createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder. Annotations @Override

createEncoder

back to summary

public MessageToByteEncoder<ByteBuf> createEncoder()

Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Annotations

@Override

io.netty.handler.codec.http back to summary

private final Class HttpContentCompressor.SnappyEncoderFactory

Class Inheritance

extends Object
implements CompressionEncoderFactory

java.lang.Object
io.netty.handler.codec.http.HttpContentCompressor.SnappyEncoderFactory

All Implemented Interfaces

io.netty.handler.codec.http.CompressionEncoderFactory

Compression Encoder Factory for create SnappyFrameEncoder used to compress http content for snappy content encoding

Constructor Summary

Access	Constructor and Description
private	SnappyEncoderFactory()

Method Summary

Modifier and Type	Method and Description
public MessageToByteEncoder<ByteBuf>	createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SnappyEncoderFactory	back to summary
private SnappyEncoderFactory()

Method Detail

createEncoder	back to summary
public MessageToByteEncoder<ByteBuf> createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder. Annotations @Override

createEncoder

back to summary

public MessageToByteEncoder<ByteBuf> createEncoder()

Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Annotations

@Override

io.netty.handler.codec.http back to summary

private final Class HttpContentCompressor.ZstdEncoderFactory

Class Inheritance

extends Object
implements CompressionEncoderFactory

java.lang.Object
io.netty.handler.codec.http.HttpContentCompressor.ZstdEncoderFactory

All Implemented Interfaces

io.netty.handler.codec.http.CompressionEncoderFactory

Compression Encoder Factory for create ZstdEncoder used to compress http content for zstd content encoding

Constructor Summary

Access	Constructor and Description
private	ZstdEncoderFactory()

Method Summary

Modifier and Type	Method and Description
public MessageToByteEncoder<ByteBuf>	createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ZstdEncoderFactory	back to summary
private ZstdEncoderFactory()

Method Detail

createEncoder	back to summary
public MessageToByteEncoder<ByteBuf> createEncoder() Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder. Annotations @Override

createEncoder

back to summary

public MessageToByteEncoder<ByteBuf> createEncoder()

Implements io.netty.handler.codec.http.CompressionEncoderFactory.createEncoder.

Annotations

@Override