org.springframework.cache.ehcache

Class EhCacheCacheManager

java.lang.Object

org.springframework.cache.support.AbstractCacheManager

org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager

org.springframework.cache.ehcache.EhCacheCacheManager

All Implemented Interfaces:

InitializingBean, CacheManager

public class EhCacheCacheManager
extends AbstractTransactionSupportingCacheManager

CacheManager backed by an EhCache net.sf.ehcache.CacheManager.

Since:

3.1

Author:

Costin Leau, Juergen Hoeller, Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field and Description
private net.sf.ehcache.CacheManager	cacheManager

Constructor Summary

Constructors

Constructor and Description
EhCacheCacheManager() Create a new EhCacheCacheManager, setting the target EhCache CacheManager through the setCacheManager(net.sf.ehcache.CacheManager) bean property.
EhCacheCacheManager(net.sf.ehcache.CacheManager cacheManager) Create a new EhCacheCacheManager for the given backing EhCache CacheManager.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
net.sf.ehcache.CacheManager	getCacheManager() Return the backing EhCache net.sf.ehcache.CacheManager.
protected Cache	getMissingCache(java.lang.String name) Return a missing cache with the specified name or null if such cache does not exist or could not be created on the fly.
protected java.util.Collection<Cache>	loadCaches() Load the initial caches for this cache manager.
void	setCacheManager(net.sf.ehcache.CacheManager cacheManager) Set the backing EhCache net.sf.ehcache.CacheManager.

Methods inherited from class org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager

decorateCache, isTransactionAware, setTransactionAware

Methods inherited from class org.springframework.cache.support.AbstractCacheManager

addCache, getCache, getCacheNames, initializeCaches, lookupCache

Methods inherited from class java.lang.Object

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

Field Detail

cacheManager

private net.sf.ehcache.CacheManager cacheManager

Constructor Detail

EhCacheCacheManager

public EhCacheCacheManager()

Create a new EhCacheCacheManager, setting the target EhCache CacheManager through the setCacheManager(net.sf.ehcache.CacheManager) bean property.

EhCacheCacheManager

public EhCacheCacheManager(net.sf.ehcache.CacheManager cacheManager)

Create a new EhCacheCacheManager for the given backing EhCache CacheManager.

Parameters:

cacheManager - the backing EhCache net.sf.ehcache.CacheManager

Method Detail

setCacheManager

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

Set the backing EhCache net.sf.ehcache.CacheManager.

getCacheManager

public net.sf.ehcache.CacheManager getCacheManager()

Return the backing EhCache net.sf.ehcache.CacheManager.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractCacheManager

loadCaches

protected java.util.Collection<Cache> loadCaches()

Description copied from class: AbstractCacheManager

Load the initial caches for this cache manager.

Called by AbstractCacheManager.afterPropertiesSet() on startup. The returned collection may be empty but must not be null.

Specified by:

loadCaches in class AbstractCacheManager

getMissingCache

protected Cache getMissingCache(java.lang.String name)

Description copied from class: AbstractCacheManager

Return a missing cache with the specified name or null if such cache does not exist or could not be created on the fly.

Some caches may be created at runtime in the native provided. If a lookup by name does not yield any result, a subclass gets a chance to register such a cache at runtime. The returned cache will be automatically added to this instance.

Overrides:

getMissingCache in class AbstractCacheManager

Parameters:

name - the name of the cache to retrieve

Returns:

the missing cache or null if no such cache exists or could be created

See Also:

AbstractCacheManager.getCache(String)