Package org.nuxeo.ecm.core.convert.extension

Class ConvertCacheDescriptor

java.lang.Object

org.nuxeo.ecm.core.convert.extension.ConvertCacheDescriptor

All Implemented Interfaces:

Descriptor

public class ConvertCacheDescriptor
extends Object
implements Descriptor

Since:

2025.0

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_CACHE_ENABLED
static final String	DEFAULT_CACHING_DIRECTORY
static final ByteSize	DEFAULT_DISK_CACHE
static final long	DEFAULT_DISK_CACHE_IN_KB	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.11, use DEFAULT_DISK_CACHE instead
static final Duration	DEFAULT_GC_RATE
protected String	directory
protected Boolean	enabled
protected Duration	gcRate	The rate to run the GC.
protected ByteSize	maxSize	The maximum byte size to reach to run the GC.

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
ConvertCacheDescriptor()

Method Summary

Modifier and Type	Method	Description
Path	getDirectory()
Duration	getGcRate()
String	getId()	The descriptor id, descriptors with same id are merged.
ByteSize	getMaxSize()
long	getMaxSizeKB()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.11, use getMaxSize() instead
boolean	isEnabled()
Descriptor	merge(Descriptor o)	Returns a descriptor representing other merged into this
protected void	setMaxSizeKB(Long maxSizeKB)	Deprecated. since 2025.11

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove

Field Details

DEFAULT_CACHE_ENABLED

public static final boolean DEFAULT_CACHE_ENABLED

See Also:

• Constant Field Values

DEFAULT_CACHING_DIRECTORY

public static final String DEFAULT_CACHING_DIRECTORY

See Also:

• Constant Field Values

DEFAULT_GC_RATE

public static final Duration DEFAULT_GC_RATE

DEFAULT_DISK_CACHE

public static final ByteSize DEFAULT_DISK_CACHE

DEFAULT_DISK_CACHE_IN_KB

@Deprecated(since="2025.11",
            forRemoval=true)
public static final long DEFAULT_DISK_CACHE_IN_KB

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.11, use DEFAULT_DISK_CACHE instead

enabled

protected Boolean enabled

directory

protected String directory

gcRate

protected Duration gcRate

The rate to run the GC.

maxSize

protected ByteSize maxSize

The maximum byte size to reach to run the GC.

Use a negative value to clear the cache on each GC run.

Constructor Details

ConvertCacheDescriptor

public ConvertCacheDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

isEnabled

public boolean isEnabled()

getDirectory

public Path getDirectory()

getGcRate

public Duration getGcRate()

getMaxSize

public ByteSize getMaxSize()

Since:

2025.11

getMaxSizeKB

@Deprecated(since="2025.11",
            forRemoval=true)
public long getMaxSizeKB()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.11, use getMaxSize() instead

setMaxSizeKB

protected void setMaxSizeKB(Long maxSizeKB)

Deprecated.

since 2025.11

Since:

2025.11, for backward compatibility purpose

merge

public Descriptor merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor