org.axonframework.extensions.mongo.eventsourcing.tokenstore

Class MongoTokenStore.Builder

java.lang.Object

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

Enclosing class:

MongoTokenStore

public static class MongoTokenStore.Builder
extends Object

Builder class to instantiate 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, the contentType to a byte[] Class, and the ensureIndexes to true. The MongoTemplate and Serializer are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MongoTokenStore	build() Initializes a MongoTokenStore as specified through this Builder.
MongoTokenStore.Builder	claimTimeout(TemporalAmount claimTimeout) Sets the claimTimeout specifying the amount of time this process will wait after which this process will force a claim of a TrackingToken.
MongoTokenStore.Builder	contentType(Class<?> contentType) Sets the contentType to which a TrackingToken should be serialized.
MongoTokenStore.Builder	ensureIndexes(boolean ensureIndexes) Sets the ensureIndexes to tell the builder whether to create or not the indexes required to work with the TokenStore.
MongoTokenStore.Builder	mongoTemplate(MongoTemplate mongoTemplate) Sets the MongoTemplate providing access to the collection which stores the TrackingTokens.
MongoTokenStore.Builder	nodeId(String nodeId) Sets the nodeId to identify ownership of the tokens.
MongoTokenStore.Builder	serializer(org.axonframework.serialization.Serializer serializer) Sets the Serializer used to de-/serialize TrackingTokens with.
protected void	validate() Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

mongoTemplate

public MongoTokenStore.Builder mongoTemplate(MongoTemplate mongoTemplate)

Sets the MongoTemplate providing access to the collection which stores the TrackingTokens.

Parameters:

mongoTemplate - the MongoTemplate providing access to the collection which stores the TrackingTokens

Returns:

the current Builder instance, for fluent interfacing

serializer

public MongoTokenStore.Builder serializer(org.axonframework.serialization.Serializer serializer)

Sets the Serializer used to de-/serialize TrackingTokens with.

Parameters:

serializer - a Serializer used to de-/serialize TrackingTokens with

Returns:

the current Builder instance, for fluent interfacing

claimTimeout

public MongoTokenStore.Builder claimTimeout(TemporalAmount claimTimeout)

Sets the claimTimeout specifying the amount of time this process will wait after which this process will force a claim of a TrackingToken. Thus if a claim has not been updated for the given claimTimeout, this process will 'steal' the claim. Defaults to a duration of 10 seconds.

Parameters:

claimTimeout - a timeout specifying the time after which this process will force a claim

Returns:

the current Builder instance, for fluent interfacing

nodeId

public MongoTokenStore.Builder nodeId(String nodeId)

Sets the nodeId to identify ownership of the tokens. Defaults to ManagementFactory#getRuntimeMXBean#getName output as the node id.

Parameters:

nodeId - the id as a String to identify ownership of the tokens

Returns:

the current Builder instance, for fluent interfacing

contentType

public MongoTokenStore.Builder contentType(Class<?> contentType)

Sets the contentType to which a TrackingToken should be serialized. Defaults to a byte[] Class type.

Parameters:

contentType - the content type as a Class to which a TrackingToken should be serialized

Returns:

the current Builder instance, for fluent interfacing

ensureIndexes

public MongoTokenStore.Builder ensureIndexes(boolean ensureIndexes)

Sets the ensureIndexes to tell the builder whether to create or not the indexes required to work with the TokenStore. Defaults to true. If set to false, the developer is responsible for the creation of the indexes defined in the MongoTokenStore.ensureIndexes() method beforehand.

Parameters:

ensureIndexes - the boolean to indicate if the indexes should be created.

Returns:

the current Builder instance, for fluent interfacing

build

public MongoTokenStore build()

Initializes a MongoTokenStore as specified through this Builder.

Returns:

a MongoTokenStore as specified through this Builder

validate

protected void validate()
                 throws org.axonframework.common.AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Throws:

org.axonframework.common.AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications