org.axonframework.mongo.eventsourcing.tokenstore

Class MongoTokenStore

java.lang.Object

org.axonframework.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.

Constructor Summary

Constructors

Constructor and Description
MongoTokenStore(MongoTemplate mongoTemplate, org.axonframework.serialization.Serializer serializer) Creates a MongoTokenStore with a default claim timeout of 10 seconds, a default owner identifier and a default content type.
MongoTokenStore(MongoTemplate mongoTemplate, org.axonframework.serialization.Serializer serializer, TemporalAmount claimTimeout, String nodeId, Class<?> contentType) Creates a MongoTokenStore by using the given values.

Method Summary

Modifier and Type	Method and Description
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)
int[]	fetchSegments(String processorName)
org.axonframework.eventsourcing.eventstore.TrackingToken	fetchToken(String processorName, int segment)
void	initializeTokenSegments(String processorName, int segmentCount)
void	initializeTokenSegments(String processorName, int segmentCount, org.axonframework.eventsourcing.eventstore.TrackingToken initialToken)
void	releaseClaim(String processorName, int segment)
void	storeToken(org.axonframework.eventsourcing.eventstore.TrackingToken token, String processorName, int segment)

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoTokenStore

public MongoTokenStore(MongoTemplate mongoTemplate,
                       org.axonframework.serialization.Serializer serializer)

Creates a MongoTokenStore with a default claim timeout of 10 seconds, a default owner identifier and a default content type.

Parameters:

mongoTemplate - used to access the collection in which tracking tokens are stored

serializer - serializer used to serialize tracking tokens

MongoTokenStore

public MongoTokenStore(MongoTemplate mongoTemplate,
                       org.axonframework.serialization.Serializer serializer,
                       TemporalAmount claimTimeout,
                       String nodeId,
                       Class<?> contentType)

Creates a MongoTokenStore by using the given values.

Parameters:

mongoTemplate - used to access the collection in which tracking tokens are stored

serializer - serializer used to serialize TrackingToken

claimTimeout - the amount of time after which a claim is automatically released

nodeId - the owner identifier that this token store uses

contentType - the data type of the serialized tracking token

Method Detail

storeToken

public void storeToken(org.axonframework.eventsourcing.eventstore.TrackingToken token,
                       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(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(String processorName,
                                    int segmentCount,
                                    org.axonframework.eventsourcing.eventstore.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.eventsourcing.eventstore.TrackingToken fetchToken(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(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(String processorName,
                         int segment)

Specified by:

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

fetchSegments

public int[] fetchSegments(String processorName)

Specified by:

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

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.