org.nuxeo.ecm.core.transientstore.api

Interface TransientStore

All Known Implementing Classes:

AbstractTransientStore, RedisTransientStore, SimpleTransientStore

@Experimental(comment="https://jira.nuxeo.com/browse/NXP-16577")
public interface TransientStore

Service Interface for managing a transient store.

Since:

7.2

Author:

Tiry

Method Summary

Methods

Modifier and Type	Method and Description
void	canDelete(String key) Informs the Store that the entry can be deleted if TTL or GC parameters requires to do some cleanup
void	doGC() Runs the Garbage Collecting to delete the Filesystem resources that may correspond to cache entries that were removed
StorageEntry	get(String key) Retrieve a new entry inside the Store
TransientStoreConfig	getConfig() Returns the Store configuration
int	getStorageSizeMB() Return the size of the disk storage used
void	init(TransientStoreConfig config) Initialize the store from the configuration
void	put(StorageEntry entry) Add a new entry in the Store
void	remove(String key) Remove an entry from the Store
void	removeAll() Deletes all entries inside the Store
void	shutdown()

Method Detail

put

void put(StorageEntry entry)
         throws IOException

Add a new entry in the Store

Parameters:

entry -

Throws:

IOException

get

StorageEntry get(String key)
                 throws IOException

Retrieve a new entry inside the Store

Parameters:

key -

Returns:

the corresponding StorageEntry or null

Throws:

IOException

remove

void remove(String key)
            throws IOException

Remove an entry from the Store

Parameters:

key -

Throws:

IOException

canDelete

void canDelete(String key)
               throws IOException

Informs the Store that the entry can be deleted if TTL or GC parameters requires to do some cleanup

Parameters:

key -

Throws:

IOException

removeAll

void removeAll()
               throws IOException

Deletes all entries inside the Store

Throws:

IOException - *

getConfig

TransientStoreConfig getConfig()
                               throws IOException

Returns the Store configuration

Returns:

the TransientStoreConfig

Throws:

IOException

doGC

void doGC()

Runs the Garbage Collecting to delete the Filesystem resources that may correspond to cache entries that were removed

getStorageSizeMB

int getStorageSizeMB()

Return the size of the disk storage used

Returns:

the size of the disk storage used in MB

shutdown

void shutdown()

init

void init(TransientStoreConfig config)

Initialize the store from the configuration

Parameters:

config -