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 backed by a Redis cache.

This cache manager creates caches by default upon first write. Empty caches are not visible on Redis due to how Redis represents empty data structures.

Caches requiring a different RedisCacheConfiguration than the default configuration can be specified via RedisCacheManager.RedisCacheManagerBuilder.withInitialCacheConfigurations(Map).

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

See Also:

RedisCacheConfiguration, RedisCacheWriter

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration) Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, boolean allowInFlightCacheCreation, String... initialCacheNames) Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.
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 allowInFlightCacheCreation) Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.
RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration, String... initialCacheNames) Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Method Summary

Modifier and Type	Method and Description
static RedisCacheManager.RedisCacheManagerBuilder	builder() Entry point for builder style RedisCacheManager configuration.
static RedisCacheManager.RedisCacheManagerBuilder	builder(RedisCacheWriter cacheWriter) Entry point for builder style RedisCacheManager configuration.
static RedisCacheManager.RedisCacheManagerBuilder	builder(RedisConnectionFactory connectionFactory) Entry point for builder style RedisCacheManager configuration.
static RedisCacheManager	create(RedisConnectionFactory connectionFactory) Create a new RedisCacheManager with defaults applied.
protected RedisCache	createRedisCache(String name, RedisCacheConfiguration cacheConfig) Configuration hook for creating RedisCache with given name and cacheConfig.
Map<String,RedisCacheConfiguration>	getCacheConfigurations()
protected RedisCache	getMissingCache(String name)
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

addCache, afterPropertiesSet, getCache, getCacheNames, initializeCaches, lookupCache

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisCacheManager

public RedisCacheManager(RedisCacheWriter cacheWriter,
                         RedisCacheConfiguration defaultCacheConfiguration)

Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Parameters:

cacheWriter - must not be null.

defaultCacheConfiguration - must not be null. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

RedisCacheManager

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

Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Parameters:

cacheWriter - must not be null.

defaultCacheConfiguration - must not be null. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

initialCacheNames - optional set of known cache names that will be created with given defaultCacheConfiguration.

RedisCacheManager

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

Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Parameters:

cacheWriter - must not be null.

defaultCacheConfiguration - must not be null. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

allowInFlightCacheCreation - if set to true no new caches can be acquire at runtime but limited to the given list of initial cache names.

initialCacheNames - optional set of known cache names that will be created with given defaultCacheConfiguration.

Since:

2.0.4

RedisCacheManager

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

Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Parameters:

cacheWriter - must not be null.

defaultCacheConfiguration - must not be null. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

initialCacheConfigurations - Map of known cache names along with the configuration to use for those caches. Must not be null.

RedisCacheManager

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

Creates new RedisCacheManager using given RedisCacheWriter and default RedisCacheConfiguration.

Parameters:

cacheWriter - must not be null.

defaultCacheConfiguration - must not be null. Maybe just use RedisCacheConfiguration.defaultCacheConfig().

initialCacheConfigurations - Map of known cache names along with the configuration to use for those caches. Must not be null.

allowInFlightCacheCreation - if set to false this cache manager is limited to the initial cache configurations and will not create new caches at runtime.

Since:

2.0.4

Method Detail

create

public static RedisCacheManager create(RedisConnectionFactory connectionFactory)

Create a new RedisCacheManager with defaults applied.

locking

disabled

cache configuration

RedisCacheConfiguration.defaultCacheConfig()

initial caches

none

transaction aware

no

in-flight cache creation

enabled

Parameters:

connectionFactory - must not be null.

Returns:

new instance of RedisCacheManager.

builder

public static RedisCacheManager.RedisCacheManagerBuilder builder()

Entry point for builder style RedisCacheManager configuration.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.3

builder

public static RedisCacheManager.RedisCacheManagerBuilder builder(RedisConnectionFactory connectionFactory)

Entry point for builder style RedisCacheManager configuration.

Parameters:

connectionFactory - must not be null.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

builder

public static RedisCacheManager.RedisCacheManagerBuilder builder(RedisCacheWriter cacheWriter)

Entry point for builder style RedisCacheManager configuration.

Parameters:

cacheWriter - must not be null.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

loadCaches

protected Collection<RedisCache> loadCaches()

Specified by:

loadCaches in class AbstractCacheManager

getMissingCache

protected RedisCache getMissingCache(String name)

Overrides:

getMissingCache in class AbstractCacheManager

getCacheConfigurations

public Map<String,RedisCacheConfiguration> getCacheConfigurations()

Returns:

unmodifiable Map containing cache name / configuration pairs. Never null.

createRedisCache

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

Configuration hook for creating RedisCache with given name and cacheConfig.

Parameters:

name - must not be null.

cacheConfig - can be null.

Returns:

never null.