Package org.opensearch.core.compress

Class CompressorRegistry

java.lang.Object

org.opensearch.core.compress.CompressorRegistry

@InternalApi
public final class CompressorRegistry
extends Object

A registry that wraps a static Map singleton which holds a mapping of unique String names (typically the compressor header as a string) to registerd Compressor implementations.

This enables plugins, modules, extensions to register their own compression implementations through SPI

Opensearch.internal:

Opensearch.experimental:

Method Summary

Modifier and Type	Method	Description
static Compressor	compressor(BytesReference bytes)
static Compressor	compressorForWritable(BytesReference bytes)
static Compressor	defaultCompressor()	Returns the default compressor
static Compressor	getCompressor(String name)	Returns a registered compressor by its registered name
static boolean	isCompressed(BytesReference bytes)
static Compressor	none()
static Map<String,Compressor>	registeredCompressors()	Returns the registered compressors as an Immutable collection
static BytesReference	uncompress(BytesReference bytes)	Decompress the provided BytesReference.
static BytesReference	uncompressIfNeeded(BytesReference bytes)	Uncompress the provided data, data can be detected as compressed using isCompressed(BytesReference).

Methods inherited from class java.lang.Object

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

Method Details

defaultCompressor

public static Compressor defaultCompressor()

Returns the default compressor

none

public static Compressor none()

isCompressed

public static boolean isCompressed(BytesReference bytes)

compressor

@Nullable
public static Compressor compressor(BytesReference bytes)

compressorForWritable

public static Compressor compressorForWritable(BytesReference bytes)

Parameters:

bytes - The bytes to check the compression for

Returns:

The detected compressor. If no compressor detected then return NoneCompressor.

uncompress

public static BytesReference uncompress(BytesReference bytes)
                                 throws IOException

Decompress the provided BytesReference.

Throws:

IOException

uncompressIfNeeded

public static BytesReference uncompressIfNeeded(BytesReference bytes)
                                         throws IOException

Uncompress the provided data, data can be detected as compressed using isCompressed(BytesReference).

Throws:

IOException

getCompressor

public static Compressor getCompressor(String name)

Returns a registered compressor by its registered name

registeredCompressors

public static Map<String,Compressor> registeredCompressors()

Returns the registered compressors as an Immutable collection

note: used for testing