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` in the `Accept-Encoding` header will have their response entities compressed and requests with `gzip` in the `Content-Encoding` header will have their request entities decompressed.
minimumEntitySize	256 bytes	All response entities under this DataSize are not compressed.
bufferSize	8KiB	The DataSize of the buffer to use when compressing.
excludedUserAgentPatterns	(Jetty's default)	A list of regex patterns for User-Agent names from which requests should not be compressed. The default is [".*MSIE 6.0.*"]
compressedMimeTypes	(Jetty's default)	List of MIME types to compress. The default is all types apart the commonly known image, video, audio and compressed types.
excludedMimeTypes	(Jetty's default)	List of MIME types not to compress. The default is a list of commonly known image, video, audio and compressed types.
includedPaths	(Jetty's default)	List of paths to consider for compression. The default is all paths.
excludedPaths	(none)	List of paths to exclude from compression. Performs a String.startsWith(String) comparison to check if the path matches. If it does match then there is no compression. To match subpaths use excludePathPatterns instead.
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 deflation(compression).
gzipCompatibleInflation	true	This option is unused and deprecated as compressed requests without header info are unsupported

Constructor Summary

Constructors

Constructor and Description
GzipHandlerFactory()

Method Summary

Modifier and Type	Method and Description
org.eclipse.jetty.server.handler.gzip.GzipHandler	build(org.eclipse.jetty.server.Handler handler)
DataSize	getBufferSize()
Set<String>	getCompressedMimeTypes()
int	getDeflateCompressionLevel()
Set<String>	getExcludedMimeTypes()
Set<String>	getExcludedPaths()
Set<String>	getExcludedUserAgentPatterns() Deprecated. excluding by user agent will be removed in Jetty 10
Set<String>	getIncludedMethods()
Set<String>	getIncludedPaths()
DataSize	getMinimumEntitySize()
boolean	isEnabled()
boolean	isGzipCompatibleInflation() Deprecated. gzip handler no longer supports inflate streams
boolean	isSyncFlush()
void	setBufferSize(DataSize size)
void	setCompressedMimeTypes(Set<String> mimeTypes)
void	setDeflateCompressionLevel(int level)
void	setEnabled(boolean enabled)
void	setExcludedMimeTypes(Set<String> mimeTypes)
void	setExcludedPaths(Set<String> paths)
void	setExcludedUserAgentPatterns(Set<String> excludedUserAgentPatterns) Deprecated. excluding by user agent will be removed in Jetty 10
void	setGzipCompatibleInflation(boolean gzipCompatibleInflation) Deprecated. gzip handler no longer supports inflate streams
void	setIncludedMethods(Set<String> methods)
void	setIncludedPaths(Set<String> paths)
void	setMinimumEntitySize(DataSize 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 DataSize getMinimumEntitySize()

setMinimumEntitySize

public void setMinimumEntitySize(DataSize size)

getBufferSize

public DataSize getBufferSize()

setBufferSize

public void setBufferSize(DataSize size)

getCompressedMimeTypes

@Nullable
public Set<String> getCompressedMimeTypes()

setCompressedMimeTypes

public void setCompressedMimeTypes(Set<String> mimeTypes)

getExcludedMimeTypes

@Nullable
public Set<String> getExcludedMimeTypes()

Since:

2.0

setExcludedMimeTypes

public void setExcludedMimeTypes(Set<String> mimeTypes)

Since:

2.0

getDeflateCompressionLevel

public int getDeflateCompressionLevel()

setDeflateCompressionLevel

public void setDeflateCompressionLevel(int level)

isGzipCompatibleInflation

@Deprecated
public boolean isGzipCompatibleInflation()

Deprecated. gzip handler no longer supports inflate streams

setGzipCompatibleInflation

@Deprecated
public void setGzipCompatibleInflation(boolean gzipCompatibleInflation)

Deprecated. gzip handler no longer supports inflate streams

getExcludedUserAgentPatterns

@Deprecated
public Set<String> getExcludedUserAgentPatterns()

Deprecated. excluding by user agent will be removed in Jetty 10

setExcludedUserAgentPatterns

@Deprecated
public void setExcludedUserAgentPatterns(Set<String> excludedUserAgentPatterns)

Deprecated. excluding by user agent will be removed in Jetty 10

getIncludedMethods

@Nullable
public Set<String> getIncludedMethods()

setIncludedMethods

public void setIncludedMethods(Set<String> methods)

getExcludedPaths

@Nullable
public Set<String> getExcludedPaths()

Since:

2.0

setExcludedPaths

public void setExcludedPaths(Set<String> paths)

Since:

2.0

getIncludedPaths

@Nullable
public Set<String> getIncludedPaths()

Since:

2.0

setIncludedPaths

public void setIncludedPaths(Set<String> paths)

Since:

2.0

isSyncFlush

public boolean isSyncFlush()

setSyncFlush

public void setSyncFlush(boolean syncFlush)

build

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