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

Class EhCacheManager

java.lang.Object

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

All Implemented Interfaces:

CacheManager

public class EhCacheManager
extends Object
implements CacheManager

Implementation of the CacheManager interface using Ehcache. The Ehcache configuration is searched on the class-path and must be provided via setConfigurer(EhCacheConfigurer) before initializing the manager.

Author:

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

Constructor Summary

Constructors

Constructor and Description
EhCacheManager()

Method Summary

Modifier and Type	Method and Description
List<String>	getAdditionalCaches() Returns a list of all additional caches managed by CacheManager.
Cache	getCache() Returns the cache managed by this manager.
void	init(Properties properties) Called to initialize the cache manager from properties.
void	invalidateAdditionalCache(String id) Invalidates the additional cache with the given id.
void	invalidateMainCache() Invalidates the whole main cache.
void	setConfigurer(EhCacheConfigurer provider) Sets the configurer that should be used when initializing the EhCache.
void	shutdown() Shutdown hook that allows the cache manager to do any kind of clean-up operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheManager

public EhCacheManager()

Method Detail

getAdditionalCaches

public List<String> getAdditionalCaches()

Returns a list of all additional caches managed by CacheManager.

Specified by:

getAdditionalCaches in interface CacheManager

Returns:

a list of additional caches, an empty list if no additional caches are managed

getCache

public Cache getCache()

Returns the cache managed by this manager.

Specified by:

getCache in interface CacheManager

Returns:

the cache

init

public void init(Properties properties)

Called to initialize the cache manager from properties. The manager might use this method to initialize the associated cache.

Specified by:

init in interface CacheManager

Parameters:

properties - properties object that can contain cache manager specific settings to set up the manager

invalidateAdditionalCache

public void invalidateAdditionalCache(String id)

Invalidates the additional cache with the given id.

Specified by:

invalidateAdditionalCache in interface CacheManager

Parameters:

id - id of the cache

invalidateMainCache

public void invalidateMainCache()

Invalidates the whole main cache.

Specified by:

invalidateMainCache in interface CacheManager

setConfigurer

public void setConfigurer(EhCacheConfigurer provider)

Sets the configurer that should be used when initializing the EhCache. This Method must be run before calling the init(Properties) method.

Parameters:

provider - the provider to be used

shutdown

public void shutdown()

Shutdown hook that allows the cache manager to do any kind of clean-up operations. This method is usually called when the application is shutting down.

Specified by:

shutdown in interface CacheManager