org.cache2k.extra.spring

Class SpringCache2kCacheManager

java.lang.Object

org.cache2k.extra.spring.SpringCache2kCacheManager

All Implemented Interfaces:

org.springframework.cache.CacheManager

public class SpringCache2kCacheManager
extends Object
implements org.springframework.cache.CacheManager

A Spring cache manager that manages cache2k caches. The manager delegates to the cache2k native CacheManager. The available caches can be configured programmatically in a Spring configuration class via the use of addCaches(Function[]), via a Spring XML configuration and setCaches(Collection) or via the cache2k XML configuration.

Author:

Jens Wilke

See Also:

Spring Framework - cache2k User Guide

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SPRING_CACHE_MANAGER_NAME Default name used for the cache2k cache manager controlled by the spring cache manager.

Constructor Summary

Constructors

Constructor and Description
SpringCache2kCacheManager() Construct a spring cache manager, using the cache2k cache manager with the name "springDefault".
SpringCache2kCacheManager(org.cache2k.CacheManager manager) Construct a spring cache manager, using a custom cache2k cache manager.
SpringCache2kCacheManager(String name) Construct a spring cache manager, using the cache2k cache manager instance with the specified name.

Method Summary

Modifier and Type	Method and Description
SpringCache2kCacheManager	addCaches(Function<org.cache2k.Cache2kBuilder<?,?>,org.cache2k.Cache2kBuilder<?,?>>... fs) Adds a caches to this cache manager that maybe is configured via the Cache2kBuilder.
SpringCache2kCacheManager	defaultSetup(Function<org.cache2k.Cache2kBuilder<?,?>,org.cache2k.Cache2kBuilder<?,?>> f) Function providing default settings for caches added to the manager via addCaches(java.util.function.Function<org.cache2k.Cache2kBuilder<?, ?>, org.cache2k.Cache2kBuilder<?, ?>>...)
SpringCache2kCache	getCache(String name) Returns an existing cache or retrieves and wraps a cache from cache2k.
Map<String,SpringCache2kCache>	getCacheMap() Expose the map of created and wrapped caches.
Collection<String>	getCacheNames() Get a list of known caches.
Collection<String>	getConfiguredCacheNames() List of configured cache names.
org.cache2k.CacheManager	getNativeCacheManager() Expose the native cache manager.
boolean	isAllowUnknownCache()
void	setAllowUnknownCache(boolean v) If false, the cache manager only manages a cache if added via addCaches(java.util.function.Function<org.cache2k.Cache2kBuilder<?, ?>, org.cache2k.Cache2kBuilder<?, ?>>...), setCaches(Collection) or enlisted in the cache2k XML configuration.
void	setCaches(Collection<org.cache2k.configuration.Cache2kConfiguration<?,?>> cacheConfigurationList) Configure the known caches via the configuration bean.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SPRING_CACHE_MANAGER_NAME

public static final String DEFAULT_SPRING_CACHE_MANAGER_NAME

Default name used for the cache2k cache manager controlled by the spring cache manager.

See Also:

Constant Field Values

Constructor Detail

SpringCache2kCacheManager

public SpringCache2kCacheManager()

Construct a spring cache manager, using the cache2k cache manager with the name "springDefault". It is recommended that the spring cache manager uses a cache2k cache manager exclusively and all caches are created only via the spring cache manager. (Behavior since cache2k version 1.4)

See Also:

CacheManager

SpringCache2kCacheManager

public SpringCache2kCacheManager(String name)

Construct a spring cache manager, using the cache2k cache manager instance with the specified name.

See Also:

CacheManager, CacheManager.getInstance()

SpringCache2kCacheManager

public SpringCache2kCacheManager(org.cache2k.CacheManager manager)

Construct a spring cache manager, using a custom cache2k cache manager. This allows for the use of a different manager name and classloader.

See Also:

CacheManager, CacheManager.getInstance(String), CacheManager.getInstance(ClassLoader), CacheManager.getInstance(ClassLoader, String)

Method Detail

getCache

public SpringCache2kCache getCache(String name)

Returns an existing cache or retrieves and wraps a cache from cache2k.

Specified by:

getCache in interface org.springframework.cache.CacheManager

defaultSetup

public SpringCache2kCacheManager defaultSetup(Function<org.cache2k.Cache2kBuilder<?,?>,org.cache2k.Cache2kBuilder<?,?>> f)

Function providing default settings for caches added to the manager via addCaches(java.util.function.Function<org.cache2k.Cache2kBuilder<?, ?>, org.cache2k.Cache2kBuilder<?, ?>>...)

addCaches

@SafeVarargs
public final SpringCache2kCacheManager addCaches(Function<org.cache2k.Cache2kBuilder<?,?>,org.cache2k.Cache2kBuilder<?,?>>... fs)

Adds a caches to this cache manager that maybe is configured via the Cache2kBuilder. The configuration parameter Cache2kBuilder.exceptionPropagator(org.cache2k.integration.ExceptionPropagator<K>) is managed by this class and cannot be used. This method can be used in case a programmatic configuration of a cache manager is preferred.

Rationale: The method provides a builder that is already seeded with the effective cache2k cache manager. This makes it possible to use the builder without code bloat. Since the actual build is done within this class, it is also possible to reset specific settings or do assertions.

Throws:

IllegalArgumentException - if cache is already created

setCaches

public void setCaches(Collection<org.cache2k.configuration.Cache2kConfiguration<?,?>> cacheConfigurationList)

Configure the known caches via the configuration bean. This method is intended to be used together with Springs' own XML bean configuration. If a cache name is configured also with a cache2k XML configuration, the configuration is merged.

getCacheNames

public Collection<String> getCacheNames()

Get a list of known caches. Depending on the configuration, caches may be created dynamically without providing a configuration for a specific cache name. Because of this combine the known names from configuration and activated caches.

Specified by:

getCacheNames in interface org.springframework.cache.CacheManager

getConfiguredCacheNames

public Collection<String> getConfiguredCacheNames()

List of configured cache names. These are caches configured in cache2k via XML and caches added to this cache manager with programmatic configuration addCache(org.cache2k.Cache2kBuilder<?, ?>). Used for testing purposes to determine whether a cache was added dynamically.

getNativeCacheManager

public org.cache2k.CacheManager getNativeCacheManager()

Expose the native cache manager.

getCacheMap

public Map<String,SpringCache2kCache> getCacheMap()

Expose the map of created and wrapped caches.

isAllowUnknownCache

public boolean isAllowUnknownCache()

setAllowUnknownCache

public void setAllowUnknownCache(boolean v)

If false, the cache manager only manages a cache if added via addCaches(java.util.function.Function<org.cache2k.Cache2kBuilder<?, ?>, org.cache2k.Cache2kBuilder<?, ?>>...), setCaches(Collection) or enlisted in the cache2k XML configuration. Setting this to true will create a cache with a default configuration if the requested cache name is not known. The default is true.