org.axonframework.extensions.mongo

Class DefaultMongoTemplate.Builder

java.lang.Object

org.axonframework.extensions.mongo.AbstractMongoTemplate.Builder

org.axonframework.extensions.mongo.DefaultMongoTemplate.Builder

Enclosing class:

DefaultMongoTemplate

public static class DefaultMongoTemplate.Builder
extends AbstractMongoTemplate.Builder

Builder class to instantiate 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 mongoDatabase(MongoClient, String) function. Otherwise, the database name defaults to AbstractMongoTemplate.Builder#DEFAULT_AXONFRAMEWORK_DATABASE

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DefaultMongoTemplate	build() Initializes a DefaultMongoTemplate as specified through this Builder.
DefaultMongoTemplate.Builder	domainEventsCollectionName(String domainEventsCollectionName) Sets the domainEventsCollectionName to use as the collection name for Domain Events.
DefaultMongoTemplate.Builder	mongoDatabase(com.mongodb.client.MongoClient mongoClient) Sets the MongoDatabase by means of providing a MongoClient.
DefaultMongoTemplate.Builder	mongoDatabase(com.mongodb.client.MongoClient mongoClient, String databaseName) Sets the MongoDatabase by means of providing a MongoClient.
DefaultMongoTemplate.Builder	mongoDatabase(com.mongodb.client.MongoDatabase mongoDatabase) Sets the MongoDatabase used by this template to connect to a Mongo instance.
DefaultMongoTemplate.Builder	sagasCollectionName(String sagasCollectionName) Sets the sagasCollectionName to use as the collection name for Saga instances.
DefaultMongoTemplate.Builder	snapshotEventsCollectionName(String snapshotEventsCollectionName) Sets the snapshotEventsCollectionName to use as the collection name for Snapshot Events.
DefaultMongoTemplate.Builder	trackingTokensCollectionName(String trackingTokensCollectionName) Sets the trackingTokensCollectionName to use as the collection name for Tracking Tokens.

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

validate

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

mongoDatabase

public DefaultMongoTemplate.Builder mongoDatabase(com.mongodb.client.MongoClient mongoClient)

Description copied from class: AbstractMongoTemplate.Builder

Sets the MongoDatabase by means of providing a MongoClient. The MongoClient.getDatabase(String) function is in turn used to retrieve the MongoDatabase, using AbstractMongoTemplate.Builder.DEFAULT_AXONFRAMEWORK_DATABASE as the database name.

Overrides:

mongoDatabase in class AbstractMongoTemplate.Builder

Parameters:

mongoClient - the MongoClient used to retrieve a MongoDatabase from

Returns:

the current Builder instance, for fluent interfacing

mongoDatabase

public DefaultMongoTemplate.Builder mongoDatabase(com.mongodb.client.MongoClient mongoClient,
                                                  String databaseName)

Description copied from class: AbstractMongoTemplate.Builder

Sets the MongoDatabase by means of providing a MongoClient. The MongoClient.getDatabase(String) function is in turn used to retrieve the MongoDatabase using databaseName as the database name.

Overrides:

mongoDatabase in class AbstractMongoTemplate.Builder

Parameters:

mongoClient - the MongoClient used to retrieve a MongoDatabase from

databaseName - a String denoting the name of the MongoDatabase

Returns:

the current Builder instance, for fluent interfacing

mongoDatabase

public DefaultMongoTemplate.Builder mongoDatabase(com.mongodb.client.MongoDatabase mongoDatabase)

Description copied from class: AbstractMongoTemplate.Builder

Sets the MongoDatabase used by this template to connect to a Mongo instance.

Overrides:

mongoDatabase in class AbstractMongoTemplate.Builder

Parameters:

mongoDatabase - the MongoDatabase used by this template to connect to a Mongo instance

Returns:

the current Builder instance, for fluent interfacing

domainEventsCollectionName

public DefaultMongoTemplate.Builder domainEventsCollectionName(String domainEventsCollectionName)

Sets the domainEventsCollectionName to use as the collection name for Domain Events. Defaults to a "domainevents" String.

Parameters:

domainEventsCollectionName - a String specifying the collection name for Domain Events

Returns:

the current Builder instance, for fluent interfacing

snapshotEventsCollectionName

public DefaultMongoTemplate.Builder snapshotEventsCollectionName(String snapshotEventsCollectionName)

Sets the snapshotEventsCollectionName to use as the collection name for Snapshot Events. Defaults to a "snapshotevents" String.

Parameters:

snapshotEventsCollectionName - a String specifying the collection name for Snapshot Events

Returns:

the current Builder instance, for fluent interfacing

trackingTokensCollectionName

public DefaultMongoTemplate.Builder trackingTokensCollectionName(String trackingTokensCollectionName)

Sets the trackingTokensCollectionName to use as the collection name for Tracking Tokens. Defaults to a "trackingtokens" String.

Parameters:

trackingTokensCollectionName - a String specifying the collection name for Tracking Tokens

Returns:

the current Builder instance, for fluent interfacing

sagasCollectionName

public DefaultMongoTemplate.Builder sagasCollectionName(String sagasCollectionName)

Sets the sagasCollectionName to use as the collection name for Saga instances. Defaults to a "sagas" String.

Parameters:

sagasCollectionName - a String specifying the collection name for Sagas

Returns:

the current Builder instance, for fluent interfacing

build

public DefaultMongoTemplate build()

Initializes a DefaultMongoTemplate as specified through this Builder.

Returns:

a DefaultMongoTemplate as specified through this Builder