Class SimpleReactiveMongoDatabaseFactory

java.lang.Object

org.springframework.data.mongodb.core.SimpleReactiveMongoDatabaseFactory

All Implemented Interfaces:

DisposableBean, CodecRegistryProvider, ReactiveMongoDatabaseFactory

public class SimpleReactiveMongoDatabaseFactory
extends Object
implements DisposableBean, ReactiveMongoDatabaseFactory

Factory to create MongoDatabase instances from a MongoClient instance.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl, Mathieu Ouellet

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	destroy()	Clean up the Mongo instance if it was created by the factory itself.
org.bson.codecs.configuration.CodecRegistry	getCodecRegistry()	Get the underlying CodecRegistry used by the reactive MongoDB Java driver.
PersistenceExceptionTranslator	getExceptionTranslator()	Exposes a shared MongoExceptionTranslator.
Mono<com.mongodb.reactivestreams.client.MongoDatabase>	getMongoDatabase()	Creates a default MongoDatabase instance.
Mono<com.mongodb.reactivestreams.client.MongoDatabase>	getMongoDatabase(String dbName)	Obtain a MongoDatabase instance to access the database with the given name.
Mono<com.mongodb.reactivestreams.client.ClientSession>	getSession(com.mongodb.ClientSessionOptions options)	Obtain a Mono emitting a ClientSession for given options.
void	setExceptionTranslator(PersistenceExceptionTranslator exceptionTranslator)	Configures the PersistenceExceptionTranslator to be used.
void	setWriteConcern(com.mongodb.WriteConcern writeConcern)	Configures the WriteConcern to be used on the MongoDatabase instance being created.
ReactiveMongoDatabaseFactory	withSession(com.mongodb.reactivestreams.client.ClientSession session)	Obtain a ClientSession bound instance of ReactiveMongoDatabaseFactory returning MongoDatabase instances that are aware and bound to the given session.

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 ReactiveMongoDatabaseFactory

isTransactionActive

Constructor Details

SimpleReactiveMongoDatabaseFactory

public SimpleReactiveMongoDatabaseFactory(com.mongodb.ConnectionString connectionString)

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

Parameters:

connectionString - must not be null.

SimpleReactiveMongoDatabaseFactory

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

Creates a new SimpleReactiveMongoDatabaseFactory instance from the given MongoClient. Note that the client will not be closed when calling destroy() as we assume a managed client instance that we do not want to close on 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.

Since:

1.7

Method Details

setExceptionTranslator

public void setExceptionTranslator(PersistenceExceptionTranslator exceptionTranslator)

Configures the PersistenceExceptionTranslator to be used.

Parameters:

exceptionTranslator - the exception translator to set.

Since:

4.4

getExceptionTranslator

public PersistenceExceptionTranslator getExceptionTranslator()

Description copied from interface: ReactiveMongoDatabaseFactory

Exposes a shared MongoExceptionTranslator.

Specified by:

getExceptionTranslator in interface ReactiveMongoDatabaseFactory

Returns:

will never be null.

setWriteConcern

public void setWriteConcern(com.mongodb.WriteConcern writeConcern)

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

Parameters:

writeConcern - the writeConcern to set

getMongoDatabase

public Mono<com.mongodb.reactivestreams.client.MongoDatabase> getMongoDatabase()
                                                                        throws DataAccessException

Description copied from interface: ReactiveMongoDatabaseFactory

Creates a default MongoDatabase instance.

Specified by:

getMongoDatabase in interface ReactiveMongoDatabaseFactory

Returns:

never null.

Throws:

DataAccessException

getMongoDatabase

public Mono<com.mongodb.reactivestreams.client.MongoDatabase> getMongoDatabase(String dbName)
                                                                        throws DataAccessException

Description copied from interface: ReactiveMongoDatabaseFactory

Obtain a MongoDatabase instance to access the database with the given name.

Specified by:

getMongoDatabase in interface ReactiveMongoDatabaseFactory

Parameters:

dbName - must not be null or empty.

Returns:

never null.

Throws:

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 DisposableBean

Throws:

Exception

See Also:

• DisposableBean.destroy()

getCodecRegistry

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

Description copied from interface: ReactiveMongoDatabaseFactory

Get the underlying CodecRegistry used by the reactive MongoDB Java driver.

Specified by:

getCodecRegistry in interface CodecRegistryProvider

Specified by:

getCodecRegistry in interface ReactiveMongoDatabaseFactory

Returns:

never null.

getSession

public Mono<com.mongodb.reactivestreams.client.ClientSession> getSession(com.mongodb.ClientSessionOptions options)

Description copied from interface: ReactiveMongoDatabaseFactory

Obtain a Mono emitting a ClientSession for given options.

Specified by:

getSession in interface ReactiveMongoDatabaseFactory

Parameters:

options - must not be null.

Returns:

never null.

withSession

public ReactiveMongoDatabaseFactory withSession(com.mongodb.reactivestreams.client.ClientSession session)

Description copied from interface: ReactiveMongoDatabaseFactory

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

Specified by:

withSession in interface ReactiveMongoDatabaseFactory

Parameters:

session - must not be null.

Returns:

never null.