MongoDatabaseFactory (Spring Data MongoDB 3.2.5 API)

All Superinterfaces:

CodecRegistryProvider, MongoSessionProvider

All Known Subinterfaces:

MongoDbFactory

All Known Implementing Classes:

MongoDatabaseFactorySupport, MongoDbFactorySupport, SimpleMongoClientDatabaseFactory, SimpleMongoClientDbFactory
```
public interface MongoDatabaseFactory
extends CodecRegistryProvider, MongoSessionProvider
```
Interface for factories creating MongoDatabase instances.

Since:

3.0

Author:

Mark Pollack, Thomas Darimont, Christoph Strobl

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default org.bson.codecs.configuration.CodecRegistry`	`getCodecRegistry()` Get the underlying `CodecRegistry` used by the MongoDB Java driver.
`PersistenceExceptionTranslator`	`getExceptionTranslator()` Exposes a shared `MongoExceptionTranslator`.
`com.mongodb.client.MongoDatabase`	`getMongoDatabase()` Obtain a `MongoDatabase` from the underlying factory.
`com.mongodb.client.MongoDatabase`	`getMongoDatabase(String dbName)` Obtain a `MongoDatabase` instance to access the database with the given name.
`com.mongodb.client.ClientSession`	`getSession(com.mongodb.ClientSessionOptions options)` Obtain a `ClientSession` for given ClientSessionOptions.
`default boolean`	`isTransactionActive()` Returns if the given `MongoDatabaseFactory` is bound to a `ClientSession` that has an `active transaction`.
`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.
`default MongoDatabaseFactory`	`withSession(com.mongodb.ClientSessionOptions options)` Obtain a `ClientSession` bound instance of `MongoDatabaseFactory` 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
  - getMongoDatabase
```
com.mongodb.client.MongoDatabase getMongoDatabase()
                                           throws DataAccessException
```
    Obtain a MongoDatabase from the underlying factory.
    
    Returns:
    
    never null.
    
    Throws:
    
    DataAccessException
  - getMongoDatabase
```
com.mongodb.client.MongoDatabase getMongoDatabase(String dbName)
                                           throws DataAccessException
```
    Obtain a MongoDatabase instance to access the database with the given name.
    
    Parameters:
    
    dbName - must not be null.
    
    Returns:
    
    never null.
    
    Throws:
    
    DataAccessException
  - getExceptionTranslator
```
PersistenceExceptionTranslator getExceptionTranslator()
```
    Exposes a shared MongoExceptionTranslator.
    
    Returns:
    
    will never be null.
  - 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 MongoDatabaseFactory withSession(com.mongodb.ClientSessionOptions options)
```
    Obtain a ClientSession bound instance of MongoDatabaseFactory 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
```
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.
    
    Parameters:
    
    session - must not be null.
    
    Returns:
    
    never null.
    
    Since:
    
    2.1
  - isTransactionActive
```
default boolean isTransactionActive()
```
    Returns if the given MongoDatabaseFactory is bound to a ClientSession that has an active transaction.
    
    Returns:
    
    true if there's an active transaction, false otherwise.
    
    Since:
    
    2.1.3

Interface MongoDatabaseFactory

Method Summary

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

Method Detail

getMongoDatabase

getMongoDatabase

getExceptionTranslator

getCodecRegistry

getSession

withSession

withSession

isTransactionActive