Package org.nuxeo.elasticsearch.seqgen

Class ESUIDSequencer

java.lang.Object

org.nuxeo.ecm.core.uidgen.AbstractUIDSequencer

org.nuxeo.elasticsearch.seqgen.ESUIDSequencer

All Implemented Interfaces:

UIDSequencer

public class ESUIDSequencer
extends AbstractUIDSequencer

Elasticsearch implementation of UIDSequencer.

Since elasticsearch does not seem to support a notion of native sequence, the implementation uses the auto-increment of the version attribute as described in the ElasticSearch::Sequence - a blazing fast ticket server blog post.

Since:

7.3

Field Summary

Fields

Modifier and Type	Field	Description
protected ESClient	esClient
protected String	indexName
protected static final int	MAX_RETRY

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

name

Constructor Summary

Constructors

Constructor	Description
ESUIDSequencer()

Method Summary

Modifier and Type	Method	Description
void	dispose()	Cleanup callback
List<Long>	getNextBlock(String key, int blockSize)	Returns a block containing blockSize sequences.
protected long	getNextBlockWithRetry(String key, int blockSize)
long	getNextLong(String sequenceName)	For the given key returns the incremented UID which is also stored in the same sequence entry.
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

MAX_RETRY

protected static final int MAX_RETRY

See Also:

• Constant Field Values

esClient

protected ESClient esClient

indexName

protected String indexName

Constructor Details

ESUIDSequencer

public ESUIDSequencer()

Method Details

init

public void init()

Description copied from interface: UIDSequencer

Init Sequencer

dispose

public void dispose()

Description copied from interface: UIDSequencer

Cleanup callback

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

getNextLong

public long getNextLong(String sequenceName)

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.

getNextBlockWithRetry

protected long getNextBlockWithRetry(String key,
 int blockSize)