Class CompressionHandler
- All Implemented Interfaces:
Handler
,Handler.Container
,Handler.Singleton
,Request.Handler
,Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,LifeCycle
,Invocable
CompressionHandler to provide compression of response bodies and decompression of request bodies.
Supports any arbitrary Content-Encoding
via Compression
implementations such as gzip
, zstd
, and brotli
, discovered via ServiceLoader
.
Configuration is handled by associating a CompressionConfig
against a PathSpec
.
By default, if no configuration is specified, then a default CompressionConfig
is
assigned to the /
PathSpec
.
-
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
AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
Container.InheritedListener, Container.Listener
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer, 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
Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request.Handler
Request.Handler.AbortException
-
Field Summary
FieldsFields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
FAILED, STARTED, STARTING, STOPPED, STOPPING
Fields inherited from interface org.eclipse.jetty.util.thread.Invocable
__nonBlocking, NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doStart()
Starts the managed lifecycle beans in the order they were added.ensureConfiguration
(String pathSpecString) Obtain a CompressionConfig for the specified PathSpec.ensureConfiguration
(PathSpec pathSpec) Obtain a CompressionConfig for the specified PathSpec.getConfiguration
(String pathSpecString) Get theCompressionConfig
associated with thisPathSpec
getConfiguration
(PathSpec pathSpec) Get theCompressionConfig
associated with thisPathSpec
boolean
Invoked to handle the passed HTTP request and response.putCompression
(Compression compression) Registers support for a Compression implementation to this Handler.putConfiguration
(String pathSpecString, CompressionConfig config) Establish aCompressionConfig
associated with the specificPathSpec
putConfiguration
(PathSpec pathSpec, CompressionConfig config) Establish aCompressionConfig
associated with the specificPathSpec
removeCompression
(String encodingName) Unregisters a specific Compression implementation.toString()
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, doStop, 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.DumpableContainer
isDumpable
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
-
HANDLER_ETAGS
-
-
Constructor Details
-
CompressionHandler
public CompressionHandler() -
CompressionHandler
-
-
Method Details
-
putCompression
Registers support for a Compression implementation to this Handler.- Parameters:
compression
- the compression implementation.- Returns:
- the previously registered compression with the same encoding name, can be null.
-
removeCompression
Unregisters a specific Compression implementation.- Parameters:
encodingName
- the encoding name of the compression to remove.- Returns:
- the Compression that was removed, can be null if no Compression exists on that encoding name.
-
ensureConfiguration
Obtain a CompressionConfig for the specified PathSpec.This is different from
getConfiguration(PathSpec)
, which will return null if the mapping to the providedPathSpec
does not exist.- Parameters:
pathSpec
- thePathSpec
to look for.- Returns:
- the
CompressionConfig
associated with thePathSpec
, mapping is created if it didn't previously exist.
-
ensureConfiguration
Obtain a CompressionConfig for the specified PathSpec.This is different from
getConfiguration(PathSpec)
, which will return null if the mapping to the providedPathSpec
does not exist.- Parameters:
pathSpecString
- the string representation of the path spec.- Returns:
- the
CompressionConfig
associated with thePathSpec
, mapping is created if it didn't previously exist. - See Also:
-
getConfiguration
Get theCompressionConfig
associated with thisPathSpec
- Parameters:
pathSpec
- the PathSpec to look for- Returns:
- the
CompressionConfig
mapped to thePathSpec
, null if nothing is mapped to thePathSpec
-
getConfiguration
Get theCompressionConfig
associated with thisPathSpec
- Parameters:
pathSpecString
- the string representation of the path spec.- Returns:
- the
CompressionConfig
mapped to thePathSpec
, null if nothing is mapped to thePathSpec
-
putConfiguration
Establish aCompressionConfig
associated with the specificPathSpec
- Parameters:
pathSpec
- the path spec to use as the keyconfig
- the config to use as the value- Returns:
- the old
CompressionConfig
if one was previously set. - See Also:
-
putConfiguration
Establish aCompressionConfig
associated with the specificPathSpec
- Parameters:
pathSpecString
- the string representation of the path spec.config
- the config to use as the value- Returns:
- the old
CompressionConfig
if one was previously set. - See Also:
-
doStart
Description copied from class:ContainerLifeCycle
Starts the managed lifecycle beans in the order they were added.- Overrides:
doStart
in classHandler.Abstract
- Throws:
Exception
- If there was a problem starting. Will cause a transition to FAILED state
-
handle
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 interfaceRequest.Handler
- Overrides:
handle
in classHandler.Wrapper
- Parameters:
request
- the HTTP request to handleresponse
- the HTTP response to handlecallback
- 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:
-
toString
- Overrides:
toString
in classAbstractLifeCycle
-