com.communote.server.core.common.caching

Interface CacheManager

All Known Implementing Classes:

EhCacheManager

public interface CacheManager

Interface describing a cache manager that manages a Cache.

Author:

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

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	shutdown() Shutdown hook that allows the cache manager to do any kind of clean-up operations.

Method Detail

getAdditionalCaches

List<String> getAdditionalCaches()

Returns a list of all additional caches managed by CacheManager.

Returns:

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

getCache

Cache getCache()

Returns the cache managed by this manager.

Returns:

the cache

init

void init(Properties properties)
   throws CacheManagerInitializationException

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

Parameters:

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

Throws:

CacheManagerInitializationException - if the manager or underlying cache could not be initialized

invalidateAdditionalCache

void invalidateAdditionalCache(String id)
                        throws CacheException

Invalidates the additional cache with the given id.

Parameters:

id - id of the cache

Throws:

CacheException - if id of the cache could not be found or invalidation fails

invalidateMainCache

void invalidateMainCache()
                  throws CacheException

Invalidates the whole main cache.

Throws:

CacheException - if invalidation fails

shutdown

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.