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

Class SingletonEhCacheManagerFactory

java.lang.Object

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

public class SingletonEhCacheManagerFactory
extends Object

Creates and provides a singleton EhCache CacheManager.

Author:

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

Method Summary

Modifier and Type	Method and Description
static net.sf.ehcache.CacheManager	createCacheManager(EhCacheConfigurer configurer, Properties runtimeSettings) Creates the singleton cache manager if it does not yet exist.
static net.sf.ehcache.CacheManager	createCacheManager(String pathToResource) Creates the singleton cache manager if it does not yet exist.
static net.sf.ehcache.CacheManager	getInstance()

Methods inherited from class java.lang.Object

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

Method Detail

createCacheManager

public static net.sf.ehcache.CacheManager createCacheManager(EhCacheConfigurer configurer,
                                                             Properties runtimeSettings)
                                                      throws net.sf.ehcache.CacheException

Creates the singleton cache manager if it does not yet exist. If it does exist the provided configuration will be used to update settings of the cache manager and the managed caches. Updates will only cover the registration of new listeners and creation of new caches. Other modifications are not supported by EhCache.

Parameters:

configurer - provides the configuration to use when initializing or updating the cache manager

runtimeSettings - additional settings which will be passed to the configurer to allow overriding some settings

Returns:

the cache manager

Throws:

net.sf.ehcache.CacheException - in case the creation failed

createCacheManager

public static net.sf.ehcache.CacheManager createCacheManager(String pathToResource)
                                                      throws net.sf.ehcache.CacheException

Creates the singleton cache manager if it does not yet exist. If it does exist the provided configuration will be used to update settings of the cache manager and the managed caches. Updates will only cover the registration of new listeners and creation of new caches. Other modifications are not supported by EhCache.

Parameters:

pathToResource - path to the EhCache XML configuration resource. The resource is expected to be on the class path.

Returns:

the cache manager

Throws:

net.sf.ehcache.CacheException - in case the creation failed

getInstance

public static net.sf.ehcache.CacheManager getInstance()

Returns:

singleton CacheManager, which will be null if createCacheManager(String) hasn't been called yet.