Package org.nuxeo.runtime.kv

Class MemKeyValueStore

java.lang.Object

org.nuxeo.runtime.kv.AbstractKeyValueStoreProvider

org.nuxeo.runtime.kv.MemKeyValueStore

All Implemented Interfaces:

KeyValueStore, KeyValueStoreProvider

public class MemKeyValueStore
extends AbstractKeyValueStoreProvider

Memory-based implementation of a Key/Value store.

Since:

9.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final net.jodah.expiringmap.ExpiringMap<String,byte[]>	map
protected final Lock	writeLock

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

name, UTF_8_DECODERS

Constructor Summary

Constructors

Constructor	Description
MemKeyValueStore()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the content of this Key/Value store provider.
protected static byte[]	clone(byte[] value)
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.
protected void	doSetTTL(String key, long ttl)
byte[]	get(String key)	Retrieves the value associated to the key.
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

addAndGet, bytesToLong, bytesToString, compareAndSet, compareAndSet, compareAndSet, get, getLong, getLongs, getString, getStrings, initialize, 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

Methods inherited from interface org.nuxeo.runtime.kv.KeyValueStore

remove, removeLong, removeString

Field Details

map

protected final net.jodah.expiringmap.ExpiringMap<String,byte[]> map

writeLock

protected final Lock writeLock

Constructor Details

MemKeyValueStore

public MemKeyValueStore()

Method Details

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

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.

clone

protected static byte[] clone(byte[] value)

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

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

doSetTTL

protected void doSetTTL(String key,
 long ttl)

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)