io.sphere.sdk.sequencegenerators

Class CustomObjectBigIntegerNumberGenerator

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.sequencegenerators.CustomObjectBigIntegerNumberGenerator

All Implemented Interfaces:

BigIntegerNumberGenerator

public final class CustomObjectBigIntegerNumberGenerator
extends Base
implements BigIntegerNumberGenerator

Creates an incremental sequence of BigInteger numbers, storing the last used number in a CustomObject. It is thread safe even across multiple application nodes, by using optimistic concurrency control based on the version of the CustomObject. When there is a concurrency exception, it is automatically retries to generate the number (with a maximum number of retries configured in CustomObjectBigIntegerNumberGeneratorConfig).

Create number sequence starting with 1

Execution example:

final String key = randomKey();//this could be something like "orderNumber"
final CustomObjectBigIntegerNumberGeneratorConfig config =
        CustomObjectBigIntegerNumberGeneratorConfigBuilder.of(client(), key)
                .build();
final BigIntegerNumberGenerator generator = CustomObjectBigIntegerNumberGenerator.of(config);
final BigInteger firstNumber = generator.getNextNumber().toCompletableFuture().join();
assertThat(firstNumber).isEqualTo(BigInteger.ONE);
See the test code.

Create number sequence with a given initial value

It is possible to assign an initial value for the sequence

Execution example:

final BigInteger initialCounterValue = new BigInteger("5001");
final CustomObjectBigIntegerNumberGeneratorConfig config =
        CustomObjectBigIntegerNumberGeneratorConfigBuilder.of(client(), randomKey())
                .container(randomKey())
                .initialValue(initialCounterValue)
                .build();
final BigIntegerNumberGenerator generator = CustomObjectBigIntegerNumberGenerator.of(config);
final BigInteger firstNumber = generator.getNextNumber().toCompletableFuture().join();
assertThat(firstNumber).isEqualTo(initialCounterValue);
See the test code.

Create a sequence assigning the container and key for the custom object

Execution example:

final String container = randomKey();
final String key = randomKey();
final CustomObjectBigIntegerNumberGeneratorConfig config =
        CustomObjectBigIntegerNumberGeneratorConfigBuilder.of(client(), key)
                .container(container)
                .build();
final BigIntegerNumberGenerator generator = CustomObjectBigIntegerNumberGenerator.of(config);
final BigInteger firstNumber = generator.getNextNumber().toCompletableFuture().join();
assertThat(firstNumber).isEqualTo(BigInteger.ONE);
final CustomObject<BigInteger> customObject = client().executeBlocking(CustomObjectByKeyGet.of(container, key, BigInteger.class));
assertThat(customObject.getValue()).isEqualTo(BigInteger.ONE);
generator.getNextNumber().toCompletableFuture().join();
final CustomObject<BigInteger> customObject2 = client().executeBlocking(CustomObjectByKeyGet.of(container, key, BigInteger.class));
assertThat(customObject2.getValue()).isEqualTo(BigInteger.valueOf(2));
See the test code.

Method Summary

Modifier and Type	Method and Description
CompletionStage<BigInteger>	getNextNumber() This generator ensures that all calls (even in parallel) generates a different number.
static CustomObjectBigIntegerNumberGenerator	of(CustomObjectBigIntegerNumberGeneratorConfig config)

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getNextNumber

public CompletionStage<BigInteger> getNextNumber()

Description copied from interface: BigIntegerNumberGenerator

This generator ensures that all calls (even in parallel) generates a different number.

Specified by:

getNextNumber in interface BigIntegerNumberGenerator

Returns:

nextNumber

of

public static CustomObjectBigIntegerNumberGenerator of(CustomObjectBigIntegerNumberGeneratorConfig config)