Class ZstandardCompression

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.compression.Compression

org.eclipse.jetty.compression.zstandard.ZstandardCompression

All Implemented Interfaces:

Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

public class ZstandardCompression
extends Compression

Compression for Zstandard.

Note about ByteBufferPool: the zstd-jni project requires ByteBuffer implementations that are array backed with a zero arrayOffset.

See Also:

• RFC 8478 - Zstandard Compression and the application/zstd Media Type
• Uses zstd-jni

Nested Class Summary

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.util.component.LifeCycle

LifeCycle.Listener

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
ZstandardCompression()

Method Summary

Modifier and Type	Method	Description
RetainableByteBuffer.Mutable	acquireByteBuffer(int length)	Acquire a RetainableByteBuffer that is managed by this Compression implementation which is suitable for compressed output from an EncoderSink or compressed input from a DecoderSource.
HttpField	getContentEncodingField()	The HttpField for Content-Encoding suitable for this Compression implementation.
DecoderConfig	getDefaultDecoderConfig()
EncoderConfig	getDefaultEncoderConfig()
List<String>	getFileExtensionNames()	The filename extensions for this compression implementation.
String	getName()
HttpField	getXContentEncodingField()	The HttpField for X-Content-Encoding suitable for this Compression implementation.
InputStream	newDecoderInputStream(InputStream in, DecoderConfig config)	Create a new InputStream to decode (decompress) with this compression implementation.
DecoderSource	newDecoderSource(Content.Source source, DecoderConfig config)	Create a new DecoderSource for this compression implementation
OutputStream	newEncoderOutputStream(OutputStream out, EncoderConfig config)	Create a new OutputStream to encode (compress) with this compression implementation.
EncoderSink	newEncoderSink(Content.Sink sink, EncoderConfig config)	Create a new EncoderSink for this compression implementation
void	setDefaultDecoderConfig(DecoderConfig config)
void	setDefaultEncoderConfig(EncoderConfig config)
void	setMinCompressSize(int minCompressSize)

Methods inherited from class org.eclipse.jetty.compression.Compression

doStart, etag, getBufferSize, getByteBufferPool, getContainer, getEncodingName, getEtagSuffix, getMinCompressSize, newDecoderInputStream, newDecoderSource, newEncoderOutputStream, newEncoderSink, setBufferSize, setByteBufferPool, setContainer, stripSuffixes

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

addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, 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, toString

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

dumpSelf

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

isDumpable

Constructor Details

ZstandardCompression

public ZstandardCompression()

Method Details

acquireByteBuffer

public RetainableByteBuffer.Mutable acquireByteBuffer(int length)

Description copied from class: Compression

Acquire a RetainableByteBuffer that is managed by this Compression implementation which is suitable for compressed output from an EncoderSink or compressed input from a DecoderSource.

It is recommended to use this method so that any compression specific details can be managed by this Compression implementation (such as ByteOrder or buffer pooling)

Specified by:

acquireByteBuffer in class Compression

Parameters:

length - the requested size of the buffer

Returns:

the ByteBuffer suitable for this compression implementation.

getContentEncodingField

public HttpField getContentEncodingField()

Description copied from class: Compression

The HttpField for Content-Encoding suitable for this Compression implementation.

Specified by:

getContentEncodingField in class Compression

Returns:

the HttpField for Content-Encoding.

getDefaultDecoderConfig

public DecoderConfig getDefaultDecoderConfig()

Specified by:

getDefaultDecoderConfig in class Compression

setDefaultDecoderConfig

public void setDefaultDecoderConfig(DecoderConfig config)

Specified by:

setDefaultDecoderConfig in class Compression

getDefaultEncoderConfig

public EncoderConfig getDefaultEncoderConfig()

Specified by:

getDefaultEncoderConfig in class Compression

setDefaultEncoderConfig

public void setDefaultEncoderConfig(EncoderConfig config)

Specified by:

setDefaultEncoderConfig in class Compression

getFileExtensionNames

public List<String> getFileExtensionNames()

Description copied from class: Compression

The filename extensions for this compression implementation.

Not an exhaustive list, just the most commonly seen extensions.

Specified by:

getFileExtensionNames in class Compression

Returns:

the list of common extension names (all lowercase) for this compression implementation. ordered by most common to least common.

setMinCompressSize

public void setMinCompressSize(int minCompressSize)

Overrides:

setMinCompressSize in class Compression

getName

public String getName()

Specified by:

getName in class Compression

Returns:

the name of the compression implementation.

getXContentEncodingField

public HttpField getXContentEncodingField()

Description copied from class: Compression

The HttpField for X-Content-Encoding suitable for this Compression implementation.

Specified by:

getXContentEncodingField in class Compression

Returns:

the HttpField for X-Content-Encoding.

newDecoderInputStream

public InputStream newDecoderInputStream(InputStream in,
 DecoderConfig config)
                                  throws IOException

Description copied from class: Compression

Create a new InputStream to decode (decompress) with this compression implementation.

Specified by:

newDecoderInputStream in class Compression

Parameters:

in - the input stream to write the decoded (decompressed) bytes to

config - the DecoderConfig for this input stream.

Returns:

the InputStream implementation for this compression.

Throws:

IOException - if unable to create InputStream

newDecoderSource

public DecoderSource newDecoderSource(Content.Source source,
 DecoderConfig config)

Description copied from class: Compression

Create a new DecoderSource for this compression implementation

Specified by:

newDecoderSource in class Compression

Parameters:

source - the source to write the decoded bytes to

config - the DecoderConfig for this source.

Returns:

a new DecoderSource

newEncoderOutputStream

public OutputStream newEncoderOutputStream(OutputStream out,
 EncoderConfig config)
                                    throws IOException

Description copied from class: Compression

Create a new OutputStream to encode (compress) with this compression implementation.

Specified by:

newEncoderOutputStream in class Compression

Parameters:

out - the output stream to write the encoded (compressed) bytes to

config - the EncoderConfig for this output stream.

Returns:

the OutputStream implementation for this compression.

Throws:

IOException - if unable to create OutputStream

newEncoderSink

public EncoderSink newEncoderSink(Content.Sink sink,
 EncoderConfig config)

Description copied from class: Compression

Create a new EncoderSink for this compression implementation

Specified by:

newEncoderSink in class Compression

Parameters:

sink - the sink to write the encoded bytes to

config - the EncoderConfig for this sink.

Returns:

a new EncoderSink