com.communote.server.core.common.caching.eh

Interface EhCacheConfigurer

All Known Implementing Classes:

DefaultEhCacheConfigurer

public interface EhCacheConfigurer

An EhCacheConfigurer gives access to a configuration for the EhCache backend. The configuration is usually loaded from an XML file.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
net.sf.ehcache.config.Configuration	getConfiguration(Properties properties) Returns the configuration to be used to initialize the EhCache.
String	getMainCacheName() Returns the name of the cache of the provided configuration which should be used as the main cache.
List<String>	getProtectedCacheNames() Returns a list of names of caches which should not be changed by CacheManager.
void	postConfiguration(net.sf.ehcache.CacheManager cacheManager) Called after the CacheManager which was configured with the configuration of the configuration file provided by this instance has been created.

Method Detail

getConfiguration

net.sf.ehcache.config.Configuration getConfiguration(Properties properties)
                                              throws net.sf.ehcache.CacheException

Returns the configuration to be used to initialize the EhCache.

Parameters:

properties - optional properties to override some of the configuration settings at runtime

Returns:

the configuration

Throws:

net.sf.ehcache.CacheException - if parsing the configuration failed

getMainCacheName

String getMainCacheName()

Returns the name of the cache of the provided configuration which should be used as the main cache. The main cache is the cache returned by EhCacheManager.getCache().

Returns:

the name of the main cache

getProtectedCacheNames

List<String> getProtectedCacheNames()

Returns a list of names of caches which should not be changed by CacheManager.

Returns:

the list of names of caches

postConfiguration

void postConfiguration(net.sf.ehcache.CacheManager cacheManager)

Called after the CacheManager which was configured with the configuration of the configuration file provided by this instance has been created. This allows additional configuration of the manager or the managed caches. Note: the configuration possibilities are rather limited after the cache manager and the caches have been created. See the EhCache documentation for details.

Parameters:

cacheManager - the created cache manager