Package 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 AbstractTransactionSupportingCacheManager

CacheManager implementation for Redis backed by RedisCache.

This CacheManager creates caches on first write, by default. Empty caches are not visible in Redis due to how Redis represents empty data structures.

Caches requiring a different cache configuration than the default cache configuration can be specified via RedisCacheManager.RedisCacheManagerBuilder.withInitialCacheConfigurations(Map) or individually using RedisCacheManager.RedisCacheManagerBuilder.withCacheConfiguration(String, RedisCacheConfiguration).

Since:

2.0

Author:

Christoph Strobl, Mark Paluch, Yanming Zhou, John Blum

See Also:

• AbstractTransactionSupportingCacheManager
• RedisConnectionFactory
• RedisCacheConfiguration
• RedisCacheWriter
• RedisCache

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisCacheManager.RedisCacheManagerBuilder	Builder for creating a RedisCacheManager.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	DEFAULT_ALLOW_RUNTIME_CACHE_CREATION

Constructor Summary

Constructors

Constructor	Description
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration)	Creates a new RedisCacheManager initialized with the given RedisCacheWriter and default RedisCacheConfiguration.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, boolean allowRuntimeCacheCreation, String... initialCacheNames)	Creates a new RedisCacheManager initialized with the given RedisCacheWriter and default RedisCacheConfiguration along with whether to allow cache creation at runtime.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, boolean allowRuntimeCacheCreation, Map<String,RedisCacheConfiguration> initialCacheConfigurations)	Creates a new RedisCacheManager initialized with the given RedisCacheWriter and a default RedisCacheConfiguration, and whether to allow RedisCache creation at runtime.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, String... initialCacheNames)	Creates a new RedisCacheManager initialized with the given RedisCacheWriter and a default RedisCacheConfiguration along with an optional, initial set of cache names used to create Redis caches on startup.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, Map<String,RedisCacheConfiguration> initialCacheConfigurations)	Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, Map<String,RedisCacheConfiguration> initialCacheConfigurations, boolean allowRuntimeCacheCreation)	Deprecated. since 3.2.

Method Summary

Modifier and Type	Method	Description
static RedisCacheManager.RedisCacheManagerBuilder	builder()	Factory method returning a Builder used to construct and configure a RedisCacheManager.
static RedisCacheManager.RedisCacheManagerBuilder	builder(RedisCacheWriter cacheWriter)	Factory method returning a Builder used to construct and configure a RedisCacheManager initialized with the given RedisCacheWriter.
static RedisCacheManager.RedisCacheManagerBuilder	builder(RedisConnectionFactory connectionFactory)	Factory method returning a Builder used to construct and configure a RedisCacheManager initialized with the given RedisConnectionFactory.
static RedisCacheManager	create(RedisConnectionFactory connectionFactory)	Factory method used to construct a new RedisCacheManager initialized with the given RedisConnectionFactory and using defaults for caching.
protected RedisCache	createRedisCache(String name, RedisCacheConfiguration cacheConfiguration)	Creates a new RedisCache with given name and RedisCacheConfiguration.
Map<String,RedisCacheConfiguration>	getCacheConfigurations()	Return an unmodifiable Map containing caches name mapped to the RedisCache configuration.
protected RedisCacheWriter	getCacheWriter()	Returns a reference to the configured RedisCacheWriter used to perform RedisCache operations, such as reading from and writing to the cache.
protected RedisCacheConfiguration	getDefaultCacheConfiguration()	Gets the default RedisCacheConfiguration applied to new RedisCache instances on creation when custom, non-specific RedisCacheConfiguration was not provided.
protected Map<String,RedisCacheConfiguration>	getInitialCacheConfiguration()	Gets a Map of cache names to RedisCacheConfiguration objects as the initial set of Redis caches to create on startup.
protected RedisCache	getMissingCache(String name)
boolean	isAllowRuntimeCacheCreation()	Determines whether Redis caches are allowed to be created at runtime.
protected Collection<RedisCache>	loadCaches()

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

decorateCache, isTransactionAware, setTransactionAware

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

afterPropertiesSet, getCache, getCacheNames, initializeCaches, lookupCache

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ALLOW_RUNTIME_CACHE_CREATION

protected static final boolean DEFAULT_ALLOW_RUNTIME_CACHE_CREATION

See Also:

• Constant Field Values

Constructor Details

RedisCacheManager

public RedisCacheManager(RedisCacheWriter cacheWriter,
 RedisCacheConfiguration defaultCacheConfiguration)

Creates a new RedisCacheManager initialized with the given RedisCacheWriter and default RedisCacheConfiguration.

Allows cache creation at runtime.

Parameters:

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing appropriate Redis commands; must not be null.

defaultCacheConfiguration - RedisCacheConfiguration applied to new Redis caches by default when no cache-specific RedisCacheConfiguration is provided; must not be null.

Throws:

IllegalArgumentException - if either the given RedisCacheWriter or RedisCacheConfiguration are null.

See Also:

• RedisCacheConfiguration
• RedisCacheWriter

RedisCacheManager

public RedisCacheManager(RedisCacheWriter cacheWriter,
 RedisCacheConfiguration defaultCacheConfiguration,
 String... initialCacheNames)

Creates a new RedisCacheManager initialized with the given RedisCacheWriter and a default RedisCacheConfiguration along with an optional, initial set of cache names used to create Redis caches on startup.

Allows cache creation at runtime.

Parameters:

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing appropriate Redis commands; must not be null.

defaultCacheConfiguration - RedisCacheConfiguration applied to new Redis caches by default when no cache-specific RedisCacheConfiguration is provided; must not be null.

initialCacheNames - optional set of cache names used to create Redis caches on startup. The default RedisCacheConfiguration will be applied to each cache.

Throws:

IllegalArgumentException - if either the given RedisCacheWriter or RedisCacheConfiguration are null.

See Also:

• RedisCacheConfiguration
• RedisCacheWriter

RedisCacheManager

public RedisCacheManager(RedisCacheWriter cacheWriter,
 RedisCacheConfiguration defaultCacheConfiguration,
 boolean allowRuntimeCacheCreation,
 String... initialCacheNames)

Creates a new RedisCacheManager initialized with the given RedisCacheWriter and default RedisCacheConfiguration along with whether to allow cache creation at runtime.

Additionally, the optional, initial set of cache names will be used to create Redis caches on startup.

Parameters:

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing appropriate Redis commands; must not be null.

defaultCacheConfiguration - RedisCacheConfiguration applied to new Redis caches by default when no cache-specific RedisCacheConfiguration is provided; must not be null.

allowRuntimeCacheCreation - boolean specifying whether to allow creation of undeclared caches at runtime; true by default. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

initialCacheNames - optional set of cache names used to create Redis caches on startup. The default RedisCacheConfiguration will be applied to each cache.

Throws:

IllegalArgumentException - if either the given RedisCacheWriter or RedisCacheConfiguration are null.

Since:

2.0.4

See Also:

• RedisCacheConfiguration
• RedisCacheWriter

RedisCacheManager

public RedisCacheManager(RedisCacheWriter cacheWriter,
 RedisCacheConfiguration defaultCacheConfiguration,
 Map<String,RedisCacheConfiguration> initialCacheConfigurations)

Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Additionally, an initial RedisCache will be created and configured using the associated RedisCacheConfiguration for each named RedisCache in the given Map.

Allows cache creation at runtime.

Parameters:

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing appropriate Redis commands; must not be null.

defaultCacheConfiguration - RedisCacheConfiguration applied to new Redis caches by default when no cache-specific RedisCacheConfiguration is provided; must not be null.

initialCacheConfigurations - Map of declared, known cache names along with associated RedisCacheConfiguration used to create and configure Reds caches on startup; must not be null.

Throws:

IllegalArgumentException - if either the given RedisCacheWriter or RedisCacheConfiguration are null.

See Also:

• RedisCacheConfiguration
• RedisCacheWriter

RedisCacheManager

public RedisCacheManager(RedisCacheWriter cacheWriter,
 RedisCacheConfiguration defaultCacheConfiguration,
 boolean allowRuntimeCacheCreation,
 Map<String,RedisCacheConfiguration> initialCacheConfigurations)

Creates a new RedisCacheManager initialized with the given RedisCacheWriter and a default RedisCacheConfiguration, and whether to allow RedisCache creation at runtime.

Additionally, an initial RedisCache will be created and configured using the associated RedisCacheConfiguration for each named RedisCache in the given Map.

Parameters:

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing appropriate Redis commands; must not be null.

defaultCacheConfiguration - RedisCacheConfiguration applied to new Redis caches by default when no cache-specific RedisCacheConfiguration is provided; must not be null.

allowRuntimeCacheCreation - boolean specifying whether to allow creation of undeclared caches at runtime; true by default. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

initialCacheConfigurations - Map of declared, known cache names along with the associated RedisCacheConfiguration used to create and configure Redis caches on startup; must not be null.

Throws:

IllegalArgumentException - if either the given RedisCacheWriter or RedisCacheConfiguration are null.

Since:

2.0.4

See Also:

• RedisCacheConfiguration
• RedisCacheWriter

RedisCacheManager

@Deprecated(since="3.2")
public RedisCacheManager(RedisCacheWriter cacheWriter,
 RedisCacheConfiguration defaultCacheConfiguration,
 Map<String,RedisCacheConfiguration> initialCacheConfigurations,
 boolean allowRuntimeCacheCreation)

Deprecated.

since 3.2. Use RedisCacheManager(RedisCacheWriter, RedisCacheConfiguration, boolean, Map) instead.

Method Details

builder

public static RedisCacheManager.RedisCacheManagerBuilder builder()

Factory method returning a Builder used to construct and configure a RedisCacheManager.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.3

builder

public static RedisCacheManager.RedisCacheManagerBuilder builder(RedisCacheWriter cacheWriter)

Factory method returning a Builder used to construct and configure a RedisCacheManager initialized with the given RedisCacheWriter.

Parameters:

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing appropriate Redis commands; must not be null.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

Throws:

IllegalArgumentException - if the given RedisCacheWriter is null.

See Also:

• RedisCacheWriter

builder

public static RedisCacheManager.RedisCacheManagerBuilder builder(RedisConnectionFactory connectionFactory)

Factory method returning a Builder used to construct and configure a RedisCacheManager initialized with the given RedisConnectionFactory.

Parameters:

connectionFactory - RedisConnectionFactory used by the RedisCacheManager to acquire connections to Redis when performing RedisCache operations; must not be null.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

Throws:

IllegalArgumentException - if the given RedisConnectionFactory is null.

See Also:

• RedisConnectionFactory

create

public static RedisCacheManager create(RedisConnectionFactory connectionFactory)

Factory method used to construct a new RedisCacheManager initialized with the given RedisConnectionFactory and using defaults for caching.

locking

disabled

batch strategy

BatchStrategies.keys()

cache configuration

RedisCacheConfiguration.defaultCacheConfig()

initial caches

none

transaction aware

no

in-flight cache creation

enabled

Parameters:

connectionFactory - RedisConnectionFactory used by the RedisCacheManager to acquire connections to Redis when performing RedisCache operations; must not be null.

Returns:

new RedisCacheManager.

Throws:

IllegalArgumentException - if the given RedisConnectionFactory is null.

See Also:

• RedisConnectionFactory

isAllowRuntimeCacheCreation

public boolean isAllowRuntimeCacheCreation()

Determines whether Redis caches are allowed to be created at runtime.

Returns:

a boolean value indicating whether Redis caches are allowed to be created at runtime.

getCacheConfigurations

public Map<String,RedisCacheConfiguration> getCacheConfigurations()

Return an unmodifiable Map containing caches name mapped to the RedisCache configuration.

Returns:

unmodifiable Map containing cache name / configuration pairs.

getDefaultCacheConfiguration

protected RedisCacheConfiguration getDefaultCacheConfiguration()

Gets the default RedisCacheConfiguration applied to new RedisCache instances on creation when custom, non-specific RedisCacheConfiguration was not provided.

Returns:

the default RedisCacheConfiguration.

getInitialCacheConfiguration

protected Map<String,RedisCacheConfiguration> getInitialCacheConfiguration()

Gets a Map of cache names to RedisCacheConfiguration objects as the initial set of Redis caches to create on startup.

Returns:

a Map of cache names to RedisCacheConfiguration objects.

getCacheWriter

protected RedisCacheWriter getCacheWriter()

Returns a reference to the configured RedisCacheWriter used to perform RedisCache operations, such as reading from and writing to the cache.

Returns:

a reference to the configured RedisCacheWriter.

See Also:

• RedisCacheWriter

getMissingCache

protected RedisCache getMissingCache(String name)

Overrides:

getMissingCache in class AbstractCacheManager

createRedisCache

protected RedisCache createRedisCache(String name,
 @Nullable
 RedisCacheConfiguration cacheConfiguration)

Creates a new RedisCache with given name and RedisCacheConfiguration.

Parameters:

name - name for the RedisCache; must not be null.

cacheConfiguration - RedisCacheConfiguration used to configure the RedisCache; resolves to the getDefaultCacheConfiguration() if null.

Returns:

a new RedisCache instance; never null.

loadCaches

protected Collection<RedisCache> loadCaches()

Specified by:

loadCaches in class AbstractCacheManager