public Class GzipHandler

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

Parameters

pathspecs:String[]

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

Add excluded to the HTTP methods filtering.

Parameters

methods:String[]

The methods to exclude in compression

See Also

addIncludedMethods(String...)

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:String[]

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

See Also

addIncludedMimeTypes(String...)

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

Parameters

pathspecs:String[]

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

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

Parameters

pathspecs:String[]

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

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

Parameters

methods:String[]

The HTTP methods to include in compression.

See Also

addExcludedMethods(String...)

Add included MIME types for response filtering

Parameters

types:String[]

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

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

Parameters

pathspecs:String[]

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

Implements org.eclipse.jetty.server.handler.gzip.GzipFactory.getDeflaterEntry.

Annotations

@Override

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

the DeflaterPool being used.

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

Returns:String[]

the filter list of excluded Path Specs

See Also

getIncludedInflationPaths()

Get the excluded filter list of HTTP methods in CSV format

Returns:String

the excluded filter list of HTTP methods in CSV format

See Also

getIncludedMethodList()

Get the current filter list of excluded HTTP methods

Returns:String[]

the filter list of excluded HTTP methods

See Also

getIncludedMethods()

Get the current filter list of excluded MIME types

Returns:String[]

the filter list of excluded MIME types

See Also

getIncludedMimeTypes()

Get the current filter list of excluded Path Specs

Returns:String[]

the filter list of excluded Path Specs

See Also

getIncludedPaths()

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

Returns:String[]

the filter list of included Path Specs

See Also

getExcludedInflationPaths()

Get the included filter list of HTTP methods in CSV format

Returns:String

the included filter list of HTTP methods in CSV format

See Also

getExcludedMethodList()

Get the current filter list of included HTTP Methods

Returns:String[]

the filter list of included HTTP methods

See Also

getExcludedMethods()

Get the current filter list of included MIME types

Returns:String[]

the filter list of included MIME types

See Also

getExcludedMimeTypes()

Get the current filter list of included Path Specs

Returns:String[]

the filter list of included Path Specs

See Also

getExcludedPaths()

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

Returns:int

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

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

the DeflaterPool being used.

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

Returns:int

minimum response size (in bytes) that triggers compression

See Also

setMinGzipSize(int)

Returns:HttpField

The VARY field to use.

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

Implements org.eclipse.jetty.server.Request.Handler.handle.

Doc from org.eclipse.jetty.server.Request.Handler.handle.

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

Parameters

request:Request

the HTTP request to handle

response:Response

the HTTP response to handle

callback:Callback

the callback to complete when the handling is complete

Returns:boolean

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.

Annotations

@Override

Exceptions

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.

Implements org.eclipse.jetty.server.handler.gzip.GzipFactory.isMimeTypeDeflatable.

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

Parameters

mimetype:String

the MIME type to test

Returns:boolean

true if allowed, false otherwise

Annotations

@Override

Is the Deflater running Deflater#SYNC_FLUSH or not.

Returns:boolean

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

See Also

setSyncFlush(boolean)

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

the DeflaterPool to use.

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

Parameters

pathspecs:String[]

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

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

Parameters

csvMethods:String

the list of methods, CSV format

See Also

setIncludedMethodList(String)

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

Parameters

methods:String[]

the HTTP methods to exclude

See Also

setIncludedMethods(String...)

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

Parameters

types:String[]

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

See Also

setIncludedMimeTypes(String...)

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

Parameters

csvTypes:String

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

See Also

setIncludedMimeTypesList(String)

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

Parameters

pathspecs:String[]

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

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

Parameters

pathspecs:String[]

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

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

Parameters

csvMethods:String

the list of methods, CSV format

See Also

setExcludedMethodList(String)

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

Parameters

methods:String[]

The methods to include in compression

See Also

setExcludedMethods(String...)

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

Parameters

types:String[]

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

See Also

setExcludedMimeTypes(String...)

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

Parameters

csvTypes:String

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

See Also

setExcludedMimeTypesList(String)

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

Parameters

pathspecs:String[]

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

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

Parameters

size:int

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

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

the InflaterPool to use.

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

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

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

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

See Also

isSyncFlush()

Parameters

vary:HttpField

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

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override