io.dropwizard.jetty

Class GzipHandlerFactory

java.lang.Object

io.dropwizard.jetty.GzipHandlerFactory

public class GzipHandlerFactory
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.
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).
gzipCompatibleInflation	true	If true, then ZLIB inflation(decompression) will be performed in the GZIP-compatible mode.

Constructor Summary

Constructors

Constructor and Description
GzipHandlerFactory()

Method Summary

Modifier and Type	Method and Description
BiDiGzipHandler	build(org.eclipse.jetty.server.Handler handler)
io.dropwizard.util.Size	getBufferSize()
Set<String>	getCompressedMimeTypes()
int	getDeflateCompressionLevel()
Set<String>	getExcludedUserAgentPatterns()
Set<String>	getIncludedMethods()
io.dropwizard.util.Size	getMinimumEntitySize()
boolean	isEnabled()
boolean	isGzipCompatibleInflation()
boolean	isSyncFlush()
void	setBufferSize(io.dropwizard.util.Size size)
void	setCompressedMimeTypes(Set<String> mimeTypes)
void	setDeflateCompressionLevel(int level)
void	setEnabled(boolean enabled)
void	setExcludedUserAgentPatterns(Set<String> excludedUserAgentPatterns)
void	setGzipCompatibleInflation(boolean gzipCompatibleInflation)
void	setIncludedMethods(Set<String> methods)
void	setMinimumEntitySize(io.dropwizard.util.Size size)
void	setSyncFlush(boolean syncFlush)

Methods inherited from class java.lang.Object

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

Constructor Detail

GzipHandlerFactory

public GzipHandlerFactory()

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)

getCompressedMimeTypes

@Nullable
public Set<String> getCompressedMimeTypes()

setCompressedMimeTypes

public void setCompressedMimeTypes(Set<String> mimeTypes)

getDeflateCompressionLevel

public int getDeflateCompressionLevel()

setDeflateCompressionLevel

public void setDeflateCompressionLevel(int level)

isGzipCompatibleInflation

public boolean isGzipCompatibleInflation()

setGzipCompatibleInflation

public void setGzipCompatibleInflation(boolean gzipCompatibleInflation)

getExcludedUserAgentPatterns

public Set<String> getExcludedUserAgentPatterns()

setExcludedUserAgentPatterns

public void setExcludedUserAgentPatterns(Set<String> excludedUserAgentPatterns)

getIncludedMethods

@Nullable
public Set<String> getIncludedMethods()

setIncludedMethods

public void setIncludedMethods(Set<String> methods)

isSyncFlush

public boolean isSyncFlush()

setSyncFlush

public void setSyncFlush(boolean syncFlush)

build

public BiDiGzipHandler build(@Nullable
                             org.eclipse.jetty.server.Handler handler)