DATAMONGO-843 - Improvements in auditing configuration.

Repositories now declare a fallback MappingContext in case none is configured explicitly to make sure @EnableMongoAuditing also works without an explicit MappingContext bean defined.

AuditingEntityListener is now referring to the IsNewAwareAuditingHandler via an intermediate ObjectFactory to prevent the downstream dependencies from being instantiated eagerly at listener init time.

This is to prevent circular initialization dependencies as Spring accesses ApplicationEventListener beans very early in the container lifecycle to check whether they might be interested in a certain even and just dropped immediately afterwards.

Changed BeanNames.MAPPING_CONTEXT constant to mongoMappingContext to let the XML configuration be consistent with AbstractMongoConfiguration.mongoMappingContext().

Author: Thomas Darimont

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/BeanNames.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,13 +24,14 @@
  */
 public abstract class BeanNames {
 
-	static final String MAPPING_CONTEXT = "mappingContext";
-	static final String INDEX_HELPER = "indexCreationHelper";
-	static final String MONGO = "mongo";
-	static final String DB_FACTORY = "mongoDbFactory";
-	static final String VALIDATING_EVENT_LISTENER = "validatingMongoEventListener";
-	static final String IS_NEW_STRATEGY_FACTORY = "isNewStrategyFactory";
+	public static final String MAPPING_CONTEXT_BEAN_NAME = "mongoMappingContext";
+
+	static final String INDEX_HELPER_BEAN_NAME = "indexCreationHelper";
+	static final String MONGO_BEAN_NAME = "mongo";
+	static final String DB_FACTORY_BEAN_NAME = "mongoDbFactory";
+	static final String VALIDATING_EVENT_LISTENER_BEAN_NAME = "validatingMongoEventListener";
+	static final String IS_NEW_STRATEGY_FACTORY_BEAN_NAME = "isNewStrategyFactory";
 	static final String DEFAULT_CONVERTER_BEAN_NAME = "mappingConverter";
-	static final String MONGO_TEMPLATE = "mongoTemplate";
-	static final String GRID_FS_TEMPLATE = "gridFsTemplate";
+	static final String MONGO_TEMPLATE_BEAN_NAME = "mongoTemplate";
+	static final String GRID_FS_TEMPLATE_BEAN_NAME = "gridFsTemplate";
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/GridFsTemplateParser.java

@@ -43,7 +43,7 @@ protected String resolveId(Element element, AbstractBeanDefinition definition, P
 			throws BeanDefinitionStoreException {
 
 		String id = super.resolveId(element, definition, parserContext);
-		return StringUtils.hasText(id) ? id : BeanNames.GRID_FS_TEMPLATE;
+		return StringUtils.hasText(id) ? id : BeanNames.GRID_FS_TEMPLATE_BEAN_NAME;
 	}
 
 	/*
@@ -64,7 +64,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 		if (StringUtils.hasText(dbFactoryRef)) {
 			gridFsTemplateBuilder.addConstructorArgReference(dbFactoryRef);
 		} else {
-			gridFsTemplateBuilder.addConstructorArgReference(BeanNames.DB_FACTORY);
+			gridFsTemplateBuilder.addConstructorArgReference(BeanNames.DB_FACTORY_BEAN_NAME);
 		}
 
 		if (StringUtils.hasText(converterRef)) {
@@ -77,7 +77,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 			gridFsTemplateBuilder.addConstructorArgValue(bucket);
 		}
 
-		return (AbstractBeanDefinition) helper.getComponentIdButFallback(gridFsTemplateBuilder, BeanNames.GRID_FS_TEMPLATE)
+		return (AbstractBeanDefinition) helper.getComponentIdButFallback(gridFsTemplateBuilder, BeanNames.GRID_FS_TEMPLATE_BEAN_NAME)
 				.getBeanDefinition();
 	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MappingMongoConverterParser.java

@@ -86,7 +86,7 @@ public BeanDefinition parse(Element element, ParserContext parserContext) {
 		BeanDefinitionRegistry registry = parserContext.getRegistry();
 
 		String id = element.getAttribute(AbstractBeanDefinitionParser.ID_ATTRIBUTE);
-		id = StringUtils.hasText(id) ? id : "mappingConverter";
+		id = StringUtils.hasText(id) ? id : DEFAULT_CONVERTER_BEAN_NAME;
 
 		parserContext.pushContainingComponent(new CompositeComponentDefinition("Mapping Mongo Converter", element));
 
@@ -98,7 +98,7 @@ public BeanDefinition parse(Element element, ParserContext parserContext) {
 		// Need a reference to a Mongo instance
 		String dbFactoryRef = element.getAttribute("db-factory-ref");
 		if (!StringUtils.hasText(dbFactoryRef)) {
-			dbFactoryRef = DB_FACTORY;
+			dbFactoryRef = DB_FACTORY_BEAN_NAME;
 		}
 
 		// Converter
@@ -116,10 +116,10 @@ public BeanDefinition parse(Element element, ParserContext parserContext) {
 		}
 
 		try {
-			registry.getBeanDefinition(INDEX_HELPER);
+			registry.getBeanDefinition(INDEX_HELPER_BEAN_NAME);
 		} catch (NoSuchBeanDefinitionException ignored) {
 			if (!StringUtils.hasText(dbFactoryRef)) {
-				dbFactoryRef = DB_FACTORY;
+				dbFactoryRef = DB_FACTORY_BEAN_NAME;
 			}
 			BeanDefinitionBuilder indexHelperBuilder = BeanDefinitionBuilder
 					.genericBeanDefinition(MongoPersistentEntityIndexCreator.class);
@@ -128,14 +128,14 @@ public BeanDefinition parse(Element element, ParserContext parserContext) {
 			indexHelperBuilder.addDependsOn(ctxRef);
 
 			parserContext.registerBeanComponent(new BeanComponentDefinition(indexHelperBuilder.getBeanDefinition(),
-					INDEX_HELPER));
+					INDEX_HELPER_BEAN_NAME));
 		}
 
 		BeanDefinition validatingMongoEventListener = potentiallyCreateValidatingMongoEventListener(element, parserContext);
 
 		if (validatingMongoEventListener != null) {
 			parserContext.registerBeanComponent(new BeanComponentDefinition(validatingMongoEventListener,
-					VALIDATING_EVENT_LISTENER));
+					VALIDATING_EVENT_LISTENER_BEAN_NAME));
 		}
 
 		parserContext.registerBeanComponent(new BeanComponentDefinition(converterBuilder.getBeanDefinition(), id));
@@ -180,7 +180,7 @@ private RuntimeBeanReference getValidator(Object source, ParserContext parserCon
 		return new RuntimeBeanReference(validatorName);
 	}
 
-	static String potentiallyCreateMappingContext(Element element, ParserContext parserContext,
+	public static String potentiallyCreateMappingContext(Element element, ParserContext parserContext,
 			BeanDefinition conversionsDefinition, String converterId) {
 
 		String ctxRef = element.getAttribute("mapping-context-ref");
@@ -215,7 +215,8 @@ static String potentiallyCreateMappingContext(Element element, ParserContext par
 					CamelCaseAbbreviatingFieldNamingStrategy.class));
 		}
 
-		ctxRef = converterId + "." + MAPPING_CONTEXT;
+		ctxRef = converterId == null || DEFAULT_CONVERTER_BEAN_NAME.equals(converterId) ? MAPPING_CONTEXT_BEAN_NAME
+				: converterId + "." + MAPPING_CONTEXT_BEAN_NAME;
 
 		parserContext.registerBeanComponent(componentDefinitionBuilder.getComponent(mappingContextBuilder, ctxRef));
 		return ctxRef;
@@ -310,9 +311,10 @@ public static String createIsNewStrategyFactoryBeanDefinition(String mappingCont
 		mappingContextStrategyFactoryBuilder.addConstructorArgReference(mappingContextRef);
 
 		BeanComponentDefinitionBuilder builder = new BeanComponentDefinitionBuilder(element, context);
-		context.registerBeanComponent(builder.getComponent(mappingContextStrategyFactoryBuilder, IS_NEW_STRATEGY_FACTORY));
+		context.registerBeanComponent(builder.getComponent(mappingContextStrategyFactoryBuilder,
+				IS_NEW_STRATEGY_FACTORY_BEAN_NAME));
 
-		return IS_NEW_STRATEGY_FACTORY;
+		return IS_NEW_STRATEGY_FACTORY_BEAN_NAME;
 	}
 
 	/**

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoAuditingBeanDefinitionParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 the original author or authors.
+ * Copyright 2012-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,10 @@
  */
 package org.springframework.data.mongodb.config;
 
-import org.springframework.beans.factory.config.BeanDefinition;
+import static org.springframework.data.config.ParsingUtils.*;
+import static org.springframework.data.mongodb.config.BeanNames.*;
+import static org.springframework.data.mongodb.config.MappingMongoConverterParser.*;
+
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
@@ -60,21 +63,23 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
 
 		BeanDefinitionRegistry registry = parserContext.getRegistry();
 
-		if (!registry.containsBeanDefinition(BeanNames.IS_NEW_STRATEGY_FACTORY)) {
+		String isNewStrategyFactoryName = IS_NEW_STRATEGY_FACTORY_BEAN_NAME;
+		String mappingContextName = MAPPING_CONTEXT_BEAN_NAME;
 
-			String mappingContextName = BeanNames.MAPPING_CONTEXT;
+		if (!registry.containsBeanDefinition(isNewStrategyFactoryName)) {
 
-			if (!registry.containsBeanDefinition(BeanNames.MAPPING_CONTEXT)) {
-				mappingContextName = MappingMongoConverterParser.potentiallyCreateMappingContext(element, parserContext, null,
-						BeanNames.DEFAULT_CONVERTER_BEAN_NAME);
+			if (!registry.containsBeanDefinition(mappingContextName)) {
+				mappingContextName = potentiallyCreateMappingContext(element, parserContext, null, null);
 			}
 
-			MappingMongoConverterParser.createIsNewStrategyFactoryBeanDefinition(mappingContextName, parserContext, element);
+			isNewStrategyFactoryName = createIsNewStrategyFactoryBeanDefinition(mappingContextName, parserContext, element);
 		}
 
-		BeanDefinitionParser parser = new IsNewAwareAuditingHandlerBeanDefinitionParser(BeanNames.IS_NEW_STRATEGY_FACTORY);
-		BeanDefinition handlerBeanDefinition = parser.parse(element, parserContext);
+		IsNewAwareAuditingHandlerBeanDefinitionParser parser = new IsNewAwareAuditingHandlerBeanDefinitionParser(
+				isNewStrategyFactoryName);
+		parser.parse(element, parserContext);
 
-		builder.addConstructorArgValue(handlerBeanDefinition);
+		builder.addConstructorArgValue(getObjectFactoryBeanDefinition(parser.getResolvedBeanName(),
+				parserContext.extractSource(element)));
 	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoAuditingRegistrar.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,13 +18,15 @@
 import java.lang.annotation.Annotation;
 
 import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean;
+import org.springframework.beans.factory.support.AbstractBeanDefinition;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.data.auditing.IsNewAwareAuditingHandler;
-import org.springframework.data.auditing.config.AnnotationAuditingConfiguration;
 import org.springframework.data.auditing.config.AuditingBeanDefinitionRegistrarSupport;
+import org.springframework.data.auditing.config.AuditingConfiguration;
 import org.springframework.data.mapping.context.MappingContextIsNewStrategyFactory;
 import org.springframework.data.mongodb.core.mapping.event.AuditingEventListener;
 import org.springframework.data.support.IsNewStrategyFactory;
@@ -47,6 +49,15 @@ protected Class<? extends Annotation> getAnnotation() {
 		return EnableMongoAuditing.class;
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.auditing.config.AuditingBeanDefinitionRegistrarSupport#getAuditingHandlerBeanName()
+	 */
+	@Override
+	protected String getAuditingHandlerBeanName() {
+		return "mongoAuditingHandler";
+	}
+
 	/* 
 	 * (non-Javadoc)
 	 * @see org.springframework.data.auditing.config.AuditingBeanDefinitionRegistrarSupport#registerBeanDefinitions(org.springframework.core.type.AnnotationMetadata, org.springframework.beans.factory.support.BeanDefinitionRegistry)
@@ -63,16 +74,16 @@ public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanD
 
 	/* 
 	 * (non-Javadoc)
-	 * @see org.springframework.data.auditing.config.AuditingBeanDefinitionRegistrarSupport#getAuditHandlerBeanDefinitionBuilder(org.springframework.data.auditing.config.AnnotationAuditingConfiguration)
+	 * @see org.springframework.data.auditing.config.AuditingBeanDefinitionRegistrarSupport#getAuditHandlerBeanDefinitionBuilder(org.springframework.data.auditing.config.AuditingConfiguration)
 	 */
 	@Override
-	protected BeanDefinitionBuilder getAuditHandlerBeanDefinitionBuilder(AnnotationAuditingConfiguration configuration) {
+	protected BeanDefinitionBuilder getAuditHandlerBeanDefinitionBuilder(AuditingConfiguration configuration) {
 
-		Assert.notNull(configuration, "AnnotationAuditingConfiguration must not be null!");
+		Assert.notNull(configuration, "AuditingConfiguration must not be null!");
 
-		return configureDefaultAuditHandlerAttributes(configuration,
-				BeanDefinitionBuilder.rootBeanDefinition(IsNewAwareAuditingHandler.class)).addConstructorArgReference(
-				BeanNames.IS_NEW_STRATEGY_FACTORY);
+		BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(IsNewAwareAuditingHandler.class);
+		builder.addConstructorArgReference(BeanNames.IS_NEW_STRATEGY_FACTORY_BEAN_NAME);
+		return configureDefaultAuditHandlerAttributes(configuration, builder);
 	}
 
 	/* 
@@ -86,8 +97,15 @@ protected void registerAuditListenerBeanDefinition(BeanDefinition auditingHandle
 		Assert.notNull(auditingHandlerDefinition, "BeanDefinition must not be null!");
 		Assert.notNull(registry, "BeanDefinitionRegistry must not be null!");
 
-		registerInfrastructureBeanWithId(BeanDefinitionBuilder.rootBeanDefinition(AuditingEventListener.class)
-				.addConstructorArgValue(auditingHandlerDefinition).getRawBeanDefinition(),
+		BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(ObjectFactoryCreatingFactoryBean.class);
+		builder.addPropertyValue("targetBeanName", getAuditingHandlerBeanName());
+		builder.setRole(AbstractBeanDefinition.ROLE_INFRASTRUCTURE);
+
+		BeanDefinitionBuilder listenerBeanDefinitionBuilder = BeanDefinitionBuilder
+				.rootBeanDefinition(AuditingEventListener.class);
+		listenerBeanDefinitionBuilder.addConstructorArgValue(builder.getBeanDefinition());
+
+		registerInfrastructureBeanWithId(listenerBeanDefinitionBuilder.getBeanDefinition(),
 				AuditingEventListener.class.getName(), registry);
 	}
 
@@ -96,10 +114,10 @@ protected void registerAuditListenerBeanDefinition(BeanDefinition auditingHandle
 	 */
 	private void registerIsNewStrategyFactoryIfNecessary(BeanDefinitionRegistry registry) {
 
-		if (!registry.containsBeanDefinition(BeanNames.IS_NEW_STRATEGY_FACTORY)) {
-			registry.registerBeanDefinition(BeanNames.IS_NEW_STRATEGY_FACTORY,
+		if (!registry.containsBeanDefinition(BeanNames.IS_NEW_STRATEGY_FACTORY_BEAN_NAME)) {
+			registry.registerBeanDefinition(BeanNames.IS_NEW_STRATEGY_FACTORY_BEAN_NAME,
 					BeanDefinitionBuilder.rootBeanDefinition(MappingContextIsNewStrategyFactory.class)
-							.addConstructorArgReference(BeanNames.MAPPING_CONTEXT).getBeanDefinition());
+							.addConstructorArgReference(BeanNames.MAPPING_CONTEXT_BEAN_NAME).getBeanDefinition());
 		}
 	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoDbFactoryParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 by the original author(s).
+ * Copyright 2011-2014 by the original author(s).
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -54,7 +54,7 @@ protected String resolveId(Element element, AbstractBeanDefinition definition, P
 			throws BeanDefinitionStoreException {
 
 		String id = super.resolveId(element, definition, parserContext);
-		return StringUtils.hasText(id) ? id : BeanNames.DB_FACTORY;
+		return StringUtils.hasText(id) ? id : BeanNames.DB_FACTORY_BEAN_NAME;
 	}
 
 	/* 
@@ -103,7 +103,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 		BeanComponentDefinition component = helper.getComponent(writeConcernPropertyEditorBuilder);
 		parserContext.registerBeanComponent(component);
 
-		return (AbstractBeanDefinition) helper.getComponentIdButFallback(dbFactoryBuilder, BeanNames.DB_FACTORY)
+		return (AbstractBeanDefinition) helper.getComponentIdButFallback(dbFactoryBuilder, BeanNames.DB_FACTORY_BEAN_NAME)
 				.getBeanDefinition();
 	}
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2012 the original author or authors.
+ * Copyright 2011-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -58,7 +58,7 @@ public BeanDefinition parse(Element element, ParserContext parserContext) {
 		MongoParsingUtils.parseMongoOptions(element, builder);
 		MongoParsingUtils.parseReplicaSet(element, builder);
 
-		String defaultedId = StringUtils.hasText(id) ? id : BeanNames.MONGO;
+		String defaultedId = StringUtils.hasText(id) ? id : BeanNames.MONGO_BEAN_NAME;
 
 		parserContext.pushContainingComponent(new CompositeComponentDefinition("Mongo", source));
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoTemplateParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@
  * {@link BeanDefinitionParser} to parse {@code template} elements into {@link BeanDefinition}s.
  * 
  * @author Martin Baumgartner
+ * @author Oliver Gierke
  */
 class MongoTemplateParser extends AbstractBeanDefinitionParser {
 
@@ -47,7 +48,7 @@ protected String resolveId(Element element, AbstractBeanDefinition definition, P
 			throws BeanDefinitionStoreException {
 
 		String id = super.resolveId(element, definition, parserContext);
-		return StringUtils.hasText(id) ? id : BeanNames.MONGO_TEMPLATE;
+		return StringUtils.hasText(id) ? id : BeanNames.MONGO_TEMPLATE_BEAN_NAME;
 	}
 
 	/*
@@ -68,7 +69,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 		if (StringUtils.hasText(dbFactoryRef)) {
 			mongoTemplateBuilder.addConstructorArgReference(dbFactoryRef);
 		} else {
-			mongoTemplateBuilder.addConstructorArgReference(BeanNames.DB_FACTORY);
+			mongoTemplateBuilder.addConstructorArgReference(BeanNames.DB_FACTORY_BEAN_NAME);
 		}
 
 		if (StringUtils.hasText(converterRef)) {
@@ -80,7 +81,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 		BeanComponentDefinition component = helper.getComponent(writeConcernPropertyEditorBuilder);
 		parserContext.registerBeanComponent(component);
 
-		return (AbstractBeanDefinition) helper.getComponentIdButFallback(mongoTemplateBuilder, BeanNames.MONGO_TEMPLATE)
-				.getBeanDefinition();
+		return (AbstractBeanDefinition) helper.getComponentIdButFallback(mongoTemplateBuilder,
+				BeanNames.MONGO_TEMPLATE_BEAN_NAME).getBeanDefinition();
 	}
 }