Package org.exoplatform.services.cache.invalidation

Class AsyncInvalidationExoCache<K extends Serializable,V>

java.lang.Object

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

org.exoplatform.services.cache.invalidation.AsyncInvalidationExoCache<K,V>

All Implemented Interfaces:

ExoCache<K,V>

public class AsyncInvalidationExoCache<K extends Serializable,V>
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 invalidated 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.

Constructor Summary

Constructors

Constructor	Description
AsyncInvalidationExoCache(ExoCache<K,HashCode<V>> replicatedCache)

Method Summary

Modifier and Type	Method	Description
List<ListenerContext<K,V>>	getListeners()
void	onClearCache()	on clear cache event
void	onExpire(K key, V obj)	On expire entry event
void	put(K key, V value)	Performs a put in the cache.
void	putLocal(K key, V value)	Performs a put in the cache local mode (avoid replication).
void	putMap(Map<? extends K,? extends V> objs)	Performs a put of all the entries provided by the map argument.
V	remove(Serializable key)	Removes an entry from the cache.
void	removeLocal(Serializable key)	Removes an entry from the cache local mode (avoid replication).

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

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

Methods inherited from class java.lang.Object

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

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

putAsyncMap

Constructor Detail

AsyncInvalidationExoCache

public AsyncInvalidationExoCache(ExoCache<K,HashCode<V>> replicatedCache)

Method Detail

put

public void put(K key,
                V value)
         throws NullPointerException

Description copied from interface: ExoCache

Performs a put in the cache.

Specified by:

put in interface ExoCache<K extends Serializable,V>

Overrides:

put in class ConcurrentFIFOExoCache<K extends Serializable,V>

Parameters:

key - the cache key

value - the cached value

Throws:

NullPointerException - if the key is null

putLocal

public void putLocal(K key,
                     V value)
              throws NullPointerException

Description copied from interface: ExoCache

Performs a put in the cache local mode (avoid replication).

Specified by:

putLocal in interface ExoCache<K extends Serializable,V>

Overrides:

putLocal in class ConcurrentFIFOExoCache<K extends Serializable,V>

Parameters:

key - the cache key

value - the cached value

Throws:

NullPointerException - if the key is null

remove

public V remove(Serializable key)
         throws NullPointerException

Description copied from interface: ExoCache

Removes an entry from the cache.

Specified by:

remove in interface ExoCache<K extends Serializable,V>

Overrides:

remove in class ConcurrentFIFOExoCache<K extends Serializable,V>

Parameters:

key - the cache key

Returns:

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

Throws:

NullPointerException - if the provided key is null

removeLocal

public void removeLocal(Serializable key)
                 throws NullPointerException

Description copied from interface: ExoCache

Removes an entry from the cache local mode (avoid replication).

Parameters:

key - the cache key

Throws:

NullPointerException - if the provided key is null

putMap

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

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>

Overrides:

putMap in class ConcurrentFIFOExoCache<K extends Serializable,V>

Parameters:

objs - the objects to put

Throws:

NullPointerException - if the provided argument is null

IllegalArgumentException - if the provided map contains a null key

onExpire

public void onExpire(K key,
                     V obj)

Description copied from interface: ExoCache

On expire entry event

Specified by:

onExpire in interface ExoCache<K extends Serializable,V>

Overrides:

onExpire in class ConcurrentFIFOExoCache<K extends Serializable,V>

Parameters:

key - entry key

obj - value

onClearCache

public void onClearCache()

Description copied from interface: ExoCache

on clear cache event

Specified by:

onClearCache in interface ExoCache<K extends Serializable,V>

Overrides:

onClearCache in class ConcurrentFIFOExoCache<K extends Serializable,V>

getListeners

public List<ListenerContext<K,V>> getListeners()

Overrides:

getListeners in class ConcurrentFIFOExoCache<K extends Serializable,V>