Package 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 saga collection via a given MongoClient instance. Will use the default name for the collection, when none is set.

The default is sagas for the sagas.

Since:

3.0

Author:

Allard Buijze

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DefaultMongoTemplate.Builder	builder()	Instantiate a Builder to be able to create a DefaultMongoTemplate.
com.mongodb.client.MongoCollection<org.bson.Document>	sagaCollection()	Returns a reference to the collection containing the saga instances.
DefaultMongoTemplate	withSagasCollection(String sagasCollectionName)	Overwrites the sagasCollectionName to use as the collection name for Sagas.

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 Details

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 Details

builder

public static DefaultMongoTemplate.Builder builder()

Instantiate a Builder to be able to create a DefaultMongoTemplate.

The sagasCollectionName is defaulted to 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

withSagasCollection

public DefaultMongoTemplate withSagasCollection(String sagasCollectionName)

Overwrites the sagasCollectionName to use as the collection name for Sagas.

Parameters:

sagasCollectionName - a String specifying the collection name for Sagas

Returns:

a new DefaultMongoTemplate with the given sagasCollectionName set.

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