org.glassfish.grizzly.http.server

Class CompressionEncodingFilter

java.lang.Object

org.glassfish.grizzly.http.server.CompressionEncodingFilter

All Implemented Interfaces:

EncodingFilter

public class CompressionEncodingFilter
extends Object
implements EncodingFilter

Constructor Summary

Constructors

Constructor and Description
CompressionEncodingFilter(CompressionConfig.CompressionModeI compressionMode, int compressionMinSize, String[] compressibleMimeTypes, String[] noCompressionUserAgents, String[] aliases) Creates a new CompressionEncodingFilter based on the provided configuration details.
CompressionEncodingFilter(CompressionConfig.CompressionModeI compressionMode, int compressionMinSize, String[] compressibleMimeTypes, String[] noCompressionUserAgents, String[] aliases, boolean enableDecompression) Creates a new CompressionEncodingFilter based on the provided configuration details.
CompressionEncodingFilter(CompressionConfig compressionConfig, String[] aliases)

Method Summary

Modifier and Type	Method and Description
boolean	applyDecoding(HttpHeader httpPacket)
boolean	applyEncoding(HttpHeader httpPacket)
protected static boolean	canCompressHttpResponse(HttpResponsePacket response, CompressionConfig compressionConfig, String[] aliases) Returns true if the HttpResponsePacket could be compressed, or false otherwise.
protected static boolean	canDecompressHttpRequest(HttpRequestPacket request, CompressionConfig config, String[] aliases) Returns true if the HttpResponsePacket could be compressed, or false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressionEncodingFilter

public CompressionEncodingFilter(CompressionConfig compressionConfig,
                                 String[] aliases)

CompressionEncodingFilter

public CompressionEncodingFilter(CompressionConfig.CompressionModeI compressionMode,
                                 int compressionMinSize,
                                 String[] compressibleMimeTypes,
                                 String[] noCompressionUserAgents,
                                 String[] aliases)

Creates a new CompressionEncodingFilter based on the provided configuration details.

Parameters:

compressionMode - is compression on, off, or forced.

compressionMinSize - the minimum size, in bytes, the resource must be before being considered for compression.

compressibleMimeTypes - resource mime types that may be compressed. if null or zero-length, then there will be no type restriction.

noCompressionUserAgents - user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered.

aliases - aliases for the compression name as defined in the accept-encoding header of the request.

CompressionEncodingFilter

public CompressionEncodingFilter(CompressionConfig.CompressionModeI compressionMode,
                                 int compressionMinSize,
                                 String[] compressibleMimeTypes,
                                 String[] noCompressionUserAgents,
                                 String[] aliases,
                                 boolean enableDecompression)

Creates a new CompressionEncodingFilter based on the provided configuration details.

Parameters:

compressionMode - is compression on, off, or forced.

compressionMinSize - the minimum size, in bytes, the resource must be before being considered for compression.

compressibleMimeTypes - resource mime types that may be compressed. if null or zero-length, then there will be no type restriction.

noCompressionUserAgents - user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered.

aliases - aliases for the compression name as defined in the accept-encoding header of the request.

enableDecompression - enabled decompression of incoming data according to the content-encoding header

Since:

2.3.29

Method Detail

applyEncoding

public boolean applyEncoding(HttpHeader httpPacket)

Specified by:

applyEncoding in interface EncodingFilter

applyDecoding

public boolean applyDecoding(HttpHeader httpPacket)

Specified by:

applyDecoding in interface EncodingFilter

canCompressHttpResponse

protected static boolean canCompressHttpResponse(HttpResponsePacket response,
                                                 CompressionConfig compressionConfig,
                                                 String[] aliases)

Returns true if the HttpResponsePacket could be compressed, or false otherwise. The method checks if client supports compression and if the resource, that we are about to send matches CompressionConfig configuration.

canDecompressHttpRequest

protected static boolean canDecompressHttpRequest(HttpRequestPacket request,
                                                  CompressionConfig config,
                                                  String[] aliases)

Returns true if the HttpResponsePacket could be compressed, or false otherwise. The method checks if client supports compression and if the resource, that we are about to send matches CompressionConfig configuration.