org.nuxeo.ecm.core.transientstore.api

Interface TransientStoreProvider

All Superinterfaces:

TransientStore

All Known Implementing Classes:

AbstractTransientStore, KeyValueBlobTransientStore, RedisTransientStore, SimpleTransientStore

public interface TransientStoreProvider
extends TransientStore

Transient Store SPI.

Since:

9.3

Method Summary

Modifier and Type	Method and Description
void	doGC() Runs garbage collecting to delete the file system resources that are associated with entries that were removed.
long	getStorageSize() Returns the size (in bytes) of the disk storage used for blobs.
default int	getStorageSizeMB() Deprecated. since 9.3 because it is imprecise, use getStorageSize() instead
void	init(TransientStoreConfig config) Initializes the store from the given config.
default Set<String>	keySet() Returns the set of keys for all entries.
Stream<String>	keyStream() Returns a Stream of keys for all entries.
void	removeAll() Removes all entries from the store.
void	shutdown() Shuts down the store.

Methods inherited from interface org.nuxeo.ecm.core.transientstore.api.TransientStore

exists, getBlobs, getParameter, getParameters, getSize, isCompleted, putBlobs, putParameter, putParameters, release, remove, setCompleted

Method Detail

init

void init(TransientStoreConfig config)

Initializes the store from the given config.

Since:

7.2

shutdown

void shutdown()

Shuts down the store.

Since:

7.2

keySet

default Set<String> keySet()

Returns the set of keys for all entries.

Since:

8.3

keyStream

Stream<String> keyStream()

Returns a Stream of keys for all entries.

Since:

9.3

getStorageSizeMB

@Deprecated
default int getStorageSizeMB()

Deprecated. since 9.3 because it is imprecise, use getStorageSize() instead

Returns the size (in MB) of the disk storage used for blobs.

Returns:

the number of MB (rounded down) used by stored blobs

Since:

7.2

getStorageSize

long getStorageSize()

Returns the size (in bytes) of the disk storage used for blobs.

Returns:

the number of bytes used by stored blobs

Since:

9.3

doGC

void doGC()

Runs garbage collecting to delete the file system resources that are associated with entries that were removed.

Since:

7.2

removeAll

void removeAll()

Removes all entries from the store.

Since:

7.2