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 CacheManager.

Since:

3.1

Author:

Costin Leau, Juergen Hoeller, Stephane Nicoll

See Also:

EhCacheCache

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(CacheManager cacheManager) Create a new EhCacheCacheManager for the given backing EhCache CacheManager.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
CacheManager	getCacheManager() Return the backing EhCache CacheManager.
protected Cache	getMissingCache(String name) Return a missing cache with the specified name, or null if such a cache does not exist or could not be created on demand.
protected Collection<Cache>	loadCaches() Load the initial caches for this cache manager.
void	setCacheManager(CacheManager cacheManager) Set the backing 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

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(CacheManager cacheManager)

Create a new EhCacheCacheManager for the given backing EhCache CacheManager.

Parameters:

cacheManager - the backing EhCache CacheManager

Method Detail

setCacheManager

public void setCacheManager(@Nullable
                            CacheManager cacheManager)

Set the backing EhCache CacheManager.

getCacheManager

@Nullable
public CacheManager getCacheManager()

Return the backing EhCache CacheManager.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractCacheManager

loadCaches

protected 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(String name)

Description copied from class: AbstractCacheManager

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

Caches may be lazily created at runtime if the native provider supports it. If a lookup by name does not yield any result, an AbstractCacheManager subclass gets a chance to register such a cache at runtime. The returned cache will be automatically added to this cache manager.

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 on demand

See Also:

AbstractCacheManager.getCache(String)