org.springframework.data.redis.cache

Class RedisCacheManager

java.lang.Object

org.springframework.cache.support.AbstractCacheManager

org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager

org.springframework.data.redis.cache.RedisCacheManager

All Implemented Interfaces:

InitializingBean, CacheManager

public class RedisCacheManager
extends org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager

CacheManager implementation for Redis. By default saves the keys directly, without appending a prefix (which acts as a namespace). To avoid clashes, it is recommended to change this (by setting 'usePrefix' to 'true').
By default RedisCaches will be lazily initialized for each getCache(String) request unless a set of predefined cache names is provided.

Setting AbstractTransactionSupportingCacheManager.setTransactionAware(boolean) to true will force Caches to be decorated as TransactionAwareCacheDecorator so values will only be written to the cache after successful commit of surrounding transaction.

Constructor Summary

Constructors

Constructor and Description
RedisCacheManager(RedisTemplate template) Construct a RedisCacheManager.
RedisCacheManager(RedisTemplate template, Collection<String> cacheNames) Construct a static RedisCacheManager, managing caches for the specified cache names only.

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<? extends Cache>	addConfiguredCachesIfNecessary(Collection<? extends Cache> caches) Returns a new Collection of Cache from the given caches collection and adds the configured Caches of they are not already present.
void	afterPropertiesSet() 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.
protected long	computeExpiration(String name)
protected Cache	createAndAddCache(String cacheName)
protected RedisCache	createCache(String cacheName)
protected Cache	decorateCache(Cache cache)
Cache	getCache(String name)
protected RedisCachePrefix	getCachePrefix()
protected RedisTemplate	getTemplate()
protected boolean	isCacheAlreadyDecorated(Cache cache)
protected boolean	isUsePrefix()
protected List<Cache>	loadAndInitRemoteCaches()
protected Collection<? extends Cache>	loadCaches()
protected Set<String>	loadRemoteCacheKeys()
void	setCacheNames(Collection<String> cacheNames) Specify the set of cache names for this CacheManager's 'static' mode.
void	setCachePrefix(RedisCachePrefix cachePrefix) Sets the cachePrefix.
void	setDefaultExpiration(long defaultExpireTime) Sets the default expire time (in seconds).
void	setExpires(Map<String,Long> expires) Sets the expire time (in seconds) for cache regions (by key).
void	setLoadRemoteCachesOnStartup(boolean loadRemoteCachesOnStartup) If set to true RedisCacheManager will try to retrieve cache names from redis server using KEYS command and initialize RedisCache for each of them.
void	setUsePrefix(boolean usePrefix)

Methods inherited from class org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager

isTransactionAware, setTransactionAware

Methods inherited from class org.springframework.cache.support.AbstractCacheManager

addCache, getCacheNames

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisCacheManager

public RedisCacheManager(RedisTemplate template)

Construct a RedisCacheManager.

Parameters:

template -

RedisCacheManager

public RedisCacheManager(RedisTemplate template,
                 Collection<String> cacheNames)

Construct a static RedisCacheManager, managing caches for the specified cache names only.

Parameters:

template -

cacheNames -

Since:

1.2

Method Detail

getCache

public Cache getCache(String name)

Specified by:

getCache in interface CacheManager

Overrides:

getCache in class AbstractCacheManager

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 or empty collection argument resets the mode to 'dynamic', allowing for further creation of caches again.

setUsePrefix

public void setUsePrefix(boolean usePrefix)

setCachePrefix

public void setCachePrefix(RedisCachePrefix cachePrefix)

Sets the cachePrefix. Defaults to 'DefaultRedisCachePrefix').

Parameters:

cachePrefix - the cachePrefix to set

setDefaultExpiration

public void setDefaultExpiration(long defaultExpireTime)

Sets the default expire time (in seconds).

Parameters:

defaultExpireTime - time in seconds.

setExpires

public void setExpires(Map<String,Long> expires)

Sets the expire time (in seconds) for cache regions (by key).

Parameters:

expires - time in seconds

setLoadRemoteCachesOnStartup

public void setLoadRemoteCachesOnStartup(boolean loadRemoteCachesOnStartup)

If set to true RedisCacheManager will try to retrieve cache names from redis server using KEYS command and initialize RedisCache for each of them.

Parameters:

loadRemoteCachesOnStartup -

Since:

1.2

loadCaches

protected Collection<? extends Cache> loadCaches()

Specified by:

loadCaches in class AbstractCacheManager

addConfiguredCachesIfNecessary

protected Collection<? extends Cache> addConfiguredCachesIfNecessary(Collection<? extends Cache> caches)

Returns a new Collection of Cache from the given caches collection and adds the configured Caches of they are not already present.

Parameters:

caches - must not be null

Returns:

createAndAddCache

protected Cache createAndAddCache(String cacheName)

createCache

protected RedisCache createCache(String cacheName)

computeExpiration

protected long computeExpiration(String name)

loadAndInitRemoteCaches

protected List<Cache> loadAndInitRemoteCaches()

loadRemoteCacheKeys

protected Set<String> loadRemoteCacheKeys()

getTemplate

protected RedisTemplate getTemplate()

getCachePrefix

protected RedisCachePrefix getCachePrefix()

isUsePrefix

protected boolean isUsePrefix()

afterPropertiesSet

public void afterPropertiesSet()

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.

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractCacheManager

See Also:

AbstractCacheManager.afterPropertiesSet()

decorateCache

protected Cache decorateCache(Cache cache)

Overrides:

decorateCache in class org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager

isCacheAlreadyDecorated

protected boolean isCacheAlreadyDecorated(Cache cache)