info.magnolia.module.cache.ehcache

Class EhCacheWrapper

java.lang.Object

info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper

info.magnolia.module.cache.ehcache.EhCacheWrapper

All Implemented Interfaces:

BlockingCache, Cache

public class EhCacheWrapper
extends AbstractListeningCacheWrapper
implements BlockingCache

Magnolia cache wrapper for underlying ehCache implementation.

Constructor Summary

Constructors

Constructor and Description
EhCacheWrapper(net.sf.ehcache.constructs.blocking.BlockingCache ehcache, CacheMonitor cacheMonitor, String name) Deprecated. since 5.3. Use EhCacheWrapper(CacheModule, Ehcache, CacheMonitor, String) instead.
EhCacheWrapper(CacheModule cacheModule, net.sf.ehcache.Ehcache ehcache, CacheMonitor cacheMonitor, String name)
EhCacheWrapper(net.sf.ehcache.Ehcache ehcache, CacheMonitor cacheMonitor, String name) Deprecated. since 5.3. Use EhCacheWrapper(CacheModule, Ehcache, CacheMonitor, String) instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
Object	get(Object key)
int	getBlockingTimeout() If the timeout is reached an exception is thrown to unlock the blocked thread (in milliseconds).
List<Object>	getKeys()
String	getName()
Object	getQuiet(Object key)
int	getSize()
net.sf.ehcache.Ehcache	getWrappedEhcache()
boolean	hasElement(Object key)
void	put(Object key, Object value)
void	put(Object key, Object value, int timeToLiveInSeconds)
void	remove(Object key)
void	unlock(Object key) Will unlock the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheWrapper

public EhCacheWrapper(CacheModule cacheModule,
              net.sf.ehcache.Ehcache ehcache,
              CacheMonitor cacheMonitor,
              String name)

EhCacheWrapper

public EhCacheWrapper(net.sf.ehcache.constructs.blocking.BlockingCache ehcache,
              CacheMonitor cacheMonitor,
              String name)

Deprecated. since 5.3. Use EhCacheWrapper(CacheModule, Ehcache, CacheMonitor, String) instead.

EhCacheWrapper

public EhCacheWrapper(net.sf.ehcache.Ehcache ehcache,
              CacheMonitor cacheMonitor,
              String name)

Deprecated. since 5.3. Use EhCacheWrapper(CacheModule, Ehcache, CacheMonitor, String) instead.

Method Detail

get

public Object get(Object key)

Specified by:

get in interface Cache

Overrides:

get in class AbstractListeningCacheWrapper

getQuiet

public Object getQuiet(Object key)

Specified by:

getQuiet in interface Cache

Overrides:

getQuiet in class AbstractListeningCacheWrapper

hasElement

public boolean hasElement(Object key)

Specified by:

hasElement in interface Cache

put

public void put(Object key,
       Object value)

Specified by:

put in interface Cache

Overrides:

put in class AbstractListeningCacheWrapper

put

public void put(Object key,
       Object value,
       int timeToLiveInSeconds)

Specified by:

put in interface Cache

Overrides:

put in class AbstractListeningCacheWrapper

remove

public void remove(Object key)

Specified by:

remove in interface Cache

Overrides:

remove in class AbstractListeningCacheWrapper

clear

public void clear()

Specified by:

clear in interface Cache

Overrides:

clear in class AbstractListeningCacheWrapper

unlock

public void unlock(Object key)

Description copied from interface: BlockingCache

Will unlock the key.

Specified by:

unlock in interface BlockingCache

getBlockingTimeout

public int getBlockingTimeout()

Description copied from interface: BlockingCache

If the timeout is reached an exception is thrown to unlock the blocked thread (in milliseconds). This guarantees that not all threads are waiting on a non-available resource.

Specified by:

getBlockingTimeout in interface BlockingCache

getWrappedEhcache

public net.sf.ehcache.Ehcache getWrappedEhcache()

getName

public String getName()

Specified by:

getName in interface Cache

Specified by:

getName in class AbstractListeningCacheWrapper

getSize

public int getSize()

Specified by:

getSize in interface Cache

Specified by:

getSize in class AbstractListeningCacheWrapper

getKeys

public List<Object> getKeys()

Specified by:

getKeys in interface Cache