com.communote.server.core.common.caching.eh

Class EhCache

java.lang.Object

com.communote.server.core.common.caching.Cache

com.communote.server.core.common.caching.eh.EhCache

public class EhCache
extends Cache

Cache backend by Ehcache.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
EhCache(net.sf.ehcache.Ehcache cacheBackend) Creates the EhCache instance.

Method Summary

Modifier and Type	Method and Description
protected CacheElementWrapper<Serializable>	handleGet(String cacheKey) Retrieves an element identified by the provided key from the cache.
protected void	handleInvalidate(String cacheKey) Invalidates the data stored under the supplied key.
protected void	handlePut(String cacheKey, CacheElementWrapper<Serializable> cacheElement, int timeToLive) Stores an element under the key cacheKey in the cache.

Methods inherited from class com.communote.server.core.common.caching.Cache

get, get, invalidate, invalidateAll, invalidateAllOfCurrentClient, put

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCache

public EhCache(net.sf.ehcache.Ehcache cacheBackend)

Creates the EhCache instance.

Parameters:

cacheBackend - an initialized Ehcache which will be used as backend for caching data

Method Detail

handleGet

protected CacheElementWrapper<Serializable> handleGet(String cacheKey)

Retrieves an element identified by the provided key from the cache.

Specified by:

handleGet in class Cache

Parameters:

cacheKey - the key used for storing the element in the cache

Returns:

the cached element or null if there is no element cached that has the supplied cacheKey or the cached element is expired

handleInvalidate

protected void handleInvalidate(String cacheKey)

Invalidates the data stored under the supplied key.

Specified by:

handleInvalidate in class Cache

Parameters:

cacheKey - the key used for caching

handlePut

protected void handlePut(String cacheKey,
                         CacheElementWrapper<Serializable> cacheElement,
                         int timeToLive)

Stores an element under the key cacheKey in the cache.

Specified by:

handlePut in class Cache

Parameters:

cacheKey - the key used for caching and retrieving

cacheElement - the element to be cached; never null

timeToLive - the time in seconds until the item will expire. A negative value indicates eternal caching.