InvalidationExoCache (eXo Kernel :: Component :: Cache Service 2.4.10-UXP01 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

eXo Kernel :: Component :: Cache Service 2.4.10-UXP01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.exoplatform.services.cache.invalidation
Class InvalidationExoCache<K extends Serializable,V>

java.lang.Object
  org.exoplatform.services.cache.invalidation.InvalidationExoCache<K,V>

All Implemented Interfaces:: CacheListener<K,InvalidationExoCache.HashCode<V>>, ExoCache<K,V>

public class InvalidationExoCache<K extends Serializable,V>
extends Object
implements ExoCache<K,V>, CacheListener<K,InvalidationExoCache.HashCode<V>>
extends Object
implements ExoCache<K,V>, CacheListener<K,InvalidationExoCache.HashCode<V>>

This eXo cache type is a decorator allowing ExoCache instances that have big values or non serializable values to be replicated thanks to an invalidation mechanism. To prevent infinite loop described below, we replicate the hash code of the value such that if the hash code is the same, we don't invalidate the value locally

Cluster node #1 puts (key1, value1) into the cache
On cluster node #2 key1 is invalidated by the put call in node #1
Node #2 re-loads key1 and puts (key1, value1) into the cache
On cluster node #1 key1 is invalidated, so we get back to step #1

Version:: $Id$
Author:: Nicolas Filotto

Nested Class Summary
`static class`	`InvalidationExoCache.HashCode<V>` We use this class to propagate the hash code of the value efficiently over the network

Constructor Summary
`InvalidationExoCache(ExoCache<K,V> delegate)`
`InvalidationExoCache(ExoCache<K,V> delegate, int concurrencyLevel)`

Method Summary
`void`	`addCacheListener(CacheListener<? super K,? super V> listener)` Add a listener.
`void`	`clearCache()` Clears the cache.
`V`	`get(Serializable name)` Performs a lookup operation.
`List<? extends V>`	`getCachedObjects()` Returns a list of cached object that are considered as valid when the method is called.
`int`	`getCacheHit()` Returns the number of time the cache was queried and a valid entry was returned.
`int`	`getCacheMiss()` Returns the number of time the cache was queried and no entry was returned.
`int`	`getCacheSize()` Returns the number of entries in the cache.
`String`	`getLabel()` Returns the cache label
`long`	`getLiveTime()` Returns the maximum life time of an entry in the cache.
`int`	`getMaxSize()` Returns the maximum capacity of the cache.
`String`	`getName()` Returns the cache name
`boolean`	`isLogEnabled()`
`void`	`onClearCache(CacheListenerContext context)` The cache is globally cleared.
`void`	`onExpire(CacheListenerContext context, K key, InvalidationExoCache.HashCode<V> obj)` An entry is expired from the cache.
`void`	`onGet(CacheListenerContext context, K key, InvalidationExoCache.HashCode<V> obj)` An entry is retrieved from the cache.
`void`	`onPut(CacheListenerContext context, K key, InvalidationExoCache.HashCode<V> obj)` An entry is inserted in the cache.
`void`	`onRemove(CacheListenerContext context, K key, InvalidationExoCache.HashCode<V> obj)` An entry is removed from the cache.
`void`	`put(K key, V value)` 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 key)` Removes an entry from the cache.
`List<? extends V>`	`removeCachedObjects()` Clears the cache and returns the list of cached object that are considered as valid when the method is called.
`void`	`select(CachedObjectSelector<? super K,? super V> selector)` Selects a subset of the cache.
`void`	`setLabel(String s)` Sets the cache label
`void`	`setLiveTime(long period)` Sets the maximum life time of an entry in the cache.
`void`	`setLogEnabled(boolean b)`
`void`	`setMaxSize(int max)` Sets the maximum capacity of the cache.
`void`	`setName(String name)` Sets the cache name.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

InvalidationExoCache

public InvalidationExoCache(ExoCache<K,V> delegate)

Parameters:: delegate - the underneath eXo cache instance, we assume that the eXo cache implementation behind is fully functional.

InvalidationExoCache

public InvalidationExoCache(ExoCache<K,V> delegate,
                            int concurrencyLevel)

Parameters:: delegate - the underneath eXo cache instance, we assume that the eXo cache implementation behind is fully functional.

Method Detail