RedisKeyValueStore (Nuxeo ECM Projects 10.10 API)

java.lang.Object
- org.nuxeo.runtime.kv.AbstractKeyValueStoreProvider
- - org.nuxeo.ecm.core.redis.contribs.RedisKeyValueStore

All Implemented Interfaces:

KeyValueStore, KeyValueStoreProvider
```
public class RedisKeyValueStore
extends AbstractKeyValueStoreProvider
```
Redis implementation of a Key/Value Store Provider.
The following configuration properties are available:
- namespace: the Redis namespace to use for keys (in addition to the global Redis namespace configured in the Redis service). DEPRECATED since 10.10, use the descriptor's <namespace> element instead.
Since:

9.1

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`compareAndDelSHA`
`protected byte[]`	`compareAndSetSHA`
`protected byte[]`	`compareNullAndSetSHA`
`protected String`	`namespace`
`static String`	`NAMESPACE_PROP` Deprecated. since 10.10
`protected static Long`	`ONE`

Fields inherited from class org.nuxeo.runtime.kv.AbstractKeyValueStoreProvider
name, UTF_8_DECODERS

Constructor Summary

Constructors
Constructor and Description

RedisKeyValueStore()

Constructors
Constructor and Description
`RedisKeyValueStore()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`addAndGet(String key, long delta)` Atomically adds the delta to the value associated to the key, interpreted as a long represented as a string.
`void`	`clear()` Clears the content of this Key/Value store provider.
`void`	`close()` Closes this Key/Value store provider.
`boolean`	`compareAndSet(String key, byte[] expected, byte[] value, long ttl)` Atomically sets the value associated to the key to the given value, with the given TTL, if the current value is the expected value.
`static String`	`ecapeGlob(String prefix)` Escape glob-like wildcards and [] char ranges with a backslash.
`Map<String,byte[]>`	`get(Collection<String> keys)` Retrieves the key/value map associated with the keys.
`byte[]`	`get(String key)` Retrieves the value associated to the key.
`protected static byte[]`	`getBytes(String key)`
`Map<String,Long>`	`getLongs(Collection<String> keys)` Retrieves the key/value map associated with the keys.
`protected String[]`	`getNamespace(KeyValueStoreDescriptor descriptor)`
`Map<String,String>`	`getStrings(Collection<String> keys)` Retrieves the key/value map associated with the keys.
`protected List<byte[]>`	`getValuesForKeys(Collection<String> keys)`
`void`	`initialize(KeyValueStoreDescriptor descriptor)` Initializes this Key/Value store provider.
`Stream<String>`	`keyStream()` Returns a `Stream` of the keys contained in this Key/Value store provider.
`Stream<String>`	`keyStream(String prefix)` Returns a `Stream` of the keys with the given prefix contained in this Key/Value store provider.
`void`	`put(String key, byte[] value, long ttl)` Sets the value associated to the key, and a TTL.
`boolean`	`setTTL(String key, long ttl)` Sets the TTL for an existing key.

Methods inherited from class org.nuxeo.runtime.kv.AbstractKeyValueStoreProvider
bytesToLong, bytesToString, compareAndSet, compareAndSet, compareAndSet, getLong, getString, longToBytes, put, put, put, put, put, stringToBytes, toString

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

- Field Detail
  - NAMESPACE_PROP
```
@Deprecated
public static final String NAMESPACE_PROP
```
    Deprecated. since 10.10
    
    See Also:
    
    Constant Field Values
  - ONE
```
protected static final Long ONE
```
  - namespace
```
protected String namespace
```
  - compareAndSetSHA
```
protected byte[] compareAndSetSHA
```
  - compareAndDelSHA
```
protected byte[] compareAndDelSHA
```
  - compareNullAndSetSHA
```
protected byte[] compareNullAndSetSHA
```
- Constructor Detail
  - RedisKeyValueStore
```
public RedisKeyValueStore()
```
- Method Detail
  - getBytes
```
protected static byte[] getBytes(String key)
```
  - initialize
```
public void initialize(KeyValueStoreDescriptor descriptor)
```
    Description copied from interface: KeyValueStoreProvider
    
    Initializes this Key/Value store provider.
    
    Specified by:
    
    initialize in interface KeyValueStoreProvider
    
    Overrides:
    
    initialize in class AbstractKeyValueStoreProvider
    
    Parameters:
    
    descriptor - the store provider descriptor
  - getNamespace
```
protected String[] getNamespace(KeyValueStoreDescriptor descriptor)
```
  - keyStream
```
public Stream<String> keyStream()
```
    Description copied from interface: KeyValueStoreProvider
    
    Returns a Stream of the keys contained in this Key/Value store provider.
    This operation may be slow and should only be used for management or debug purposes.
    
    Returns:
    
    the stream of keys
  - keyStream
```
public Stream<String> keyStream(String prefix)
```
    Description copied from interface: KeyValueStoreProvider
    
    Returns a Stream of the keys with the given prefix contained in this Key/Value store provider.
    This operation may be slow and should only be used for management or debug purposes.
    
    Returns:
    
    the stream of keys
  - ecapeGlob
```
public static String ecapeGlob(String prefix)
```
    Escape glob-like wildcards and [] char ranges with a backslash.
  - close
```
public void close()
```
    Description copied from interface: KeyValueStoreProvider
    
    Closes this Key/Value store provider.
  - clear
```
public void clear()
```
    Description copied from interface: KeyValueStoreProvider
    
    Clears the content of this Key/Value store provider.
  - put
```
public void put(String key,
                byte[] value,
                long ttl)
```
    Description copied from interface: KeyValueStore
    
    Sets the value associated to the key, and a TTL.
    
    Parameters:
    
    key - the key
    
    value - the value, which may be null
    
    ttl - the TTL, in seconds (0 for infinite)
  - get
```
public byte[] get(String key)
```
    Description copied from interface: KeyValueStore
    
    Retrieves the value associated to the key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value, or null if there is no value
  - get
```
public Map<String,byte[]> get(Collection<String> keys)
```
    Description copied from interface: KeyValueStore
    
    Retrieves the key/value map associated with the keys.
    
    Specified by:
    
    get in interface KeyValueStore
    
    Overrides:
    
    get in class AbstractKeyValueStoreProvider
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the key/value map
  - getStrings
```
public Map<String,String> getStrings(Collection<String> keys)
```
    Description copied from interface: KeyValueStore
    
    Retrieves the key/value map associated with the keys.
    
    Specified by:
    
    getStrings in interface KeyValueStore
    
    Overrides:
    
    getStrings in class AbstractKeyValueStoreProvider
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the key/value map
  - getLongs
```
public Map<String,Long> getLongs(Collection<String> keys)
```
    Description copied from interface: KeyValueStore
    
    Retrieves the key/value map associated with the keys.
    
    Specified by:
    
    getLongs in interface KeyValueStore
    
    Overrides:
    
    getLongs in class AbstractKeyValueStoreProvider
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the key/value map
  - getValuesForKeys
```
protected List<byte[]> getValuesForKeys(Collection<String> keys)
```
    Since:
    
    9.10
  - setTTL
```
public boolean setTTL(String key,
                      long ttl)
```
    Description copied from interface: KeyValueStore
    
    Sets the TTL for an existing key.
    
    Parameters:
    
    key - the key
    
    ttl - the TTL, in seconds (0 for infinite)
    
    Returns:
    
    true if the TTL has been set, or false if the key does not exist
  - compareAndSet
```
public boolean compareAndSet(String key,
                             byte[] expected,
                             byte[] value,
                             long ttl)
```
    Description copied from interface: KeyValueStore
    
    Atomically sets the value associated to the key to the given value, with the given TTL, if the current value is the expected value.
    Note value comparison is done by value and not by reference.
    
    Parameters:
    
    key - the key
    
    expected - the expected value, which may be null
    
    value - the updated value, which may be null
    
    ttl - the TTL, in seconds (0 for infinite)
    
    Returns:
    
    true if the value was updated, or false if not (the expected value was not found)
  - addAndGet
```
public long addAndGet(String key,
                      long delta)
               throws NumberFormatException
```
    Description copied from interface: KeyValueStore
    
    Atomically adds the delta to the value associated to the key, interpreted as a long represented as a string.
    If the value does not exist (if KeyValueStore.get(java.lang.String) would return null), it is interpreted as 0.
    
    Specified by:
    
    addAndGet in interface KeyValueStore
    
    Overrides:
    
    addAndGet in class AbstractKeyValueStoreProvider
    
    Parameters:
    
    key - the key
    
    delta - the delta to add
    
    Returns:
    
    the new value
    
    Throws:
    
    NumberFormatException - if the existing value cannot be interpreted as a long

Class RedisKeyValueStore

Field Summary

Fields inherited from class org.nuxeo.runtime.kv.AbstractKeyValueStoreProvider

Constructor Summary

Method Summary

Methods inherited from class org.nuxeo.runtime.kv.AbstractKeyValueStoreProvider

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE_PROP

ONE

namespace

compareAndSetSHA

compareAndDelSHA

compareNullAndSetSHA

Constructor Detail

RedisKeyValueStore

Method Detail

getBytes

initialize

getNamespace

keyStream

keyStream

ecapeGlob

close

clear

put

get

get

getStrings

getLongs

getValuesForKeys

setTTL

compareAndSet

addAndGet