Package 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

Builder for creating a RedisCacheManager.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch, Kezhu Wang, John Blum

Method Summary

Modifier and Type	Method	Description
RedisCacheManager.RedisCacheManagerBuilder	allowCreateOnMissingCache(boolean allowRuntimeCacheCreation)	Configure whether to allow cache creation at runtime.
RedisCacheManager	build()	Create new instance of RedisCacheManager with configuration options applied.
RedisCacheConfiguration	cacheDefaults()	Returns the default RedisCacheConfiguration.
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 RedisCache creation at runtime for non-configured, undeclared caches.
RedisCacheManager.RedisCacheManagerBuilder	enableCreateOnMissingCache()	Enables RedisCache creation at runtime for unconfigured, undeclared caches.
RedisCacheManager.RedisCacheManagerBuilder	enableStatistics()	Enables cache statistics.
static RedisCacheManager.RedisCacheManagerBuilder	fromCacheWriter(RedisCacheWriter cacheWriter)	Factory method returning a new Builder used to create and configure a RedisCacheManager using the given RedisCacheWriter.
static RedisCacheManager.RedisCacheManagerBuilder	fromConnectionFactory(RedisConnectionFactory connectionFactory)	Factory method returning a new Builder used to create and configure a RedisCacheManager using the given RedisConnectionFactory.
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)	Registers the given cache name and RedisCacheConfiguration used to create and configure a RedisCache on startup.
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 Details

fromCacheWriter

public static RedisCacheManager.RedisCacheManagerBuilder fromCacheWriter(RedisCacheWriter cacheWriter)

Factory method returning a new Builder used to create and configure a RedisCacheManager using 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

fromConnectionFactory

public static RedisCacheManager.RedisCacheManagerBuilder fromConnectionFactory(RedisConnectionFactory connectionFactory)

Factory method returning a new Builder used to create and configure a RedisCacheManager using 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

allowCreateOnMissingCache

public RedisCacheManager.RedisCacheManagerBuilder allowCreateOnMissingCache(boolean allowRuntimeCacheCreation)

Configure whether to allow cache creation at runtime.

Parameters:

allowRuntimeCacheCreation - boolean to allow creation of undeclared caches at runtime; true by default.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

disableCreateOnMissingCache

public RedisCacheManager.RedisCacheManagerBuilder disableCreateOnMissingCache()

Disable RedisCache creation at runtime for non-configured, undeclared caches.

RedisCacheManager.getMissingCache(String) returns null for any non-configured, undeclared Cache instead of a new RedisCache instance. This allows the CompositeCacheManager to participate.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.0.4

See Also:

• allowCreateOnMissingCache(boolean)
• enableCreateOnMissingCache()

enableCreateOnMissingCache

public RedisCacheManager.RedisCacheManagerBuilder enableCreateOnMissingCache()

Enables RedisCache creation at runtime for unconfigured, undeclared caches.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.0.4

See Also:

• allowCreateOnMissingCache(boolean)
• disableCreateOnMissingCache()

cacheDefaults

public RedisCacheConfiguration cacheDefaults()

Returns the default RedisCacheConfiguration.

Returns:

the default RedisCacheConfiguration.

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

enableStatistics

public RedisCacheManager.RedisCacheManagerBuilder enableStatistics()

Enables cache statistics.

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.

transactionAware

public RedisCacheManager.RedisCacheManagerBuilder transactionAware()

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

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

withCacheConfiguration

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

Registers the given cache name and RedisCacheConfiguration used to create and configure a RedisCache on startup.

Parameters:

cacheName - name of the cache to register for creation on startup.

cacheConfiguration - RedisCacheConfiguration used to configure the new cache on startup.

Returns:

this RedisCacheManager.RedisCacheManagerBuilder.

Since:

2.2

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.

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

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

build

public RedisCacheManager build()

Create new instance of RedisCacheManager with configuration options applied.

Returns:

new instance of RedisCacheManager.