org.springframework.data.redis.cache

Class RedisCacheManager.RedisCacheManagerBuilder

java.lang.Object

org.springframework.data.redis.cache.RedisCacheManager.RedisCacheManagerBuilder

Enclosing class:

RedisCacheManager

public static class RedisCacheManager.RedisCacheManagerBuilder
extends Object

Configurator for creating RedisCacheManager.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch, Kezhu Wang

Method Summary

Modifier and Type	Method and Description
RedisCacheManager	build() Create new instance of RedisCacheManager with configuration options applied.
RedisCacheManager.RedisCacheManagerBuilder	cacheDefaults(RedisCacheConfiguration defaultCacheConfiguration) Define a default RedisCacheConfiguration applied to dynamically created RedisCaches.
RedisCacheManager.RedisCacheManagerBuilder	cacheWriter(RedisCacheWriter cacheWriter) Configure a RedisCacheWriter.
RedisCacheManager.RedisCacheManagerBuilder	disableCreateOnMissingCache() Disable in-flight Cache creation for unconfigured caches.
RedisCacheManager.RedisCacheManagerBuilder	enableStatistics()
static RedisCacheManager.RedisCacheManagerBuilder	fromCacheWriter(RedisCacheWriter cacheWriter) Entry point for builder style RedisCacheManager configuration.
static RedisCacheManager.RedisCacheManagerBuilder	fromConnectionFactory(RedisConnectionFactory connectionFactory) Entry point for builder style RedisCacheManager configuration.
Optional<RedisCacheConfiguration>	getCacheConfigurationFor(String cacheName) Get the RedisCacheConfiguration for a given cache by its name.
Set<String>	getConfiguredCaches() Get the Set of cache names for which the builder holds configuration.
RedisCacheManager.RedisCacheManagerBuilder	initialCacheNames(Set<String> cacheNames) Append a Set of cache names to be pre initialized with current RedisCacheConfiguration.
RedisCacheManager.RedisCacheManagerBuilder	transactionAware() Enable RedisCaches to synchronize cache put/evict operations with ongoing Spring-managed transactions.
RedisCacheManager.RedisCacheManagerBuilder	withCacheConfiguration(String cacheName, RedisCacheConfiguration cacheConfiguration)
RedisCacheManager.RedisCacheManagerBuilder	withInitialCacheConfigurations(Map<String,RedisCacheConfiguration> cacheConfigurations) Append a Map of cache name/RedisCacheConfiguration pairs to be pre initialized.

Methods inherited from class java.lang.Object

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

Method Detail

fromConnectionFactory

public static RedisCacheManager.RedisCacheManagerBuilder fromConnectionFactory(RedisConnectionFactory connectionFactory)

Entry point for builder style RedisCacheManager configuration.

Parameters:

connectionFactory - must not be null.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

fromCacheWriter

public static RedisCacheManager.RedisCacheManagerBuilder fromCacheWriter(RedisCacheWriter cacheWriter)

Entry point for builder style RedisCacheManager configuration.

Parameters:

cacheWriter - must not be null.

Returns:

new RedisCacheManager.RedisCacheManagerBuilder.

cacheDefaults

public RedisCacheManager.RedisCacheManagerBuilder cacheDefaults(RedisCacheConfiguration defaultCacheConfiguration)

Define a default RedisCacheConfiguration applied to dynamically created RedisCaches.

Parameters:

defaultCacheConfiguration - must not be null.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

cacheWriter

public RedisCacheManager.RedisCacheManagerBuilder cacheWriter(RedisCacheWriter cacheWriter)

Configure a RedisCacheWriter.

Parameters:

cacheWriter - must not be null.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.3

transactionAware

public RedisCacheManager.RedisCacheManagerBuilder transactionAware()

Enable RedisCaches to synchronize cache put/evict operations with ongoing Spring-managed transactions.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

initialCacheNames

public RedisCacheManager.RedisCacheManagerBuilder initialCacheNames(Set<String> cacheNames)

Append a Set of cache names to be pre initialized with current RedisCacheConfiguration. NOTE: This calls depends on cacheDefaults(RedisCacheConfiguration) using whatever default RedisCacheConfiguration is present at the time of invoking this method.

Parameters:

cacheNames - must not be null.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

withInitialCacheConfigurations

public RedisCacheManager.RedisCacheManagerBuilder withInitialCacheConfigurations(Map<String,RedisCacheConfiguration> cacheConfigurations)

Append a Map of cache name/RedisCacheConfiguration pairs to be pre initialized.

Parameters:

cacheConfigurations - must not be null.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

withCacheConfiguration

public RedisCacheManager.RedisCacheManagerBuilder withCacheConfiguration(String cacheName,
                                                                         RedisCacheConfiguration cacheConfiguration)

Parameters:

cacheName -

cacheConfiguration -

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.2

disableCreateOnMissingCache

public RedisCacheManager.RedisCacheManagerBuilder disableCreateOnMissingCache()

Disable in-flight Cache creation for unconfigured caches.

RedisCacheManager.getMissingCache(String) returns null for any unconfigured Cache instead of a new RedisCache instance. This allows eg. CompositeCacheManager to chime in.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.0.4

getConfiguredCaches

public Set<String> getConfiguredCaches()

Get the Set of cache names for which the builder holds configuration.

Returns:

an unmodifiable Set holding the name of caches for which a configuration has been set.

Since:

2.2

getCacheConfigurationFor

public Optional<RedisCacheConfiguration> getCacheConfigurationFor(String cacheName)

Get the RedisCacheConfiguration for a given cache by its name.

Parameters:

cacheName - must not be null.

Returns:

Optional.empty() if no RedisCacheConfiguration set for the given cache name.

Since:

2.2

enableStatistics

public RedisCacheManager.RedisCacheManagerBuilder enableStatistics()

Returns:

Since:

2.4

build

public RedisCacheManager build()

Create new instance of RedisCacheManager with configuration options applied.

Returns:

new instance of RedisCacheManager.