Package org.nuxeo.ecm.core.uidgen

Class KeyValueStoreUIDSequencer

java.lang.Object

org.nuxeo.ecm.core.uidgen.AbstractUIDSequencer

org.nuxeo.ecm.core.uidgen.KeyValueStoreUIDSequencer

All Implemented Interfaces:

UIDSequencer

public class KeyValueStoreUIDSequencer
extends AbstractUIDSequencer

UID Sequencer based on a key/value store. The store is the same for all sequencers, but they are using different keys, prefixed by the sequencer name.

Since:

10.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_STORE_NAME
static final String	SEP
static final String	STORE_NAME_PROPERTY	Configuration property to specify the key/value store name.
protected String	storeName

Fields inherited from class org.nuxeo.ecm.core.uidgen.AbstractUIDSequencer

name

Fields inherited from interface org.nuxeo.ecm.core.uidgen.UIDSequencer

SEQUENCE_DOES_NOT_EXIST

Constructor Summary

Constructors

Constructor	Description
KeyValueStoreUIDSequencer()

Method Summary

Modifier and Type	Method	Description
void	dispose()	Cleanup callback
long	getCurrent(String key)
protected String	getKey(String key)
List<String>	getKeys()
List<Long>	getNextBlock(String key, int blockSize)	Returns a block containing blockSize sequences.
long	getNextLong(String key)	For the given key returns the incremented UID which is also stored in the same sequence entry.
protected KeyValueStore	getStore()
void	init()	Init Sequencer
void	initSequence(String key, long id)	Initializes the sequencer with the given key to at least the given long id.

Methods inherited from class org.nuxeo.ecm.core.uidgen.AbstractUIDSequencer

getName, setName

Methods inherited from class java.lang.Object

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

Field Details

STORE_NAME_PROPERTY

public static final String STORE_NAME_PROPERTY

Configuration property to specify the key/value store name. If none is specified, sequence is used.

See Also:

• Constant Field Values

DEFAULT_STORE_NAME

public static final String DEFAULT_STORE_NAME

See Also:

• Constant Field Values

SEP

public static final String SEP

See Also:

• Constant Field Values

storeName

protected String storeName

Constructor Details

KeyValueStoreUIDSequencer

public KeyValueStoreUIDSequencer()

Method Details

init

public void init()

Description copied from interface: UIDSequencer

Init Sequencer

dispose

public void dispose()

Description copied from interface: UIDSequencer

Cleanup callback

getStore

protected KeyValueStore getStore()

getKey

protected String getKey(String key)

initSequence

public void initSequence(String key,
 long id)

Description copied from interface: UIDSequencer

Initializes the sequencer with the given key to at least the given long id.

A sequence can only be incremented, so if its current id is greater than the given id the sequence won't be decremented to reach the given id.

Specified by:

initSequence in interface UIDSequencer

Overrides:

initSequence in class AbstractUIDSequencer

getKeys

public List<String> getKeys()

Returns:

all keys known to this sequencer

getCurrent

public long getCurrent(String key)

Returns:

the current sequence value for the given key, or UIDSequencer.SEQUENCE_DOES_NOT_EXIST if the sequence doesn't exist

getNextLong

public long getNextLong(String key)

Description copied from interface: UIDSequencer

For the given key returns the incremented UID which is also stored in the same sequence entry. This is a "one time use" function for a document.

getNextBlock

public List<Long> getNextBlock(String key,
 int blockSize)

Description copied from interface: UIDSequencer

Returns a block containing blockSize sequences.