org.springframework.data.mongodb.core

Class SimpleMongoDbFactory

java.lang.Object

org.springframework.data.mongodb.core.SimpleMongoDbFactory

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, MongoDbFactory

public class SimpleMongoDbFactory
extends Object
implements org.springframework.beans.factory.DisposableBean, MongoDbFactory

Factory to create DB instances from a Mongo instance.

Author:

Mark Pollack, Oliver Gierke, Thomas Darimont, Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
SimpleMongoDbFactory(com.mongodb.MongoClient mongoClient, String databaseName) Creates a new SimpleMongoDbFactory instance from the given MongoClient.
SimpleMongoDbFactory(com.mongodb.MongoClientURI uri) Creates a new SimpleMongoDbFactory instance from the given MongoClientURI.
SimpleMongoDbFactory(com.mongodb.Mongo mongo, String databaseName) Deprecated. since 1.7. Please use SimpleMongoDbFactory(MongoClient, String).
SimpleMongoDbFactory(com.mongodb.Mongo mongo, String databaseName, org.springframework.data.authentication.UserCredentials credentials) Deprecated. since 1.7. The credentials used should be provided by MongoClient.getCredentialsList().
SimpleMongoDbFactory(com.mongodb.Mongo mongo, String databaseName, org.springframework.data.authentication.UserCredentials credentials, String authenticationDatabaseName) Deprecated. since 1.7. The credentials used should be provided by MongoClient.getCredentialsList().
SimpleMongoDbFactory(com.mongodb.MongoURI uri) Deprecated. since 1.7. Please use SimpleMongoDbFactory(MongoClientURI) instead.

Method Summary

Modifier and Type	Method and Description
void	destroy() Clean up the Mongo instance if it was created by the factory itself.
com.mongodb.DB	getDb() Creates a default DB instance.
com.mongodb.DB	getDb(String dbName) Creates a DB instance to access the database with the given name.
org.springframework.dao.support.PersistenceExceptionTranslator	getExceptionTranslator() Exposes a shared MongoExceptionTranslator.
void	setWriteConcern(com.mongodb.WriteConcern writeConcern) Configures the WriteConcern to be used on the DB instance being created.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMongoDbFactory

@Deprecated
public SimpleMongoDbFactory(com.mongodb.Mongo mongo,
                                        String databaseName)

Deprecated. since 1.7. Please use SimpleMongoDbFactory(MongoClient, String).

Create an instance of SimpleMongoDbFactory given the Mongo instance and database name.

Parameters:

mongo - Mongo instance, must not be null.

databaseName - database name, not be null or empty.

SimpleMongoDbFactory

@Deprecated
public SimpleMongoDbFactory(com.mongodb.Mongo mongo,
                                        String databaseName,
                                        org.springframework.data.authentication.UserCredentials credentials)

Deprecated. since 1.7. The credentials used should be provided by MongoClient.getCredentialsList().

Create an instance of SimpleMongoDbFactory given the Mongo instance, database name, and username/password

Parameters:

mongo - Mongo instance, must not be null.

databaseName - Database name, must not be null or empty.

credentials - username and password.

SimpleMongoDbFactory

@Deprecated
public SimpleMongoDbFactory(com.mongodb.Mongo mongo,
                                        String databaseName,
                                        org.springframework.data.authentication.UserCredentials credentials,
                                        String authenticationDatabaseName)

Deprecated. since 1.7. The credentials used should be provided by MongoClient.getCredentialsList().

Create an instance of SimpleMongoDbFactory given the Mongo instance, database name, and username/password

Parameters:

mongo - Mongo instance, must not be null.

databaseName - Database name, must not be null or empty.

credentials - username and password.

authenticationDatabaseName - the database name to use for authentication

SimpleMongoDbFactory

@Deprecated
public SimpleMongoDbFactory(com.mongodb.MongoURI uri)
                                 throws com.mongodb.MongoException,
                                        UnknownHostException

Deprecated. since 1.7. Please use SimpleMongoDbFactory(MongoClientURI) instead.

Creates a new SimpleMongoDbFactory instance from the given MongoURI.

Parameters:

uri - must not be null.

Throws:

com.mongodb.MongoException

UnknownHostException

See Also:

MongoURI

SimpleMongoDbFactory

public SimpleMongoDbFactory(com.mongodb.MongoClientURI uri)
                     throws UnknownHostException

Creates a new SimpleMongoDbFactory instance from the given MongoClientURI.

Parameters:

uri - must not be null.

Throws:

UnknownHostException

Since:

1.7

SimpleMongoDbFactory

public SimpleMongoDbFactory(com.mongodb.MongoClient mongoClient,
                            String databaseName)

Creates a new SimpleMongoDbFactory instance from the given MongoClient.

Parameters:

mongoClient - must not be null.

databaseName - must not be null.

Since:

1.7

Method Detail

setWriteConcern

public void setWriteConcern(com.mongodb.WriteConcern writeConcern)

Configures the WriteConcern to be used on the DB instance being created.

Parameters:

writeConcern - the writeConcern to set

getDb

public com.mongodb.DB getDb()
                     throws org.springframework.dao.DataAccessException

Description copied from interface: MongoDbFactory

Creates a default DB instance.

Specified by:

getDb in interface MongoDbFactory

Returns:

Throws:

org.springframework.dao.DataAccessException

getDb

public com.mongodb.DB getDb(String dbName)
                     throws org.springframework.dao.DataAccessException

Description copied from interface: MongoDbFactory

Creates a DB instance to access the database with the given name.

Specified by:

getDb in interface MongoDbFactory

Parameters:

dbName - must not be null or empty.

Returns:

Throws:

org.springframework.dao.DataAccessException

destroy

public void destroy()
             throws Exception

Clean up the Mongo instance if it was created by the factory itself.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

See Also:

DisposableBean.destroy()

getExceptionTranslator

public org.springframework.dao.support.PersistenceExceptionTranslator getExceptionTranslator()

Description copied from interface: MongoDbFactory

Exposes a shared MongoExceptionTranslator.

Specified by:

getExceptionTranslator in interface MongoDbFactory

Returns:

will never be null.