org.onebusaway.container.spring.ehcache
Class EhCacheFactoryBean

java.lang.Object
  org.onebusaway.container.spring.ehcache.EhCacheFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.FactoryBean<net.sf.ehcache.Ehcache>, org.springframework.beans.factory.InitializingBean

public class EhCacheFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<net.sf.ehcache.Ehcache>, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

A Spring FactoryBean for programmatically creating an EhCache Cache with standard configuration options, but also progrmattic Terracotta configuration. A special note about Terracotta config. While you can create all your Terracotta-enabled caches programatically using this FactoryBean, you need to have at least one Terracotta-enabled cache created the old fashioned way (through an ehcache.xml resource config) so that the CacheManager will properly enable Terracotta support.

Author:

bdferris

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

EhCacheFactoryBean()

Method Summary

void	afterPropertiesSet()
protected net.sf.ehcache.Ehcache	decorateCache(net.sf.ehcache.Ehcache cache) Decorate the given Cache, if necessary.
net.sf.ehcache.Ehcache	getObject()
Class<?>	getObjectType()
boolean	isSingleton()
void	setBeanName(String name)
void	setBlocking(boolean blocking) Set whether to use a blocking cache that lets read attempts block until the requested element is created.
void	setCacheEntryFactory(net.sf.ehcache.constructs.blocking.CacheEntryFactory cacheEntryFactory) Set an EHCache CacheEntryFactory to use for a self-populating cache.
void	setCacheManager(net.sf.ehcache.CacheManager cacheManager) Set a CacheManager from which to retrieve a named Cache instance.
void	setCacheName(String cacheName) Set a name for which to retrieve or create a cache instance.
void	setDiskExpiryThreadIntervalSeconds(int diskExpiryThreadIntervalSeconds) Set the number of seconds between runs of the disk expiry thread.
void	setDiskPersistent(boolean diskPersistent) Set whether the disk store persists between restarts of the Virtual Machine.
void	setEternal(boolean eternal) Set whether elements are considered as eternal.
void	setMaxElementsInMemory(int maxElementsInMemory) Specify the maximum number of cached objects in memory.
void	setMaxElementsOnDisk(int maxElementsOnDisk) Specify the maximum number of cached objects on disk.
void	setMemoryStoreEvictionPolicy(net.sf.ehcache.store.MemoryStoreEvictionPolicy memoryStoreEvictionPolicy) Set the memory style eviction policy for this cache.
void	setOverflowToDisk(boolean overflowToDisk) Set whether elements can overflow to disk when the in-memory cache has reached the maximum size limit.
void	setTerracottaClustered(boolean terracottaClustered)
void	setTimeToIdle(int timeToIdle) Set the time in seconds to idle for an element before it expires, that is, the maximum amount of time between accesses before an element expires.
void	setTimeToLive(int timeToLive) Set t he time in seconds to live for an element before it expires, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

EhCacheFactoryBean

public EhCacheFactoryBean()

Method Detail

setCacheManager

public void setCacheManager(net.sf.ehcache.CacheManager cacheManager)

Set a CacheManager from which to retrieve a named Cache instance. By default, CacheManager.getInstance() will be called.

Note that in particular for persistent caches, it is advisable to properly handle the shutdown of the CacheManager: Set up a separate EhCacheManagerFactoryBean and pass a reference to this bean property.

A separate EhCacheManagerFactoryBean is also necessary for loading EHCache configuration from a non-default config location.

See Also:

EhCacheManagerFactoryBean, CacheManager.getInstance()

setCacheName

public void setCacheName(String cacheName)

Set a name for which to retrieve or create a cache instance. Default is the bean name of this EhCacheFactoryBean.

setMaxElementsInMemory

public void setMaxElementsInMemory(int maxElementsInMemory)

Specify the maximum number of cached objects in memory. Default is 10000 elements.

setMaxElementsOnDisk

public void setMaxElementsOnDisk(int maxElementsOnDisk)

Specify the maximum number of cached objects on disk. Default is 10000000 elements.

setMemoryStoreEvictionPolicy

public void setMemoryStoreEvictionPolicy(net.sf.ehcache.store.MemoryStoreEvictionPolicy memoryStoreEvictionPolicy)

Set the memory style eviction policy for this cache. Supported values are "LRU", "LFU" and "FIFO", according to the constants defined in EHCache's MemoryStoreEvictionPolicy class. Default is "LRU".

setOverflowToDisk

public void setOverflowToDisk(boolean overflowToDisk)

Set whether elements can overflow to disk when the in-memory cache has reached the maximum size limit. Default is "true".

setEternal

public void setEternal(boolean eternal)

Set whether elements are considered as eternal. If "true", timeouts are ignored and the element is never expired. Default is "false".

setTimeToLive

public void setTimeToLive(int timeToLive)

Set t he time in seconds to live for an element before it expires, i.e. the maximum time between creation time and when an element expires. It is only used if the element is not eternal. Default is 120 seconds.

setTimeToIdle

public void setTimeToIdle(int timeToIdle)

Set the time in seconds to idle for an element before it expires, that is, the maximum amount of time between accesses before an element expires. This is only used if the element is not eternal. Default is 120 seconds.

setDiskPersistent

public void setDiskPersistent(boolean diskPersistent)

Set whether the disk store persists between restarts of the Virtual Machine. The default is "false".

setDiskExpiryThreadIntervalSeconds

public void setDiskExpiryThreadIntervalSeconds(int diskExpiryThreadIntervalSeconds)

Set the number of seconds between runs of the disk expiry thread. The default is 120 seconds.

setBlocking

public void setBlocking(boolean blocking)

Set whether to use a blocking cache that lets read attempts block until the requested element is created.

If you intend to build a self-populating blocking cache, consider specifying a CacheEntryFactory.

See Also:

BlockingCache, setCacheEntryFactory(net.sf.ehcache.constructs.blocking.CacheEntryFactory)

setTerracottaClustered

public void setTerracottaClustered(boolean terracottaClustered)

setCacheEntryFactory

public void setCacheEntryFactory(net.sf.ehcache.constructs.blocking.CacheEntryFactory cacheEntryFactory)

Set an EHCache CacheEntryFactory to use for a self-populating cache. If such a factory is specified, the cache will be decorated with EHCache's SelfPopulatingCache.

The specified factory can be of type UpdatingCacheEntryFactory, which will lead to the use of an UpdatingSelfPopulatingCache.

Note: Any such self-populating cache is automatically a blocking cache.

See Also:

SelfPopulatingCache, UpdatingSelfPopulatingCache, UpdatingCacheEntryFactory

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

afterPropertiesSet

public void afterPropertiesSet()
                        throws net.sf.ehcache.CacheException,
                               IOException

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

net.sf.ehcache.CacheException

IOException

decorateCache

protected net.sf.ehcache.Ehcache decorateCache(net.sf.ehcache.Ehcache cache)

Decorate the given Cache, if necessary.

Parameters:

cache - the raw Cache object, based on the configuration of this FactoryBean

Returns:

the (potentially decorated) cache object to be registered with the CacheManager

getObject

public net.sf.ehcache.Ehcache getObject()

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<net.sf.ehcache.Ehcache>

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<net.sf.ehcache.Ehcache>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<net.sf.ehcache.Ehcache>