org.eclipse.jetty.servlets.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.servlets.gzip.GzipHandler

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, LifeCycle

public class GzipHandler
extends HandlerWrapper

GZIP Handler This handler will gzip the content of a response if:

• The handler is mapped to a matching path
• The response status code is >=200 and <300
• The content length is unknown or more than the minGzipSize initParameter or the minGzipSize is 0(default)
• The content-type matches one of the set of mimetypes to be compressed
• The content-type does NOT match one of the set of mimetypes AND setExcludeMimeTypes is true
• No content-encoding is specified by the resource

Compressing the content can greatly improve the network bandwidth usage, but at a cost of memory and CPU cycles. If this handler is used for static content, then use of efficient direct NIO may be prevented, thus use of the gzip mechanism of the org.eclipse.jetty.servlet.DefaultServlet is advised instead.

Nested Class Summary

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

AbstractLifeCycle.AbstractLifeCycleListener

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

LifeCycle.Listener

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

Container.InheritedListener, Container.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_bufferSize
protected int	_minGzipSize
protected String	_vary

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

_handler

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
GzipHandler() Instantiates a new gzip handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExcludedAgentPatterns(String... patterns)
void	addExcludedMethods(String... methods)
void	addExcludedMimeTypes(String... types) Set the mime types.
void	addExcludedPaths(String... pathspecs) Add path to excluded paths list.
void	addIncludedAgentPatterns(String... patterns)
void	addIncludedMethods(String... methods)
void	addIncludedMimeTypes(String... types) Add included mime types.
void	addIncludedPaths(String... pathspecs) Add path specs to include.
protected void	doStart()
int	getBufferSize() Get the buffer size.
Set<String>	getExcluded() Get the excluded user agents.
String[]	getExcludedAgentPatterns()
String[]	getExcludedMethods()
String[]	getExcludedMimeTypes()
String[]	getExcludedPaths()
String[]	getIncludedAgentPatterns()
String[]	getIncludedMethods()
String[]	getIncludedMimeTypes()
String[]	getIncludedPaths()
Set<String>	getMimeTypes() Deprecated. use getExcludedMimeTypes() or getIncludedMimeTypes() instead
int	getMinGzipSize() Get the minimum reponse size.
String	getVary()
void	handle(String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected CompressedResponseWrapper	newGzipResponseWrapper(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Allows derived implementations to replace ResponseWrapper implementation.
protected PrintWriter	newWriter(OutputStream out, String encoding) Allows derived implementations to replace PrintWriter implementation.
void	setBufferSize(int bufferSize) Set the buffer size.
void	setExcluded(Set<String> excluded) Set the excluded user agents.
void	setExcluded(String excluded) Set the excluded user agents.
void	setExcludeMimeTypes(boolean exclude) Deprecated. use #setExcludedMimeTypes() instead
void	setMimeTypes(Set<String> mimeTypes) Deprecated. use #setExcludedMimeTypes() or #setIncludedMimeTypes() instead
void	setMimeTypes(String mimeTypes) Deprecated. use #setExcludedMimeTypes() or #setIncludedMimeTypes() instead
void	setMinGzipSize(int minGzipSize) Set the minimum reponse size.
void	setVary(String vary) Set the value of the Vary header sent with responses that could be compressed.

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

destroy, expandChildren, getHandler, getHandlers, setHandler, setServer

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

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

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

doStop, dumpThis, getServer

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, updateBeans

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 java.lang.Object

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

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

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

Field Detail

_bufferSize

protected int _bufferSize

_minGzipSize

protected int _minGzipSize

_vary

protected String _vary

Constructor Detail

GzipHandler

public GzipHandler()

Instantiates a new gzip handler.

Method Detail

addExcludedAgentPatterns

public void addExcludedAgentPatterns(String... patterns)

Parameters:

patterns - Regular expressions matching user agents to exclude

addExcludedMethods

public void addExcludedMethods(String... methods)

Parameters:

methods - The methods to exclude in compression

addExcludedMimeTypes

public void addExcludedMimeTypes(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(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(String... patterns)

Parameters:

patterns - Regular expressions matching user agents to exclude

addIncludedMethods

public void addIncludedMethods(String... methods)

Parameters:

methods - The methods to include in compression

addIncludedMimeTypes

public void addIncludedMimeTypes(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(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

getExcludedAgentPatterns

public String[] getExcludedAgentPatterns()

getExcludedMethods

public String[] getExcludedMethods()

getExcludedMimeTypes

public String[] getExcludedMimeTypes()

getExcludedPaths

public String[] getExcludedPaths()

getIncludedAgentPatterns

public String[] getIncludedAgentPatterns()

getIncludedMethods

public String[] getIncludedMethods()

getIncludedMimeTypes

public String[] getIncludedMimeTypes()

getIncludedPaths

public String[] getIncludedPaths()

getMimeTypes

@Deprecated
public Set<String> getMimeTypes()

Deprecated. use getExcludedMimeTypes() or getIncludedMimeTypes() instead

Get the mime types.

Returns:

mime types to set

setMimeTypes

@Deprecated
public void setMimeTypes(Set<String> mimeTypes)

Deprecated. use #setExcludedMimeTypes() or #setIncludedMimeTypes() instead

Set the mime types.

Parameters:

mimeTypes - the mime types to set

setMimeTypes

@Deprecated
public void setMimeTypes(String mimeTypes)

Deprecated. use #setExcludedMimeTypes() or #setIncludedMimeTypes() instead

Set the mime types.

Parameters:

mimeTypes - the mime types to set

setExcludeMimeTypes

@Deprecated
public void setExcludeMimeTypes(boolean exclude)

Deprecated. use #setExcludedMimeTypes() instead

Set the mime types.

getExcluded

public Set<String> getExcluded()

Get the excluded user agents.

Returns:

excluded user agents

setExcluded

public void setExcluded(Set<String> excluded)

Set the excluded user agents.

Parameters:

excluded - excluded user agents to set

setExcluded

public void setExcluded(String excluded)

Set the excluded user agents.

Parameters:

excluded - excluded user agents to set

getVary

public String getVary()

Returns:

The value of the Vary header set if a response can be compressed.

setVary

public void setVary(String vary)

Set the value of the Vary header sent with responses that could be compressed.

By default it is set to 'Accept-Encoding, User-Agent' since IE6 is excluded by default from the excludedAgents. If user-agents are not to be excluded, then this can be set to 'Accept-Encoding'. Note also that shared caches may cache many copies of a resource that is varied by User-Agent - one per variation of the User-Agent, unless the cache does some normalization of the UA string.

Parameters:

vary - The value of the Vary header set if a response can be compressed.

getBufferSize

public int getBufferSize()

Get the buffer size.

Returns:

the buffer size

setBufferSize

public void setBufferSize(int bufferSize)

Set the buffer size.

Parameters:

bufferSize - buffer size to set

getMinGzipSize

public int getMinGzipSize()

Get the minimum reponse size.

Returns:

minimum reponse size

setMinGzipSize

public void setMinGzipSize(int minGzipSize)

Set the minimum reponse size.

Parameters:

minGzipSize - minimum reponse size

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class AbstractHandler

Throws:

Exception

handle

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

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerWrapper

Throws:

IOException

javax.servlet.ServletException

See Also:

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

newGzipResponseWrapper

protected CompressedResponseWrapper newGzipResponseWrapper(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)

Allows derived implementations to replace ResponseWrapper implementation.

Parameters:

request - the request

response - the response

Returns:

the gzip response wrapper

newWriter

protected PrintWriter newWriter(OutputStream out,
                    String encoding)
                         throws UnsupportedEncodingException

Allows derived implementations to replace PrintWriter implementation.

Parameters:

out - the out

encoding - the encoding

Returns:

the prints the writer

Throws:

UnsupportedEncodingException