org.springframework.data.mongodb.config

Class AbstractMongoConfiguration

java.lang.Object

org.springframework.data.mongodb.config.AbstractMongoConfiguration

@Configuration
public abstract class AbstractMongoConfiguration
extends Object

Base class for Spring Data MongoDB configuration using JavaConfig.

Author:

Mark Pollack, Oliver Gierke, Thomas Darimont, Ryan Tenney, Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
AbstractMongoConfiguration()

Method Summary

Modifier and Type	Method and Description
protected boolean	abbreviateFieldNames() Configures whether to abbreviate field names for domain objects by configuring a CamelCaseAbbreviatingFieldNamingStrategy on the MongoMappingContext instance created.
CustomConversions	customConversions() Register custom Converters in a CustomConversions object if required.
protected FieldNamingStrategy	fieldNamingStrategy() Configures a FieldNamingStrategy on the MongoMappingContext instance created.
protected String	getAuthenticationDatabaseName() Deprecated. since 1.7. MongoClient should hold authentication data within MongoClient.getCredentialsList()
protected abstract String	getDatabaseName() Return the name of the database to connect to.
protected Set<Class<?>>	getInitialEntitySet() Scans the mapping base package for classes annotated with Document.
protected String	getMappingBasePackage() Deprecated. use getMappingBasePackages() instead.
protected Collection<String>	getMappingBasePackages() Returns the base packages to scan for MongoDB mapped entities at startup.
protected UserCredentials	getUserCredentials() Deprecated. since 1.7. MongoClient should hold authentication data within MongoClient.getCredentialsList()
IsNewStrategyFactory	isNewStrategyFactory() Returns a MappingContextIsNewStrategyFactory wrapped into a CachingIsNewStrategyFactory.
MappingMongoConverter	mappingMongoConverter() Creates a MappingMongoConverter using the configured mongoDbFactory() and mongoMappingContext().
abstract com.mongodb.Mongo	mongo() Return the Mongo instance to connect to.
MongoDbFactory	mongoDbFactory() Creates a SimpleMongoDbFactory to be used by the MongoTemplate.
MongoMappingContext	mongoMappingContext() Creates a MongoMappingContext equipped with entity classes scanned from the mapping base package.
MongoTemplate	mongoTemplate() Creates a MongoTemplate.
protected Set<Class<?>>	scanForEntities(String basePackage) Scans the given base package for entities, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMongoConfiguration

public AbstractMongoConfiguration()

Method Detail

getDatabaseName

protected abstract String getDatabaseName()

Return the name of the database to connect to.

Returns:

must not be null.

getAuthenticationDatabaseName

@Deprecated
protected String getAuthenticationDatabaseName()

Deprecated. since 1.7. MongoClient should hold authentication data within MongoClient.getCredentialsList()

Return the name of the authentication database to use. Defaults to null and will turn into the value returned by getDatabaseName() later on effectively.

Returns:

mongo

public abstract com.mongodb.Mongo mongo()
                                 throws Exception

Return the Mongo instance to connect to. Annotate with Bean in case you want to expose a Mongo instance to the ApplicationContext.

Returns:

Throws:

Exception

mongoTemplate

@Bean
public MongoTemplate mongoTemplate()
                                  throws Exception

Creates a MongoTemplate.

Returns:

Throws:

Exception

mongoDbFactory

@Bean
public MongoDbFactory mongoDbFactory()
                                    throws Exception

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

Returns:

Throws:

Exception

See Also:

mongo(), mongoTemplate()

getMappingBasePackage

@Deprecated
protected String getMappingBasePackage()

Deprecated. use 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 AbstractMongoConfiguration 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.

getMappingBasePackages

protected Collection<String> getMappingBasePackages()

Returns the base packages to scan for MongoDB mapped entities at startup. 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 AbstractMongoConfiguration the base package will be considered com.acme unless the method is overridden to implement alternate behavior.

Returns:

the base packages to scan for mapped Document classes or an empty collection to not enable scanning for entities.

Since:

1.10

getUserCredentials

@Deprecated
protected UserCredentials getUserCredentials()

Deprecated. since 1.7. MongoClient should hold authentication data within MongoClient.getCredentialsList()

Return UserCredentials to be used when connecting to the MongoDB instance or null if none shall be used.

Returns:

mongoMappingContext

@Bean
public MongoMappingContext mongoMappingContext()
                                              throws ClassNotFoundException

Creates a MongoMappingContext equipped with entity classes scanned from the mapping base package.

Returns:

Throws:

ClassNotFoundException

See Also:

getMappingBasePackage()

isNewStrategyFactory

@Bean
public IsNewStrategyFactory isNewStrategyFactory()
                                                throws ClassNotFoundException

Returns a MappingContextIsNewStrategyFactory wrapped into a CachingIsNewStrategyFactory.

Returns:

Throws:

ClassNotFoundException

customConversions

@Bean
public CustomConversions customConversions()

Register custom Converters in a CustomConversions object if required. These CustomConversions will be registered with the mappingMongoConverter() and mongoMappingContext(). Returns an empty CustomConversions instance by default.

Returns:

must not be null.

mappingMongoConverter

@Bean
public MappingMongoConverter mappingMongoConverter()
                                                  throws Exception

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

Returns:

Throws:

Exception

See Also:

customConversions(), mongoMappingContext(), mongoDbFactory()

getInitialEntitySet

protected Set<Class<?>> getInitialEntitySet()
                                     throws ClassNotFoundException

Scans the mapping base package for classes annotated with Document. By default, it scans for entities in all packages returned by getMappingBasePackages().

Returns:

Throws:

ClassNotFoundException

See Also:

getMappingBasePackages()

scanForEntities

protected Set<Class<?>> scanForEntities(String basePackage)
                                 throws ClassNotFoundException

Scans the given base package for entities, i.e. MongoDB specific types annotated with Document and Persistent.

Parameters:

basePackage - must not be null.

Returns:

Throws:

ClassNotFoundException

Since:

1.10

abbreviateFieldNames

protected boolean abbreviateFieldNames()

Configures whether to abbreviate field names for domain objects by configuring a CamelCaseAbbreviatingFieldNamingStrategy on the MongoMappingContext instance created. For advanced customization needs, consider overriding mappingMongoConverter().

Returns:

fieldNamingStrategy

protected FieldNamingStrategy fieldNamingStrategy()

Configures a FieldNamingStrategy on the MongoMappingContext instance created.

Returns:

Since:

1.5