Top Fields Constructors Methods
org.apache.coyote

public Class CompressionConfig

extends Object
Class Inheritance
Imports
java.io.IOException, .StringReader, java.util.ArrayList, .Enumeration, .HashSet, .List, .Set, .StringTokenizer, java.util.regex.Pattern, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.buf.MessageBytes, org.apache.tomcat.util.http.MimeHeaders, .ResponseUtil, org.apache.tomcat.util.http.parser.AcceptEncoding, .TokenList, org.apache.tomcat.util.res.StringManager

Field Summary

Modifier and TypeField and Description
private String
compressibleMimeType

private String[]
compressibleMimeTypes

private int
compressionLevel

private int
compressionMinSize

private static final Log
log

private Pattern
noCompressionUserAgents

private static final StringManager
sm

Constructor Summary

AccessConstructor and Description
public
CompressionConfig()

Method Summary

Modifier and TypeMethod and Description
public String
getCompressibleMimeType()

public String[]
getCompressibleMimeTypes()

public String

Returns:

The current compression level in string form (off/on/force)
getCompression()

Return compression level.

public int
getCompressionLevel()

public int
getCompressionMinSize()

public String

Returns:

The regular expression as a String
getNoCompressionUserAgents()

Obtain the String form of the regular expression that defines the user agents to not use gzip with.

public Pattern
getNoCompressionUserAgentsPattern()

public void
setCompressibleMimeType(String valueS)

public void
setCompression(String
One of on, force, off or the minimum compression size in bytes which implies on
compression)

Set compression level.

public void
setCompressionMinSize(int
The minimum content length required for compression in bytes
compressionMinSize)

Set Minimum size to trigger compression.

public void
setNoCompressionUserAgents(String
The regular expression for user agent strings for which compression should not be applied
noCompressionUserAgents)

Set no compression user agent pattern.

private static boolean
startsWithStringArray(String[]
the StringArray
sArray, String
string
value)

Checks if any entry in the string array starts with the specified value

public boolean

Returns:

true if compression was enabled for the given response, otherwise false
useCompression(Request
The request that triggered the response
request, Response
The response to consider compressing
response)

Determines if compression should be enabled for the given response and if it is, sets any necessary headers to mark it as such.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

compressibleMimeTypeback to summary
private String compressibleMimeType
compressibleMimeTypesback to summary
private String[] compressibleMimeTypes
compressionLevelback to summary
private int compressionLevel
compressionMinSizeback to summary
private int compressionMinSize
logback to summary
private static final Log log
noCompressionUserAgentsback to summary
private Pattern noCompressionUserAgents
smback to summary
private static final StringManager sm

Constructor Detail

CompressionConfigback to summary
public CompressionConfig()

Method Detail

getCompressibleMimeTypeback to summary
public String getCompressibleMimeType()
getCompressibleMimeTypesback to summary
public String[] getCompressibleMimeTypes()
getCompressionback to summary
public String getCompression()

Return compression level.

Returns:String

The current compression level in string form (off/on/force)

getCompressionLevelback to summary
public int getCompressionLevel()
getCompressionMinSizeback to summary
public int getCompressionMinSize()
getNoCompressionUserAgentsback to summary
public String getNoCompressionUserAgents()

Obtain the String form of the regular expression that defines the user agents to not use gzip with.

Returns:String

The regular expression as a String

getNoCompressionUserAgentsPatternback to summary
public Pattern getNoCompressionUserAgentsPattern()
setCompressibleMimeTypeback to summary
public void setCompressibleMimeType(String valueS)
setCompressionback to summary
public void setCompression(String compression)

Set compression level.

Parameters
compression:String

One of on, force, off or the minimum compression size in bytes which implies on

setCompressionMinSizeback to summary
public void setCompressionMinSize(int compressionMinSize)

Set Minimum size to trigger compression.

Parameters
compressionMinSize:int

The minimum content length required for compression in bytes

setNoCompressionUserAgentsback to summary
public void setNoCompressionUserAgents(String noCompressionUserAgents)

Set no compression user agent pattern. Regular expression as supported by Pattern. e.g.: gorilla|desesplorer|tigrus.

Parameters
noCompressionUserAgents:String

The regular expression for user agent strings for which compression should not be applied

startsWithStringArrayback to summary
private static boolean startsWithStringArray(String[] sArray, String value)

Checks if any entry in the string array starts with the specified value

Parameters
sArray:String[]

the StringArray

value:String

string

useCompressionback to summary
public boolean useCompression(Request request, Response response)

Determines if compression should be enabled for the given response and if it is, sets any necessary headers to mark it as such.

Parameters
request:Request

The request that triggered the response

response:Response

The response to consider compressing

Returns:boolean

true if compression was enabled for the given response, otherwise false