org.axonframework.mongo.AbstractMongoTemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of axon-mongo Show documentation
This module contains components that integrate with MongoDB.
There is a newer version: 4.0-M2
/*
 * Copyright (c) 2010-2017. Axon Framework
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.axonframework.mongo;

import com.mongodb.MongoClient;
import com.mongodb.client.MongoDatabase;

/**
 * Abstract implementation for Mongo templates. Mongo templates give access to the collections in a Mongo Database used
 * by components of the Axon Framework.
 *
 * @author Allard Buijze
 * @since 2.0
 */
public abstract class AbstractMongoTemplate {

    private static final String DEFAULT_AXONFRAMEWORK_DATABASE = "axonframework";

    private final MongoDatabase database;

    /**
     * Initializes the MongoTemplate to connect using the given {@code mongo} instance and a database with default
     * name "axonframework". The given {@code userName} and {@code password}, when not {@code null}, are
     * used to authenticate against the database.
     *
     * @param mongo The Mongo instance configured to connect to the Mongo Server
     */
    protected AbstractMongoTemplate(MongoClient mongo) { // NOSONAR
        this(mongo, DEFAULT_AXONFRAMEWORK_DATABASE);
    }

    /**
     * Initializes the MongoTemplate to connect using the given {@code mongo} instance and the database with given
     * {@code databaseName}.
     *
     * @param mongo        The Mongo instance configured to connect to the Mongo Server
     * @param databaseName The name of the database containing the data
     */
    protected AbstractMongoTemplate(MongoClient mongo, String databaseName) { // NOSONAR
        database = mongo.getDatabase(databaseName);
    }

    /**
     * Initializes the MongoTemplate to connect using the given {@code database} instance.
     *
     * @param database The database instance to open collections in
     */
    protected AbstractMongoTemplate(MongoDatabase database) {
        this.database = 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 {@code userName} and {@code password} are ignored if the database is already
     * in an authenticated state.
     *
     * @return a DB instance, referring to the database with configured name.
     */
    protected MongoDatabase database() {
        return database;
    }
}