Modifier and Type	Class and Description
public static enum	CompressionConfig.CompressionMode
public static interface	CompressionConfig.CompressionModeI Common CompressionMode interface.

Modifier and Type	Field and Description
private final ArraySet<String>	compressibleMimeTypes
private int	compressionMinSize
private CompressionConfig.CompressionMode	compressionMode
private boolean	decompressionEnabled
private final ArraySet<String>	noCompressionUserAgents

Access	Constructor and Description
public	CompressionConfig()
public	CompressionConfig(final CompressionConfig compression) The copy constructor.
public	CompressionConfig(final CompressionConfig.CompressionMode compressionMode, final int compressionMinSize, final Set<String> compressibleMimeTypes, final Set<String> noCompressionUserAgents)
public	CompressionConfig(final CompressionConfig.CompressionMode compressionMode, final int compressionMinSize, final Set<String> compressibleMimeTypes, final Set<String> noCompressionUserAgents, final boolean decompressionEnabled)

Method Summary

Modifier and Type	Method and Description
public boolean	checkMimeType(final String contentType) Returns `true` if the resource with the given content-type could be compressed, or `false` otherwise.
public boolean	checkUserAgent(final HttpRequestPacket request) Returns `true` if based on this configuration user-agent, specified in the `HttpRequestPacket`, can receive compressed data.
public Set<String>	getCompressableMimeTypes() Deprecated Use `getCompressibleMimeTypes()` Returns the read-only set of the mime-types, which are allowed to be compressed.
public Set<String>	getCompressibleMimeTypes() Returns the read-only set of the mime-types, which are allowed to be compressed.
public int	getCompressionMinSize() Returns the minimum size of an entity, which will be compressed.
public CompressionConfig.CompressionMode	getCompressionMode() Returns the `CompressionMode`.
public Set<String>	getNoCompressionUserAgents() Returns the read-only set of the user-agents, which will be always responded with uncompressed are.
private static int	indexOf(String[] aliases, DataChunk dc)
private static int	indexOfStartsWith(String[] aliases, String s)
public static boolean	Returns: `true` if a client, based on its `HttpRequestPacket`, could be responded with compressed data, or `false` otherwise isClientSupportCompression(final CompressionConfig `CompressionConfig` compressionConfig, final HttpRequestPacket client-side `HttpRequestPacket` request, final String[] compression algorithm aliases (to match with Accept-Encoding header) aliases) Returns `true` if a client, based on its `HttpRequestPacket`, could be responded with compressed data, or `false` otherwise.
private static boolean	isClientSupportContentEncoding(HttpRequestPacket request, final String[] aliases)
public boolean	isDecompressionEnabled() Returns: `true` if decompression of incoming data is enabled.
public void	set(final CompressionConfig compression) Copies the source CompressionConfig object value into this object.
public void	setCompressableMimeTypes(final Set<String> compressibleMimeTypes) Deprecated Use `setCompressibleMimeTypes(Set)` Sets the set of the mime-types, which are allowed to be compressed.
public void	setCompressableMimeTypes(final String... compressibleMimeTypes) Deprecated Use `setCompressibleMimeTypes(String...)` Sets the set of the mime-types, which are allowed to be compressed.
public void	setCompressibleMimeTypes(final Set<String> compressibleMimeTypes) Sets the set of the mime-types, which are allowed to be compressed.
public void	setCompressibleMimeTypes(final String... compressibleMimeTypes) Sets the set of the mime-types, which are allowed to be compressed.
public void	setCompressionMinSize(int compressionMinSize) Sets the minimum size of an entity, which will be compressed.
public void	setCompressionMode(final CompressionConfig.CompressionMode mode) Sets the `CompressionMode`.
public void	setDecompressionEnabled(boolean decompressionEnabled) If set to `true` content-encoding header for incoming data will be respected and data will be decompressed and the decompressed stream will be passed on.
public void	setNoCompressionUserAgents(final Set<String> noCompressionUserAgents) Sets the set of the user-agents, which will be always responded with uncompressed data.
public void	setNoCompressionUserAgents(final String... noCompressionUserAgents) Sets the set of the user-agents, which will be always responded with uncompressed data.

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

Field Detail

compressibleMimeTypes	back to summary
private final ArraySet<String> compressibleMimeTypes

compressionMinSize	back to summary
private int compressionMinSize

compressionMode	back to summary
private CompressionConfig.CompressionMode compressionMode

decompressionEnabled	back to summary
private boolean decompressionEnabled

noCompressionUserAgents	back to summary
private final ArraySet<String> noCompressionUserAgents

Constructor Detail

CompressionConfig	back to summary
public CompressionConfig()

CompressionConfig	back to summary
public CompressionConfig(final CompressionConfig compression) The copy constructor. The newly constructed CompressionConfig object will have the same settings as the source one, but actual values will be independent, so changes to one CompressionConfig object will not affect the other one. Annotations @SuppressWarnings:IncompleteCopyConstructor

CompressionConfig

back to summary

public CompressionConfig(final CompressionConfig compression)

The copy constructor. The newly constructed CompressionConfig object will have the same settings as the source one, but actual values will be independent, so changes to one CompressionConfig object will not affect the other one.

Annotations

@SuppressWarnings:IncompleteCopyConstructor

CompressionConfig	back to summary
public CompressionConfig(final CompressionConfig.CompressionMode compressionMode, final int compressionMinSize, final Set<String> compressibleMimeTypes, final Set<String> noCompressionUserAgents)

CompressionConfig	back to summary
public CompressionConfig(final CompressionConfig.CompressionMode compressionMode, final int compressionMinSize, final Set<String> compressibleMimeTypes, final Set<String> noCompressionUserAgents, final boolean decompressionEnabled)

Method Detail

checkMimeType	back to summary
public boolean checkMimeType(final String contentType) Returns `true` if the resource with the given content-type could be compressed, or `false` otherwise.

checkUserAgent	back to summary
public boolean checkUserAgent(final HttpRequestPacket request) Returns `true` if based on this configuration user-agent, specified in the `HttpRequestPacket`, can receive compressed data.

getCompressableMimeTypes back to summary

getCompressableMimeTypes	back to summary
public Set<String> getCompressableMimeTypes() Deprecated Use `getCompressibleMimeTypes()` Returns the read-only set of the mime-types, which are allowed to be compressed. Empty set means all mime-types are allowed to be compressed. Annotations @Deprecated

public Set<String> getCompressableMimeTypes()

Deprecated

Use getCompressibleMimeTypes()

Returns the read-only set of the mime-types, which are allowed to be compressed. Empty set means *all* mime-types are allowed to be compressed.

Annotations

@Deprecated

getCompressibleMimeTypes	back to summary
public Set<String> getCompressibleMimeTypes() Returns the read-only set of the mime-types, which are allowed to be compressed. Empty set means all mime-types are allowed to be compressed. Since 2.3.29

getCompressibleMimeTypes

back to summary

public Set<String> getCompressibleMimeTypes()

Returns the read-only set of the mime-types, which are allowed to be compressed. Empty set means *all* mime-types are allowed to be compressed.

Since: 2.3.29

getCompressionMinSize	back to summary
public int getCompressionMinSize() Returns the minimum size of an entity, which will be compressed.

getCompressionMode	back to summary
public CompressionConfig.CompressionMode getCompressionMode() Returns the `CompressionMode`.

getNoCompressionUserAgents	back to summary
public Set<String> getNoCompressionUserAgents() Returns the read-only set of the user-agents, which will be always responded with uncompressed are. Empty set means that compressed data could be sent to all user-agents.

indexOf	back to summary
private static int indexOf(String[] aliases, DataChunk dc)

indexOfStartsWith	back to summary
private static int indexOfStartsWith(String[] aliases, String s)

isClientSupportCompression back to summary

isClientSupportCompression	back to summary
public static boolean isClientSupportCompression(final CompressionConfig compressionConfig, final HttpRequestPacket request, final String[] aliases) Returns `true` if a client, based on its `HttpRequestPacket`, could be responded with compressed data, or `false` otherwise. Parameters compressionConfig:CompressionConfig `CompressionConfig` request:HttpRequestPacket client-side `HttpRequestPacket` aliases:String[] compression algorithm aliases (to match with Accept-Encoding header) Returns:boolean `true` if a client, based on its `HttpRequestPacket`, could be responded with compressed data, or `false` otherwise

public static boolean isClientSupportCompression(final CompressionConfig compressionConfig, final HttpRequestPacket request, final String[] aliases)

Returns true if a client, based on its HttpRequestPacket, could be responded with compressed data, or false otherwise.

Parameters

compressionConfig:CompressionConfig: CompressionConfig
request:HttpRequestPacket: client-side HttpRequestPacket
aliases:String[]: compression algorithm aliases (to match with Accept-Encoding header)

Returns:boolean

true if a client, based on its HttpRequestPacket, could be responded with compressed data, or false otherwise

isClientSupportContentEncoding	back to summary
private static boolean isClientSupportContentEncoding(HttpRequestPacket request, final String[] aliases)

isDecompressionEnabled	back to summary
public boolean isDecompressionEnabled() Returns:boolean `true` if decompression of incoming data is enabled. Since 2.3.29

set	back to summary
public void set(final CompressionConfig compression) Copies the source CompressionConfig object value into this object. As the result this CompressionConfig object will have the same settings as the source one, but actual values will be independent, so changes to one CompressionConfig object will not affect the other one.

setCompressableMimeTypes back to summary

setCompressableMimeTypes	back to summary
public void setCompressableMimeTypes(final Set<String> compressibleMimeTypes) Deprecated Use `setCompressibleMimeTypes(Set)` Sets the set of the mime-types, which are allowed to be compressed. Empty set means all mime-types are allowed to be compressed. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state. Annotations @Deprecated

public void setCompressableMimeTypes(final Set<String> compressibleMimeTypes)

Deprecated

Use setCompressibleMimeTypes(Set)

Sets the set of the mime-types, which are allowed to be compressed. Empty set means *all* mime-types are allowed to be compressed. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state.

Annotations

@Deprecated

setCompressableMimeTypes back to summary

setCompressableMimeTypes	back to summary
public void setCompressableMimeTypes(final String... compressibleMimeTypes) Deprecated Use `setCompressibleMimeTypes(String...)` Sets the set of the mime-types, which are allowed to be compressed. Empty set means all mime-types are allowed to be compressed. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state. Annotations @Deprecated

public void setCompressableMimeTypes(final String... compressibleMimeTypes)

Deprecated

Use setCompressibleMimeTypes(String...)

Annotations

@Deprecated

setCompressibleMimeTypes	back to summary
public void setCompressibleMimeTypes(final Set<String> compressibleMimeTypes) Sets the set of the mime-types, which are allowed to be compressed. Empty set means all mime-types are allowed to be compressed. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state. Since 2.3.29

setCompressibleMimeTypes

back to summary

public void setCompressibleMimeTypes(final Set<String> compressibleMimeTypes)

Since: 2.3.29

setCompressibleMimeTypes	back to summary
public void setCompressibleMimeTypes(final String... compressibleMimeTypes) Sets the set of the mime-types, which are allowed to be compressed. Empty set means all mime-types are allowed to be compressed. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state. Since 2.3.29

setCompressibleMimeTypes

back to summary

public void setCompressibleMimeTypes(final String... compressibleMimeTypes)

Since: 2.3.29

setCompressionMinSize	back to summary
public void setCompressionMinSize(int compressionMinSize) Sets the minimum size of an entity, which will be compressed.

setCompressionMode	back to summary
public void setCompressionMode(final CompressionConfig.CompressionMode mode) Sets the `CompressionMode`.

setDecompressionEnabled back to summary

setDecompressionEnabled	back to summary
public void setDecompressionEnabled(boolean decompressionEnabled) If set to `true` content-encoding header for incoming data will be respected and data will be decompressed and the decompressed stream will be passed on. Since 2.3.29

public void setDecompressionEnabled(boolean decompressionEnabled)

If set to true content-encoding header for incoming data will be respected and data will be decompressed and the decompressed stream will be passed on.

Since: 2.3.29

setNoCompressionUserAgents	back to summary
public void setNoCompressionUserAgents(final Set<String> noCompressionUserAgents) Sets the set of the user-agents, which will be always responded with uncompressed data. Empty set means that compressed data could be sent to all user-agents. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state.

setNoCompressionUserAgents

back to summary

public void setNoCompressionUserAgents(final Set<String> noCompressionUserAgents)

Sets the set of the user-agents, which will be always responded with uncompressed data. Empty set means that compressed data could be sent to *all* user-agents. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state.

setNoCompressionUserAgents	back to summary
public void setNoCompressionUserAgents(final String... noCompressionUserAgents) Sets the set of the user-agents, which will be always responded with uncompressed data. Empty set means that compressed data could be sent to all user-agents. Please note that CompressionConfig object will copy the source Set content, so further changes made on the source Set will not affect CompressionConfig object state.

setNoCompressionUserAgents

back to summary

public void setNoCompressionUserAgents(final String... noCompressionUserAgents)

org.glassfish.grizzly.http back to summary

public final Enum CompressionConfig.CompressionMode

Class Inheritance

extends Enum<CompressionConfig.CompressionMode>
implements CompressionModeI

java.lang.Object
java.lang.Enum
org.glassfish.grizzly.http.CompressionConfig.CompressionMode

All Implemented Interfaces

org.glassfish.grizzly.http.CompressionConfig.CompressionModeI

Field Summary

Modifier and Type	Field and Description
public static final CompressionConfig.CompressionMode	FORCE
public static final CompressionConfig.CompressionMode	OFF
public static final CompressionConfig.CompressionMode	ON

Constructor Summary

Access	Constructor and Description
private	CompressionMode()

Method Summary

Modifier and Type	Method and Description
public static CompressionConfig.CompressionMode	fromString(final String mode) Returns the `CompressionMode` based on the string representation.
public static CompressionConfig.CompressionMode	valueOf(String name)
public static CompressionConfig.CompressionMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FORCE	back to summary
public static final CompressionConfig.CompressionMode FORCE

OFF	back to summary
public static final CompressionConfig.CompressionMode OFF

ON	back to summary
public static final CompressionConfig.CompressionMode ON

Constructor Detail

CompressionMode	back to summary
private CompressionMode()

Method Detail

fromString	back to summary
public static CompressionConfig.CompressionMode fromString(final String mode) Returns the `CompressionMode` based on the string representation.

valueOf	back to summary
public static CompressionConfig.CompressionMode valueOf(String name)

values	back to summary
public static CompressionConfig.CompressionMode[] values()

public final Class CompressionConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum CompressionConfig.CompressionMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface CompressionConfig.CompressionModeI