org.springframework.data.redis.cache

Class RedisCache

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

org.springframework.data.redis.cache.RedisCache

All Implemented Interfaces:

Cache

public class RedisCache
extends AbstractValueAdaptingCache

Cache implementation using for Redis as underlying store.

Use RedisCacheManager to create RedisCache instances.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

See Also:

RedisCacheConfiguration, RedisCacheWriter

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

Cache.ValueRetrievalException, Cache.ValueWrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedisCache(String name, RedisCacheWriter cacheWriter, RedisCacheConfiguration cacheConfig) Create new RedisCache.

Method Summary

Modifier and Type	Method and Description
void	clear()
protected String	convertKey(Object key) Convert key to a String representation used for cache key creation.
protected String	createCacheKey(Object key) Customization hook for creating cache key before it gets serialized.
protected Object	deserializeCacheValue(byte[] value) Deserialize the given value to the actual cache value.
void	evict(Object key)
<T> T	get(Object key, Callable<T> valueLoader)
RedisCacheConfiguration	getCacheConfiguration() Get RedisCacheConfiguration used.
String	getName()
RedisCacheWriter	getNativeCache()
protected Object	lookup(Object key)
protected Object	preProcessCacheValue(Object value) Customization hook called before passing object to RedisSerializer.
void	put(Object key, Object value)
Cache.ValueWrapper	putIfAbsent(Object key, Object value)
protected byte[]	serializeCacheKey(String cacheKey) Serialize the key.
protected byte[]	serializeCacheValue(Object value) Serialize the value to cache.

Methods inherited from class org.springframework.cache.support.AbstractValueAdaptingCache

fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cache.Cache

evictIfPresent, invalidate

Constructor Detail

RedisCache

protected RedisCache(String name,
                     RedisCacheWriter cacheWriter,
                     RedisCacheConfiguration cacheConfig)

Create new RedisCache.

Parameters:

name - must not be null.

cacheWriter - must not be null.

cacheConfig - must not be null.

Method Detail

lookup

protected Object lookup(Object key)

Specified by:

lookup in class AbstractValueAdaptingCache

getName

public String getName()

getNativeCache

public RedisCacheWriter getNativeCache()

get

public <T> T get(Object key,
                 Callable<T> valueLoader)

put

public void put(Object key,
                @Nullable
                Object value)

putIfAbsent

public Cache.ValueWrapper putIfAbsent(Object key,
                                      @Nullable
                                      Object value)

evict

public void evict(Object key)

clear

public void clear()

getCacheConfiguration

public RedisCacheConfiguration getCacheConfiguration()

Get RedisCacheConfiguration used.

Returns:

immutable RedisCacheConfiguration. Never null.

preProcessCacheValue

@Nullable
protected Object preProcessCacheValue(@Nullable
                                                Object value)

Customization hook called before passing object to RedisSerializer.

Parameters:

value - can be null.

Returns:

preprocessed value. Can be null.

serializeCacheKey

protected byte[] serializeCacheKey(String cacheKey)

Serialize the key.

Parameters:

cacheKey - must not be null.

Returns:

never null.

serializeCacheValue

protected byte[] serializeCacheValue(Object value)

Serialize the value to cache.

Parameters:

value - must not be null.

Returns:

never null.

deserializeCacheValue

@Nullable
protected Object deserializeCacheValue(byte[] value)

Deserialize the given value to the actual cache value.

Parameters:

value - must not be null.

Returns:

can be null.

createCacheKey

protected String createCacheKey(Object key)

Customization hook for creating cache key before it gets serialized.

Parameters:

key - will never be null.

Returns:

never null.

convertKey

protected String convertKey(Object key)

Convert key to a String representation used for cache key creation.

Parameters:

key - will never be null.

Returns:

never null.

Throws:

IllegalStateException - if key cannot be converted to String.