Package org.exoplatform.services.cache.concurrent

Class SimpleReplicatedExoCache<K extends Serializable,V extends Serializable>

java.lang.Object

org.exoplatform.services.cache.concurrent.ConcurrentFIFOExoCache<K,V>

org.exoplatform.services.cache.concurrent.SimpleReplicatedExoCache<K,V>

All Implemented Interfaces:

ExoCache<K,V>

public class SimpleReplicatedExoCache<K extends Serializable,V extends Serializable>
extends ConcurrentFIFOExoCache<K,V>

This implementation of ExoCache will behave exactly the same way as ConcurrentFIFOExoCache except in case of a cache change, indeed the modifications will be first applied locally then it will be replicated over the cluster asynchronously to limit the performance impact on the local cluster node.

This class can be used as a drop-in replacement for ConcurrentFIFOExoCache in a cluster environment as long as we know that modifications like remove, clearCache, removeCachedObjects, put or putMap happen rarely. In other words, it should be used for caches that rarely change.

This limitation is due to the fact that the mechanism used for the replication has not been designed to support heavy load so it must be used with a lot of caution.

Version:

$Id$

Author:

Nicolas Filotto

Constructor Summary

Constructors

Constructor	Description
SimpleReplicatedExoCache()

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the cache.
protected void	finalize()
void	put(K name, V obj)	Performs a put in the cache.
void	putMap(Map<? extends K,? extends V> objs)	Performs a put of all the entries provided by the map argument.
V	remove(Serializable name)	Removes an entry from the cache.
void	setName(String s)	Sets the cache name.

Methods inherited from class org.exoplatform.services.cache.concurrent.ConcurrentFIFOExoCache

addCacheListener, assertConsistent, get, getCachedObjects, getCacheHit, getCacheMiss, getCacheSize, getLabel, getListeners, getLiveTime, getLiveTimeMillis, getMaxSize, getName, isLogEnabled, onClearCache, onExpire, onGet, onPut, onPutLocal, onRemove, putLocal, removeCachedObjects, select, setLabel, setLiveTime, setLiveTimeMillis, setLogEnabled, setMaxSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exoplatform.services.cache.ExoCache

putAsyncMap, removeLocal

Constructor Details

SimpleReplicatedExoCache

public SimpleReplicatedExoCache()

Method Details

setName

public void setName(String s)

Description copied from interface: ExoCache

Sets the cache name.

Specified by:

setName in interface ExoCache<K extends Serializable,V extends Serializable>

Overrides:

setName in class ConcurrentFIFOExoCache<K extends Serializable,V extends Serializable>

Parameters:

s - the cache name

remove

public V remove(Serializable name)

Description copied from interface: ExoCache

Removes an entry from the cache.

Specified by:

remove in interface ExoCache<K extends Serializable,V extends Serializable>

Overrides:

remove in class ConcurrentFIFOExoCache<K extends Serializable,V extends Serializable>

Parameters:

name - the cache key

Returns:

the previously cached value or null if no entry existed or that entry value was evaluated to null

clearCache

public void clearCache()

Description copied from interface: ExoCache

Clears the cache.

Specified by:

clearCache in interface ExoCache<K extends Serializable,V extends Serializable>

Overrides:

clearCache in class ConcurrentFIFOExoCache<K extends Serializable,V extends Serializable>

put

public void put(K name,
 V obj)

Description copied from interface: ExoCache

Performs a put in the cache.

Specified by:

put in interface ExoCache<K extends Serializable,V extends Serializable>

Overrides:

put in class ConcurrentFIFOExoCache<K extends Serializable,V extends Serializable>

Parameters:

name - the cache key

obj - the cached value

putMap

public void putMap(Map<? extends K,? extends V> objs)

Description copied from interface: ExoCache

Performs a put of all the entries provided by the map argument.

Specified by:

putMap in interface ExoCache<K extends Serializable,V extends Serializable>

Overrides:

putMap in class ConcurrentFIFOExoCache<K extends Serializable,V extends Serializable>

Parameters:

objs - the objects to put

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable