Package org.apache.coyote
Class CompressionConfig
java.lang.Object
org.apache.coyote.CompressionConfig
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Return compression level.int
int
Obtain the String form of the regular expression that defines the user agents to not use gzip with.void
setCompressibleMimeType
(String valueS) void
setCompression
(String compression) Set compression level.void
setCompressionMinSize
(int compressionMinSize) Set Minimum size to trigger compression.void
setNoCompressionUserAgents
(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.
-
Constructor Details
-
CompressionConfig
public CompressionConfig()
-
-
Method Details
-
setCompression
Set compression level.- Parameters:
compression
- One ofon
,force
,off
or the minimum compression size in bytes which implieson
-
getCompression
Return compression level.- Returns:
- The current compression level in string form (off/on/force)
-
getCompressionLevel
public int getCompressionLevel() -
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
-
setNoCompressionUserAgents
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
-
setCompressibleMimeType
-
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
-
useCompression
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
-