Package org.eclipse.jetty.server.handler.gzip

Class GzipHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.handler.gzip.GzipHandler

All Implemented Interfaces:

Handler, GzipFactory, HandlerContainer, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.LifeCycle

public class GzipHandler
extends HandlerWrapper
implements GzipFactory

A Handler that can dynamically GZIP compress responses. Unlike previous and 3rd party GzipFilters, this mechanism works with asynchronously generated responses and does not need to wrap the response or it's output stream. Instead it uses the efficient HttpOutput.Interceptor mechanism.

The handler can be applied to the entire server (a gzip.mod is included in the distribution) or it may be applied to individual contexts.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MIN_GZIP_SIZE
static java.lang.String	DEFLATE
static java.lang.String	GZIP

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Constructor Summary

Constructors

Constructor	Description
GzipHandler()	Instantiates a new gzip handler.

Method Summary

Modifier and Type	Method	Description
void	addExcludedAgentPatterns(java.lang.String... patterns)
void	addExcludedMethods(java.lang.String... methods)
void	addExcludedMimeTypes(java.lang.String... types)	Set the mime types.
void	addExcludedPaths(java.lang.String... pathspecs)	Add path to excluded paths list.
void	addIncludedAgentPatterns(java.lang.String... patterns)
void	addIncludedMethods(java.lang.String... methods)
void	addIncludedMimeTypes(java.lang.String... types)	Add included mime types.
void	addIncludedPaths(java.lang.String... pathspecs)	Add path specs to include.
protected void	doStart()
boolean	getCheckGzExists()
int	getCompressionLevel()
java.util.zip.Deflater	getDeflater(Request request, long content_length)
java.lang.String[]	getExcludedAgentPatterns()
java.lang.String[]	getExcludedMethods()
java.lang.String[]	getExcludedMimeTypes()
java.lang.String[]	getExcludedPaths()
java.lang.String[]	getIncludedAgentPatterns()
java.lang.String[]	getIncludedMethods()
java.lang.String[]	getIncludedMimeTypes()
java.lang.String[]	getIncludedPaths()
int	getInflateBufferSize()
java.lang.String[]	getMethods()	Deprecated.
int	getMinGzipSize()	Get the minimum response size.
protected org.eclipse.jetty.http.HttpField	getVaryField()
void	handle(java.lang.String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Handle a request.
protected boolean	isAgentGzipable(java.lang.String ua)	Checks to see if the userAgent is excluded
boolean	isMimeTypeGzipable(java.lang.String mimetype)
protected boolean	isPathGzipable(java.lang.String requestURI)	Checks to see if the path is included or not excluded
boolean	isSyncFlush()
void	recycle(java.util.zip.Deflater deflater)
void	setCheckGzExists(boolean checkGzExists)
void	setCompressionLevel(int compressionLevel)
void	setExcludedAgentPatterns(java.lang.String... patterns)
void	setExcludedMethods(java.lang.String... method)
void	setExcludedMimeTypes(java.lang.String... types)	Set the mime types.
void	setExcludedPaths(java.lang.String... pathspecs)
void	setIncludedAgentPatterns(java.lang.String... patterns)
void	setIncludedMethods(java.lang.String... methods)
void	setIncludedMimeTypes(java.lang.String... types)	Set included mime types.
void	setIncludedPaths(java.lang.String... pathspecs)	Set the path specs to include.
void	setInflateBufferSize(int size)
void	setMinGzipSize(int minGzipSize)	Set the minimum response size to trigger dynamic compresssion
void	setSyncFlush(boolean syncFlush)	Set the Deflater flush mode to use.

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, doStop, dumpThis, getServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

GZIP

public static final java.lang.String GZIP

See Also:

Constant Field Values

DEFLATE

public static final java.lang.String DEFLATE

See Also:

Constant Field Values

DEFAULT_MIN_GZIP_SIZE

public static final int DEFAULT_MIN_GZIP_SIZE

See Also:

Constant Field Values

Constructor Detail

GzipHandler

public GzipHandler()

Instantiates a new gzip handler. The excluded Mime Types are initialized to common known images, audio, video and other already compressed types. The included methods is initialized to GET. The excluded agent patterns are set to exclude MSIE 6.0

Method Detail

addExcludedAgentPatterns

public void addExcludedAgentPatterns(java.lang.String... patterns)

Parameters:

patterns - Regular expressions matching user agents to exclude

addExcludedMethods

public void addExcludedMethods(java.lang.String... methods)

Parameters:

methods - The methods to exclude in compression

addExcludedMimeTypes

public void addExcludedMimeTypes(java.lang.String... types)

Set the mime types.

Parameters:

types - The mime types to exclude (without charset or other parameters). For backward compatibility the mimetypes may be comma separated strings, but this will not be supported in future versions.

addExcludedPaths

public void addExcludedPaths(java.lang.String... pathspecs)

Add path to excluded paths list.

There are 2 syntaxes supported, Servlet url-pattern based, and Regex based. This means that the initial characters on the path spec line are very strict, and determine the behavior of the path matching.

• If the spec starts with '^' the spec is assumed to be a regex based path spec and will match with normal Java regex rules.
• If the spec starts with '/' then spec is assumed to be a Servlet url-pattern rules path spec for either an exact match or prefix based match.
• If the spec starts with '*.' then spec is assumed to be a Servlet url-pattern rules path spec for a suffix based match.
• All other syntaxes are unsupported

Note: inclusion takes precedence over exclude.

Parameters:

pathspecs - Path specs (as per servlet spec) to exclude. If a ServletContext is available, the paths are relative to the context path, otherwise they are absolute.
For backward compatibility the pathspecs may be comma separated strings, but this will not be supported in future versions.

addIncludedAgentPatterns

public void addIncludedAgentPatterns(java.lang.String... patterns)

Parameters:

patterns - Regular expressions matching user agents to exclude

addIncludedMethods

public void addIncludedMethods(java.lang.String... methods)

Parameters:

methods - The methods to include in compression

isSyncFlush

public boolean isSyncFlush()

Returns:

True if Deflater.SYNC_FLUSH is used, else Deflater.NO_FLUSH

setSyncFlush

public void setSyncFlush(boolean syncFlush)

Set the Deflater flush mode to use. Deflater.SYNC_FLUSH should be used if the application wishes to stream the data, but this may hurt compression performance.

Parameters:

syncFlush - True if Deflater.SYNC_FLUSH is used, else Deflater.NO_FLUSH

addIncludedMimeTypes

public void addIncludedMimeTypes(java.lang.String... types)

Add included mime types. Inclusion takes precedence over exclusion.

Parameters:

types - The mime types to include (without charset or other parameters) For backward compatibility the mimetypes may be comma separated strings, but this will not be supported in future versions.

addIncludedPaths

public void addIncludedPaths(java.lang.String... pathspecs)

Add path specs to include.

There are 2 syntaxes supported, Servlet url-pattern based, and Regex based. This means that the initial characters on the path spec line are very strict, and determine the behavior of the path matching.

• If the spec starts with '^' the spec is assumed to be a regex based path spec and will match with normal Java regex rules.
• If the spec starts with '/' then spec is assumed to be a Servlet url-pattern rules path spec for either an exact match or prefix based match.
• If the spec starts with '*.' then spec is assumed to be a Servlet url-pattern rules path spec for a suffix based match.
• All other syntaxes are unsupported

Note: inclusion takes precedence over exclude.

Parameters:

pathspecs - Path specs (as per servlet spec) to include. If a ServletContext is available, the paths are relative to the context path, otherwise they are absolute

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class AbstractHandler

Throws:

java.lang.Exception

getCheckGzExists

public boolean getCheckGzExists()

getCompressionLevel

public int getCompressionLevel()

getDeflater

public java.util.zip.Deflater getDeflater(Request request,
                                          long content_length)

Specified by:

getDeflater in interface GzipFactory

getExcludedAgentPatterns

public java.lang.String[] getExcludedAgentPatterns()

getExcludedMethods

public java.lang.String[] getExcludedMethods()

getExcludedMimeTypes

public java.lang.String[] getExcludedMimeTypes()

getExcludedPaths

public java.lang.String[] getExcludedPaths()

getIncludedAgentPatterns

public java.lang.String[] getIncludedAgentPatterns()

getIncludedMethods

public java.lang.String[] getIncludedMethods()

getIncludedMimeTypes

public java.lang.String[] getIncludedMimeTypes()

getIncludedPaths

public java.lang.String[] getIncludedPaths()

getMethods

@Deprecated
public java.lang.String[] getMethods()

Deprecated.

getMinGzipSize

public int getMinGzipSize()

Get the minimum response size.

Returns:

minimum response size

getVaryField

protected org.eclipse.jetty.http.HttpField getVaryField()

getInflateBufferSize

public int getInflateBufferSize()

Returns:

size in bytes of the buffer to inflate compressed request, or 0 for no inflation.

setInflateBufferSize

public void setInflateBufferSize(int size)

Parameters:

size - size in bytes of the buffer to inflate compressed request, or 0 for no inflation.

handle

public void handle(java.lang.String target,
                   Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException

Description copied from interface: Handler

Handle a request.

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerWrapper

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

java.io.IOException - if unable to handle the request or response processing

javax.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue

See Also:

HandlerWrapper.handle(java.lang.String, org.eclipse.jetty.server.Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

isAgentGzipable

protected boolean isAgentGzipable(java.lang.String ua)

Checks to see if the userAgent is excluded

Parameters:

ua - the user agent

Returns:

boolean true if excluded

isMimeTypeGzipable

public boolean isMimeTypeGzipable(java.lang.String mimetype)

Specified by:

isMimeTypeGzipable in interface GzipFactory

isPathGzipable

protected boolean isPathGzipable(java.lang.String requestURI)

Checks to see if the path is included or not excluded

Parameters:

requestURI - the request uri

Returns:

boolean true if gzipable

recycle

public void recycle(java.util.zip.Deflater deflater)

Specified by:

recycle in interface GzipFactory

setCheckGzExists

public void setCheckGzExists(boolean checkGzExists)

Parameters:

checkGzExists - If true, check if a static gz file exists for the resource that the DefaultServlet may serve as precompressed.

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

Parameters:

compressionLevel - The compression level to use to initialize Deflater.setLevel(int)

setExcludedAgentPatterns

public void setExcludedAgentPatterns(java.lang.String... patterns)

Parameters:

patterns - Regular expressions matching user agents to exclude

setExcludedMethods

public void setExcludedMethods(java.lang.String... method)

Parameters:

method - to exclude

setExcludedMimeTypes

public void setExcludedMimeTypes(java.lang.String... types)

Set the mime types.

Parameters:

types - The mime types to exclude (without charset or other parameters)

setExcludedPaths

public void setExcludedPaths(java.lang.String... pathspecs)

Parameters:

pathspecs - Path specs (as per servlet spec) to exclude. If a ServletContext is available, the paths are relative to the context path, otherwise they are absolute.

setIncludedAgentPatterns

public void setIncludedAgentPatterns(java.lang.String... patterns)

Parameters:

patterns - Regular expressions matching user agents to include

setIncludedMethods

public void setIncludedMethods(java.lang.String... methods)

Parameters:

methods - The methods to include in compression

setIncludedMimeTypes

public void setIncludedMimeTypes(java.lang.String... types)

Set included mime types. Inclusion takes precedence over exclusion.

Parameters:

types - The mime types to include (without charset or other parameters)

setIncludedPaths

public void setIncludedPaths(java.lang.String... pathspecs)

Set the path specs to include. Inclusion takes precedence over exclusion.

Parameters:

pathspecs - Path specs (as per servlet spec) to include. If a ServletContext is available, the paths are relative to the context path, otherwise they are absolute

setMinGzipSize

public void setMinGzipSize(int minGzipSize)

Set the minimum response size to trigger dynamic compresssion

Parameters:

minGzipSize - minimum response size in bytes