RedisCacheConfiguration (Spring Data Redis 2.0.0.RELEASE API)

java.lang.Object
- org.springframework.data.redis.cache.RedisCacheConfiguration

```
public class RedisCacheConfiguration
extends Object
```
Immutable RedisCacheConfiguration helps customizing RedisCache behaviour such as caching null values, cache key prefixes and binary serialization.
Start with defaultCacheConfig() and customize RedisCache behaviour from there on.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RedisCacheConfiguration`	`defaultCacheConfig()` Default `RedisCacheConfiguration` using the following: key expiration eternal cache null values yes prefix cache keys yes default prefix [the actual cache name] key serializer StringRedisSerializer.class value serializer JdkSerializationRedisSerializer.class conversion service `DefaultFormattingConversionService` with `default` cache key converters
`RedisCacheConfiguration`	`disableCachingNullValues()` Disable caching null values.
`RedisCacheConfiguration`	`disableKeyPrefix()` Disable using cache key prefixes.
`RedisCacheConfiguration`	`entryTtl(Duration ttl)` Set the ttl to apply for cache entries.
`boolean`	`getAllowCacheNullValues()`
`org.springframework.core.convert.ConversionService`	`getConversionService()`
`Optional<String>`	`getKeyPrefix()`
`RedisSerializationContext.SerializationPair<String>`	`getKeySerializationPair()`
`Duration`	`getTtl()`
`RedisSerializationContext.SerializationPair<Object>`	`getValueSerializationPair()`
`RedisCacheConfiguration`	`prefixKeysWith(String prefix)` Use the given prefix instead of the default one.
`static void`	`registerDefaultConverters(org.springframework.core.convert.converter.ConverterRegistry registry)` Registers default cache key converters.
`RedisCacheConfiguration`	`serializeKeysWith(RedisSerializationContext.SerializationPair<String> keySerializationPair)` Define the `RedisSerializationContext.SerializationPair` used for de-/serializing cache keys.
`RedisCacheConfiguration`	`serializeValuesWith(RedisSerializationContext.SerializationPair<?> valueSerializationPair)` Define the `RedisSerializationContext.SerializationPair` used for de-/serializing cache values.
`boolean`	`usePrefix()`
`RedisCacheConfiguration`	`withConversionService(org.springframework.core.convert.ConversionService conversionService)` Define the `ConversionService` used for cache key to `String` conversion.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - defaultCacheConfig
```
public static RedisCacheConfiguration defaultCacheConfig()
```
    Default RedisCacheConfiguration using the following:
    
    key expiration
    
    eternal
    
    cache null values
    
    yes
    
    prefix cache keys
    
    yes
    
    default prefix
    
    [the actual cache name]
    
    key serializer
    
    StringRedisSerializer.class
    
    value serializer
    
    JdkSerializationRedisSerializer.class
    
    conversion service
    
    DefaultFormattingConversionService with default cache key converters
    
    Returns:
    
    new RedisCacheConfiguration.
  - entryTtl
```
public RedisCacheConfiguration entryTtl(Duration ttl)
```
    Set the ttl to apply for cache entries. Use Duration.ZERO to declare an eternal cache.
    
    Parameters:
    
    ttl - must not be null.
    
    Returns:
    
    new RedisCacheConfiguration.
  - prefixKeysWith
```
public RedisCacheConfiguration prefixKeysWith(String prefix)
```
    Use the given prefix instead of the default one.
    
    Parameters:
    
    prefix - must not be null.
    
    Returns:
    
    new RedisCacheConfiguration.
  - disableCachingNullValues
```
public RedisCacheConfiguration disableCachingNullValues()
```
    Disable caching null values.
    NOTE any Cache.put(Object, Object) operation involving null value will error. Nothing will be written to Redis, nothing will be removed. An already existing key will still be there afterwards with the very same value as before.
    
    Returns:
    
    new RedisCacheConfiguration.
  - disableKeyPrefix
```
public RedisCacheConfiguration disableKeyPrefix()
```
    Disable using cache key prefixes.
    NOTE: Cache.clear() might result in unintended removal of keys in Redis. Make sure to use a dedicated Redis instance when disabling prefixes.
    
    Returns:
    
    new RedisCacheConfiguration.
  - withConversionService
```
public RedisCacheConfiguration withConversionService(org.springframework.core.convert.ConversionService conversionService)
```
    Define the ConversionService used for cache key to String conversion.
    
    Parameters:
    
    conversionService - must not be null.
    
    Returns:
    
    new RedisCacheConfiguration.
  - serializeKeysWith
```
public RedisCacheConfiguration serializeKeysWith(RedisSerializationContext.SerializationPair<String> keySerializationPair)
```
    Define the RedisSerializationContext.SerializationPair used for de-/serializing cache keys.
    
    Parameters:
    
    keySerializationPair - must not be null.
    
    Returns:
    
    new RedisCacheConfiguration.
  - serializeValuesWith
```
public RedisCacheConfiguration serializeValuesWith(RedisSerializationContext.SerializationPair<?> valueSerializationPair)
```
    Define the RedisSerializationContext.SerializationPair used for de-/serializing cache values.
    
    Parameters:
    
    valueSerializationPair - must not be null.
    
    Returns:
    
    new RedisCacheConfiguration.
  - getKeyPrefix
```
public Optional<String> getKeyPrefix()
```
    Returns:
    
    never null.
  - usePrefix
```
public boolean usePrefix()
```
    Returns:
    
    true if cache keys need to be prefixed with the getKeyPrefix() if present or the default which resolves to Cache.getName().
  - getAllowCacheNullValues
```
public boolean getAllowCacheNullValues()
```
    Returns:
    
    true if caching null is allowed.
  - getKeySerializationPair
```
public RedisSerializationContext.SerializationPair<String> getKeySerializationPair()
```
    Returns:
    
    never null.
  - getValueSerializationPair
```
public RedisSerializationContext.SerializationPair<Object> getValueSerializationPair()
```
    Returns:
    
    never null.
  - getTtl
```
public Duration getTtl()
```
    Returns:
    
    The expiration time (ttl) for cache entries. Never null.
  - getConversionService
```
public org.springframework.core.convert.ConversionService getConversionService()
```
    Returns:
    
    The ConversionService used for cache key to String conversion. Never null.
  - registerDefaultConverters
```
public static void registerDefaultConverters(org.springframework.core.convert.converter.ConverterRegistry registry)
```
    Registers default cache key converters. The following converters get registered:
    - String to byte[] using UTF-8 encoding.
    - SimpleKey to String
    Parameters:
    
    registry - must not be null.

Class RedisCacheConfiguration

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaultCacheConfig

entryTtl

prefixKeysWith

disableCachingNullValues

disableKeyPrefix

withConversionService

serializeKeysWith

serializeValuesWith

getKeyPrefix

usePrefix

getAllowCacheNullValues

getKeySerializationPair

getValueSerializationPair

getTtl

getConversionService

registerDefaultConverters