sirius.biz.sequences

Interface SequenceStrategy

All Superinterfaces:

sirius.kernel.di.std.Named

All Known Implementing Classes:

MongoSequenceStrategy, SmartSequenceStrategy, SQLSequenceStrategy

public interface SequenceStrategy
extends sirius.kernel.di.std.Named

Encapsulates the effective implementation of generating sequences of unique IDs.

Method Summary

Modifier and Type	Method and Description
void	collectKnownSequences(Consumer<String> nameConsumer) Enumerates the names of all known sequences.
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 interface sirius.kernel.di.std.Named

getName

Method Detail

tryGenerateId

Long tryGenerateId(String sequence)
            throws Exception

Tries to generate the next id in the given sequence.

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

long peekNextValue(String sequence)
            throws Exception

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

Parameters:

sequence - the sequence to determine the next value for

Returns:

the next value in the given sequence

Throws:

Exception - in case of a severe error

See Also:

Sequences.peekNextValue(String)

setNextValue

void setNextValue(String sequence,
                  long nextValue,
                  boolean force)
           throws Exception

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.

Parameters:

sequence - the sequence to update

nextValue - the next value that will be returned when calling 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.

Throws:

Exception - in case or a severe error

collectKnownSequences

void collectKnownSequences(Consumer<String> nameConsumer)
                    throws Exception

Enumerates the names of all known sequences.

Parameters:

nameConsumer - the consumer to be supplied with the names

Throws:

Exception - in case or a severe error