org.nuxeo.ecm.core.transientstore

Class AbstractTransientStore

java.lang.Object

org.nuxeo.ecm.core.transientstore.AbstractTransientStore

All Implemented Interfaces:

TransientStore

Direct Known Subclasses:

RedisTransientStore, SimpleTransientStore

public abstract class AbstractTransientStore
extends Object
implements TransientStore

Base class for TransientStore implementation.

Since:

7.2

Author:

Tiry

Constructor Summary

Constructors

Constructor and Description
AbstractTransientStore()

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
abstract Class<? extends Cache>	getCacheImplClass()
File	getCachingDirectory(String key)
TransientStoreConfig	getConfig() Returns the Store configuration
Cache	getL1Cache()
Cache	getL2Cache()
abstract long	getStorageSize()
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTransientStore

public AbstractTransientStore()

Method Detail

init

public void init(TransientStoreConfig config)

Description copied from interface: TransientStore

Initialize the store from the configuration

Specified by:

init in interface TransientStore

shutdown

public void shutdown()

Specified by:

shutdown in interface TransientStore

getStorageSize

public abstract long getStorageSize()

getL1Cache

public Cache getL1Cache()

getL2Cache

public Cache getL2Cache()

put

public void put(StorageEntry entry)
         throws IOException

Description copied from interface: TransientStore

Add a new entry in the Store

Specified by:

put in interface TransientStore

Throws:

IOException

get

public StorageEntry get(String key)
                 throws IOException

Description copied from interface: TransientStore

Retrieve a new entry inside the Store

Specified by:

get in interface TransientStore

Returns:

the corresponding StorageEntry or null

Throws:

IOException

remove

public void remove(String key)
            throws IOException

Description copied from interface: TransientStore

Remove an entry from the Store

Specified by:

remove in interface TransientStore

Throws:

IOException

canDelete

public void canDelete(String key)
               throws IOException

Description copied from interface: TransientStore

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

Specified by:

canDelete in interface TransientStore

Throws:

IOException

removeAll

public void removeAll()
               throws IOException

Description copied from interface: TransientStore

Deletes all entries inside the Store

Specified by:

removeAll in interface TransientStore

Throws:

IOException - *

getConfig

public TransientStoreConfig getConfig()

Description copied from interface: TransientStore

Returns the Store configuration

Specified by:

getConfig in interface TransientStore

Returns:

the TransientStoreConfig

getStorageSizeMB

public int getStorageSizeMB()

Description copied from interface: TransientStore

Return the size of the disk storage used

Specified by:

getStorageSizeMB in interface TransientStore

Returns:

the size of the disk storage used in MB

getCachingDirectory

public File getCachingDirectory(String key)

doGC

public void doGC()

Description copied from interface: TransientStore

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

Specified by:

doGC in interface TransientStore

getCacheImplClass

public abstract Class<? extends Cache> getCacheImplClass()