org.springframework.data.mongodb.config

Class MongoConfigurationSupport

java.lang.Object

org.springframework.data.mongodb.config.MongoConfigurationSupport

Direct Known Subclasses:

AbstractMongoClientConfiguration, AbstractReactiveMongoConfiguration

public abstract class MongoConfigurationSupport
extends Object

Base class for Spring Data MongoDB to be extended for JavaConfiguration usage.

Since:

2.0

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor and Description
MongoConfigurationSupport()

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.
protected boolean	autoIndexCreation() Configure whether to automatically create indices for domain types by deriving the IndexDefinition from the entity or not.
protected void	configureClientSettings(com.mongodb.MongoClientSettings.Builder builder) Configure MongoClientSettings via its MongoClientSettings.Builder API.
protected void	configureConverters(MongoCustomConversions.MongoConverterConfigurationAdapter converterConfigurationAdapter) Configuration hook for MongoCustomConversions creation.
MongoCustomConversions	customConversions() Register custom Converters in a CustomConversions object if required.
protected FieldNamingStrategy	fieldNamingStrategy() Configures a FieldNamingStrategy on the MongoMappingContext instance created.
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 Collection<String>	getMappingBasePackages() Returns the base packages to scan for MongoDB mapped entities at startup.
protected com.mongodb.MongoClientSettings	mongoClientSettings() Return the MongoClientSettings used to create the actual MongoClient.
MongoMappingContext	mongoMappingContext(MongoCustomConversions customConversions) Creates a MongoMappingContext equipped with entity classes scanned from the mapping base package.
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

MongoConfigurationSupport

public MongoConfigurationSupport()

Method Detail

getDatabaseName

protected abstract String getDatabaseName()

Return the name of the database to connect to.

Returns:

must not be null.

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 MongoConfigurationSupport 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

mongoMappingContext

@Bean
public MongoMappingContext mongoMappingContext(MongoCustomConversions customConversions)
                                              throws ClassNotFoundException

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

Returns:

Throws:

ClassNotFoundException

See Also:

getMappingBasePackages()

customConversions

@Bean
public MongoCustomConversions customConversions()

Register custom Converters in a CustomConversions object if required. These CustomConversions will be registered with the MappingMongoConverter and MongoMappingContext. Returns an empty MongoCustomConversions instance by default.

NOTE: Use #configureConverters(MongoConverterConfigurationAdapter) to configure MongoDB native simple types and register custom converters.

Returns:

must not be null.

configureConverters

protected void configureConverters(MongoCustomConversions.MongoConverterConfigurationAdapter converterConfigurationAdapter)

Configuration hook for MongoCustomConversions creation.

Parameters:

converterConfigurationAdapter - never null.

Since:

2.3

See Also:

MongoCustomConversions.MongoConverterConfigurationAdapter.useNativeDriverJavaTimeCodecs(), MongoCustomConversions.MongoConverterConfigurationAdapter.useSpringDataJavaTimeCodecs()

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

autoIndexCreation

protected boolean autoIndexCreation()

Configure whether to automatically create indices for domain types by deriving the IndexDefinition from the entity or not.

Returns:

false by default.
INFO: As of 3.x the default is set to false; In 2.x it was true.

Since:

2.2

mongoClientSettings

protected com.mongodb.MongoClientSettings mongoClientSettings()

Return the MongoClientSettings used to create the actual MongoClient.
Override either this method, or use #configureClientSettings(Builder) to alter the setup.

Returns:

never null.

Since:

3.0

configureClientSettings

protected void configureClientSettings(com.mongodb.MongoClientSettings.Builder builder)

Configure MongoClientSettings via its MongoClientSettings.Builder API.

Parameters:

builder - never null.

Since:

3.0