org.axonframework.mongo

Class AbstractMongoTemplate

java.lang.Object

org.axonframework.mongo.AbstractMongoTemplate

Direct Known Subclasses:

DefaultMongoTemplate, DefaultMongoTemplate, 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMongoTemplate(com.mongodb.MongoClient mongo) Initializes the MongoTemplate to connect using the given mongo instance and a database with default name "axonframework".
protected	AbstractMongoTemplate(com.mongodb.MongoClient mongo, String databaseName) Initializes the MongoTemplate to connect using the given mongo instance and the database with given databaseName.
protected	AbstractMongoTemplate(com.mongodb.client.MongoDatabase database) Initializes the MongoTemplate to connect using the given database instance.

Method Summary

Modifier and Type	Method and 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 Detail

AbstractMongoTemplate

protected AbstractMongoTemplate(com.mongodb.MongoClient mongo)

Initializes the MongoTemplate to connect using the given mongo instance and a database with default name "axonframework". The given userName and password, when not null, are used to authenticate against the database.

Parameters:

mongo - The Mongo instance configured to connect to the Mongo Server

AbstractMongoTemplate

protected AbstractMongoTemplate(com.mongodb.MongoClient mongo,
                                String databaseName)

Initializes the MongoTemplate to connect using the given mongo instance and the database with given databaseName.

Parameters:

mongo - The Mongo instance configured to connect to the Mongo Server

databaseName - The name of the database containing the data

AbstractMongoTemplate

protected AbstractMongoTemplate(com.mongodb.client.MongoDatabase database)

Initializes the MongoTemplate to connect using the given database instance.

Parameters:

database - The database instance to open collections in

Method Detail

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.