org.springframework.data.mongodb.core

Class MongoDbUtils

java.lang.Object

org.springframework.data.mongodb.core.MongoDbUtils

public abstract class MongoDbUtils
extends 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, Randy Watler, Thomas Darimont

Method Summary

Modifier and Type	Method and Description
static void	closeDB(com.mongodb.DB db) Perform actual closing of the Mongo DB object, catching and logging any cleanup exceptions thrown.
static com.mongodb.DB	getDB(com.mongodb.Mongo mongo, String databaseName) Obtains a DB connection for the given Mongo instance and database name
static com.mongodb.DB	getDB(com.mongodb.Mongo mongo, String databaseName, UserCredentials credentials) Obtains a DB connection for the given Mongo instance and database name
static com.mongodb.DB	getDB(com.mongodb.Mongo mongo, String databaseName, UserCredentials credentials, String authenticationDatabaseName)
static boolean	isDBTransactional(com.mongodb.DB db, com.mongodb.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

Method Detail

getDB

public static com.mongodb.DB getDB(com.mongodb.Mongo mongo,
                                   String databaseName)

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

Parameters:

mongo - the Mongo instance, must not be null.

databaseName - the database name, must not be null or empty.

Returns:

the DB connection

getDB

public static com.mongodb.DB getDB(com.mongodb.Mongo mongo,
                                   String databaseName,
                                   UserCredentials credentials)

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

Parameters:

mongo - the Mongo instance, must not be null.

databaseName - the database name, must not be null or empty.

credentials - the credentials to use, must not be null.

Returns:

the DB connection

getDB

public static com.mongodb.DB getDB(com.mongodb.Mongo mongo,
                                   String databaseName,
                                   UserCredentials credentials,
                                   String authenticationDatabaseName)

isDBTransactional

public static boolean isDBTransactional(com.mongodb.DB db,
                                        com.mongodb.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(com.mongodb.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)