nl.nn.adapterframework.cache

Class EhCache<V>

java.lang.Object

nl.nn.adapterframework.cache.CacheAdapterBase<V>

nl.nn.adapterframework.cache.EhCache<V>

All Implemented Interfaces:

ICache<String,V>, IConfigurationAware, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class EhCache<V>
extends CacheAdapterBase<V>

General Cache provider. N.B. the default values shown can be overridden using properties in appConstants. The property names are found by prefixing the attribute name with cache.default..

Since:

4.11

Author:

Gerrit van Brakel

Field Summary

Fields inherited from class nl.nn.adapterframework.cache.CacheAdapterBase

log

Constructor Summary

Constructors

Constructor and Description
EhCache()

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(String ownerName)
int	getDiskExpiryThreadIntervalSeconds()
protected V	getElement(String key)
int	getMaxElementsInMemory()
int	getMaxElementsOnDisk()
String	getMemoryStoreEvictionPolicy()
int	getTimeToIdleSeconds()
int	getTimeToLiveSeconds()
boolean	isDiskPersistent()
boolean	isEternal()
boolean	isOverflowToDisk()
void	open()
protected void	putElement(String key, V value)
protected boolean	removeElement(Object key)
void	setDiskExpiryThreadIntervalSeconds(int diskExpiryThreadIntervalSeconds) How often to run the disk store expiry thread
void	setDiskPersistent(boolean diskPersistent) If true, the the cache is reloaded after the JVM restarts
void	setEternal(boolean eternal) If true, the elements in the cache are eternal, i.e.
void	setMaxElementsInMemory(int maxElementsInMemory) The maximum number of elements in memory, before they are evicted
void	setMaxElementsOnDisk(int maxElementsOnDisk) The maximum number of elements on disk, before they are removed
void	setMemoryStoreEvictionPolicy(String memoryStoreEvictionPolicy) Either LRU=Least Recent Use,LFU=Least Frequent Use or FIFO=First In - First Out
void	setOverflowToDisk(boolean overflowToDisk) If true, the elements that are evicted from memory are spooled to disk
void	setTimeToIdleSeconds(int timeToIdleSeconds) The amount of time in seconds to live for an element from its last accessed or modified date
void	setTimeToLiveSeconds(int timeToLiveSeconds) The amount of time in seconds to live for an element from its creation date
protected V	toValue(Message value)

Methods inherited from class nl.nn.adapterframework.cache.CacheAdapterBase

get, getLogPrefix, put, remove, setCacheEmptyKeys, setCacheEmptyValues, setKeyInputSessionKey, setKeyNamespaceDefs, setKeyStyleSheet, setKeyXPath, setKeyXPathOutputType, setName, setValueInputSessionKey, setValueNamespaceDefs, setValueStyleSheet, setValueXPath, setValueXPathOutputType, transformKey, transformValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

EhCache

public EhCache()

Method Detail

configure

public void configure(String ownerName)
               throws ConfigurationException

Specified by:

configure in interface ICache<String,V>

Overrides:

configure in class CacheAdapterBase<V>

Throws:

ConfigurationException

open

public void open()

close

public void close()

getElement

protected V getElement(String key)

Specified by:

getElement in class CacheAdapterBase<V>

putElement

protected void putElement(String key,
                          V value)

Specified by:

putElement in class CacheAdapterBase<V>

removeElement

protected boolean removeElement(Object key)

Specified by:

removeElement in class CacheAdapterBase<V>

toValue

protected V toValue(Message value)

Specified by:

toValue in class CacheAdapterBase<V>

setMaxElementsInMemory

public void setMaxElementsInMemory(int maxElementsInMemory)

The maximum number of elements in memory, before they are evicted

Default value

100

getMaxElementsInMemory

public int getMaxElementsInMemory()

setMemoryStoreEvictionPolicy

public void setMemoryStoreEvictionPolicy(String memoryStoreEvictionPolicy)

Either LRU=Least Recent Use,LFU=Least Frequent Use or FIFO=First In - First Out

Default value

LRU

getMemoryStoreEvictionPolicy

public String getMemoryStoreEvictionPolicy()

setEternal

public void setEternal(boolean eternal)

If true, the elements in the cache are eternal, i.e. never expire

Default value

false

isEternal

public boolean isEternal()

setTimeToLiveSeconds

public void setTimeToLiveSeconds(int timeToLiveSeconds)

The amount of time in seconds to live for an element from its creation date

Default value

36000

getTimeToLiveSeconds

public int getTimeToLiveSeconds()

setTimeToIdleSeconds

public void setTimeToIdleSeconds(int timeToIdleSeconds)

The amount of time in seconds to live for an element from its last accessed or modified date

Default value

36000

getTimeToIdleSeconds

public int getTimeToIdleSeconds()

setOverflowToDisk

public void setOverflowToDisk(boolean overflowToDisk)

If true, the elements that are evicted from memory are spooled to disk

Default value

false

isOverflowToDisk

public boolean isOverflowToDisk()

setMaxElementsOnDisk

public void setMaxElementsOnDisk(int maxElementsOnDisk)

The maximum number of elements on disk, before they are removed

Default value

10000

getMaxElementsOnDisk

public int getMaxElementsOnDisk()

setDiskPersistent

public void setDiskPersistent(boolean diskPersistent)

If true, the the cache is reloaded after the JVM restarts

Default value

false

isDiskPersistent

public boolean isDiskPersistent()

setDiskExpiryThreadIntervalSeconds

public void setDiskExpiryThreadIntervalSeconds(int diskExpiryThreadIntervalSeconds)

How often to run the disk store expiry thread

Default value

600

getDiskExpiryThreadIntervalSeconds

public int getDiskExpiryThreadIntervalSeconds()