org.springframework.data.document.mongodb
Class MongoDbUtils

java.lang.Object
  org.springframework.data.document.mongodb.MongoDbUtils

public abstract class MongoDbUtils
extends java.lang.Object

Helper class featuring helper methods for internal MongoDb classes.

Mainly intended for internal use within the framework.

Since:

1.0

Author:

Thomas Risberg, Graeme Rocher, Oliver Gierke

Field Summary

private static Log

LOGGER

Constructor Summary

private

MongoDbUtils() Private constructor to prevent instantiation.

Method Summary

static void	closeDB(DB db) Perform actual closing of the Mongo DB object, catching and logging any cleanup exceptions thrown.
static DB	doGetDB(Mongo mongo, java.lang.String databaseName, java.lang.String username, char[] password, boolean allowCreate)
static DB	getDB(Mongo mongo, java.lang.String databaseName) Obtains a DB connection for the given Mongo instance and database name
static DB	getDB(Mongo mongo, java.lang.String databaseName, java.lang.String username, char[] password) Obtains a DB connection for the given Mongo instance and database name
static boolean	isDBTransactional(DB db, Mongo mongo) Return whether the given DB instance is transactional, that is, bound to the current thread by Spring's transaction facilities.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Log LOGGER

Constructor Detail

MongoDbUtils

private MongoDbUtils()

Private constructor to prevent instantiation.

Method Detail

getDB

public static DB getDB(Mongo mongo,
                       java.lang.String databaseName)

Obtains a DB connection for the given Mongo instance and database name

Parameters:

mongo - The Mongo instance

databaseName - The database name

Returns:

The DB connection

getDB

public static DB getDB(Mongo mongo,
                       java.lang.String databaseName,
                       java.lang.String username,
                       char[] password)

Obtains a DB connection for the given Mongo instance and database name

Parameters:

mongo - The Mongo instance

databaseName - The database name

username - The username to authenticate with

password - The password to authenticate with

Returns:

The DB connection

doGetDB

public static DB doGetDB(Mongo mongo,
                         java.lang.String databaseName,
                         java.lang.String username,
                         char[] password,
                         boolean allowCreate)

isDBTransactional

public static boolean isDBTransactional(DB db,
                                        Mongo mongo)

Return whether the given DB instance is transactional, that is, bound to the current thread by Spring's transaction facilities.

Parameters:

db - the DB to check

mongo - the Mongo instance that the DB was created with (may be null)

Returns:

whether the DB is transactional

closeDB

public static void closeDB(DB db)

Perform actual closing of the Mongo DB object, catching and logging any cleanup exceptions thrown.

Parameters:

db - the DB to close (may be null)