net.sf.ehcache.config

Class CacheConfiguration

public final class CacheConfiguration extends Object

A class to represent Cache configuration. e.g.

Version: $Id: CacheConfiguration.java 52 2006-04-24 14:50:03Z gregluck $

Nested Class Summary
class	CacheConfiguration.CacheEventListenerFactoryConfiguration Configuration for the CachePeerListenerFactoryConfiguration.

Field Summary
protected List	cacheEventListenerConfigurations The event listener factories added by BeanUtils.
protected long	diskExpiryThreadIntervalSeconds The interval in seconds between runs of the disk expiry thread.
protected boolean	diskPersistent For caches that overflow to disk, whether the disk cache persists between CacheManager instances.
protected boolean	eternal Sets whether elements are eternal.
protected int	maxElementsInMemory the maximum objects to be held in the MemoryStore.
protected MemoryStoreEvictionPolicy	memoryStoreEvictionPolicy The policy used to evict elements from the MemoryStore.
protected String	name the name of the cache.
protected boolean	overflowToDisk whether elements can overflow to disk when the in-memory cache has reached the set limit.
protected int	timeToIdleSeconds the time to idle for an element before it expires.
protected int	timeToLiveSeconds Sets the time to idle for an element before it expires.

Method Summary
void	addCacheEventListenerFactory(CacheConfiguration.CacheEventListenerFactoryConfiguration factory) Used by BeanUtils to add cacheEventListenerFactory elements to the cache configuration.
void	setDiskExpiryThreadIntervalSeconds(int diskExpiryThreadIntervalSeconds) Sets the interval in seconds between runs of the disk expiry thread.
void	setDiskPersistent(boolean diskPersistent) Sets whether, for caches that overflow to disk, the disk cache persist between CacheManager instances.
void	setEternal(boolean eternal) Sets whether elements are eternal.
void	setMaxElementsInMemory(int maxElementsInMemory) Sets the maximum objects to be held in memory.
void	setMemoryStoreEvictionPolicy(String memoryStoreEvictionPolicy) Sets the eviction policy.
void	setName(String name) Sets the name of the cache.
void	setOverflowToDisk(boolean overflowToDisk) Sets whether elements can overflow to disk when the in-memory cache has reached the set limit.
void	setTimeToIdleSeconds(int timeToIdleSeconds) Sets the time to idle for an element before it expires.
void	setTimeToLiveSeconds(int timeToLiveSeconds) Sets the time to idle for an element before it expires.

Field Detail

cacheEventListenerConfigurations

protected final List cacheEventListenerConfigurations

The event listener factories added by BeanUtils.

diskExpiryThreadIntervalSeconds

protected long diskExpiryThreadIntervalSeconds

The interval in seconds between runs of the disk expiry thread.

2 minutes is the default. This is not the same thing as time to live or time to idle. When the thread runs it checks these things. So this value is how often we check for expiry.

diskPersistent

protected boolean diskPersistent

For caches that overflow to disk, whether the disk cache persists between CacheManager instances.

eternal

protected boolean eternal

Sets whether elements are eternal. If eternal, timeouts are ignored and the element is never expired.

maxElementsInMemory

protected int maxElementsInMemory

the maximum objects to be held in the MemoryStore.

memoryStoreEvictionPolicy

protected MemoryStoreEvictionPolicy memoryStoreEvictionPolicy

The policy used to evict elements from the MemoryStore. This can be one of:

LRU - least recently used
LFU - Less frequently used
FIFO - first in first out, the oldest element by creation time

The default value is LRU

Since: 1.2

name

protected String name

the name of the cache.

overflowToDisk

protected boolean overflowToDisk

whether elements can overflow to disk when the in-memory cache has reached the set limit.

timeToIdleSeconds

protected int timeToIdleSeconds

the time to idle for an element before it expires. Is only used if the element is not eternal.A value of 0 means do not check for idling.

timeToLiveSeconds

protected int timeToLiveSeconds

Sets the time to idle for an element before it expires. Is only used if the element is not eternal. This attribute is optional in the configuration. A value of 0 means do not check time to live.

Method Detail

addCacheEventListenerFactory

public final void addCacheEventListenerFactory(CacheConfiguration.CacheEventListenerFactoryConfiguration factory)

Used by BeanUtils to add cacheEventListenerFactory elements to the cache configuration.

setDiskExpiryThreadIntervalSeconds

public final void setDiskExpiryThreadIntervalSeconds(int diskExpiryThreadIntervalSeconds)

Sets the interval in seconds between runs of the disk expiry thread.

2 minutes is the default. This is not the same thing as time to live or time to idle. When the thread runs it checks these things. So this value is how often we check for expiry.