Package org.apache.logging.log4j.core.appender.rolling.action

Interface CompressActionFactoryProvider

@NullMarked
public interface CompressActionFactoryProvider

Interface for plugins that provide additional compression algorithms.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAMESPACE

Method Summary

Modifier and Type	Method	Description
@Nullable CompressActionFactory	createFactoryForAlgorithm(String algorithm)	Creates the appropriate CompressActionFactory for the given compression algorithm.
default @Nullable CompressActionFactory	createFactoryForFileName(String fileName)	Creates the appropriate CompressActionFactory for the given file name.
static CompressActionFactoryProvider	newInstance(@Nullable Configuration configuration)

Field Details

NAMESPACE

static final String NAMESPACE

See Also:

• Constant Field Values

Method Details

createFactoryForAlgorithm

@Nullable CompressActionFactory createFactoryForAlgorithm(String algorithm)

Creates the appropriate CompressActionFactory for the given compression algorithm.

When applicable the algorithm should correspond to the name used by Apache Commons Compress.

Parameters:

algorithm - The compression algorithm.

Returns:

A CompressActionFactory or null if the extension is not supported.

createFactoryForFileName

default @Nullable CompressActionFactory createFactoryForFileName(String fileName)

Creates the appropriate CompressActionFactory for the given file name.

Parameters:

fileName - The file name.

Returns:

A CompressActionFactory or null if the extension is not supported.

newInstance

static CompressActionFactoryProvider newInstance(@Nullable Configuration configuration)