Class ConcurrentMapCacheManager
- java.lang.Object
- org.springframework.cache.concurrent.ConcurrentMapCacheManager
- All Implemented Interfaces:
Aware
,BeanClassLoaderAware
,CacheManager
public class ConcurrentMapCacheManager extends Object implements CacheManager, BeanClassLoaderAware
CacheManager
implementation that lazily buildsConcurrentMapCache
instances for eachgetCache(java.lang.String)
request. Also supports a 'static' mode where the set of cache names is pre-defined throughsetCacheNames(java.util.Collection<java.lang.String>)
, with no dynamic creation of further cache regions at runtime.Note: This is by no means a sophisticated CacheManager; it comes with no cache configuration options. However, it may be useful for testing or simple caching scenarios. For advanced local caching needs, consider
JCacheCacheManager
,EhCacheCacheManager
,CaffeineCacheManager
orGuavaCacheManager
.- Since:
- 3.1
- Author:
- Juergen Hoeller
- See Also:
ConcurrentMapCache
Constructor Summary
Constructors Constructor Description ConcurrentMapCacheManager()
Construct a dynamic ConcurrentMapCacheManager, lazily creating cache instances as they are being requested.ConcurrentMapCacheManager(String... cacheNames)
Construct a static ConcurrentMapCacheManager, managing caches for the specified cache names only.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Cache
createConcurrentMapCache(String name)
Create a new ConcurrentMapCache instance for the specified cache name.Cache
getCache(String name)
Get the cache associated with the given name.Collection<String>
getCacheNames()
Get a collection of the cache names known by this manager.boolean
isAllowNullValues()
Return whether this cache manager accepts and convertsnull
values for all of its caches.boolean
isStoreByValue()
Return whether this cache manager stores a copy of each entry or a reference for all its caches.void
setAllowNullValues(boolean allowNullValues)
Specify whether to accept and convertnull
values for all caches in this cache manager.void
setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the beanclass loader
to a bean instance.void
setCacheNames(Collection<String> cacheNames)
Specify the set of cache names for this CacheManager's 'static' mode.void
setStoreByValue(boolean storeByValue)
Specify whether this cache manager stores a copy of each entry (true
or the reference (false
for all of its caches.
Constructor Detail
ConcurrentMapCacheManager
public ConcurrentMapCacheManager()
Construct a dynamic ConcurrentMapCacheManager, lazily creating cache instances as they are being requested.
ConcurrentMapCacheManager
public ConcurrentMapCacheManager(String... cacheNames)
Construct a static ConcurrentMapCacheManager, managing caches for the specified cache names only.
Method Detail
setCacheNames
public void setCacheNames(Collection<String> cacheNames)
Specify the set of cache names for this CacheManager's 'static' mode.The number of caches and their names will be fixed after a call to this method, with no creation of further cache regions at runtime.
Calling this with a
null
collection argument resets the mode to 'dynamic', allowing for further creation of caches again.
setAllowNullValues
public void setAllowNullValues(boolean allowNullValues)
Specify whether to accept and convertnull
values for all caches in this cache manager.Default is "true", despite ConcurrentHashMap itself not supporting
null
values. An internal holder object will be used to store user-levelnull
s.Note: A change of the null-value setting will reset all existing caches, if any, to reconfigure them with the new null-value requirement.
isAllowNullValues
public boolean isAllowNullValues()
Return whether this cache manager accepts and convertsnull
values for all of its caches.
setStoreByValue
public void setStoreByValue(boolean storeByValue)
Specify whether this cache manager stores a copy of each entry (true
or the reference (false
for all of its caches.Default is "false" so that the value itself is stored and no serializable contract is required on cached values.
Note: A change of the store-by-value setting will reset all existing caches, if any, to reconfigure them with the new store-by-value requirement.
- Since:
- 4.3
isStoreByValue
public boolean isStoreByValue()
Return whether this cache manager stores a copy of each entry or a reference for all its caches. If store by value is enabled, any cache entry must be serializable.- Since:
- 4.3
setBeanClassLoader
public void setBeanClassLoader(ClassLoader classLoader)
Description copied from interface:BeanClassLoaderAware
Callback that supplies the beanclass loader
to a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean's
InitializingBean.afterPropertiesSet()
method or a custom init-method.- Specified by:
setBeanClassLoader
in interfaceBeanClassLoaderAware
- Parameters:
classLoader
- the owning class loader; may benull
in which case a defaultClassLoader
must be used, for example theClassLoader
obtained viaClassUtils.getDefaultClassLoader()
getCacheNames
public Collection<String> getCacheNames()
Description copied from interface:CacheManager
Get a collection of the cache names known by this manager.- Specified by:
getCacheNames
in interfaceCacheManager
- Returns:
- the names of all caches known by the cache manager
getCache
public Cache getCache(String name)
Description copied from interface:CacheManager
Get the cache associated with the given name.Note that the cache may be lazily created at runtime if the native provider supports it.
- Specified by:
getCache
in interfaceCacheManager
- Parameters:
name
- the cache identifier (must not benull
)- Returns:
- the associated cache, or
null
if such a cache does not exist or could be not created
createConcurrentMapCache
protected Cache createConcurrentMapCache(String name)
Create a new ConcurrentMapCache instance for the specified cache name.- Parameters:
name
- the name of the cache- Returns:
- the ConcurrentMapCache (or a decorator thereof)