Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.server.CompressionEncodingFilter

Modifier and Type	Field and Description
private final String[]	aliases
private final CompressionConfig	compressionConfig

Constructor Summary

Access	Constructor and Description
public	CompressionEncodingFilter(final CompressionConfig compressionConfig, final String[] aliases)
public	CompressionEncodingFilter(CompressionConfig.CompressionModeI is compression on, off, or forced. compressionMode, int the minimum size, in bytes, the resource must be before being considered for compression. compressionMinSize, String[] resource mime types that may be compressed. if null or zero-length, then there will be no type restriction. compressibleMimeTypes, String[] user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered. noCompressionUserAgents, String[] aliases for the compression name as defined in the accept-encoding header of the request. aliases) Creates a new CompressionEncodingFilter based on the provided configuration details.
public	CompressionEncodingFilter(CompressionConfig.CompressionModeI is compression on, off, or forced. compressionMode, int the minimum size, in bytes, the resource must be before being considered for compression. compressionMinSize, String[] resource mime types that may be compressed. if null or zero-length, then there will be no type restriction. compressibleMimeTypes, String[] user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered. noCompressionUserAgents, String[] aliases for the compression name as defined in the accept-encoding header of the request. aliases, boolean enabled decompression of incoming data according to the content-encoding header enableDecompression) Creates a new CompressionEncodingFilter based on the provided configuration details.

Method Summary

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

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

Field Detail

aliases	back to summary
private final String[] aliases

compressionConfig	back to summary
private final CompressionConfig compressionConfig

Constructor Detail

CompressionEncodingFilter	back to summary
public CompressionEncodingFilter(final CompressionConfig compressionConfig, final String[] aliases)

CompressionEncodingFilter	back to summary
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:CompressionConfig.CompressionModeI is compression on, off, or forced. compressionMinSize:int the minimum size, in bytes, the resource must be before being considered for compression. compressibleMimeTypes:String[] resource mime types that may be compressed. if null or zero-length, then there will be no type restriction. noCompressionUserAgents:String[] user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered. aliases:String[] aliases for the compression name as defined in the accept-encoding header of the request.

CompressionEncodingFilter

back to summary

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:CompressionConfig.CompressionModeI: is compression on, off, or forced.
compressionMinSize:int: the minimum size, in bytes, the resource must be before being considered for compression.
compressibleMimeTypes:String[]: resource mime types that may be compressed. if null or zero-length, then there will be no type restriction.
noCompressionUserAgents:String[]: user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered.
aliases:String[]: aliases for the compression name as defined in the accept-encoding header of the request.

CompressionEncodingFilter	back to summary
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:CompressionConfig.CompressionModeI is compression on, off, or forced. compressionMinSize:int the minimum size, in bytes, the resource must be before being considered for compression. compressibleMimeTypes:String[] resource mime types that may be compressed. if null or zero-length, then there will be no type restriction. noCompressionUserAgents:String[] user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered. aliases:String[] aliases for the compression name as defined in the accept-encoding header of the request. enableDecompression:boolean enabled decompression of incoming data according to the content-encoding header Since 2.3.29

CompressionEncodingFilter

back to summary

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:CompressionConfig.CompressionModeI: is compression on, off, or forced.
compressionMinSize:int: the minimum size, in bytes, the resource must be before being considered for compression.
compressibleMimeTypes:String[]: resource mime types that may be compressed. if null or zero-length, then there will be no type restriction.
noCompressionUserAgents:String[]: user agents for which compression will not be performed. If null or zero-length, the user agent will not be considered.
aliases:String[]: aliases for the compression name as defined in the accept-encoding header of the request.
enableDecompression:boolean: enabled decompression of incoming data according to the content-encoding header

Since

2.3.29

Method Detail

applyDecoding	back to summary
public boolean applyDecoding(final HttpHeader httpPacket) Implements org.glassfish.grizzly.http.EncodingFilter.applyDecoding. Annotations @Override

applyDecoding

back to summary

public boolean applyDecoding(final HttpHeader httpPacket)

Implements org.glassfish.grizzly.http.EncodingFilter.applyDecoding.

Annotations

@Override

applyEncoding	back to summary
public boolean applyEncoding(final HttpHeader httpPacket) Implements org.glassfish.grizzly.http.EncodingFilter.applyEncoding. Annotations @Override

applyEncoding

back to summary

public boolean applyEncoding(final HttpHeader httpPacket)

Implements org.glassfish.grizzly.http.EncodingFilter.applyEncoding.

Annotations

@Override

canCompressHttpResponse	back to summary
protected static boolean canCompressHttpResponse(final HttpResponsePacket response, final CompressionConfig compressionConfig, final 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	back to summary
protected static boolean canDecompressHttpRequest(final HttpRequestPacket request, final CompressionConfig config, final 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.

public Class CompressionEncodingFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail