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 on top of Redis.

Author:

Costin Leau, Christoph Strobl, Thomas Darimont, Mark Paluch

Nested Class Summary

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

Cache.ValueRetrievalException, Cache.ValueWrapper

Constructor Summary

Constructors

Constructor and Description
RedisCache(String name, byte[] prefix, RedisOperations<? extends Object,? extends Object> redisOperations, long expiration) Constructs a new RedisCache instance.
RedisCache(String name, byte[] prefix, RedisOperations<? extends Object,? extends Object> redisOperations, long expiration, boolean allowNullValues) Constructs a new RedisCache instance.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	evict(Object key)
void	evict(RedisCacheElement element)
protected Object	fromStoreValue(Object storeValue)
Cache.ValueWrapper	get(Object key)
<T> T	get(Object key, Callable<T> valueLoader)
<T> T	get(Object key, Class<T> type) Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.
RedisCacheElement	get(RedisCacheKey cacheKey) Return the value to which this cache maps the specified key.
String	getName()
Object	getNativeCache() This implementation simply returns the RedisTemplate used for configuring the cache, giving access to the underlying Redis store.
protected Object	lookup(Object key)
void	put(Object key, Object value)
void	put(RedisCacheElement element) Add the element by adding SimpleValueWrapper.get() at RedisCacheElement.getKeyBytes().
Cache.ValueWrapper	putIfAbsent(Object key, Object value)
Cache.ValueWrapper	putIfAbsent(RedisCacheElement element) Add the element as long as no element exists at RedisCacheElement.getKeyBytes().

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

isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisCache

public RedisCache(String name,
                  byte[] prefix,
                  RedisOperations<? extends Object,? extends Object> redisOperations,
                  long expiration)

Constructs a new RedisCache instance.

Parameters:

name - cache name

prefix -

redisOperations -

expiration -

RedisCache

public RedisCache(String name,
                  byte[] prefix,
                  RedisOperations<? extends Object,? extends Object> redisOperations,
                  long expiration,
                  boolean allowNullValues)

Constructs a new RedisCache instance.

Parameters:

name - cache name

prefix - must not be null or empty.

redisOperations -

expiration -

allowNullValues -

Since:

1.8

Method Detail

get

public <T> T get(Object key,
                 Class<T> type)

Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.

Specified by:

get in interface Cache

Overrides:

get in class AbstractValueAdaptingCache

Parameters:

key -

type -

Returns:

See Also:

DATAREDIS-243

get

public Cache.ValueWrapper get(Object key)

Specified by:

get in interface Cache

Overrides:

get in class AbstractValueAdaptingCache

get

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

get

public RedisCacheElement get(RedisCacheKey cacheKey)

Return the value to which this cache maps the specified key.

Parameters:

cacheKey - the key whose associated value is to be returned via its binary representation.

Returns:

the RedisCacheElement stored at given key or null if no value found for key.

Since:

1.5

put

public void put(Object key,
                Object value)

fromStoreValue

protected Object fromStoreValue(Object storeValue)

Overrides:

fromStoreValue in class AbstractValueAdaptingCache

put

public void put(RedisCacheElement element)

Add the element by adding SimpleValueWrapper.get() at RedisCacheElement.getKeyBytes(). If the cache previously contained a mapping for this RedisCacheElement.getKeyBytes(), the old value is replaced by SimpleValueWrapper.get().

Parameters:

element - must not be null.

Since:

1.5

putIfAbsent

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

putIfAbsent

public Cache.ValueWrapper putIfAbsent(RedisCacheElement element)

Add the element as long as no element exists at RedisCacheElement.getKeyBytes(). If a value is present for RedisCacheElement.getKeyBytes() this one is returned.

Parameters:

element - must not be null.

Returns:

Since:

1.5

evict

public void evict(Object key)

evict

public void evict(RedisCacheElement element)

Parameters:

element - RedisCacheElement.getKeyBytes()

Since:

1.5

clear

public void clear()

getName

public String getName()

getNativeCache

public Object getNativeCache()

This implementation simply returns the RedisTemplate used for configuring the cache, giving access to the underlying Redis store.

lookup

protected Object lookup(Object key)

Specified by:

lookup in class AbstractValueAdaptingCache