Module org.eclipse.jetty.server

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.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

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

All Implemented Interfaces:

Handler, Handler.Container, GzipFactory, Handler.Singleton, Request.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.thread.Invocable

@Deprecated(since="12.1.1",
            forRemoval=true)
public class GzipHandler
extends Handler.Wrapper
implements GzipFactory

Deprecated, for removal: This API element is subject to removal in a future version.

use the new CompressionHandler available in org.eclipse.jetty.compression:jetty-compression-server with your choice of compression implementation (gzip is org.eclipse.jetty.compression:jetty-compression-gzip, brotli is org.eclipse.jetty.compression:jetty-compression-brotli, and zstandard is org.eclipse.jetty.compression:jetty-compression-zstandard)

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.Handler.Abstract

Handler.Abstract.NonBlocking

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

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

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.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.Dumpable.DumpAppendable

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Handler

Handler.Abstract, Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

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

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

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request.Handler

Request.Handler.AbortException

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BREAK_EVEN_GZIP_SIZE	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	DEFAULT_MIN_GZIP_SIZE	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	DEFLATE	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	GZIP	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	GZIP_HANDLER_ETAGS	Deprecated, for removal: This API element is subject to removal in a future version.

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

LEGEND

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
GzipHandler()	Deprecated, for removal: This API element is subject to removal in a future version. Instantiates a new GzipHandler.
GzipHandler(Handler handler)	Deprecated, for removal: This API element is subject to removal in a future version. Instantiates a new GzipHandler.

Method Summary

Modifier and Type	Method	Description
void	addExcludedInflationPaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Adds excluded Path Specs for request filtering on request inflation.
void	addExcludedMethods(String... methods)	Deprecated, for removal: This API element is subject to removal in a future version. Add excluded to the HTTP methods filtering.
void	addExcludedMimeTypes(String... types)	Deprecated, for removal: This API element is subject to removal in a future version. Adds excluded MIME types for response filtering.
void	addExcludedPaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Adds excluded Path Specs for request filtering.
void	addIncludedInflationPaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Add included Path Specs for filtering on request inflation.
void	addIncludedMethods(String... methods)	Deprecated, for removal: This API element is subject to removal in a future version. Adds included HTTP Methods (eg: POST, PATCH, DELETE) for filtering.
void	addIncludedMimeTypes(String... types)	Deprecated, for removal: This API element is subject to removal in a future version. Add included MIME types for response filtering
void	addIncludedPaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Add included Path Specs for filtering.
protected void	doStart()	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	doStop()	Deprecated, for removal: This API element is subject to removal in a future version.
org.eclipse.jetty.util.compression.CompressionPool<Deflater>.org.eclipse.jetty.util.compression.CompressionPool.Entry	getDeflaterEntry(Request request, long contentLength)	Deprecated, for removal: This API element is subject to removal in a future version.
org.eclipse.jetty.util.compression.DeflaterPool	getDeflaterPool()	Deprecated, for removal: This API element is subject to removal in a future version. Get the DeflaterPool being used.
String[]	getExcludedInflationPaths()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of excluded Path Specs for request inflation.
String	getExcludedMethodList()	Deprecated, for removal: This API element is subject to removal in a future version. Get the excluded filter list of HTTP methods in CSV format
String[]	getExcludedMethods()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of excluded HTTP methods
String[]	getExcludedMimeTypes()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of excluded MIME types
String[]	getExcludedPaths()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of excluded Path Specs
String[]	getIncludedInflationPaths()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of included Path Specs for request inflation.
String	getIncludedMethodList()	Deprecated, for removal: This API element is subject to removal in a future version. Get the included filter list of HTTP methods in CSV format
String[]	getIncludedMethods()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of included HTTP Methods
String[]	getIncludedMimeTypes()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of included MIME types
String[]	getIncludedPaths()	Deprecated, for removal: This API element is subject to removal in a future version. Get the current filter list of included Path Specs
int	getInflateBufferSize()	Deprecated, for removal: This API element is subject to removal in a future version. Get the size (in bytes) of the Inflater buffer used to inflate compressed requests.
org.eclipse.jetty.util.compression.InflaterPool	getInflaterPool()	Deprecated, for removal: This API element is subject to removal in a future version. Get the InflaterPool being used.
int	getMinGzipSize()	Deprecated, for removal: This API element is subject to removal in a future version. Get the minimum size, in bytes, that a response Content-Length must be before compression will trigger.
org.eclipse.jetty.http.HttpField	getVary()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	handle(Request request, Response response, org.eclipse.jetty.util.Callback callback)	Deprecated, for removal: This API element is subject to removal in a future version. Invoked to handle the passed HTTP request and response.
boolean	isMimeTypeDeflatable(String mimetype)	Deprecated, for removal: This API element is subject to removal in a future version. Test if the provided MIME type is allowed based on the MIME type filters.
protected boolean	isMimeTypeDeflatable(org.eclipse.jetty.http.MimeTypes mimeTypes, String requestURI)	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	isPathDeflatable(String requestURI)	Deprecated, for removal: This API element is subject to removal in a future version. Test if the provided Request URI is allowed based on the Path Specs filters.
protected boolean	isPathInflatable(String pathInContext)	Deprecated, for removal: This API element is subject to removal in a future version. Test if the provided Request URI is allowed to be inflated based on the Path Specs filters.
boolean	isSyncFlush()	Deprecated, for removal: This API element is subject to removal in a future version. Is the Deflater running Deflater.SYNC_FLUSH or not.
void	setDeflaterPool(org.eclipse.jetty.util.compression.DeflaterPool deflaterPool)	Deprecated, for removal: This API element is subject to removal in a future version. Set the DeflaterPool to be used.
void	setExcludedInflatePaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Set the excluded filter list of Path specs (replacing any previously set)
void	setExcludedMethodList(String csvMethods)	Deprecated, for removal: This API element is subject to removal in a future version. Set the excluded filter list of HTTP Methods (replacing any previously set)
void	setExcludedMethods(String... methods)	Deprecated, for removal: This API element is subject to removal in a future version. Set the excluded filter list of HTTP methods (replacing any previously set)
void	setExcludedMimeTypes(String... types)	Deprecated, for removal: This API element is subject to removal in a future version. Set the excluded filter list of MIME types (replacing any previously set)
void	setExcludedMimeTypesList(String csvTypes)	Deprecated, for removal: This API element is subject to removal in a future version. Set the excluded filter list of MIME types (replacing any previously set)
void	setExcludedPaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Set the excluded filter list of Path specs (replacing any previously set)
void	setIncludedInflatePaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Set the included filter list of Path specs (replacing any previously set)
void	setIncludedMethodList(String csvMethods)	Deprecated, for removal: This API element is subject to removal in a future version. Set the included filter list of HTTP Methods (replacing any previously set)
void	setIncludedMethods(String... methods)	Deprecated, for removal: This API element is subject to removal in a future version. Set the included filter list of HTTP methods (replacing any previously set)
void	setIncludedMimeTypes(String... types)	Deprecated, for removal: This API element is subject to removal in a future version. Set the included filter list of MIME types (replacing any previously set)
void	setIncludedMimeTypesList(String csvTypes)	Deprecated, for removal: This API element is subject to removal in a future version. Set the included filter list of MIME types (replacing any previously set)
void	setIncludedPaths(String... pathspecs)	Deprecated, for removal: This API element is subject to removal in a future version. Set the included filter list of Path specs (replacing any previously set)
void	setInflateBufferSize(int size)	Deprecated, for removal: This API element is subject to removal in a future version. Set the size (in bytes) of the Inflater buffer used to inflate comrpessed requests.
void	setInflaterPool(org.eclipse.jetty.util.compression.InflaterPool inflaterPool)	Deprecated, for removal: This API element is subject to removal in a future version. Set the InflaterPool to be used.
void	setMinGzipSize(int minGzipSize)	Deprecated, for removal: This API element is subject to removal in a future version. Set the minimum response size to trigger dynamic compression.
void	setSyncFlush(boolean syncFlush)	Deprecated, for removal: This API element is subject to removal in a future version. Set the Deflater flush mode to use.
void	setVary(org.eclipse.jetty.http.HttpField vary)	Deprecated, for removal: This API element is subject to removal in a future version.
String	toString()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class org.eclipse.jetty.server.Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class org.eclipse.jetty.server.Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class org.eclipse.jetty.server.Handler.Abstract

destroy, getServer

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

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

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

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

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

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

getCachedBeans, getEventListeners

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

destroy

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

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.server.Handler

getServer, setServer

Methods inherited from interface org.eclipse.jetty.server.Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface org.eclipse.jetty.server.Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

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

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Field Details

GZIP_HANDLER_ETAGS

public static final String GZIP_HANDLER_ETAGS

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

GZIP

public static final String GZIP

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

DEFLATE

public static final String DEFLATE

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

DEFAULT_MIN_GZIP_SIZE

public static final int DEFAULT_MIN_GZIP_SIZE

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

BREAK_EVEN_GZIP_SIZE

public static final int BREAK_EVEN_GZIP_SIZE

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Constructor Details

GzipHandler

public GzipHandler()

Deprecated, for removal: This API element is subject to removal in a future version.

Instantiates a new GzipHandler.

GzipHandler

public GzipHandler(Handler handler)

Deprecated, for removal: This API element is subject to removal in a future version.

Instantiates a new GzipHandler.

Parameters:

handler - the handler to wrap

Method Details

doStart

protected void doStart()
                throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

doStart in class Handler.Abstract

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

doStop in class Handler.Abstract

Throws:

Exception

getVary

public org.eclipse.jetty.http.HttpField getVary()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

The VARY field to use.

setVary

public void setVary(org.eclipse.jetty.http.HttpField vary)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

vary - The VARY field to use. It if is not an instance of PreEncodedHttpField, then it will be converted to one.

addExcludedMethods

public void addExcludedMethods(String... methods)

Deprecated, for removal: This API element is subject to removal in a future version.

Add excluded to the HTTP methods filtering.

Parameters:

methods - The methods to exclude in compression

See Also:

• addIncludedMethods(String...)

addExcludedMimeTypes

public void addExcludedMimeTypes(String... types)

Deprecated, for removal: This API element is subject to removal in a future version.

Adds excluded MIME types for response filtering.

Deprecation Warning: For backward compatibility the MIME types parameters may be comma separated strings, but this will not be supported in future versions of Jetty.

Parameters:

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

See Also:

• addIncludedMimeTypes(String...)

addExcludedPaths

public void addExcludedPaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Adds excluded Path Specs for request filtering.

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.

See Also:

• addIncludedPaths(String...)

addExcludedInflationPaths

public void addExcludedInflationPaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Adds excluded Path Specs for request filtering on request inflation.

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.

See Also:

• addIncludedInflationPaths(String...)

addIncludedMethods

public void addIncludedMethods(String... methods)

Deprecated, for removal: This API element is subject to removal in a future version.

Adds included HTTP Methods (eg: POST, PATCH, DELETE) for filtering.

Parameters:

methods - The HTTP methods to include in compression.

See Also:

• addExcludedMethods(String...)

isSyncFlush

public boolean isSyncFlush()

Deprecated, for removal: This API element is subject to removal in a future version.

Is the Deflater running Deflater.SYNC_FLUSH or not.

Returns:

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

See Also:

• setSyncFlush(boolean)

setSyncFlush

public void setSyncFlush(boolean syncFlush)

Deprecated, for removal: This API element is subject to removal in a future version.

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

See Also:

• isSyncFlush()

addIncludedMimeTypes

public void addIncludedMimeTypes(String... types)

Deprecated, for removal: This API element is subject to removal in a future version.

Add included MIME types for response filtering

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.

See Also:

• addExcludedMimeTypes(String...)

addIncludedPaths

public void addIncludedPaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Add included Path Specs for filtering.

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

addIncludedInflationPaths

public void addIncludedInflationPaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Add included Path Specs for filtering on request inflation.

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

getDeflaterEntry

public org.eclipse.jetty.util.compression.CompressionPool<Deflater>.org.eclipse.jetty.util.compression.CompressionPool.Entry getDeflaterEntry(Request request,
 long contentLength)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getDeflaterEntry in interface GzipFactory

getExcludedMethods

public String[] getExcludedMethods()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of excluded HTTP methods

Returns:

the filter list of excluded HTTP methods

See Also:

• getIncludedMethods()

getExcludedMimeTypes

public String[] getExcludedMimeTypes()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of excluded MIME types

Returns:

the filter list of excluded MIME types

See Also:

• getIncludedMimeTypes()

getExcludedPaths

public String[] getExcludedPaths()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of excluded Path Specs

Returns:

the filter list of excluded Path Specs

See Also:

• getIncludedPaths()

getExcludedInflationPaths

public String[] getExcludedInflationPaths()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of excluded Path Specs for request inflation.

Returns:

the filter list of excluded Path Specs

See Also:

• getIncludedInflationPaths()

getIncludedMethods

public String[] getIncludedMethods()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of included HTTP Methods

Returns:

the filter list of included HTTP methods

See Also:

• getExcludedMethods()

getIncludedMimeTypes

public String[] getIncludedMimeTypes()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of included MIME types

Returns:

the filter list of included MIME types

See Also:

• getExcludedMimeTypes()

getIncludedPaths

public String[] getIncludedPaths()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of included Path Specs

Returns:

the filter list of included Path Specs

See Also:

• getExcludedPaths()

getIncludedInflationPaths

public String[] getIncludedInflationPaths()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the current filter list of included Path Specs for request inflation.

Returns:

the filter list of included Path Specs

See Also:

• getExcludedInflationPaths()

getMinGzipSize

public int getMinGzipSize()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the minimum size, in bytes, that a response Content-Length must be before compression will trigger.

Returns:

minimum response size (in bytes) that triggers compression

See Also:

• setMinGzipSize(int)

getInflateBufferSize

public int getInflateBufferSize()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the size (in bytes) of the Inflater buffer used to inflate compressed requests.

Returns:

size in bytes of the buffer, or 0 for no inflation.

setInflateBufferSize

public void setInflateBufferSize(int size)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the size (in bytes) of the Inflater buffer used to inflate comrpessed requests.

Parameters:

size - size in bytes of the buffer, or 0 for no inflation.

handle

public boolean handle(Request request,
 Response response,
 org.eclipse.jetty.util.Callback callback)
               throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Request.Handler

Invoked to handle the passed HTTP request and response.

The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

The simplest implementation is:

 public boolean handle(Request request, Response response, Callback callback)
 {
     callback.succeeded();
     return true;
 }
 

A HelloWorld implementation is:

 public boolean handle(Request request, Response response, Callback callback)
 {
     response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
     return true;
 }
 

Specified by:

handle in interface Request.Handler

Overrides:

handle in class Handler.Wrapper

Parameters:

request - the HTTP request to handle

response - the HTTP response to handle

callback - the callback to complete when the handling is complete

Returns:

True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.

Throws:

Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.

See Also:

• Request.Handler.AbortException

isMimeTypeDeflatable

protected boolean isMimeTypeDeflatable(org.eclipse.jetty.http.MimeTypes mimeTypes,
 String requestURI)

Deprecated, for removal: This API element is subject to removal in a future version.

isMimeTypeDeflatable

public boolean isMimeTypeDeflatable(String mimetype)

Deprecated, for removal: This API element is subject to removal in a future version.

Test if the provided MIME type is allowed based on the MIME type filters.

Specified by:

isMimeTypeDeflatable in interface GzipFactory

Parameters:

mimetype - the MIME type to test

Returns:

true if allowed, false otherwise

isPathDeflatable

protected boolean isPathDeflatable(String requestURI)

Deprecated, for removal: This API element is subject to removal in a future version.

Test if the provided Request URI is allowed based on the Path Specs filters.

Parameters:

requestURI - the request uri

Returns:

whether compressing is allowed for the given the path

isPathInflatable

protected boolean isPathInflatable(String pathInContext)

Deprecated, for removal: This API element is subject to removal in a future version.

Test if the provided Request URI is allowed to be inflated based on the Path Specs filters.

Parameters:

pathInContext - the request path in context

Returns:

whether decompressing is allowed for the given the path.

setExcludedMethods

public void setExcludedMethods(String... methods)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the excluded filter list of HTTP methods (replacing any previously set)

Parameters:

methods - the HTTP methods to exclude

See Also:

• setIncludedMethods(String...)

setExcludedMimeTypes

public void setExcludedMimeTypes(String... types)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the excluded filter list of MIME types (replacing any previously set)

Parameters:

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

See Also:

• setIncludedMimeTypes(String...)

setExcludedMimeTypesList

public void setExcludedMimeTypesList(String csvTypes)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the excluded filter list of MIME types (replacing any previously set)

Parameters:

csvTypes - The list of mime types to exclude (without charset or other parameters), CSV format

See Also:

• setIncludedMimeTypesList(String)

setExcludedPaths

public void setExcludedPaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the excluded filter list of Path specs (replacing any previously set)

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.

See Also:

• setIncludedPaths(String...)

setExcludedInflatePaths

public void setExcludedInflatePaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the excluded filter list of Path specs (replacing any previously set)

Parameters:

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

See Also:

• setIncludedInflatePaths(String...)

setIncludedMethods

public void setIncludedMethods(String... methods)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the included filter list of HTTP methods (replacing any previously set)

Parameters:

methods - The methods to include in compression

See Also:

• setExcludedMethods(String...)

setIncludedMimeTypes

public void setIncludedMimeTypes(String... types)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the included filter list of MIME types (replacing any previously set)

Parameters:

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

See Also:

• setExcludedMimeTypes(String...)

setIncludedMimeTypesList

public void setIncludedMimeTypesList(String csvTypes)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the included filter list of MIME types (replacing any previously set)

Parameters:

csvTypes - The list of mime types to include (without charset or other parameters), CSV format

See Also:

• setExcludedMimeTypesList(String)

setIncludedPaths

public void setIncludedPaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the included filter list of Path specs (replacing any previously set)

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

See Also:

• setExcludedPaths(String...)

setIncludedInflatePaths

public void setIncludedInflatePaths(String... pathspecs)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the included filter list of Path specs (replacing any previously set)

Parameters:

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

See Also:

• setExcludedInflatePaths(String...)

setMinGzipSize

public void setMinGzipSize(int minGzipSize)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the minimum response size to trigger dynamic compression.

Sizes below BREAK_EVEN_GZIP_SIZE will result a compressed response that is larger than the original data.

Parameters:

minGzipSize - minimum response size in bytes (not allowed to be lower then BREAK_EVEN_GZIP_SIZE)

setIncludedMethodList

public void setIncludedMethodList(String csvMethods)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the included filter list of HTTP Methods (replacing any previously set)

Parameters:

csvMethods - the list of methods, CSV format

See Also:

• setExcludedMethodList(String)

getIncludedMethodList

public String getIncludedMethodList()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the included filter list of HTTP methods in CSV format

Returns:

the included filter list of HTTP methods in CSV format

See Also:

• getExcludedMethodList()

setExcludedMethodList

public void setExcludedMethodList(String csvMethods)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the excluded filter list of HTTP Methods (replacing any previously set)

Parameters:

csvMethods - the list of methods, CSV format

See Also:

• setIncludedMethodList(String)

getExcludedMethodList

public String getExcludedMethodList()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the excluded filter list of HTTP methods in CSV format

Returns:

the excluded filter list of HTTP methods in CSV format

See Also:

• getIncludedMethodList()

getDeflaterPool

public org.eclipse.jetty.util.compression.DeflaterPool getDeflaterPool()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the DeflaterPool being used. The default value of this is null before starting, but after starting if it is null it will be set to the default DeflaterPool which is stored as a bean on the server.

Returns:

the DeflaterPool being used.

getInflaterPool

public org.eclipse.jetty.util.compression.InflaterPool getInflaterPool()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the InflaterPool being used. The default value of this is null before starting, but after starting if it is null it will be set to the default InflaterPool which is stored as a bean on the server.

Returns:

the DeflaterPool being used.

setDeflaterPool

public void setDeflaterPool(org.eclipse.jetty.util.compression.DeflaterPool deflaterPool)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the DeflaterPool to be used. This should be called before starting. If this value is null when starting the default pool will be used from the server.

Parameters:

deflaterPool - the DeflaterPool to use.

setInflaterPool

public void setInflaterPool(org.eclipse.jetty.util.compression.InflaterPool inflaterPool)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the InflaterPool to be used. This should be called before starting. If this value is null when starting the default pool will be used from the server.

Parameters:

inflaterPool - the InflaterPool to use.

toString

public String toString()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

toString in class org.eclipse.jetty.util.component.AbstractLifeCycle