Package org.apache.coyote
Class CompressionConfig
- java.lang.Object
-
- org.apache.coyote.CompressionConfig
-
public class CompressionConfig extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description CompressionConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getCompressibleMimeType()
java.lang.String[]
getCompressibleMimeTypes()
java.lang.String
getCompression()
Return compression level.int
getCompressionLevel()
int
getCompressionMinSize()
boolean
getNoCompressionStrongETag()
Deprecated.Will be removed in Tomcat 10 where it will be hard-coded totrue
java.lang.String
getNoCompressionUserAgents()
Obtain the String form of the regular expression that defines the user agents to not use gzip with.java.util.regex.Pattern
getNoCompressionUserAgentsPattern()
void
setCompressibleMimeType(java.lang.String valueS)
void
setCompression(java.lang.String compression)
Set compression level.void
setCompressionMinSize(int compressionMinSize)
Set Minimum size to trigger compression.void
setNoCompressionStrongETag(boolean noCompressionStrongETag)
Deprecated.Will be removed in Tomcat 10 where it will be hard-coded totrue
void
setNoCompressionUserAgents(java.lang.String noCompressionUserAgents)
Set no compression user agent pattern.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.
-
-
-
Method Detail
-
setCompression
public void setCompression(java.lang.String compression)
Set compression level.- Parameters:
compression
- One ofon
,force
,off
or the minimum compression size in bytes which implieson
-
getCompression
public java.lang.String getCompression()
Return compression level.- Returns:
- The current compression level in string form (off/on/force)
-
getCompressionLevel
public int getCompressionLevel()
-
getNoCompressionUserAgents
public java.lang.String getNoCompressionUserAgents()
Obtain the String form of the regular expression that defines the user agents to not use gzip with.- Returns:
- The regular expression as a String
-
getNoCompressionUserAgentsPattern
public java.util.regex.Pattern getNoCompressionUserAgentsPattern()
-
setNoCompressionUserAgents
public void setNoCompressionUserAgents(java.lang.String noCompressionUserAgents)
Set no compression user agent pattern. Regular expression as supported byPattern
. e.g.:gorilla|desesplorer|tigrus
.- Parameters:
noCompressionUserAgents
- The regular expression for user agent strings for which compression should not be applied
-
getCompressibleMimeType
public java.lang.String getCompressibleMimeType()
-
setCompressibleMimeType
public void setCompressibleMimeType(java.lang.String valueS)
-
getCompressibleMimeTypes
public java.lang.String[] getCompressibleMimeTypes()
-
getCompressionMinSize
public int getCompressionMinSize()
-
setCompressionMinSize
public void setCompressionMinSize(int compressionMinSize)
Set Minimum size to trigger compression.- Parameters:
compressionMinSize
- The minimum content length required for compression in bytes
-
getNoCompressionStrongETag
@Deprecated public boolean getNoCompressionStrongETag()
Deprecated.Will be removed in Tomcat 10 where it will be hard-coded totrue
Determine if compression is disabled if the resource has a strong ETag.- Returns:
true
if compression is disabled, otherwisefalse
-
setNoCompressionStrongETag
@Deprecated public void setNoCompressionStrongETag(boolean noCompressionStrongETag)
Deprecated.Will be removed in Tomcat 10 where it will be hard-coded totrue
Set whether compression is disabled for resources with a strong ETag.- Parameters:
noCompressionStrongETag
-true
if compression is disabled, otherwisefalse
-
useCompression
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
- The request that triggered the responseresponse
- The response to consider compressing- Returns:
true
if compression was enabled for the given response, otherwisefalse
-
-