DATACMNS-638, DATACMNS-643 - Support for JSR-310 and ThreeTen datetime types.

Extend AuditableBeanWrapper to allow access to the last modification date of a target object. Made AuditableBeanWrapperFactory an interface and renamed what’s been previously known under this name as DefaultAuditableBeanWrapperFactory.

The components previously relying on a MappingContext to lookup a PersistentEntity now use PersistentEntities to be able to back a collection of MappingContexts behind that and also avoid unmanaged types to be added to the MappingContext.

We now also register the JSR-310 and ThreeTen back-port converters with the ConversionService to be able to get and set auditing dates as these types.

Author: odrotbohm

src/main/java/org/springframework/data/auditing/AnnotationAuditingMetadata.java

@@ -27,6 +27,8 @@
 import org.springframework.data.annotation.CreatedDate;
 import org.springframework.data.annotation.LastModifiedBy;
 import org.springframework.data.annotation.LastModifiedDate;
+import org.springframework.data.convert.Jsr310Converters;
+import org.springframework.data.convert.ThreeTenBackPortConverters;
 import org.springframework.data.util.ReflectionUtils;
 import org.springframework.data.util.ReflectionUtils.AnnotationFieldFilter;
 import org.springframework.util.Assert;
@@ -93,22 +95,23 @@ private AnnotationAuditingMetadata(Class<?> type) {
 	/**
 	 * Checks whether the given field has a type that is a supported date type.
 	 * 
-	 * @param field
+	 * @param field can be {@literal null}.
 	 */
 	private void assertValidDateFieldType(Field field) {
 
 		if (field == null || SUPPORTED_DATE_TYPES.contains(field.getType().getName())) {
 			return;
 		}
 
-		// Support JDK 8 date types if runtime allows
-		if (IS_JDK_8 && field.getType().getPackage().getName().startsWith(JDK8_TIME_PACKAGE_PREFIX)) {
+		Class<?> type = field.getType();
+
+		if (Jsr310Converters.supports(type) || ThreeTenBackPortConverters.supports(type)) {
 			return;
 		}
 
 		throw new IllegalStateException(String.format(
-				"Found created/modified date field with type %s but only %s as well as java.time types are supported!",
-				field.getType(), SUPPORTED_DATE_TYPES));
+				"Found created/modified date field with type %s but only %s as well as java.time types are supported!", type,
+				SUPPORTED_DATE_TYPES));
 	}
 
 	/**

src/main/java/org/springframework/data/auditing/AuditableBeanWrapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -46,6 +46,14 @@ public interface AuditableBeanWrapper {
 	 */
 	void setLastModifiedBy(Object value);
 
+	/**
+	 * Returns the date of the last modification date of the backing bean.
+	 * 
+	 * @return the date of the last modification, can be {@literal null}.
+	 * @since 1.10
+	 */
+	Calendar getLastModifiedDate();
+
 	/**
 	 * Set the last modification date.
 	 * 

src/main/java/org/springframework/data/auditing/AuditableBeanWrapperFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2015 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,256 +15,20 @@
  */
 package org.springframework.data.auditing;
 
-import java.lang.reflect.Field;
-import java.util.Calendar;
-
-import org.joda.time.DateTime;
-import org.joda.time.LocalDateTime;
-import org.springframework.core.convert.ConversionService;
-import org.springframework.core.convert.converter.Converter;
-import org.springframework.data.domain.Auditable;
-import org.springframework.data.util.ReflectionUtils;
-import org.springframework.format.support.DefaultFormattingConversionService;
-import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
-
 /**
- * A factory class to {@link AuditableBeanWrapper} instances.
+ * A factory to lookup {@link AuditableBeanWrapper}s.
  * 
  * @author Oliver Gierke
- * @since 1.5
+ * @since 1.10
  */
-class AuditableBeanWrapperFactory {
-
-	/**
-	 * Returns an {@link AuditableBeanWrapper} if the given object is capable of being equipped with auditing information.
-	 * 
-	 * @param source the auditing candidate.
-	 * @return
-	 */
-	@SuppressWarnings("unchecked")
-	public AuditableBeanWrapper getBeanWrapperFor(Object source) {
-
-		if (source == null) {
-			return null;
-		}
-
-		if (source instanceof Auditable) {
-			return new AuditableInterfaceBeanWrapper((Auditable<Object, ?>) source);
-		}
-
-		AnnotationAuditingMetadata metadata = AnnotationAuditingMetadata.getMetadata(source.getClass());
-
-		if (metadata.isAuditable()) {
-			return new ReflectionAuditingBeanWrapper(source);
-		}
-
-		return null;
-	}
-
-	/**
-	 * An {@link AuditableBeanWrapper} that works with objects implementing
-	 * 
-	 * @author Oliver Gierke
-	 */
-	static class AuditableInterfaceBeanWrapper implements AuditableBeanWrapper {
-
-		private final Auditable<Object, ?> auditable;
-
-		public AuditableInterfaceBeanWrapper(Auditable<Object, ?> auditable) {
-			this.auditable = auditable;
-		}
-
-		/* 
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setCreatedBy(java.lang.Object)
-		 */
-		public void setCreatedBy(Object value) {
-			auditable.setCreatedBy(value);
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setCreatedDate(org.joda.time.DateTime)
-		 */
-		public void setCreatedDate(Calendar value) {
-			auditable.setCreatedDate(new DateTime(value));
-		}
-
-		/* 
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setLastModifiedBy(java.lang.Object)
-		 */
-		public void setLastModifiedBy(Object value) {
-			auditable.setLastModifiedBy(value);
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setLastModifiedDate(org.joda.time.DateTime)
-		 */
-		public void setLastModifiedDate(Calendar value) {
-			auditable.setLastModifiedDate(new DateTime(value));
-		}
-	}
+public interface AuditableBeanWrapperFactory {
 
 	/**
-	 * Base class for {@link AuditableBeanWrapper} implementations that might need to convert {@link Calendar} values into
-	 * compatible types when setting date/time information.
+	 * Returns the {@link AuditableBeanWrapper} for the given source obejct if it's eligible for auditing.
 	 * 
-	 * @author Oliver Gierke
-	 * @since 1.8
+	 * @param source can be {@literal null}.
+	 * @return the {@link AuditableBeanWrapper} for the given source obejct if it's eligible for auditing or
+	 *         {@literal null} otherwise.
 	 */
-	abstract static class DateConvertingAuditableBeanWrapper implements AuditableBeanWrapper {
-
-		private static final boolean IS_JODA_TIME_PRESENT = ClassUtils.isPresent("org.joda.time.DateTime",
-				ReflectionAuditingBeanWrapper.class.getClassLoader());
-
-		private final ConversionService conversionService;
-
-		/**
-		 * Creates a new {@link DateConvertingAuditableBeanWrapper}.
-		 */
-		public DateConvertingAuditableBeanWrapper() {
-
-			DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
-
-			if (IS_JODA_TIME_PRESENT) {
-				conversionService.addConverter(CalendarToDateTimeConverter.INSTANCE);
-				conversionService.addConverter(CalendarToLocalDateTimeConverter.INSTANCE);
-			}
-
-			this.conversionService = conversionService;
-		}
-
-		/**
-		 * Returns the {@link Calendar} in a type, compatible to the given field.
-		 * 
-		 * @param value can be {@literal null}.
-		 * @param targetType must not be {@literal null}.
-		 * @param source must not be {@literal null}.
-		 * @return
-		 */
-		protected Object getDateValueToSet(Calendar value, Class<?> targetType, Object source) {
-
-			if (value == null) {
-				return null;
-			}
-
-			if (Calendar.class.equals(targetType)) {
-				return value;
-			}
-
-			if (conversionService.canConvert(Calendar.class, targetType)) {
-				return conversionService.convert(value, targetType);
-			}
-
-			throw new IllegalArgumentException(String.format("Invalid date type for member %s! Supported types are %s.",
-					source, AnnotationAuditingMetadata.SUPPORTED_DATE_TYPES));
-		}
-	}
-
-	/**
-	 * An {@link AuditableBeanWrapper} implementation that sets values on the target object using refelction.
-	 * 
-	 * @author Oliver Gierke
-	 */
-	static class ReflectionAuditingBeanWrapper extends DateConvertingAuditableBeanWrapper {
-
-		private final AnnotationAuditingMetadata metadata;
-		private final Object target;
-
-		/**
-		 * Creates a new {@link ReflectionAuditingBeanWrapper} to set auditing data on the given target object.
-		 * 
-		 * @param target must not be {@literal null}.
-		 */
-		public ReflectionAuditingBeanWrapper(Object target) {
-
-			Assert.notNull(target, "Target object must not be null!");
-
-			this.metadata = AnnotationAuditingMetadata.getMetadata(target.getClass());
-			this.target = target;
-		}
-
-		/* 
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setCreatedBy(java.lang.Object)
-		 */
-		public void setCreatedBy(Object value) {
-			setField(metadata.getCreatedByField(), value);
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setCreatedDate(java.util.Calendar)
-		 */
-		public void setCreatedDate(Calendar value) {
-			setDateField(metadata.getCreatedDateField(), value);
-		}
-
-		/* 
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setLastModifiedBy(java.lang.Object)
-		 */
-		public void setLastModifiedBy(Object value) {
-			setField(metadata.getLastModifiedByField(), value);
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.data.auditing.AuditableBeanWrapper#setLastModifiedDate(java.util.Calendar)
-		 */
-		public void setLastModifiedDate(Calendar value) {
-			setDateField(metadata.getLastModifiedDateField(), value);
-		}
-
-		/**
-		 * Sets the given field to the given value if the field is not {@literal null}.
-		 * 
-		 * @param field
-		 * @param value
-		 */
-		private void setField(Field field, Object value) {
-
-			if (field != null) {
-				ReflectionUtils.setField(field, target, value);
-			}
-		}
-
-		/**
-		 * Sets the given field to the given value if the field is not {@literal null}.
-		 * 
-		 * @param field
-		 * @param value
-		 */
-		private void setDateField(Field field, Calendar value) {
-
-			if (field == null) {
-				return;
-			}
-
-			ReflectionUtils.setField(field, target, getDateValueToSet(value, field.getType(), field));
-		}
-	}
-
-	private static enum CalendarToDateTimeConverter implements Converter<Calendar, DateTime> {
-
-		INSTANCE;
-
-		@Override
-		public DateTime convert(Calendar source) {
-			return new DateTime(source);
-		}
-	}
-
-	private static enum CalendarToLocalDateTimeConverter implements Converter<Calendar, LocalDateTime> {
-
-		INSTANCE;
-
-		@Override
-		public LocalDateTime convert(Calendar source) {
-			return new LocalDateTime(source);
-		}
-	}
+	AuditableBeanWrapper getBeanWrapperFor(Object source);
 }

src/main/java/org/springframework/data/auditing/AuditingHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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,6 +15,7 @@
  */
 package org.springframework.data.auditing;
 
+import java.util.Arrays;
 import java.util.Calendar;
 
 import org.joda.time.DateTime;
@@ -26,6 +27,7 @@
 import org.springframework.data.mapping.PersistentEntity;
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.mapping.context.MappingContext;
+import org.springframework.data.mapping.context.PersistentEntities;
 import org.springframework.util.Assert;
 
 /**
@@ -38,7 +40,7 @@ public class AuditingHandler implements InitializingBean {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(AuditingHandler.class);
 
-	private final AuditableBeanWrapperFactory factory;
+	private final DefaultAuditableBeanWrapperFactory factory;
 
 	private DateTimeProvider dateTimeProvider = CurrentDateTimeProvider.INSTANCE;
 	private AuditorAware<?> auditorAware;
@@ -51,12 +53,26 @@ public class AuditingHandler implements InitializingBean {
 	 * 
 	 * @param mappingContext must not be {@literal null}.
 	 * @since 1.8
+	 * @deprecated use {@link AuditingHandler(PersistentEntities)} instead.
 	 */
+	@Deprecated
+	@SuppressWarnings("unchecked")
 	public AuditingHandler(
 			MappingContext<? extends PersistentEntity<?, ?>, ? extends PersistentProperty<?>> mappingContext) {
+		this(new PersistentEntities(Arrays.asList(mappingContext)));
+	}
+
+	/**
+	 * Creates a new {@link AuditableBeanWrapper} using the given {@link PersistentEntities} when looking up auditing
+	 * metadata via reflection.
+	 * 
+	 * @param entities must not be {@literal null}.
+	 * @since 1.10
+	 */
+	public AuditingHandler(PersistentEntities entities) {
 
-		Assert.notNull(mappingContext, "MappingContext must not be null!");
-		this.factory = new MappingAuditableBeanWrapperFactory(mappingContext);
+		Assert.notNull(entities, "PersistentEntities must not be null!");
+		this.factory = new MappingAuditableBeanWrapperFactory(entities);
 	}
 
 	/**