sirius.biz.sequences.mongo

Class MongoSequenceStrategy

java.lang.Object

sirius.biz.sequences.mongo.MongoSequenceStrategy

All Implemented Interfaces:

SequenceStrategy, sirius.kernel.di.std.Named

public class MongoSequenceStrategy
extends Object
implements SequenceStrategy

Uses a collection in MongoDB to generate and maintain sequences.

See Also:

Sequences

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Contains the name of this strategy.

Constructor Summary

Constructors

Constructor and Description
MongoSequenceStrategy()

Method Summary

Modifier and Type	Method and Description
void	collectKnownSequences(Consumer<String> nameConsumer) Enumerates the names of all known sequences.
String	getName()
long	peekNextValue(String sequence) Peeks at the next value in the sequence without using it.
void	setNextValue(String sequence, long nextValue, boolean force) Specifies the next value to use for the given sequence.
Long	tryGenerateId(String sequence) Tries to generate the next id in the given sequence.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

Contains the name of this strategy.

See Also:

Constant Field Values

Constructor Detail

MongoSequenceStrategy

public MongoSequenceStrategy()

Method Detail

getName

@Nonnull
public String getName()

Specified by:

getName in interface sirius.kernel.di.std.Named

tryGenerateId

public Long tryGenerateId(String sequence)
                   throws Exception

Description copied from interface: SequenceStrategy

Tries to generate the next id in the given sequence.

Specified by:

tryGenerateId in interface SequenceStrategy

Parameters:

sequence - the sequence to generate the next id for

Returns:

either the next id to use or null if a race condition or conflict occurred. This will instruct the framework to perform a retry

Throws:

Exception - in case of a severe error

peekNextValue

public long peekNextValue(String sequence)

Description copied from interface: SequenceStrategy

Peeks at the next value in the sequence without using it.

Specified by:

peekNextValue in interface SequenceStrategy

Parameters:

sequence - the sequence to determine the next value for

Returns:

the next value in the given sequence

See Also:

Sequences.peekNextValue(String)

setNextValue

public void setNextValue(String sequence,
                         long nextValue,
                         boolean force)

Description copied from interface: SequenceStrategy

Specifies the next value to use for the given sequence.

Unless force is set to true, the value has to be higher than the current counter value to prevent non unique numbers from being generated.

Specified by:

setNextValue in interface SequenceStrategy

Parameters:

sequence - the sequence to update

nextValue - the next value that will be returned when calling SequenceStrategy.tryGenerateId(String) for this sequence.

force - if true, no sanity checks are performed and the sequence can be reset to ANY value. This is rather dangerous, as it might lead to the generation of duplicate ids. If set to false, the given nextValue has to be higher than the current sequence value.

collectKnownSequences

public void collectKnownSequences(Consumer<String> nameConsumer)
                           throws Exception

Description copied from interface: SequenceStrategy

Enumerates the names of all known sequences.

Specified by:

collectKnownSequences in interface SequenceStrategy

Parameters:

nameConsumer - the consumer to be supplied with the names

Throws:

Exception - in case or a severe error