org.nuxeo.ecm.core.redis.contribs

Class RedisTransientStore

java.lang.Object

org.nuxeo.ecm.core.transientstore.AbstractTransientStore

org.nuxeo.ecm.core.redis.contribs.RedisTransientStore

All Implemented Interfaces:

TransientStore, TransientStoreProvider

public class RedisTransientStore
extends AbstractTransientStore

Redis implementation (i.e. cluster aware) of the TransientStore.

Since hashes cannot be nested, a storage entry is flattened as follows:

  - Entry summary:

    transientStore:transientStoreName:entryKey {
      "blobCount":    number of blobs associated with the entry
      "size":         storage size of the blobs associated with the entry
      "completed":    entry status
    }

 - Entry parameters:

   transientStore:transientStoreName:entryKey:params {
      "param1": value1
      "param2": value2
   }

 - Entry blobs:

   transientStore:transientStoreName:entryKey:blobs:0 {
      "file"
      "filename"
      "encoding"
      "mimetype"
      "digest"
   }

   transientStore:transientStoreName:entryKey:blobs:1 {
      ...
   }

   ...
 

Since:

7.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RedisTransientStore.KeyMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected int	firstLevelTTL
protected RedisTransientStore.KeyMatcher	keyMatcher
protected org.apache.commons.logging.Log	log
protected String	namespace
protected RedisAdmin	redisAdmin
protected RedisExecutor	redisExecutor
protected int	secondLevelTTL
protected static String	SIZE_KEY
protected String	sizeKey

Fields inherited from class org.nuxeo.ecm.core.transientstore.AbstractTransientStore

cacheDir, config

Constructor Summary

Constructors

Constructor and Description
RedisTransientStore()

Method Summary

Modifier and Type	Method and Description
protected long	decrementStorageSize(long size)
protected void	deleteBlobInfos(String key, String blobCountStr)
protected Serializable	deserialize(byte[] bytes)
protected Map<String,Serializable>	deserialize(Map<byte[],byte[]> byteMap)
boolean	exists(String key) Returns true if an entry exists with the given key.
List<Blob>	getBlobs(String key) Gets the blobs associated with the entry with the given key.
protected byte[]	getBytes(String key)
Serializable	getParameter(String key, String parameter) Gets the value of parameter in the entry with the given key.
Map<String,Serializable>	getParameters(String key) Gets values of the parameters in the entry with the given key.
long	getSize(String key) Returns the size of the blobs associated with the entry with the given key or -1 if entry does not exist.
long	getStorageSize() Returns the size (in bytes) of the disk storage used for blobs.
protected String	getString(byte[] bytes)
protected Map<String,String>	getSummary(String key)
long	getTTL(String key)
protected long	incrementStorageSize(long size)
void	init(TransientStoreConfig config) Initializes the store from the given config.
boolean	isCompleted(String key) Returns true if the entry with the given key is ready.
protected String	join(String... fragments)
Stream<String>	keyStream() Returns a Stream of keys for all entries.
protected void	persistBlobs(String key, long sizeOfBlobs, List<Map<String,String>> blobInfos) Updates the total storage size and the storage size of the entry with the given key according to sizeOfBlobs and stores the blob information in this entry.
void	putParameter(String key, String parameter, Serializable value) Sets parameter to value in the entry with the given key.
void	putParameters(String key, Map<String,Serializable> parameters) Puts parameters in the entry with the given key.
void	release(String key) Informs the store that the entry with the given key can be released if TTL or GC parameters require to do some cleanup.
protected void	removeAllEntries()
protected void	removeEntry(String key)
protected Map<byte[],byte[]>	serialize(Map<String,Serializable> map)
protected byte[]	serialize(Serializable value)
void	setCompleted(String key, boolean completed) Marks the entry with the given key as ready.
protected void	setStorageSize(long newSize) Sets the size of the disk storage in bytes.
protected void	setTTL(String key, int seconds)
void	shutdown() Shuts down the store.

Methods inherited from class org.nuxeo.ecm.core.transientstore.AbstractTransientStore

doGC, getCacheDir, getCachingDirectory, getCachingDirName, getFilePathSize, getKeyCachingDirName, getSizeOfBlobs, loadBlobs, putBlobs, remove, removeAll, removeBlobs, storeBlobs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.transientstore.api.TransientStoreProvider

getStorageSizeMB, keySet

Field Detail

SIZE_KEY

protected static final String SIZE_KEY

See Also:

Constant Field Values

redisExecutor

protected RedisExecutor redisExecutor

namespace

protected String namespace

sizeKey

protected String sizeKey

keyMatcher

protected RedisTransientStore.KeyMatcher keyMatcher

redisAdmin

protected RedisAdmin redisAdmin

firstLevelTTL

protected int firstLevelTTL

secondLevelTTL

protected int secondLevelTTL

log

protected org.apache.commons.logging.Log log

Constructor Detail

RedisTransientStore

public RedisTransientStore()

Method Detail

init

public void init(TransientStoreConfig config)

Description copied from interface: TransientStoreProvider

Initializes the store from the given config.

Specified by:

init in interface TransientStoreProvider

Overrides:

init in class AbstractTransientStore

shutdown

public void shutdown()

Description copied from interface: TransientStoreProvider

Shuts down the store.

Specified by:

shutdown in interface TransientStoreProvider

Specified by:

shutdown in class AbstractTransientStore

exists

public boolean exists(String key)

Description copied from interface: TransientStore

Returns true if an entry exists with the given key.

Specified by:

exists in interface TransientStore

Specified by:

exists in class AbstractTransientStore

keyStream

public Stream<String> keyStream()

Description copied from interface: TransientStoreProvider

Returns a Stream of keys for all entries.

putParameter

public void putParameter(String key,
                         String parameter,
                         Serializable value)

Description copied from interface: TransientStore

Sets parameter to value in the entry with the given key.

If entry does not exist a new entry is created. If parameter already exists in the entry it is overwritten.

Specified by:

putParameter in interface TransientStore

Specified by:

putParameter in class AbstractTransientStore

getParameter

public Serializable getParameter(String key,
                                 String parameter)

Description copied from interface: TransientStore

Gets the value of parameter in the entry with the given key.

Returns null if entry or parameter does not exist.

Specified by:

getParameter in interface TransientStore

Specified by:

getParameter in class AbstractTransientStore

putParameters

public void putParameters(String key,
                          Map<String,Serializable> parameters)

Description copied from interface: TransientStore

Puts parameters in the entry with the given key. Overwrites any existing parameter in the entry.

If entry does not exist a new entry is created.

Specified by:

putParameters in interface TransientStore

Specified by:

putParameters in class AbstractTransientStore

getParameters

public Map<String,Serializable> getParameters(String key)

Description copied from interface: TransientStore

Gets values of the parameters in the entry with the given key.

Returns null if entry does not exist.

Specified by:

getParameters in interface TransientStore

Specified by:

getParameters in class AbstractTransientStore

getBlobs

public List<Blob> getBlobs(String key)

Description copied from interface: TransientStore

Gets the blobs associated with the entry with the given key.

Returns null if entry does not exist.

Specified by:

getBlobs in interface TransientStore

Specified by:

getBlobs in class AbstractTransientStore

getSize

public long getSize(String key)

Description copied from interface: TransientStore

Returns the size of the blobs associated with the entry with the given key or -1 if entry does not exist.

Specified by:

getSize in interface TransientStore

Specified by:

getSize in class AbstractTransientStore

isCompleted

public boolean isCompleted(String key)

Description copied from interface: TransientStore

Returns true if the entry with the given key is ready.

Specified by:

isCompleted in interface TransientStore

Specified by:

isCompleted in class AbstractTransientStore

setCompleted

public void setCompleted(String key,
                         boolean completed)

Description copied from interface: TransientStore

Marks the entry with the given key as ready.

If entry does not exist a new entry is created.

Specified by:

setCompleted in interface TransientStore

Specified by:

setCompleted in class AbstractTransientStore

release

public void release(String key)

Description copied from interface: TransientStore

Informs the store that the entry with the given key can be released if TTL or GC parameters require to do some cleanup.

Has no effect if entry does not exist.

Specified by:

release in interface TransientStore

Specified by:

release in class AbstractTransientStore

persistBlobs

protected void persistBlobs(String key,
                            long sizeOfBlobs,
                            List<Map<String,String>> blobInfos)

Description copied from class: AbstractTransientStore

Updates the total storage size and the storage size of the entry with the given key according to sizeOfBlobs and stores the blob information in this entry.

Specified by:

persistBlobs in class AbstractTransientStore

getStorageSize

public long getStorageSize()

Description copied from interface: TransientStoreProvider

Returns the size (in bytes) of the disk storage used for blobs.

Returns:

the number of bytes used by stored blobs

setStorageSize

protected void setStorageSize(long newSize)

Description copied from class: AbstractTransientStore

Sets the size of the disk storage in bytes.

Specified by:

setStorageSize in class AbstractTransientStore

incrementStorageSize

protected long incrementStorageSize(long size)

Specified by:

incrementStorageSize in class AbstractTransientStore

decrementStorageSize

protected long decrementStorageSize(long size)

Specified by:

decrementStorageSize in class AbstractTransientStore

removeEntry

protected void removeEntry(String key)

Specified by:

removeEntry in class AbstractTransientStore

removeAllEntries

protected void removeAllEntries()

Specified by:

removeAllEntries in class AbstractTransientStore

getTTL

public long getTTL(String key)

getSummary

protected Map<String,String> getSummary(String key)

deleteBlobInfos

protected void deleteBlobInfos(String key,
                               String blobCountStr)

join

protected String join(String... fragments)

getBytes

protected byte[] getBytes(String key)

getString

protected String getString(byte[] bytes)

serialize

protected byte[] serialize(Serializable value)

deserialize

protected Serializable deserialize(byte[] bytes)

serialize

protected Map<byte[],byte[]> serialize(Map<String,Serializable> map)

deserialize

protected Map<String,Serializable> deserialize(Map<byte[],byte[]> byteMap)

setTTL

protected void setTTL(String key,
                      int seconds)