SimpleMongoClientDbFactory (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.MongoDbFactorySupport<com.mongodb.client.MongoClient>
- - org.springframework.data.mongodb.core.SimpleMongoClientDbFactory

All Implemented Interfaces:

DisposableBean, CodecRegistryProvider, MongoDbFactory, MongoSessionProvider
```
public class SimpleMongoClientDbFactory
extends MongoDbFactorySupport<com.mongodb.client.MongoClient>
implements DisposableBean
```
Factory to create MongoDatabase instances from a MongoClient instance.

Since:

2.1

Author:

Christoph Strobl

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.DB`	`getLegacyDb()` Get the legacy database entry point.
`com.mongodb.client.ClientSession`	`getSession(com.mongodb.ClientSessionOptions options)` Obtain a `ClientSession` for given ClientSessionOptions.

Methods inherited from class org.springframework.data.mongodb.core.MongoDbFactorySupport
destroy, getDb, getDb, getDefaultDatabaseName, getExceptionTranslator, getMongoClient, setWriteConcern, withSession

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.beans.factory.DisposableBean
destroy

Methods inherited from interface org.springframework.data.mongodb.MongoDbFactory
getCodecRegistry, withSession

Methods inherited from interface org.springframework.data.mongodb.CodecRegistryProvider
getCodecFor, hasCodecFor

- Constructor Detail
  - SimpleMongoClientDbFactory
```
public SimpleMongoClientDbFactory(String connectionString)
```
    Creates a new SimpleMongoClientDbFactory instance for the given connectionString.
    
    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
  - SimpleMongoClientDbFactory
```
public SimpleMongoClientDbFactory(com.mongodb.ConnectionString connectionString)
```
    Creates a new SimpleMongoClientDbFactory instance from the given MongoClient.
    
    Parameters:
    
    connectionString - connection coordinates for a database connection. Must contain also a database name and not be null.
  - SimpleMongoClientDbFactory
```
public SimpleMongoClientDbFactory(com.mongodb.client.MongoClient mongoClient,
                                  String databaseName)
```
    Creates a new SimpleMongoClientDbFactory instance from the given MongoClient.
    
    Parameters:
    
    mongoClient - must not be null.
    
    databaseName - must not be null or empty.
- Method Detail
  - getLegacyDb
```
public com.mongodb.DB getLegacyDb()
```
    Description copied from interface: MongoDbFactory
    
    Get the legacy database entry point. Please consider MongoDbFactory.getDb() instead.
    
    Specified by:
    
    getLegacyDb in interface MongoDbFactory
    
    Returns:
  - getSession
```
public com.mongodb.client.ClientSession getSession(com.mongodb.ClientSessionOptions options)
```
    Description copied from interface: MongoDbFactory
    
    Obtain a ClientSession for given ClientSessionOptions.
    
    Specified by:
    
    getSession in interface MongoDbFactory
    
    Specified by:
    
    getSession in interface MongoSessionProvider
    
    Parameters:
    
    options - must not be null.
    
    Returns:
    
    never null.
  - closeClient
```
protected void closeClient()
```
    Description copied from class: MongoDbFactorySupport
    
    Close the client instance.
    
    Specified by:
    
    closeClient in class MongoDbFactorySupport<com.mongodb.client.MongoClient>
  - doGetMongoDatabase
```
protected com.mongodb.client.MongoDatabase doGetMongoDatabase(String dbName)
```
    Description copied from class: MongoDbFactorySupport
    
    Get the actual MongoDatabase from the client.
    
    Specified by:
    
    doGetMongoDatabase in class MongoDbFactorySupport<com.mongodb.client.MongoClient>
    
    Parameters:
    
    dbName - must not be null or empty.
    
    Returns:

Class SimpleMongoClientDbFactory

Constructor Summary

Method Summary

Methods inherited from class org.springframework.data.mongodb.core.MongoDbFactorySupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.beans.factory.DisposableBean

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

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

Constructor Detail

SimpleMongoClientDbFactory

SimpleMongoClientDbFactory

SimpleMongoClientDbFactory

Method Detail

getLegacyDb

getSession

closeClient

doGetMongoDatabase