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

Class DefaultEhCacheConfigurer

java.lang.Object

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

All Implemented Interfaces:

EhCacheConfigurer

public class DefaultEhCacheConfigurer
extends Object
implements EhCacheConfigurer

Provides the standard ehCache configuration.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DefaultEhCacheConfigurer()

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.
protected URL	getEhCacheConfigFile() Returns the location of the default Ehcache configuration XML file as a URL.
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.
protected void	overrideFactoryConfigProperties(net.sf.ehcache.config.FactoryConfiguration factoryConfig, Map<String,String> propertyMap) Helper method that overrides the factory configuration property string with other settings.
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.
protected void	postProcessConfiguration(net.sf.ehcache.config.Configuration config, Properties properties) Called by the getConfiguration(Properties) method to allow additional processing of the loaded configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEhCacheConfigurer

public DefaultEhCacheConfigurer()

Method Detail

getConfiguration

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

Returns the configuration to be used to initialize the EhCache.

Specified by:

getConfiguration in interface EhCacheConfigurer

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

getEhCacheConfigFile

protected URL getEhCacheConfigFile()

Returns the location of the default Ehcache configuration XML file as a URL. The URL could point to a class path resource like '/com/acme/cache/ehcache.xml' or a resource on the file system. Subclasses should override this method to provide another configuration file.

Returns:

the location of the ehCache configuration file

getMainCacheName

public 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().

Specified by:

getMainCacheName in interface EhCacheConfigurer

Returns:

the name of the main cache

getProtectedCacheNames

public List<String> getProtectedCacheNames()

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

Specified by:

getProtectedCacheNames in interface EhCacheConfigurer

Returns:

the list of names of caches

overrideFactoryConfigProperties

protected void overrideFactoryConfigProperties(net.sf.ehcache.config.FactoryConfiguration factoryConfig,
                                               Map<String,String> propertyMap)

Helper method that overrides the factory configuration property string with other settings.

Parameters:

factoryConfig - the cache manager factory configuration

propertyMap - a map with properties to override or add

postConfiguration

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

Specified by:

postConfiguration in interface EhCacheConfigurer

Parameters:

cacheManager - the created cache manager

postProcessConfiguration

protected void postProcessConfiguration(net.sf.ehcache.config.Configuration config,
                                        Properties properties)

Called by the getConfiguration(Properties) method to allow additional processing of the loaded configuration.

Parameters:

config - the loaded configuration to process

properties - additional configuration properties