org.kuali.rice.core.api.cache

Interface CacheManagerRegistry

All Known Implementing Classes:

CacheManagerRegistryImpl

public interface CacheManagerRegistry

Allows access to a registry of CacheManager instances that are identified by name.

Since:

2.0

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
org.springframework.cache.CacheManager	getCacheManager(String name) Gets a cache manager for a given name.
org.springframework.cache.CacheManager	getCacheManagerByCacheName(String cacheName) Gets a cache manager for a given cache name.
String	getCacheManagerName(org.springframework.cache.CacheManager cm) Gets the name of a cache manager.
List<org.springframework.cache.CacheManager>	getCacheManagers() Will return a list of registered cache managers.

Method Detail

getCacheManagers

List<org.springframework.cache.CacheManager> getCacheManagers()

Will return a list of registered cache managers. Will not return null but may return an empty list.

Returns:

a list of cache managers

getCacheManager

org.springframework.cache.CacheManager getCacheManager(String name)

Gets a cache manager for a given name. Name cannot be null or blank.

Parameters:

name - the cache manager name

Returns:

the CacheManager

Throws:

IllegalArgumentException - if the name is null or blank

getCacheManagerName

String getCacheManagerName(org.springframework.cache.CacheManager cm)

Gets the name of a cache manager. The cm cannot be null. Will not return null or blank string.

Parameters:

cm - the cache manager

Returns:

the name

Throws:

IllegalArgumentException - if the cm is null

getCacheManagerByCacheName

org.springframework.cache.CacheManager getCacheManagerByCacheName(String cacheName)

Gets a cache manager for a given cache name. Name cannot be null or blank.

Parameters:

cacheName - the name of a Cache in a CacheManager.

Returns:

the CacheManager

Throws:

IllegalArgumentException - if the name is null or blank