org.springframework.data.mongodb.config

Class AbstractMongoClientConfiguration

java.lang.Object

org.springframework.data.mongodb.config.MongoConfigurationSupport

org.springframework.data.mongodb.config.AbstractMongoClientConfiguration

@Configuration
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, AbstractMongoConfiguration

Constructor Summary

Constructors

Constructor and Description
AbstractMongoClientConfiguration()

Method Summary

Modifier and Type	Method and Description
protected String	getMappingBasePackage() Deprecated. use MongoConfigurationSupport.getMappingBasePackages() instead.
MappingMongoConverter	mappingMongoConverter() Creates a MappingMongoConverter using the configured mongoDbFactory() and MongoConfigurationSupport.mongoMappingContext().
abstract com.mongodb.client.MongoClient	mongoClient() Return the MongoClient instance to connect to.
MongoDbFactory	mongoDbFactory() Creates a SimpleMongoDbFactory to be used by the MongoTemplate.
MongoTemplate	mongoTemplate() Creates a MongoTemplate.

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

abbreviateFieldNames, autoIndexCreation, customConversions, fieldNamingStrategy, getDatabaseName, getInitialEntitySet, getMappingBasePackages, mongoMappingContext, scanForEntities

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMongoClientConfiguration

public AbstractMongoClientConfiguration()

Method Detail

mongoClient

public abstract 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.

Returns:

mongoTemplate

@Bean
public MongoTemplate mongoTemplate()
                                  throws Exception

Creates a MongoTemplate.

Returns:

Throws:

Exception

mongoDbFactory

@Bean
public MongoDbFactory mongoDbFactory()

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

Returns:

See Also:

mongoClient(), mongoTemplate()

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()
                                                  throws Exception

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

Returns:

Throws:

Exception

See Also:

MongoConfigurationSupport.customConversions(), MongoConfigurationSupport.mongoMappingContext(), mongoDbFactory()