org.springframework.data.mongodb

Interface MongoDbFactory

All Superinterfaces:

CodecRegistryProvider, MongoSessionProvider

All Known Implementing Classes:

MongoDbFactorySupport, SimpleMongoClientDbFactory, SimpleMongoDbFactory

public interface MongoDbFactory
extends CodecRegistryProvider, MongoSessionProvider

Interface for factories creating MongoDatabase instances.

Author:

Mark Pollack, Thomas Darimont, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
default org.bson.codecs.configuration.CodecRegistry	getCodecRegistry() Get the underlying CodecRegistry used by the MongoDB Java driver.
com.mongodb.client.MongoDatabase	getDb() Creates a default MongoDatabase instance.
com.mongodb.client.MongoDatabase	getDb(String dbName) Creates a DB instance to access the database with the given name.
PersistenceExceptionTranslator	getExceptionTranslator() Exposes a shared MongoExceptionTranslator.
com.mongodb.DB	getLegacyDb() Deprecated. since 2.1, use getDb(). This method will be removed with a future version as it works only with the legacy MongoDB driver.
com.mongodb.client.ClientSession	getSession(com.mongodb.ClientSessionOptions options) Obtain a ClientSession for given ClientSessionOptions.
default boolean	isTransactionActive() Returns if the given MongoDbFactory is bound to a ClientSession that has an active transaction.
MongoDbFactory	withSession(com.mongodb.client.ClientSession session) Obtain a ClientSession bound instance of MongoDbFactory returning MongoDatabase instances that are aware and bound to the given session.
default MongoDbFactory	withSession(com.mongodb.ClientSessionOptions options) Obtain a ClientSession bound instance of MongoDbFactory returning MongoDatabase instances that are aware and bound to a new session with given options.

Methods inherited from interface org.springframework.data.mongodb.CodecRegistryProvider

getCodecFor, hasCodecFor

Method Detail

getDb

com.mongodb.client.MongoDatabase getDb()
                                throws DataAccessException

Creates a default MongoDatabase instance.

Returns:

never null.

Throws:

DataAccessException

getDb

com.mongodb.client.MongoDatabase getDb(String dbName)
                                throws DataAccessException

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

Parameters:

dbName - must not be null or empty.

Returns:

never null.

Throws:

DataAccessException

getExceptionTranslator

PersistenceExceptionTranslator getExceptionTranslator()

Exposes a shared MongoExceptionTranslator.

Returns:

will never be null.

getLegacyDb

@Deprecated
com.mongodb.DB getLegacyDb()

Deprecated. since 2.1, use getDb(). This method will be removed with a future version as it works only with the legacy MongoDB driver.

Get the legacy database entry point. Please consider getDb() instead.

Returns:

getCodecRegistry

default org.bson.codecs.configuration.CodecRegistry getCodecRegistry()

Get the underlying CodecRegistry used by the MongoDB Java driver.

Specified by:

getCodecRegistry in interface CodecRegistryProvider

Returns:

never null.

getSession

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

Obtain a ClientSession for given ClientSessionOptions.

Specified by:

getSession in interface MongoSessionProvider

Parameters:

options - must not be null.

Returns:

never null.

Since:

2.1

withSession

default MongoDbFactory withSession(com.mongodb.ClientSessionOptions options)

Obtain a ClientSession bound instance of MongoDbFactory returning MongoDatabase instances that are aware and bound to a new session with given options.

Parameters:

options - must not be null.

Returns:

never null.

Since:

2.1

withSession

MongoDbFactory withSession(com.mongodb.client.ClientSession session)

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

Parameters:

session - must not be null.

Returns:

never null.

Since:

2.1

isTransactionActive

default boolean isTransactionActive()

Returns if the given MongoDbFactory is bound to a ClientSession that has an active transaction.

Returns:

true if there's an active transaction, false otherwise.

Since:

2.1.3