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

Constructor Summary

Constructors

Constructor and Description
AbstractMongoConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
CustomConversions	customConversions() Register custom Converters in a CustomConversions object if required.
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() Return the base package to scan for mapped Documents.
protected org.springframework.data.authentication.UserCredentials	getUserCredentials() Return UserCredentials to be used when connecting to the MongoDB instance or null if none shall be used.
MappingMongoConverter	mappingMongoConverter() Creates a MappingMongoConverter using the configured mongoDbFactory() and mongoMappingContext().
abstract Mongo	mongo() Return the Mongo instance to connect to.
SimpleMongoDbFactory	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.

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.

mongo

@Bean
public abstract Mongo mongo()
                     throws Exception

Return the Mongo instance to connect to.

Returns:

Throws:

Exception

mongoTemplate

@Bean
public MongoTemplate mongoTemplate()
                            throws Exception

Creates a MongoTemplate.

Returns:

Throws:

Exception

mongoDbFactory

@Bean
public SimpleMongoDbFactory 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

protected String getMappingBasePackage()

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 overriden to implement alternate behaviour.

Returns:

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

getUserCredentials

protected org.springframework.data.authentication.UserCredentials getUserCredentials()

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

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.

Returns:

Throws:

ClassNotFoundException

See Also:

getMappingBasePackage()