org.axonframework.extensions.mongo

Class DefaultMongoTemplate

java.lang.Object

org.axonframework.extensions.mongo.AbstractMongoTemplate

org.axonframework.extensions.mongo.DefaultMongoTemplate

All Implemented Interfaces:

MongoTemplate

public class DefaultMongoTemplate
extends AbstractMongoTemplate
implements MongoTemplate

MongoTemplate instance giving direct access to the TrackingToken collection via a given MongoClient instance.

Since:

3.0

Author:

Allard Buijze

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DefaultMongoTemplate.Builder	builder() Instantiate a Builder to be able to create a DefaultMongoTemplate.
com.mongodb.client.MongoCollection<org.bson.Document>	eventCollection() Returns a reference to the collection containing the events.
com.mongodb.client.MongoCollection<org.bson.Document>	sagaCollection() Returns a reference to the collection containing the saga instances.
com.mongodb.client.MongoCollection<org.bson.Document>	snapshotCollection() Returns a reference to the collection containing the snapshot events.
com.mongodb.client.MongoCollection<org.bson.Document>	trackingTokensCollection() Returns a reference to the collection containing the Tracking Tokens.
DefaultMongoTemplate	withDomainEventsCollection(String domainEventsCollectionName)
DefaultMongoTemplate	withSagasCollection(String sagasCollectionName)
DefaultMongoTemplate	withSnapshotCollection(String snapshotEventsCollectionName)
DefaultMongoTemplate	withTrackingTokenCollection(String trackingTokensCollectionName)

Methods inherited from class org.axonframework.extensions.mongo.AbstractMongoTemplate

database

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMongoTemplate

protected DefaultMongoTemplate(DefaultMongoTemplate.Builder builder)

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

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

Parameters:

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

Method Detail

builder

public static DefaultMongoTemplate.Builder builder()

Instantiate a Builder to be able to create a DefaultMongoTemplate.

The domainEventsCollectionName, snapshotEventsCollectionName, trackingTokensCollectionName and (@code sagasCollectionName} are respectively defaulted to trackingtokens, domainevents, snapshotevents and sagas.

The MongoDatabase is a hard requirement and as such should be provided. Can either be provided directly, or by setting a MongoClient. When choosing the latter approach, the MongoDatabase name can be specified by using the DefaultMongoTemplate.Builder.mongoDatabase(MongoClient, String) function. Otherwise, the database name defaults to AbstractMongoTemplate.Builder#DEFAULT_AXONFRAMEWORK_DATABASE

Returns:

a Builder to be able to create a DefaultMongoTemplate

withSnapshotCollection

public DefaultMongoTemplate withSnapshotCollection(String snapshotEventsCollectionName)

withDomainEventsCollection

public DefaultMongoTemplate withDomainEventsCollection(String domainEventsCollectionName)

withSagasCollection

public DefaultMongoTemplate withSagasCollection(String sagasCollectionName)

withTrackingTokenCollection

public DefaultMongoTemplate withTrackingTokenCollection(String trackingTokensCollectionName)

trackingTokensCollection

public com.mongodb.client.MongoCollection<org.bson.Document> trackingTokensCollection()

Description copied from interface: MongoTemplate

Returns a reference to the collection containing the Tracking Tokens.

Specified by:

trackingTokensCollection in interface MongoTemplate

Returns:

MongoCollection containing the Tracking Tokens

eventCollection

public com.mongodb.client.MongoCollection<org.bson.Document> eventCollection()

Description copied from interface: MongoTemplate

Returns a reference to the collection containing the events.

Specified by:

eventCollection in interface MongoTemplate

Returns:

MongoCollection containing the domain events

snapshotCollection

public com.mongodb.client.MongoCollection<org.bson.Document> snapshotCollection()

Description copied from interface: MongoTemplate

Returns a reference to the collection containing the snapshot events.

Specified by:

snapshotCollection in interface MongoTemplate

Returns:

MongoCollection containing the snapshot events

sagaCollection

public com.mongodb.client.MongoCollection<org.bson.Document> sagaCollection()

Description copied from interface: MongoTemplate

Returns a reference to the collection containing the saga instances.

Specified by:

sagaCollection in interface MongoTemplate

Returns:

MongoCollection containing the sagas