org.springframework.data.redis.core

Class RedisKeyValueAdapter

java.lang.Object

org.springframework.data.keyvalue.core.AbstractKeyValueAdapter

org.springframework.data.redis.core.RedisKeyValueAdapter

All Implemented Interfaces:

EventListener, Aware, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationListener<RedisKeyspaceEvent>, org.springframework.data.keyvalue.core.KeyValueAdapter

public class RedisKeyValueAdapter
extends org.springframework.data.keyvalue.core.AbstractKeyValueAdapter
implements InitializingBean, ApplicationContextAware, ApplicationListener<RedisKeyspaceEvent>

Redis specific KeyValueAdapter implementation. Uses binary codec to read/write data from/to Redis. Objects are stored in a Redis Hash using the value of RedisHash, the KeyspaceConfiguration or just Class.getName() as a prefix.
Example

 
 @RedisHash("persons")
 class Person {
   @Id String id;
   String name;
 }


         prefix              ID
           |                 |
           V                 V
 hgetall persons:5d67b7e1-8640-4475-beeb-c666fab4c0e5
 1) id
 2) 5d67b7e1-8640-4475-beeb-c666fab4c0e5
 3) name
 4) Rand al'Thor
 
 

The KeyValueAdapter is not intended to store simple types such as String values. Please use RedisTemplate for this purpose.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedisKeyValueAdapter.EnableKeyspaceEvents

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedisKeyValueAdapter() Default constructor.
	RedisKeyValueAdapter(RedisOperations<?,?> redisOps) Creates new RedisKeyValueAdapter with default RedisMappingContext and default RedisCustomConversions.
	RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisConverter redisConverter) Creates new RedisKeyValueAdapter with specific RedisConverter.
	RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisMappingContext mappingContext) Creates new RedisKeyValueAdapter with default RedisCustomConversions.
	RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisMappingContext mappingContext, CustomConversions customConversions) Deprecated. since 2.0, use RedisKeyValueAdapter(RedisOperations, RedisMappingContext, org.springframework.data.convert.CustomConversions).
	RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisMappingContext mappingContext, CustomConversions customConversions) Creates new RedisKeyValueAdapter.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	clear()
boolean	contains(Object id, String keyspace)
long	count(String keyspace)
byte[]	createKey(String keyspace, String id)
Object	delete(Object id, String keyspace)
<T> T	delete(Object id, String keyspace, Class<T> type)
void	deleteAllOf(String keyspace)
void	destroy()
CloseableIterator<Map.Entry<Object,Object>>	entries(String keyspace)
<T> T	execute(RedisCallback<T> callback) Execute RedisCallback via underlying RedisOperations.
Object	get(Object id, String keyspace)
<T> T	get(Object id, String keyspace, Class<T> type)
List<?>	getAllOf(String keyspace)
List<?>	getAllOf(String keyspace, long offset, int rows)
RedisConverter	getConverter() Get the RedisConverter in use.
void	onApplicationEvent(RedisKeyspaceEvent event)
Object	put(Object id, Object item, String keyspace)
void	setApplicationContext(ApplicationContext applicationContext)
void	setEnableKeyspaceEvents(RedisKeyValueAdapter.EnableKeyspaceEvents enableKeyspaceEvents) Configure usage of KeyExpirationEventMessageListener.
void	setKeyspaceNotificationsConfigParameter(String keyspaceNotificationsConfigParameter) Configure the notify-keyspace-events property if not already set.
byte[]	toBytes(Object source) Convert given source to binary representation using the underlying ConversionService.
void	update(PartialUpdate<?> update)

Methods inherited from class org.springframework.data.keyvalue.core.AbstractKeyValueAdapter

count, find, find, getQueryEngine

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisKeyValueAdapter

public RedisKeyValueAdapter(RedisOperations<?,?> redisOps)

Creates new RedisKeyValueAdapter with default RedisMappingContext and default RedisCustomConversions.

Parameters:

redisOps - must not be null.

RedisKeyValueAdapter

public RedisKeyValueAdapter(RedisOperations<?,?> redisOps,
                            RedisMappingContext mappingContext)

Creates new RedisKeyValueAdapter with default RedisCustomConversions.

Parameters:

redisOps - must not be null.

mappingContext - must not be null.

RedisKeyValueAdapter

@Deprecated
public RedisKeyValueAdapter(RedisOperations<?,?> redisOps,
                                        RedisMappingContext mappingContext,
                                        CustomConversions customConversions)

Deprecated. since 2.0, use RedisKeyValueAdapter(RedisOperations, RedisMappingContext, org.springframework.data.convert.CustomConversions).

Creates new RedisKeyValueAdapter.

Parameters:

redisOps - must not be null.

mappingContext - must not be null.

customConversions - can be null.

RedisKeyValueAdapter

public RedisKeyValueAdapter(RedisOperations<?,?> redisOps,
                            RedisMappingContext mappingContext,
                            @Nullable
                            CustomConversions customConversions)

Creates new RedisKeyValueAdapter.

Parameters:

redisOps - must not be null.

mappingContext - must not be null.

customConversions - can be null.

Since:

2.0

RedisKeyValueAdapter

public RedisKeyValueAdapter(RedisOperations<?,?> redisOps,
                            RedisConverter redisConverter)

Creates new RedisKeyValueAdapter with specific RedisConverter.

Parameters:

redisOps - must not be null.

redisConverter - must not be null.

RedisKeyValueAdapter

protected RedisKeyValueAdapter()

Default constructor.

Method Detail

put

public Object put(Object id,
                  Object item,
                  String keyspace)

Specified by:

put in interface org.springframework.data.keyvalue.core.KeyValueAdapter

contains

public boolean contains(Object id,
                        String keyspace)

Specified by:

contains in interface org.springframework.data.keyvalue.core.KeyValueAdapter

get

@Nullable
public Object get(Object id,
                            String keyspace)

Specified by:

get in interface org.springframework.data.keyvalue.core.KeyValueAdapter

get

@Nullable
public <T> T get(Object id,
                           String keyspace,
                           Class<T> type)

Specified by:

get in interface org.springframework.data.keyvalue.core.KeyValueAdapter

Overrides:

get in class org.springframework.data.keyvalue.core.AbstractKeyValueAdapter

delete

public Object delete(Object id,
                     String keyspace)

Specified by:

delete in interface org.springframework.data.keyvalue.core.KeyValueAdapter

delete

public <T> T delete(Object id,
                    String keyspace,
                    Class<T> type)

Specified by:

delete in interface org.springframework.data.keyvalue.core.KeyValueAdapter

Overrides:

delete in class org.springframework.data.keyvalue.core.AbstractKeyValueAdapter

getAllOf

public List<?> getAllOf(String keyspace)

Specified by:

getAllOf in interface org.springframework.data.keyvalue.core.KeyValueAdapter

getAllOf

public List<?> getAllOf(String keyspace,
                        long offset,
                        int rows)

deleteAllOf

public void deleteAllOf(String keyspace)

Specified by:

deleteAllOf in interface org.springframework.data.keyvalue.core.KeyValueAdapter

entries

public CloseableIterator<Map.Entry<Object,Object>> entries(String keyspace)

Specified by:

entries in interface org.springframework.data.keyvalue.core.KeyValueAdapter

count

public long count(String keyspace)

Specified by:

count in interface org.springframework.data.keyvalue.core.KeyValueAdapter

update

public void update(PartialUpdate<?> update)

execute

@Nullable
public <T> T execute(RedisCallback<T> callback)

Execute RedisCallback via underlying RedisOperations.

Parameters:

callback - must not be null.

Returns:

See Also:

RedisOperations.execute(RedisCallback)

getConverter

public RedisConverter getConverter()

Get the RedisConverter in use.

Returns:

never null.

clear

public void clear()

Specified by:

clear in interface org.springframework.data.keyvalue.core.KeyValueAdapter

createKey

public byte[] createKey(String keyspace,
                        String id)

toBytes

public byte[] toBytes(Object source)

Convert given source to binary representation using the underlying ConversionService.

Parameters:

source -

Returns:

Throws:

ConverterNotFoundException

setEnableKeyspaceEvents

public void setEnableKeyspaceEvents(RedisKeyValueAdapter.EnableKeyspaceEvents enableKeyspaceEvents)

Configure usage of KeyExpirationEventMessageListener.

Parameters:

enableKeyspaceEvents -

Since:

1.8

setKeyspaceNotificationsConfigParameter

public void setKeyspaceNotificationsConfigParameter(String keyspaceNotificationsConfigParameter)

Configure the notify-keyspace-events property if not already set. Use an empty String or null to retain existing server settings.

Parameters:

keyspaceNotificationsConfigParameter - can be null.

Since:

1.8

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

Since:

1.8

See Also:

InitializingBean.afterPropertiesSet()

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface DisposableBean

Throws:

Exception

onApplicationEvent

public void onApplicationEvent(RedisKeyspaceEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<RedisKeyspaceEvent>

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException