org.springframework.data.mongodb.core

Class MongoDbFactorySupport<C>

java.lang.Object

org.springframework.data.mongodb.core.MongoDbFactorySupport<C>

Type Parameters:

C - Client type.

All Implemented Interfaces:

CodecRegistryProvider, MongoDbFactory, MongoSessionProvider

Direct Known Subclasses:

SimpleMongoClientDbFactory, SimpleMongoDbFactory

public abstract class MongoDbFactorySupport<C>
extends Object
implements MongoDbFactory

Common base class for usage with both MongoClients and MongoClient defining common properties such as database name and exception translator.

Not intended to be used directly.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

See Also:

SimpleMongoDbFactory, SimpleMongoClientDbFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MongoDbFactorySupport(C mongoClient, String databaseName, boolean mongoInstanceCreated, PersistenceExceptionTranslator exceptionTranslator) Create a new MongoDbFactorySupport object given mongoClient, databaseName, mongoInstanceCreated and PersistenceExceptionTranslator.

Method Summary

Modifier and Type	Method and Description
protected abstract void	closeClient() Close the client instance.
void	destroy()
protected abstract com.mongodb.client.MongoDatabase	doGetMongoDatabase(String dbName) Get the actual MongoDatabase from the client.
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.
protected String	getDefaultDatabaseName()
PersistenceExceptionTranslator	getExceptionTranslator() Exposes a shared MongoExceptionTranslator.
protected C	getMongoClient()
void	setWriteConcern(com.mongodb.WriteConcern writeConcern) Configures the WriteConcern to be used on the MongoDatabase instance being created.
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.

Methods inherited from class java.lang.Object

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

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

getCodecRegistry, getLegacyDb, getSession, withSession

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

getCodecFor, hasCodecFor

Constructor Detail

MongoDbFactorySupport

protected MongoDbFactorySupport(C mongoClient,
                                String databaseName,
                                boolean mongoInstanceCreated,
                                PersistenceExceptionTranslator exceptionTranslator)

Create a new MongoDbFactorySupport object given mongoClient, databaseName, mongoInstanceCreated and PersistenceExceptionTranslator.

Parameters:

mongoClient - must not be null.

databaseName - must not be null or empty.

mongoInstanceCreated - true if the client instance was created by a subclass of MongoDbFactorySupport to close the client on destroy().

exceptionTranslator - must not be null.

Method Detail

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

getDb

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

Description copied from interface: MongoDbFactory

Creates a default MongoDatabase instance.

Specified by:

getDb in interface MongoDbFactory

Returns:

Throws:

DataAccessException

getDb

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

Description copied from interface: MongoDbFactory

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

Specified by:

getDb in interface MongoDbFactory

Parameters:

dbName - must not be null or empty.

Returns:

Throws:

DataAccessException

doGetMongoDatabase

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

Get the actual MongoDatabase from the client.

Parameters:

dbName - must not be null or empty.

Returns:

destroy

public void destroy()
             throws Exception

Throws:

Exception

getExceptionTranslator

public PersistenceExceptionTranslator getExceptionTranslator()

Description copied from interface: MongoDbFactory

Exposes a shared MongoExceptionTranslator.

Specified by:

getExceptionTranslator in interface MongoDbFactory

Returns:

will never be null.

withSession

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

Description copied from interface: MongoDbFactory

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

Specified by:

withSession in interface MongoDbFactory

Parameters:

session - must not be null.

Returns:

never null.

closeClient

protected abstract void closeClient()

Close the client instance.

getMongoClient

protected C getMongoClient()

Returns:

the Mongo client object.

getDefaultDatabaseName

protected String getDefaultDatabaseName()

Returns:

the database name.