DATAREST-837 - DomainObjectMerger doesn't nullify read-only properties on PUT.

PUT requests are supposed to replace the state of the resource with the request payload. However, Spring Data REST already handles a couple of domain object propoerties in a special way as theri values map to dedicated HTTP features: identifiers (URIs), last-modified dates (header) etc.

For users, it might be worthwhile to exclude other properties from being set by applying the payload, like properties that are completely under the control of the server, e.g. creation user and date, last modifying user etc. So far, users didn't have any means to exclude those properties as the handling of PUT requests treated every missing property of the payload as null value.

DomainObjectMerger now checks whether a property is actually writable before applying the implicit null value. The application can be disabled by annotation a property with @ReadOnlyProperty.

Author: odrotbohm

spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/json/DomainObjectReader.java

@@ -108,7 +108,7 @@ public <T> T readPut(final ObjectNode source, T target, final ObjectMapper mappe
 			@Override
 			public void doWithPersistentProperty(PersistentProperty<?> property) {
 
-				if (property.isIdProperty() || property.isVersionProperty()) {
+				if (property.isIdProperty() || property.isVersionProperty() || !property.isWritable()) {
 					return;
 				}
 

spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/json/DomainObjectReaderUnitTests.java

@@ -20,6 +20,7 @@
 import static org.mockito.Mockito.*;
 
 import java.util.Collections;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -28,7 +29,9 @@
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.springframework.data.annotation.CreatedDate;
 import org.springframework.data.annotation.Id;
+import org.springframework.data.annotation.ReadOnlyProperty;
 import org.springframework.data.annotation.Version;
 import org.springframework.data.keyvalue.core.mapping.context.KeyValueMappingContext;
 import org.springframework.data.mapping.context.PersistentEntities;
@@ -64,6 +67,7 @@ public void setUp() {
 		mappingContext.getPersistentEntity(Person.class);
 		mappingContext.getPersistentEntity(TypeWithGenericMap.class);
 		mappingContext.getPersistentEntity(VersionedType.class);
+		mappingContext.getPersistentEntity(SampleWithCreatedDate.class);
 		mappingContext.afterPropertiesSet();
 
 		PersistentEntities entities = new PersistentEntities(Collections.singleton(mappingContext));
@@ -172,6 +176,23 @@ public void doesNotWipeIdAndVersionPropertyForPut() throws Exception {
 		assertThat(result.version, is(1L));
 	}
 
+	/**
+	 * @see DATAREST-873
+	 */
+	@Test
+	public void doesNotApplyInputToReadOnlyFields() throws Exception {
+
+		ObjectMapper mapper = new ObjectMapper();
+		ObjectNode node = (ObjectNode) mapper.readTree("{}");
+
+		Date reference = new Date();
+
+		SampleWithCreatedDate sample = new SampleWithCreatedDate();
+		sample.createdDate = reference;
+
+		assertThat(reader.readPut(node, sample, mapper).createdDate, is(reference));
+	}
+
 	@JsonAutoDetect(fieldVisibility = Visibility.ANY)
 	static class SampleUser {
 
@@ -213,4 +234,12 @@ static class VersionedType {
 
 		String firstname, lastname;
 	}
+
+	@JsonAutoDetect(fieldVisibility = Visibility.ANY)
+	static class SampleWithCreatedDate {
+
+		@CreatedDate //
+		@ReadOnlyProperty //
+		Date createdDate;
+	}
 }