Class SimpleMongoClientDatabaseFactory

java.lang.Object

org.springframework.data.mongodb.core.MongoDatabaseFactorySupport<com.mongodb.client.MongoClient>

org.springframework.data.mongodb.core.SimpleMongoClientDatabaseFactory

All Implemented Interfaces:

DisposableBean, CodecRegistryProvider, MongoClusterCapable, MongoDatabaseFactory, MongoSessionProvider

public class SimpleMongoClientDatabaseFactory
extends MongoDatabaseFactorySupport<com.mongodb.client.MongoClient>
implements MongoClusterCapable, DisposableBean

Factory to create MongoDatabase instances from a MongoClient instance.

Since:

3.0

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
SimpleMongoClientDatabaseFactory(com.mongodb.client.MongoClient mongoClient, String databaseName)	Creates a new SimpleMongoClientDatabaseFactory instance from the given MongoClient.
SimpleMongoClientDatabaseFactory(com.mongodb.ConnectionString connectionString)	Creates a new SimpleMongoClientDatabaseFactory instance from the given MongoClient.
SimpleMongoClientDatabaseFactory(String connectionString)	Creates a new SimpleMongoClientDatabaseFactory instance for the given connectionString.

Method Summary

Modifier and Type	Method	Description
protected void	closeClient()	Close the client instance.
protected com.mongodb.client.MongoDatabase	doGetMongoDatabase(String dbName)	Get the actual MongoDatabase from the client.
com.mongodb.client.ClientSession	getSession(com.mongodb.ClientSessionOptions options)	Obtain a ClientSession for given ClientSessionOptions.
MongoDatabaseFactory	withSession(com.mongodb.client.ClientSession session)	Obtain a ClientSession bound instance of MongoDatabaseFactory returning MongoDatabase instances that are aware and bound to the given session.

Methods inherited from class MongoDatabaseFactorySupport

destroy, getDefaultDatabaseName, getExceptionTranslator, getMongoCluster, getMongoDatabase, getMongoDatabase, setExceptionTranslator, setWriteConcern

Methods inherited from class Object

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

Methods inherited from interface CodecRegistryProvider

getCodecFor, hasCodecFor

Methods inherited from interface DisposableBean

destroy

Methods inherited from interface MongoClusterCapable

getMongoCluster

Methods inherited from interface MongoDatabaseFactory

getCodecRegistry, isTransactionActive, withSession

Constructor Details

SimpleMongoClientDatabaseFactory

public SimpleMongoClientDatabaseFactory(String connectionString)

Creates a new SimpleMongoClientDatabaseFactory instance for the given connectionString. Using this constructor will create a new MongoClient instance that will be closed when calling MongoDatabaseFactorySupport.destroy().

Parameters:

connectionString - connection coordinates for a database connection. Must contain a database name and must not be null or empty.

See Also:

• MongoDB Connection String reference

SimpleMongoClientDatabaseFactory

public SimpleMongoClientDatabaseFactory(com.mongodb.ConnectionString connectionString)

Creates a new SimpleMongoClientDatabaseFactory instance from the given MongoClient. Using this constructor will create a new MongoClient instance that will be closed when calling MongoDatabaseFactorySupport.destroy().

Parameters:

connectionString - connection coordinates for a database connection. Must contain also a database name and not be null.

SimpleMongoClientDatabaseFactory

public SimpleMongoClientDatabaseFactory(com.mongodb.client.MongoClient mongoClient,
 String databaseName)

Creates a new SimpleMongoClientDatabaseFactory instance from the given MongoClient. Note that the client will not be closed when calling MongoDatabaseFactorySupport.destroy() as we assume a managed client instance that we do not want to close on MongoDatabaseFactorySupport.destroy() meaning that you (or the application container) must dispose the client instance once it is no longer required for use.

Parameters:

mongoClient - must not be null.

databaseName - must not be null or empty.

Method Details

getSession

public com.mongodb.client.ClientSession getSession(com.mongodb.ClientSessionOptions options)

Description copied from interface: MongoDatabaseFactory

Obtain a ClientSession for given ClientSessionOptions.

Specified by:

getSession in interface MongoDatabaseFactory

Specified by:

getSession in interface MongoSessionProvider

Parameters:

options - must not be null.

Returns:

never null.

withSession

public MongoDatabaseFactory withSession(com.mongodb.client.ClientSession session)

Description copied from interface: MongoDatabaseFactory

Obtain a ClientSession bound instance of MongoDatabaseFactory returning MongoDatabase instances that are aware and bound to the given session.

Specified by:

withSession in interface MongoDatabaseFactory

Overrides:

withSession in class MongoDatabaseFactorySupport<com.mongodb.client.MongoClient>

Parameters:

session - must not be null.

Returns:

never null.

closeClient

protected void closeClient()

Description copied from class: MongoDatabaseFactorySupport

Close the client instance.

Specified by:

closeClient in class MongoDatabaseFactorySupport<com.mongodb.client.MongoClient>

doGetMongoDatabase

protected com.mongodb.client.MongoDatabase doGetMongoDatabase(String dbName)

Description copied from class: MongoDatabaseFactorySupport

Get the actual MongoDatabase from the client.

Specified by:

doGetMongoDatabase in class MongoDatabaseFactorySupport<com.mongodb.client.MongoClient>

Parameters:

dbName - must not be null or empty.

Returns: