Package org.springframework.data.redis.cache

Interface RedisCacheWriter.RedisCacheWriterConfigurer

Enclosing interface:

RedisCacheWriter

public static interface RedisCacheWriter.RedisCacheWriterConfigurer

Interface that allows for configuring a RedisCacheWriter.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
RedisCacheWriter.RedisCacheWriterConfigurer	batchStrategy(BatchStrategy batchStrategy)	Configure the BatchStrategy when clearing the cache (i.e. bulk removal of cache keys).
RedisCacheWriter.RedisCacheWriterConfigurer	cacheLocking(Consumer<RedisCacheWriter.CacheLockingConfigurer> configurerConsumer)	Configure cache locking to synchronize cache access across multiple cache instances.
default RedisCacheWriter.RedisCacheWriterConfigurer	collectStatistics()	Configure the CacheStatisticsCollector to use.
RedisCacheWriter.RedisCacheWriterConfigurer	collectStatistics(CacheStatisticsCollector cacheStatisticsCollector)	Configure the CacheStatisticsCollector to use.
default RedisCacheWriter.RedisCacheWriterConfigurer	enableLocking()	Enable cache locking to synchronize cache access across multiple cache instances.
default RedisCacheWriter.RedisCacheWriterConfigurer	enableLocking(Consumer<RedisCacheWriter.CacheLockingConfiguration> configurerConsumer)	Enable cache locking to synchronize cache access across multiple cache instances.
default RedisCacheWriter.RedisCacheWriterConfigurer	immediateWrites()	Use immediate writes (i.e. write operations such as RedisCacheWriter.put(String, byte[], byte[], Duration) or RedisCacheWriter.clear(String, byte[])) shall apply immediately.
RedisCacheWriter.RedisCacheWriterConfigurer	immediateWrites(boolean enableImmediateWrites)	Configure whether to use immediate writes (i.e. write operations such as RedisCacheWriter.put(String, byte[], byte[], Duration) or RedisCacheWriter.clear(String, byte[])) shall apply immediately.

Method Details

collectStatistics

default RedisCacheWriter.RedisCacheWriterConfigurer collectStatistics()

Configure the CacheStatisticsCollector to use. This is useful for plugging in and/or customizing statistics collection.

collectStatistics

RedisCacheWriter.RedisCacheWriterConfigurer collectStatistics(CacheStatisticsCollector cacheStatisticsCollector)

Configure the CacheStatisticsCollector to use. This is useful for plugging in and/or customizing statistics collection.

If no statistics collector is specified, no statistics will be recorded. Statistics collection can be reconfigured on the built RedisCacheWriter by invoking RedisCacheWriter#withStatisticsCollector(CacheStatisticsCollector).

Parameters:

cacheStatisticsCollector - the statistics collector to use.

batchStrategy

RedisCacheWriter.RedisCacheWriterConfigurer batchStrategy(BatchStrategy batchStrategy)

Configure the BatchStrategy when clearing the cache (i.e. bulk removal of cache keys).

If no batch strategy is specified, the RedisCacheWriter uses BatchStrategies.keys();

Parameters:

batchStrategy - the batch strategy to use.

enableLocking

default RedisCacheWriter.RedisCacheWriterConfigurer enableLocking()

Enable cache locking to synchronize cache access across multiple cache instances.

enableLocking

default RedisCacheWriter.RedisCacheWriterConfigurer enableLocking(Consumer<RedisCacheWriter.CacheLockingConfiguration> configurerConsumer)

Enable cache locking to synchronize cache access across multiple cache instances.

Parameters:

configurerConsumer - a configuration function that configures RedisCacheWriter.CacheLockingConfiguration.

cacheLocking

RedisCacheWriter.RedisCacheWriterConfigurer cacheLocking(Consumer<RedisCacheWriter.CacheLockingConfigurer> configurerConsumer)

Configure cache locking to synchronize cache access across multiple cache instances.

Parameters:

configurerConsumer - a configuration function that configures RedisCacheWriter.CacheLockingConfigurer.

immediateWrites

default RedisCacheWriter.RedisCacheWriterConfigurer immediateWrites()

Use immediate writes (i.e. write operations such as RedisCacheWriter.put(String, byte[], byte[], Duration) or RedisCacheWriter.clear(String, byte[])) shall apply immediately.

Several Cache operations can be performed asynchronously or deferred and this is the default behavior for RedisCacheWriter. Enable immediate writes in case a particular cache requires stronger consistency (i.e. Cache writes must be visible immediately).

When using a reactive Redis driver, immediate writes lead to blocking.

immediateWrites

RedisCacheWriter.RedisCacheWriterConfigurer immediateWrites(boolean enableImmediateWrites)

Configure whether to use immediate writes (i.e. write operations such as RedisCacheWriter.put(String, byte[], byte[], Duration) or RedisCacheWriter.clear(String, byte[])) shall apply immediately.

Several Cache operations can be performed asynchronously or deferred and this is the default behavior for RedisCacheWriter. Enable immediate writes in case a particular cache requires stronger consistency (i.e. Cache writes must be visible immediately).

When using a reactive Redis driver, immediate writes lead to blocking.

Parameters:

enableImmediateWrites - whether write operations must be visible immediately.