EhcacheCache (Archiva Components :: Spring Cache 3.0-SNAPSHOT API)

java.lang.Object
- org.apache.archiva.components.cache.ehcache.EhcacheCache<V,T>

All Implemented Interfaces:

Cache<V,T>
```
public class EhcacheCache<V,T>
extends Object
implements Cache<V,T>
```
EhcacheCache configuration document available EhcacheUserGuide
You can use the system property org.apache.archiva.ehcache.diskStore to set the default disk store path.

Author:

Joakim Erdfelt

Constructor Summary

Constructors
Constructor and Description

EhcacheCache()

Constructors
Constructor and Description
`EhcacheCache()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear the cache of all entries.
`void`	`dispose()`
`T`	`get(V key)` Get the value of the specified key, if it exists in the cache.
`Path`	`getConfigurationFile()` Returns the path to the configuration file or `null`, if not set.
`long`	`getDiskExpiryThreadIntervalSeconds()`
`String`	`getDiskStorePath()`
`long`	`getMaxBytesLocalHeap()`
`long`	`getMaxBytesLocalOffHeap()`
`int`	`getMaxElementsInMemory()`
`int`	`getMaxElementsOnDisk()`
`String`	`getMemoryEvictionPolicy()`
`net.sf.ehcache.store.MemoryStoreEvictionPolicy`	`getMemoryStoreEvictionPolicy()`
`String`	`getName()`
`CacheStatistics`	`getStatistics()` Obtain a set of Statistics about the performance of the cache.
`int`	`getTimeToIdleSeconds()`
`int`	`getTimeToLiveSeconds()`
`boolean`	`hasKey(V key)` Tests to see if the provided key exists within the cache.
`void`	`initialize()`
`boolean`	`isDiskPersistent()`
`boolean`	`isEternal()`
`boolean`	`isFailOnDuplicateCache()`
`boolean`	`isOverflowToDisk()` Deprecated. This flag is ignored. The persistence strategy is always overflow to disk, if on.
`boolean`	`isOverflowToOffHeap()`
`boolean`	`isStatisticsEnabled()`
`T`	`put(V key, T value)` Put the specified value into the cache under the provided key.
`void`	`register(V key, T value)` Register the specified value into the cache under the provided key.
`T`	`remove(V key)` Remove the specified key and value from the cache.
`void`	`setConfigurationFile(Path configurationFile)` Sets the path to the configuration file.
`void`	`setDiskExpiryThreadIntervalSeconds(long diskExpiryThreadIntervalSeconds)`
`void`	`setDiskPersistent(boolean diskPersistent)`
`void`	`setDiskStorePath(String diskStorePath)`
`void`	`setEternal(boolean eternal)`
`void`	`setFailOnDuplicateCache(boolean failOnDuplicateCache)`
`void`	`setMaxBytesLocalHeap(long maxBytesLocalHeap)`
`void`	`setMaxBytesLocalOffHeap(long maxBytesLocalOffHeap)`
`void`	`setMaxElementsInMemory(int maxElementsInMemory)`
`void`	`setMaxElementsOnDisk(int maxElementsOnDisk)`
`void`	`setMemoryEvictionPolicy(String memoryEvictionPolicy)`
`void`	`setName(String name)`
`void`	`setOverflowToDisk(boolean overflowToDisk)` Deprecated. This flag is ignored. The persistence strategy is always overflow to disk, if on.
`void`	`setOverflowToOffHeap(boolean overflowToOffHeap)`
`void`	`setStatisticsEnabled(boolean statisticsEnabled)`
`void`	`setTimeToIdleSeconds(int timeToIdleSeconds)`
`void`	`setTimeToLiveSeconds(int timeToLiveSeconds)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EhcacheCache
```
public EhcacheCache()
```
- Method Detail
  - clear
```
public void clear()
```
    Description copied from interface: Cache
    
    Clear the cache of all entries.
    
    Specified by:
    
    clear in interface Cache<V,T>
  - initialize
```
@PostConstruct
public void initialize()
```
  - dispose
```
@PreDestroy
public void dispose()
```
  - get
```
public T get(V key)
```
    Description copied from interface: Cache
    
    Get the value of the specified key, if it exists in the cache.
    
    Specified by:
    
    get in interface Cache<V,T>
    
    Parameters:
    
    key - the key to fetch the contents of.
    
    Returns:
    
    the value of the key, or null if not found.
  - getDiskExpiryThreadIntervalSeconds
```
public long getDiskExpiryThreadIntervalSeconds()
```
  - getDiskStorePath
```
public String getDiskStorePath()
```
  - getMaxElementsInMemory
```
public int getMaxElementsInMemory()
```
    Specified by:
    
    getMaxElementsInMemory in interface Cache<V,T>
  - getMemoryEvictionPolicy
```
public String getMemoryEvictionPolicy()
```
  - getMemoryStoreEvictionPolicy
```
public net.sf.ehcache.store.MemoryStoreEvictionPolicy getMemoryStoreEvictionPolicy()
```
  - getName
```
public String getName()
```
  - getStatistics
```
public CacheStatistics getStatistics()
```
    Description copied from interface: Cache
    
    Obtain a set of Statistics about the performance of the cache.
    
    Specified by:
    
    getStatistics in interface Cache<V,T>
    
    Returns:
    
    the cache statistics.
  - getTimeToIdleSeconds
```
public int getTimeToIdleSeconds()
```
    Specified by:
    
    getTimeToIdleSeconds in interface Cache<V,T>
  - getTimeToLiveSeconds
```
public int getTimeToLiveSeconds()
```
    Specified by:
    
    getTimeToLiveSeconds in interface Cache<V,T>
  - hasKey
```
public boolean hasKey(V key)
```
    Description copied from interface: Cache
    
    Tests to see if the provided key exists within the cache.
    NOTE: Due to synchronization issues, if this method returns true, a subsequent request to the Cache.get(Object) method on the same key might return null as the period of time between the 2 request might have been long enough for the underlying Cache implementation to remove the key.
    
    Specified by:
    
    hasKey in interface Cache<V,T>
    
    Parameters:
    
    key - the key to test.
    
    Returns:
    
    true if the key exists.
  - isDiskPersistent
```
public boolean isDiskPersistent()
```
  - isEternal
```
public boolean isEternal()
```
  - isOverflowToDisk
```
public boolean isOverflowToDisk()
```
    Deprecated. This flag is ignored. The persistence strategy is always overflow to disk, if on.
    
    Returns:
    
    true, or false
  - register
```
public void register(V key,
                     T value)
```
    Description copied from interface: Cache
    
    Register the specified value into the cache under the provided key.
    This Cache.register(Object, Object) method is just an optimized version of the Cache.put(Object, Object) method, but does not return the previous value contained with the specified key.
    
    Specified by:
    
    register in interface Cache<V,T>
    
    Parameters:
    
    key - the key to put the value into
    
    value - the object to place into the cache.
  - put
```
public T put(V key,
             T value)
```
    Description copied from interface: Cache
    
    Put the specified value into the cache under the provided key.
    
    Specified by:
    
    put in interface Cache<V,T>
    
    Parameters:
    
    key - the key to put the value into
    
    value - the object to place into the cache.
    
    Returns:
    
    the previous value for the key, or null if the key contained no value.
  - remove
```
public T remove(V key)
```
    Description copied from interface: Cache
    
    Remove the specified key and value from the cache.
    
    Specified by:
    
    remove in interface Cache<V,T>
    
    Parameters:
    
    key - the key to the value to remove.
    
    Returns:
    
    the value of the key that was removed.
  - setDiskExpiryThreadIntervalSeconds
```
public void setDiskExpiryThreadIntervalSeconds(long diskExpiryThreadIntervalSeconds)
```
  - setDiskPersistent
```
public void setDiskPersistent(boolean diskPersistent)
```
  - setDiskStorePath
```
public void setDiskStorePath(String diskStorePath)
```
  - setEternal
```
public void setEternal(boolean eternal)
```
  - setMaxElementsInMemory
```
public void setMaxElementsInMemory(int maxElementsInMemory)
```
    Specified by:
    
    setMaxElementsInMemory in interface Cache<V,T>
  - setMemoryEvictionPolicy
```
public void setMemoryEvictionPolicy(String memoryEvictionPolicy)
```
  - setName
```
public void setName(String name)
```
  - setOverflowToDisk
```
public void setOverflowToDisk(boolean overflowToDisk)
```
    Deprecated. This flag is ignored. The persistence strategy is always overflow to disk, if on.
    
    Parameters:
    
    overflowToDisk - true, or false
  - setTimeToIdleSeconds
```
public void setTimeToIdleSeconds(int timeToIdleSeconds)
```
    Specified by:
    
    setTimeToIdleSeconds in interface Cache<V,T>
  - setTimeToLiveSeconds
```
public void setTimeToLiveSeconds(int timeToLiveSeconds)
```
    Specified by:
    
    setTimeToLiveSeconds in interface Cache<V,T>
  - isStatisticsEnabled
```
public boolean isStatisticsEnabled()
```
  - setStatisticsEnabled
```
public void setStatisticsEnabled(boolean statisticsEnabled)
```
  - isFailOnDuplicateCache
```
public boolean isFailOnDuplicateCache()
```
  - setFailOnDuplicateCache
```
public void setFailOnDuplicateCache(boolean failOnDuplicateCache)
```
  - isOverflowToOffHeap
```
public boolean isOverflowToOffHeap()
```
  - setOverflowToOffHeap
```
public void setOverflowToOffHeap(boolean overflowToOffHeap)
```
  - getMaxBytesLocalHeap
```
public long getMaxBytesLocalHeap()
```
  - setMaxBytesLocalHeap
```
public void setMaxBytesLocalHeap(long maxBytesLocalHeap)
```
  - getMaxBytesLocalOffHeap
```
public long getMaxBytesLocalOffHeap()
```
  - setMaxBytesLocalOffHeap
```
public void setMaxBytesLocalOffHeap(long maxBytesLocalOffHeap)
```
  - getMaxElementsOnDisk
```
public int getMaxElementsOnDisk()
```
    Specified by:
    
    getMaxElementsOnDisk in interface Cache<V,T>
  - setMaxElementsOnDisk
```
public void setMaxElementsOnDisk(int maxElementsOnDisk)
```
    Specified by:
    
    setMaxElementsOnDisk in interface Cache<V,T>
  - setConfigurationFile
```
public void setConfigurationFile(Path configurationFile)
```
    Sets the path to the configuration file. If this value is set to a valid file path, the configuration will be loaded from the given file. The cache defined in this file must match the cache name of this instance.
    
    Parameters:
    
    configurationFile - a valid path to a ehcache xml configuration file
  - getConfigurationFile
```
public Path getConfigurationFile()
```
    Returns the path to the configuration file or null, if not set.
    
    Returns:
    
    the path of the configuration file or null

Class EhcacheCache<V,T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EhcacheCache

Method Detail

clear

initialize

dispose

get

getDiskExpiryThreadIntervalSeconds

getDiskStorePath

getMaxElementsInMemory

getMemoryEvictionPolicy

getMemoryStoreEvictionPolicy

getName

getStatistics

getTimeToIdleSeconds

getTimeToLiveSeconds

hasKey

isDiskPersistent

isEternal

isOverflowToDisk

register

put

remove

setDiskExpiryThreadIntervalSeconds

setDiskPersistent

setDiskStorePath

setEternal

setMaxElementsInMemory

setMemoryEvictionPolicy

setName

setOverflowToDisk

setTimeToIdleSeconds

setTimeToLiveSeconds

isStatisticsEnabled

setStatisticsEnabled

isFailOnDuplicateCache

setFailOnDuplicateCache

isOverflowToOffHeap

setOverflowToOffHeap

getMaxBytesLocalHeap

setMaxBytesLocalHeap

getMaxBytesLocalOffHeap

setMaxBytesLocalOffHeap

getMaxElementsOnDisk

setMaxElementsOnDisk

setConfigurationFile

getConfigurationFile