Package org.springframework.data.mongodb.config

Class AbstractMongoClientConfiguration

java.lang.Object

org.springframework.data.mongodb.config.MongoConfigurationSupport

org.springframework.data.mongodb.config.AbstractMongoClientConfiguration

@Configuration(proxyBeanMethods=false)
public abstract class AbstractMongoClientConfiguration
extends MongoConfigurationSupport

Base class for Spring Data MongoDB configuration using JavaConfig with MongoClient.

Since:

2.1

Author:

Christoph Strobl

See Also:

• MongoConfigurationSupport

Constructor Summary

Constructors

Constructor	Description
AbstractMongoClientConfiguration()

Method Summary

Modifier and Type	Method	Description
protected com.mongodb.client.MongoClient	createMongoClient(com.mongodb.MongoClientSettings settings)	Create the Reactive Streams MongoClient instance with given MongoClientSettings.
protected String	getMappingBasePackage()	Deprecated. use MongoConfigurationSupport.getMappingBasePackages() instead.
MappingMongoConverter	mappingMongoConverter(MongoDatabaseFactory databaseFactory, MongoCustomConversions customConversions, MongoMappingContext mappingContext)	Creates a MappingMongoConverter using the configured mongoDbFactory() and MongoConfigurationSupport.mongoMappingContext(MongoCustomConversions).
com.mongodb.client.MongoClient	mongoClient()	Return the MongoClient instance to connect to.
MongoDatabaseFactory	mongoDbFactory()	Creates a SimpleMongoClientDatabaseFactory to be used by the MongoTemplate.
MongoTemplate	mongoTemplate(MongoDatabaseFactory databaseFactory, MappingMongoConverter converter)	Creates a MongoTemplate.

Methods inherited from class org.springframework.data.mongodb.config.MongoConfigurationSupport

abbreviateFieldNames, autoIndexCreation, configureClientSettings, configureConverters, customConversions, fieldNamingStrategy, getDatabaseName, getInitialEntitySet, getMappingBasePackages, mongoClientSettings, mongoMappingContext, scanForEntities

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractMongoClientConfiguration

public AbstractMongoClientConfiguration()

Method Details

mongoClient

public com.mongodb.client.MongoClient mongoClient()

Return the MongoClient instance to connect to. Annotate with Bean in case you want to expose a MongoClient instance to the ApplicationContext.
Override MongoConfigurationSupport.mongoClientSettings() to configure connection details.

Returns:

never null.

See Also:

• MongoConfigurationSupport.mongoClientSettings()
• MongoConfigurationSupport.configureClientSettings(Builder)

mongoTemplate

@Bean
public MongoTemplate mongoTemplate(MongoDatabaseFactory databaseFactory,
 MappingMongoConverter converter)

Creates a MongoTemplate.

See Also:

• mongoDbFactory()
• mappingMongoConverter(MongoDatabaseFactory, MongoCustomConversions, MongoMappingContext)

mongoDbFactory

@Bean
public MongoDatabaseFactory mongoDbFactory()

Creates a SimpleMongoClientDatabaseFactory to be used by the MongoTemplate. Will use the MongoClient instance configured in mongoClient().

See Also:

• mongoClient()
• mongoTemplate(MongoDatabaseFactory, MappingMongoConverter)

getMappingBasePackage

@Deprecated
@Nullable
protected String getMappingBasePackage()

Deprecated.

use MongoConfigurationSupport.getMappingBasePackages() instead.

Return the base package to scan for mapped Documents. Will return the package name of the configuration class' (the concrete class, not this one here) by default. So if you have a com.acme.AppConfig extending AbstractMongoClientConfiguration the base package will be considered com.acme unless the method is overridden to implement alternate behavior.

Returns:

the base package to scan for mapped Document classes or null to not enable scanning for entities.

mappingMongoConverter

@Bean
public MappingMongoConverter mappingMongoConverter(MongoDatabaseFactory databaseFactory,
 MongoCustomConversions customConversions,
 MongoMappingContext mappingContext)

Creates a MappingMongoConverter using the configured mongoDbFactory() and MongoConfigurationSupport.mongoMappingContext(MongoCustomConversions). Will get MongoConfigurationSupport.customConversions() applied.

See Also:

• MongoConfigurationSupport.customConversions()
• MongoConfigurationSupport.mongoMappingContext(MongoCustomConversions)
• mongoDbFactory()

createMongoClient

protected com.mongodb.client.MongoClient createMongoClient(com.mongodb.MongoClientSettings settings)

Create the Reactive Streams MongoClient instance with given MongoClientSettings.

Returns:

never null.

Since:

3.0