RedisKeyValueAdapter (Spring Data Redis 1.8.9.RELEASE API)

java.lang.Object
- org.springframework.data.keyvalue.core.AbstractKeyValueAdapter
- - org.springframework.data.redis.core.RedisKeyValueAdapter

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<RedisKeyspaceEvent>, org.springframework.data.keyvalue.core.KeyValueAdapter
```
public class RedisKeyValueAdapter
extends org.springframework.data.keyvalue.core.AbstractKeyValueAdapter
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.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

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 `CustomConversions`.
	`RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisConverter redisConverter)` Creates new `RedisKeyValueAdapter` with specific `RedisConverter`.
	`RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisMappingContext mappingContext)` Creates new `RedisKeyValueAdapter` with default `CustomConversions`.
	`RedisKeyValueAdapter(RedisOperations<?,?> redisOps, RedisMappingContext mappingContext, CustomConversions customConversions)` Creates new `RedisKeyValueAdapter`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`void`	`clear()`
`boolean`	`contains(Serializable id, Serializable keyspace)`
`long`	`count(Serializable keyspace)`
`byte[]`	`createKey(String keyspace, String id)`
`Object`	`delete(Serializable id, Serializable keyspace)`
`<T> T`	`delete(Serializable id, Serializable keyspace, Class<T> type)`
`void`	`deleteAllOf(Serializable keyspace)`
`void`	`destroy()`
`org.springframework.data.util.CloseableIterator<Map.Entry<Serializable,Object>>`	`entries(Serializable keyspace)`
`<T> T`	`execute(RedisCallback<T> callback)` Execute `RedisCallback` via underlying `RedisOperations`.
`Object`	`get(Serializable id, Serializable keyspace)`
`<T> T`	`get(Serializable id, Serializable keyspace, Class<T> type)`
`List<?>`	`getAllOf(Serializable keyspace)`
`List<?>`	`getAllOf(Serializable keyspace, int offset, int rows)`
`RedisConverter`	`getConverter()` Get the `RedisConverter` in use.
`void`	`onApplicationEvent(RedisKeyspaceEvent event)`
`Object`	`put(Serializable id, Object item, Serializable keyspace)`
`void`	`setApplicationContext(org.springframework.context.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 CustomConversions.
    
    Parameters:
    
    redisOps - must not be null.
  - RedisKeyValueAdapter
```
public RedisKeyValueAdapter(RedisOperations<?,?> redisOps,
                            RedisMappingContext mappingContext)
```
    Creates new RedisKeyValueAdapter with default CustomConversions.
    
    Parameters:
    
    redisOps - must not be null.
    
    mappingContext - must not be null.
  - RedisKeyValueAdapter
```
public RedisKeyValueAdapter(RedisOperations<?,?> redisOps,
                            RedisMappingContext mappingContext,
                            CustomConversions customConversions)
```
    Creates new RedisKeyValueAdapter.
    
    Parameters:
    
    redisOps - must not be null.
    
    mappingContext - must not be null.
    
    customConversions - can be null.
  - 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(Serializable id,
                  Object item,
                  Serializable keyspace)
```
    Specified by:
    
    put in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - contains
```
public boolean contains(Serializable id,
                        Serializable keyspace)
```
    Specified by:
    
    contains in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - get
```
public Object get(Serializable id,
                  Serializable keyspace)
```
    Specified by:
    
    get in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - get
```
public <T> T get(Serializable id,
                 Serializable 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
    
    Parameters:
    
    id -
    
    keyspace -
    
    type -
    
    Returns:
  - delete
```
public Object delete(Serializable id,
                     Serializable keyspace)
```
    Specified by:
    
    delete in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - delete
```
public <T> T delete(Serializable id,
                    Serializable 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(Serializable keyspace)
```
    Specified by:
    
    getAllOf in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - getAllOf
```
public List<?> getAllOf(Serializable keyspace,
                        int offset,
                        int rows)
```
  - deleteAllOf
```
public void deleteAllOf(Serializable keyspace)
```
    Specified by:
    
    deleteAllOf in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - entries
```
public org.springframework.data.util.CloseableIterator<Map.Entry<Serializable,Object>> entries(Serializable keyspace)
```
    Specified by:
    
    entries in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - count
```
public long count(Serializable keyspace)
```
    Specified by:
    
    count in interface org.springframework.data.keyvalue.core.KeyValueAdapter
  - update
```
public void update(PartialUpdate<?> update)
```
  - execute
```
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:
    
    org.springframework.core.convert.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 org.springframework.beans.factory.InitializingBean
    
    Since:
    
    1.8
    
    See Also:
    
    InitializingBean.afterPropertiesSet()
  - destroy
```
public void destroy()
             throws Exception
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    Exception
  - onApplicationEvent
```
public void onApplicationEvent(RedisKeyspaceEvent event)
```
    Specified by:
    
    onApplicationEvent in interface org.springframework.context.ApplicationListener<RedisKeyspaceEvent>
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException

Class RedisKeyValueAdapter

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

RedisKeyValueAdapter

RedisKeyValueAdapter

RedisKeyValueAdapter

RedisKeyValueAdapter

RedisKeyValueAdapter

Method Detail

put

contains

get

get

delete

delete

getAllOf

getAllOf

deleteAllOf

entries

count

update

execute

getConverter

clear

createKey

toBytes

setEnableKeyspaceEvents

setKeyspaceNotificationsConfigParameter

afterPropertiesSet

destroy

onApplicationEvent

setApplicationContext