Package org.axonframework.extensions.mongo

Class AbstractMongoTemplate

java.lang.Object

org.axonframework.extensions.mongo.AbstractMongoTemplate

Direct Known Subclasses:

DefaultMongoTemplate

public abstract class AbstractMongoTemplate
extends Object

Abstract implementation for Mongo templates. Mongo templates give access to the collections in a Mongo Database used by components of the Axon Framework.

Since:

2.0

Author:

Allard Buijze

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected com.mongodb.client.MongoDatabase	database()	Returns a reference to the Database with the configured database name.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractMongoTemplate

protected AbstractMongoTemplate(AbstractMongoTemplate.Builder builder)

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

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

Parameters:

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

Method Details

database

protected com.mongodb.client.MongoDatabase database()

Returns a reference to the Database with the configured database name. If a username and/or password have been provided, these are used to authenticate against the database.

Note that the configured userName and password are ignored if the database is already in an authenticated state.

Returns:

a DB instance, referring to the database with configured name.