com.aquenos.cassandra.pvarchiver.server.web.common.spring

Class ConfigureCompressionTomcatConnectorCustomizer

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.web.common.spring.ConfigureCompressionTomcatConnectorCustomizer

All Implemented Interfaces:

TomcatConnectorCustomizer

public class ConfigureCompressionTomcatConnectorCustomizer
extends Object
implements TomcatConnectorCustomizer

Customizer for Tomcat Connectors that configures compression.

This customizer sets the compressableMimeType, compression, compressionMinSize, and noCompressionUserAgents property on each connector it is invoked for.

Only those properties that have been configured are actually set. All other properties are not set, leaving Tomcat's defaults untouched.

Author:

Sebastian Marsching

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_COMPRESSABLE_MIME_TYPES MIME types that are configured as compressable when using enableCompression().

Method Summary

Modifier and Type	Method and Description
void	customize(org.apache.catalina.connector.Connector connector)
static ConfigureCompressionTomcatConnectorCustomizer	disableCompression() Returns a customizer that disables compression.
static ConfigureCompressionTomcatConnectorCustomizer	enableCompression() Returns a customizer that enabled compression using a default set of MIME types.
static ConfigureCompressionTomcatConnectorCustomizer	enableCompression(String[] compressableMimeTypes, Integer compressionMinSize, String noCompressionUserAgents) Returns a customizer that enables compression.
static ConfigureCompressionTomcatConnectorCustomizer	enableCompression(String compressableMimeTypes, Integer compressionMinSize, String noCompressionUserAgents) Returns a customizer that enables compression.
static ConfigureCompressionTomcatConnectorCustomizer	forceCompression() Returns a customizer that enforces compression.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPRESSABLE_MIME_TYPES

public static final String[] DEFAULT_COMPRESSABLE_MIME_TYPES

MIME types that are configured as compressable when using enableCompression().

Method Detail

disableCompression

public static ConfigureCompressionTomcatConnectorCustomizer disableCompression()

Returns a customizer that disables compression. Effectively, this customizer sets the compression property to off .

Returns:

customizer that disables compression.

enableCompression

public static ConfigureCompressionTomcatConnectorCustomizer enableCompression()

Returns a customizer that enabled compression using a default set of MIME types. Effectively, this customizer sets the compression property to on and the compressableMimeType property to a string generated from the MIME types listed in DEFAULT_COMPRESSABLE_MIME_TYPES.

Returns:

customizer that enables compression for a set of default MIME types.

enableCompression

public static ConfigureCompressionTomcatConnectorCustomizer enableCompression(String[] compressableMimeTypes,
                                                                              Integer compressionMinSize,
                                                                              String noCompressionUserAgents)

Returns a customizer that enables compression. Effectively, this customizer sets compression to on. If the respective parameters are not null, this customizer also sets the compressableMediaType, compressionMinSize, and noCompressionUserAgents properties.

Parameters:

compressableMimeTypes - MIME types for which compression shall be enabled. The compressableMediaType property is set to a string representing a comma-separated list generated from the specified strings. If null , the compressableMediaType property is not set, keeping Tomcat's default value ( text/html,text/xml,text/plain,text/css,text/javascript,application/javascript as of Tomcat 8.0.30).

compressionMinSize - minimum size of a response body in bytes for which compression shall be enabled. The compressionMinSize property is set to a string generated from this number. If null, the compressionMinSize property is not set, keeping Tomcat's default value ( 2048 as of Tomcat 8.0.30).

noCompressionUserAgents - regular expression matching the User-Agent header of clients for which compression shall be disabled, even if they signal that they support compression. If null, the noCompressionUserAgents property is not set, keeping Tomcat's default value ( null as of Tomcat 8.0.30).

Returns:

customizer that enables compression and sets the specified compression-related properties.

enableCompression

public static ConfigureCompressionTomcatConnectorCustomizer enableCompression(String compressableMimeTypes,
                                                                              Integer compressionMinSize,
                                                                              String noCompressionUserAgents)

Returns a customizer that enables compression. Effectively, this customizer sets compression to on. If the respective parameters are not null, this customizer also sets the compressableMediaType, compressionMinSize, and noCompressionUserAgents properties.

Parameters:

compressableMimeTypes - comma-separated list of MIME types for which compression shall be enabled. If null, the compressableMediaType property is not set, keeping Tomcat's default value ( text/html,text/xml,text/plain,text/css,text/javascript,application/javascript as of Tomcat 8.0.30).

compressionMinSize - minimum size of a response body in bytes for which compression shall be enabled. The compressionMinSize property is set to a string generated from this number. If null, the compressionMinSize property is not set, keeping Tomcat's default value ( 2048 as of Tomcat 8.0.30).

noCompressionUserAgents - regular expression matching the User-Agent header of clients for which compression shall be disabled, even if they signal that they support compression. If null, the noCompressionUserAgents property is not set, keeping Tomcat's default value ( null as of Tomcat 8.0.30).

Returns:

customizer that enables compression and sets the specified compression-related properties.

forceCompression

public static ConfigureCompressionTomcatConnectorCustomizer forceCompression()

Returns a customizer that enforces compression. Effectively, this customizer sets compression to force.

Returns:

customizer set enforces compression.

customize

public void customize(org.apache.catalina.connector.Connector connector)

Specified by:

customize in interface TomcatConnectorCustomizer