org.axonframework.extensions.mongo.eventsourcing.tokenstore

Class MongoTokenStore

java.lang.Object

org.axonframework.extensions.mongo.eventsourcing.tokenstore.MongoTokenStore

All Implemented Interfaces:

org.axonframework.eventhandling.tokenstore.TokenStore

public class MongoTokenStore
extends Object
implements org.axonframework.eventhandling.tokenstore.TokenStore

An implementation of TokenStore that allows you store and retrieve tracking tokens with MongoDB.

Since:

3.1

Author:

Joris van der Kallen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MongoTokenStore.Builder Builder class to instantiate a MongoTokenStore.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MongoTokenStore(MongoTokenStore.Builder builder) Instantiate a MongoTokenStore based on the fields contained in the MongoTokenStore.Builder.

Method Summary

Modifier and Type	Method and Description
static MongoTokenStore.Builder	builder() Instantiate a Builder to be able to create a MongoTokenStore.
void	deleteToken(String processorName, int segment)
void	ensureIndexes() Deprecated. this method is now called by the constructor instead of the dependency injection framework running the @PostConstruct. i.e. You no longer have to call it manually if you don't use a dependency injection framework.
void	extendClaim(String processorName, int segment)
List<org.axonframework.eventhandling.Segment>	fetchAvailableSegments(String processorName)
int[]	fetchSegments(String processorName)
org.axonframework.eventhandling.TrackingToken	fetchToken(String processorName, int segment)
void	initializeSegment(org.axonframework.eventhandling.TrackingToken token, String processorName, int segment)
void	initializeTokenSegments(String processorName, int segmentCount)
void	initializeTokenSegments(String processorName, int segmentCount, org.axonframework.eventhandling.TrackingToken initialToken)
void	releaseClaim(String processorName, int segment)
boolean	requiresExplicitSegmentInitialization()
Optional<String>	retrieveStorageIdentifier()
void	storeToken(org.axonframework.eventhandling.TrackingToken token, String processorName, int segment)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.eventhandling.tokenstore.TokenStore

fetchToken

Constructor Detail

MongoTokenStore

protected MongoTokenStore(MongoTokenStore.Builder builder)

Instantiate a MongoTokenStore based on the fields contained in the MongoTokenStore.Builder.

Will assert that the MongoTemplate and Serializer are not null, and will throw an AxonConfigurationException if any of them is null.

Parameters:

builder - the MongoTokenStore.Builder used to instantiate a MongoTokenStore instance

Method Detail

builder

public static MongoTokenStore.Builder builder()

Instantiate a Builder to be able to create a MongoTokenStore.

The claimTimeout is defaulted to a 10 seconds duration (by using Duration.ofSeconds(long), nodeId is defaulted to the ManagementFactory#getRuntimeMXBean#getName output and the contentType to a byte[] Class. The MongoTemplate and Serializer are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a MongoTokenStore

storeToken

public void storeToken(@Nullable
                       org.axonframework.eventhandling.TrackingToken token,
                       @Nonnull
                       String processorName,
                       int segment)
                throws org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

Specified by:

storeToken in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

initializeTokenSegments

public void initializeTokenSegments(@Nonnull
                                    String processorName,
                                    int segmentCount)
                             throws org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

Specified by:

initializeTokenSegments in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

initializeTokenSegments

public void initializeTokenSegments(@Nonnull
                                    String processorName,
                                    int segmentCount,
                                    @Nullable
                                    org.axonframework.eventhandling.TrackingToken initialToken)
                             throws org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

Specified by:

initializeTokenSegments in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

fetchToken

public org.axonframework.eventhandling.TrackingToken fetchToken(@Nonnull
                                                                String processorName,
                                                                int segment)
                                                         throws org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

Specified by:

fetchToken in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

extendClaim

public void extendClaim(@Nonnull
                        String processorName,
                        int segment)
                 throws org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

Specified by:

extendClaim in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

releaseClaim

public void releaseClaim(@Nonnull
                         String processorName,
                         int segment)

Specified by:

releaseClaim in interface org.axonframework.eventhandling.tokenstore.TokenStore

initializeSegment

public void initializeSegment(@Nullable
                              org.axonframework.eventhandling.TrackingToken token,
                              @Nonnull
                              String processorName,
                              int segment)
                       throws org.axonframework.eventhandling.tokenstore.UnableToInitializeTokenException

Specified by:

initializeSegment in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToInitializeTokenException

deleteToken

public void deleteToken(@Nonnull
                        String processorName,
                        int segment)
                 throws org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

Specified by:

deleteToken in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToClaimTokenException

requiresExplicitSegmentInitialization

public boolean requiresExplicitSegmentInitialization()

Specified by:

requiresExplicitSegmentInitialization in interface org.axonframework.eventhandling.tokenstore.TokenStore

fetchSegments

public int[] fetchSegments(@Nonnull
                           String processorName)

Specified by:

fetchSegments in interface org.axonframework.eventhandling.tokenstore.TokenStore

fetchAvailableSegments

public List<org.axonframework.eventhandling.Segment> fetchAvailableSegments(@Nonnull
                                                                            String processorName)

Specified by:

fetchAvailableSegments in interface org.axonframework.eventhandling.tokenstore.TokenStore

retrieveStorageIdentifier

public Optional<String> retrieveStorageIdentifier()
                                           throws org.axonframework.eventhandling.tokenstore.UnableToRetrieveIdentifierException

Specified by:

retrieveStorageIdentifier in interface org.axonframework.eventhandling.tokenstore.TokenStore

Throws:

org.axonframework.eventhandling.tokenstore.UnableToRetrieveIdentifierException

ensureIndexes

@Deprecated
public void ensureIndexes()

Deprecated. this method is now called by the constructor instead of the dependency injection framework running the @PostConstruct. i.e. You no longer have to call it manually if you don't use a dependency injection framework.

Creates the indexes required to work with the TokenStore.