io.dropwizard.jetty

Class GzipFilterFactory

java.lang.Object

io.dropwizard.jetty.GzipFilterFactory

public class GzipFilterFactory
extends Object

Builds GZIP filters.

Configuration Parameters:

Name	Default	Description
enabled	true	If true, all requests with `gzip` or `deflate` in the `Accept-Encoding` header will have their response entities compressed and requests with `gzip` or `deflate` in the `Content-Encoding` header will have their request entities decompressed.
minimumEntitySize	256 bytes	All response entities under this size are not compressed.
bufferSize	8KiB	The size of the buffer to use when compressing.
excludedUserAgents	(none)	The set of user agents to exclude from compression.
excludedUserAgentPatterns	(none)	The set of user agent patterns to exclude from compression.
compressedMimeTypes	(Jetty's default)	The list of mime types to compress. The default is all types apart the commonly known image, video, audio and compressed types.
includedMethods	(Jetty's default)	The list list of HTTP methods to compress. The default is to compress only GET responses.
deflateCompressionLevel	-1	The compression level used for ZLIB deflation(compression).
gzipCompatibleDeflation	true	If true, then ZLIB deflation(compression) will be performed in the GZIP-compatible mode.
gzipCompatibleInflation	true	If true, then ZLIB inflation(decompression) will be performed in the GZIP-compatible mode.
vary	Accept-Encoding	Value of the `Vary` header sent with responses that could be compressed.

Constructor Summary

Constructors

Constructor and Description
GzipFilterFactory()

Method Summary

Modifier and Type	Method and Description
BiDiGzipFilter	build()
io.dropwizard.util.Size	getBufferSize()
Set<String>	getCompressedMimeTypes()
int	getDeflateCompressionLevel()
Set<Pattern>	getExcludedUserAgentPatterns()
Set<String>	getExcludedUserAgents()
Set<String>	getIncludedMethods()
io.dropwizard.util.Size	getMinimumEntitySize()
String	getVary()
boolean	isEnabled()
boolean	isGzipCompatibleDeflation()
boolean	isGzipCompatibleInflation()
void	setBufferSize(io.dropwizard.util.Size size)
void	setCompressedMimeTypes(Set<String> mimeTypes)
void	setDeflateCompressionLevel(int level)
void	setEnabled(boolean enabled)
void	setExcludedUserAgentPatterns(Set<Pattern> patterns)
void	setExcludedUserAgents(Set<String> userAgents)
void	setGzipCompatibleDeflation(boolean compatible)
void	setGzipCompatibleInflation(boolean gzipCompatibleInflation)
void	setIncludedMethods(Set<String> methods)
void	setMinimumEntitySize(io.dropwizard.util.Size size)
void	setVary(String vary)

Methods inherited from class java.lang.Object

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

Constructor Detail

GzipFilterFactory

public GzipFilterFactory()

Method Detail

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getMinimumEntitySize

public io.dropwizard.util.Size getMinimumEntitySize()

setMinimumEntitySize

public void setMinimumEntitySize(io.dropwizard.util.Size size)

getBufferSize

public io.dropwizard.util.Size getBufferSize()

setBufferSize

public void setBufferSize(io.dropwizard.util.Size size)

getExcludedUserAgents

public Set<String> getExcludedUserAgents()

setExcludedUserAgents

public void setExcludedUserAgents(Set<String> userAgents)

getCompressedMimeTypes

public Set<String> getCompressedMimeTypes()

setCompressedMimeTypes

public void setCompressedMimeTypes(Set<String> mimeTypes)

getDeflateCompressionLevel

public int getDeflateCompressionLevel()

setDeflateCompressionLevel

public void setDeflateCompressionLevel(int level)

isGzipCompatibleDeflation

public boolean isGzipCompatibleDeflation()

setGzipCompatibleDeflation

public void setGzipCompatibleDeflation(boolean compatible)

isGzipCompatibleInflation

public boolean isGzipCompatibleInflation()

setGzipCompatibleInflation

public void setGzipCompatibleInflation(boolean gzipCompatibleInflation)

getExcludedUserAgentPatterns

public Set<Pattern> getExcludedUserAgentPatterns()

setExcludedUserAgentPatterns

public void setExcludedUserAgentPatterns(Set<Pattern> patterns)

getIncludedMethods

public Set<String> getIncludedMethods()

setIncludedMethods

public void setIncludedMethods(Set<String> methods)

getVary

public String getVary()

setVary

public void setVary(String vary)

build

public BiDiGzipFilter build()