com.edorasware.one.cache.internal

Class DefaultStatisticsAwareCache

java.lang.Object

com.edorasware.one.cache.internal.DefaultStatisticsAwareCache

All Implemented Interfaces:

StatisticsAwareCache, org.springframework.beans.factory.InitializingBean

public class DefaultStatisticsAwareCache
extends Object
implements org.springframework.beans.factory.InitializingBean, StatisticsAwareCache

Default caching class for dealing with Caches managed by a CacheManager.

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	CACHES

Fields inherited from interface com.edorasware.commons.core.cache.StatisticsAwareCache

ALL_DEFINITION_CACHES, EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_EXTERNAL_ID_CACHE_NAME, EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_ID_CACHE_NAME, EDORAS_GEAR_CONTENT_METADATA_BY_CONTENT_REFERENCE_ID, EDORAS_GEAR_CONTENT_REFERENCES_BY_CONTENT_SOURCE_ID, EDORAS_GEAR_CONTENT_VERSIONS_BY_CONTENT_REFERENCE_ID, EDORAS_GEAR_FORM_DEFINITIONS_BY_KEY_CACHE_NAME, EDORAS_GEAR_GLOBAL_ID_BY_WORK_OBJECT_ID_CACHE_NAME, EDORAS_GEAR_WORK_OBJECT_ID_BY_GLOBAL_ID_CACHE_NAME, EDORAS_ONE_CONVERTED_DOCUMENTS_CACHE_NAME, EDORAS_ONE_DEFINITION_ID_BY_MODEL_ID_CACHE_NAME, EDORAS_ONE_LANGUAGES_BY_LOCALE_CACHE_NAME, EDORAS_ONE_PREVIEWED_DOCUMENTS_CACHE_NAME, EDORAS_ONE_SYSTEM_GROUPS_BY_TENANT_ID_CACHE_NAME, EDORAS_ONE_TENANT_ID_BY_NAME_CACHE_NAME, EDORAS_ONE_TENANT_NAME_BY_ID_CACHE_NAME, EDORAS_VIS_PALETTE_CACHE_NAME, EDORAS_VIS_UTIL_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultStatisticsAwareCache(org.springframework.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	clear(String... cacheNames) Clears all values from the specified cache by name.
void	evict(String cacheName, Object key) Evicts the value in the specified cache by name and key.
<T> T	get(String cacheName, Object key, Class<T> valueClass) Gets the value from the specified cache by name and key.
org.springframework.cache.Cache	getCache(String cacheName) Return the cache instance by the given cache name.
List<CacheStatistics>	getCacheStatistics() Returns the CacheStatistics of all currently used cache instances.
void	put(String cacheName, Object key, Object value) Saves the value in the specified cache by name and key.

Methods inherited from class java.lang.Object

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

Field Detail

CACHES

public static final List<String> CACHES

Constructor Detail

DefaultStatisticsAwareCache

public DefaultStatisticsAwareCache(org.springframework.cache.CacheManager cacheManager)

Method Detail

getCacheStatistics

public List<CacheStatistics> getCacheStatistics()

Description copied from interface: StatisticsAwareCache

Returns the CacheStatistics of all currently used cache instances. If the configured Cache does not implement the CacheStatistics interface, the statistics are not returned for this instance.

Specified by:

getCacheStatistics in interface StatisticsAwareCache

Returns:

the CacheStatistics of all currently used cache instances.

getCache

public org.springframework.cache.Cache getCache(String cacheName)

Description copied from interface: StatisticsAwareCache

Return the cache instance by the given cache name.

Specified by:

getCache in interface StatisticsAwareCache

Parameters:

cacheName - the cache name for which the cache is returned

Returns:

the cache instance with the given cache name

get

public <T> T get(String cacheName,
                 Object key,
                 Class<T> valueClass)

Description copied from interface: StatisticsAwareCache

Gets the value from the specified cache by name and key. The return value is casted to the specified value class.

Specified by:

get in interface StatisticsAwareCache

Type Parameters:

T - the class of the returned value

Parameters:

cacheName - the name of the cache to get the value from

key - the key of the value

valueClass - the class of the returned value

Returns:

the value for the key casted to the specified value class

put

public void put(String cacheName,
                Object key,
                Object value)

Description copied from interface: StatisticsAwareCache

Saves the value in the specified cache by name and key.

Specified by:

put in interface StatisticsAwareCache

Parameters:

cacheName - the name of the cache to save the value to

key - the key of the value

value - the value to be saved. Depending on the underlying cache implementation, the value can be null.

evict

public void evict(String cacheName,
                  Object key)

Description copied from interface: StatisticsAwareCache

Evicts the value in the specified cache by name and key.

Specified by:

evict in interface StatisticsAwareCache

Parameters:

cacheName - the name of the cache to evict the value from

key - the key of the value

clear

public void clear(String... cacheNames)

Description copied from interface: StatisticsAwareCache

Clears all values from the specified cache by name.

Specified by:

clear in interface StatisticsAwareCache

Parameters:

cacheNames - the names of the caches to evict the value from

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception