DATAREST-1205 - Use Affordances API

gregturn · gregturn · commit a7492bcbfb04 · 2018-06-14T10:56:06.000-05:00
Leverage the Affordances API while making other media types work.
diff --git a/spring-data-rest-core/pom.xml b/spring-data-rest-core/pom.xml
@@ -16,8 +16,9 @@
 	</parent>
 
 	<properties>
-		<springplugin>1.2.0.RELEASE</springplugin>
+		<springplugin>2.0.0.BUILD-SNAPSHOT</springplugin>
 		<evoinflector>1.2.2</evoinflector>
+		<spring-hateoas>1.0.0.SDR-SNAPSHOT</spring-hateoas>
 		<java-module-name>spring.data.rest.core</java-module-name>
 		<project.root>${basedir}/..</project.root>
 	</properties>
diff --git a/spring-data-rest-core/src/main/java/org/springframework/data/rest/core/util/Java8PluginRegistry.java b/spring-data-rest-core/src/main/java/org/springframework/data/rest/core/util/Java8PluginRegistry.java
@@ -46,7 +46,7 @@ public static <T extends Plugin<S>, S> Java8PluginRegistry<T, S> empty() {
 	}
 
 	public Optional<T> getPluginFor(S delimiter) {
-		return Optional.ofNullable(registry.getPluginFor(delimiter));
+		return registry.getPluginFor(delimiter);
 	}
 
 	public T getPluginOrDefaultFor(S delimiter, T fallback) {
diff --git a/spring-data-rest-tests/spring-data-rest-tests-core/src/test/java/org/springframework/data/rest/tests/ResourceTester.java b/spring-data-rest-tests/spring-data-rest-tests-core/src/test/java/org/springframework/data/rest/tests/ResourceTester.java
@@ -83,7 +83,7 @@ public Link assertHasLinkEndingWith(String rel, String hrefEnd) {
 
 	private final Link assertHasLinkMatching(String rel, Matcher<String> hrefMatcher) {
 
-		Link link = resource.getLink(rel);
+		Link link = resource.getRequiredLink(rel);
 		assertThat("Expected link with rel '" + rel + "' but didn't find it in " + resource.getLinks(), link,
 				is(notNullValue()));
 
diff --git a/spring-data-rest-tests/spring-data-rest-tests-jpa/pom.xml b/spring-data-rest-tests/spring-data-rest-tests-jpa/pom.xml
@@ -47,6 +47,19 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-web</artifactId>
+			<version>${spring}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.hateoas</groupId>
+			<artifactId>spring-hateoas</artifactId>
+			<version>1.0.0.SDR-SNAPSHOT</version>
+			<scope>test</scope>
+		</dependency>
+
 		<!-- Jackson Hibernate -->
 
 		<dependency>
diff --git a/spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/AffordanceIntegrationTests.java b/spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/AffordanceIntegrationTests.java
diff --git a/spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/support/RepositoryEntityLinksIntegrationTests.java b/spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/support/RepositoryEntityLinksIntegrationTests.java
@@ -99,7 +99,7 @@ public void returnsLinksToSearchResources() {
 
 		assertThat(links.hasLink("firstname")).isTrue();
 
-		Link firstnameLink = links.getLink("firstname");
+		Link firstnameLink = links.getLink("firstname").orElse(null);
 		assertThat(firstnameLink.isTemplated()).isTrue();
 		assertThat(firstnameLink.getVariableNames()).contains("page", "size");
 	}
diff --git a/spring-data-rest-tests/spring-data-rest-tests-mongodb/src/test/java/org/springframework/data/rest/webmvc/PersistentEntityResourceAssemblerIntegrationTests.java b/spring-data-rest-tests/spring-data-rest-tests-mongodb/src/test/java/org/springframework/data/rest/webmvc/PersistentEntityResourceAssemblerIntegrationTests.java
@@ -72,7 +72,7 @@ public void addsSelfAndSingleResourceLinkToResourceByDefault() throws Exception
 		Links links = new Links(resource.getLinks());
 
 		assertThat(links).hasSize(2);
-		assertThat(links.getLink("self").getVariables()).isEmpty();
-		assertThat(links.getLink("user").getVariableNames()).contains("projection");
+		assertThat(links.getLink("self").orElseThrow(() -> new RuntimeException("Unable to find 'self' link")).getVariables()).isEmpty();
+		assertThat(links.getLink("user").orElseThrow(() -> new RuntimeException("Unable to find 'user' link")).getVariableNames()).contains("projection");
 	}
 }
diff --git a/spring-data-rest-webmvc/pom.xml b/spring-data-rest-webmvc/pom.xml
@@ -124,6 +124,13 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-jpa</artifactId>
+			<version>${springdata.jpa}</version>
+			<scope>test</scope>
+		</dependency>
+
 	</dependencies>
 
 </project>
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/AbstractRepositoryRestController.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/AbstractRepositoryRestController.java
@@ -63,7 +63,7 @@ protected Link resourceLink(RootResourceInformation resourceLink, Resource resou
 
 		ResourceMetadata repoMapping = resourceLink.getResourceMetadata();
 
-		Link selfLink = resource.getLink("self");
+		Link selfLink = resource.getRequiredLink(Link.REL_SELF);
 		String rel = repoMapping.getItemResourceRel();
 
 		return new Link(selfLink.getHref(), rel);
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/PersistentEntityResourceAssembler.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/PersistentEntityResourceAssembler.java
@@ -18,6 +18,9 @@
 import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
 
+import java.util.Collections;
+
+import org.springframework.core.ResolvableType;
 import org.springframework.data.mapping.PersistentEntity;
 import org.springframework.data.mapping.context.PersistentEntities;
 import org.springframework.data.rest.core.support.SelfLinkProvider;
@@ -28,6 +31,7 @@
 import org.springframework.hateoas.ResourceAssembler;
 import org.springframework.hateoas.core.EmbeddedWrapper;
 import org.springframework.hateoas.core.EmbeddedWrappers;
+import org.springframework.http.HttpMethod;
 import org.springframework.util.Assert;
 
 /**
@@ -72,9 +76,11 @@ private Builder wrap(Object instance, Object source) {
 		PersistentEntity<?, ?> entity = entities.getRequiredPersistentEntity(source.getClass());
 
 		return PersistentEntityResource.build(instance, entity).//
-				withEmbedded(getEmbeddedResources(source)).//
-				withLink(getSelfLinkFor(source)).//
-				withLink(linkProvider.createSelfLinkFor(source));
+					withEmbedded(getEmbeddedResources(source)).//
+					withLink(getExpandedSelfLink(source)
+						.andAffordance(HttpMethod.PUT, source.getClass(), Collections.emptyList(), null)
+						.andAffordance(HttpMethod.PATCH, source.getClass(), Collections.emptyList(), null)).//
+					withLink(linkProvider.createSelfLinkFor(source));
 	}
 
 	/**
@@ -94,7 +100,7 @@ private Iterable<EmbeddedWrapper> getEmbeddedResources(Object instance) {
 	 * @param instance must be a managed entity, not {@literal null}.
 	 * @return
 	 */
-	public Link getSelfLinkFor(Object instance) {
+	public Link getExpandedSelfLink(Object instance) {
 
 		Link link = linkProvider.createSelfLinkFor(instance);
 		return new Link(link.expand().getHref(), Link.REL_SELF);
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryController.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryController.java
@@ -23,6 +23,7 @@
 import org.springframework.data.rest.core.mapping.ResourceMetadata;
 import org.springframework.data.web.PagedResourcesAssembler;
 import org.springframework.hateoas.EntityLinks;
+import org.springframework.hateoas.Link;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
@@ -105,6 +106,8 @@ public HttpEntity<RepositoryLinksResource> listRepositories() {
 
 		RepositoryLinksResource resource = new RepositoryLinksResource();
 
+		resource.add(new Link("/"));
+
 		for (Class<?> domainType : repositories) {
 
 			ResourceMetadata metadata = mappings.getMetadataFor(domainType);
@@ -113,6 +116,6 @@ public HttpEntity<RepositoryLinksResource> listRepositories() {
 			}
 		}
 
-		return new ResponseEntity<RepositoryLinksResource>(resource, HttpStatus.OK);
+		return new ResponseEntity<>(resource, HttpStatus.OK);
 	}
 }
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryEntityController.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryEntityController.java
@@ -23,10 +23,12 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ApplicationEventPublisherAware;
+import org.springframework.core.ResolvableType;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.data.auditing.AuditableBeanWrapperFactory;
 import org.springframework.data.domain.Sort;
@@ -208,7 +210,29 @@ public Resources<?> getCollectionResource(@QuerydslPredicate RootResourceInforma
 
 		Resources<?> result = toResources(results, assembler, metadata.getDomainType(), baseLink);
 		result.add(getCollectionResourceLinks(resourceInformation, pageable));
-		return result;
+		return addAffordances(metadata.getDomainType(), result);
+	}
+
+	private Resources<?> addAffordances(Class<?> domainType, Resources<?> resources) {
+
+		if (resources instanceof PagedResources) {
+			return new PagedResources<>(resources.getContent(), ((PagedResources<?>) resources).getMetadata(), addAffordancesToLinks(domainType, resources.getLinks()));
+		}
+
+		return new Resources<>(resources.getContent(), addAffordancesToLinks(domainType, resources.getLinks()));
+	}
+
+	private List<Link> addAffordancesToLinks(Class<?> domainType, List<Link> links) {
+
+		return links.stream()
+			.map(link -> {
+				if (link.hasRel(Link.REL_SELF)) {
+					return link.andAffordance(HttpMethod.POST, domainType, Collections.emptyList(), null);
+				} else {
+					return link;
+				}
+			})
+			.collect(Collectors.toList());
 	}
 
 	private List<Link> getCollectionResourceLinks(RootResourceInformation resourceInformation,
@@ -495,7 +519,7 @@ private ResponseEntity<ResourceSupport> createAndReturn(Object domainObject, Rep
 	 */
 	private void addLocationHeader(HttpHeaders headers, PersistentEntityResourceAssembler assembler, Object source) {
 
-		String selfLink = assembler.getSelfLinkFor(source).getHref();
+		String selfLink = assembler.getExpandedSelfLink(source).getHref();
 		headers.setLocation(new UriTemplate(selfLink).expand());
 	}
 
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryPropertyReferenceController.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryPropertyReferenceController.java
@@ -134,11 +134,11 @@ public ResponseEntity<ResourceSupport> followPropertyReference(final RootResourc
 			} else {
 
 				PersistentEntityResource resource = assembler.toResource(it);
-				headers.set("Content-Location", resource.getId().getHref());
+				headers.set("Content-Location", resource.getRequiredLink(Link.REL_SELF).getHref());
 				return resource;
 			}
 
-		}).orElseThrow(() -> new ResourceNotFoundException());
+		}).orElseThrow(ResourceNotFoundException::new);
 
 		return ControllerUtils.toResponseEntity(HttpStatus.OK, headers, //
 				doWithReferencedProperty(repoRequest, id, property, handler, HttpMethod.GET));
@@ -187,7 +187,7 @@ public ResponseEntity<ResourceSupport> followPropertyReference(RootResourceInfor
 					if (propertyId.equals(accessor1.getIdentifier().toString())) {
 
 						PersistentEntityResource resource1 = assembler.toResource(obj);
-						headers.set("Content-Location", resource1.getId().getHref());
+						headers.set("Content-Location", resource1.getRequiredLink(Link.REL_SELF).getHref());
 						return resource1;
 					}
 				}
@@ -200,18 +200,18 @@ public ResponseEntity<ResourceSupport> followPropertyReference(RootResourceInfor
 					if (propertyId.equals(accessor2.getIdentifier().toString())) {
 
 						PersistentEntityResource resource2 = assembler.toResource(entry.getValue());
-						headers.set("Content-Location", resource2.getId().getHref());
+						headers.set("Content-Location", resource2.getRequiredLink(Link.REL_SELF).getHref());
 						return resource2;
 					}
 				}
 
 			} else {
-				return new Resource<Object>(prop.propertyValue);
+				return new Resource<>(prop.propertyValue);
 			}
 
 			throw new ResourceNotFoundException();
 
-		}).orElseThrow(() -> new ResourceNotFoundException());
+		}).orElseThrow(ResourceNotFoundException::new);
 
 		return ControllerUtils.toResponseEntity(HttpStatus.OK, headers, //
 				doWithReferencedProperty(repoRequest, id, property, handler, HttpMethod.GET));
@@ -254,7 +254,7 @@ public ResponseEntity<ResourceSupport> followPropertyReferenceCompact(RootResour
 				Map<Object, Resource<?>> map = (Map<Object, Resource<?>>) content;
 
 				for (Entry<Object, Resource<?>> entry : map.entrySet()) {
-					Link l = new Link(entry.getValue().getLink("self").getHref(), entry.getKey().toString());
+					Link l = new Link(entry.getValue().getRequiredLink(Link.REL_SELF).getHref(), entry.getKey().toString());
 					links.add(l);
 				}
 			}
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryRestHandlerMapping.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositoryRestHandlerMapping.java
@@ -35,6 +35,7 @@
 import org.springframework.data.rest.core.mapping.ResourceMappings;
 import org.springframework.data.rest.core.mapping.ResourceMetadata;
 import org.springframework.data.rest.webmvc.support.JpaHelper;
+import org.springframework.hateoas.MediaTypes;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.MediaType;
 import org.springframework.orm.jpa.support.OpenEntityManagerInViewInterceptor;
@@ -203,6 +204,8 @@ protected ProducesRequestCondition customize(ProducesRequestCondition condition)
 		HashSet<String> mediaTypes = new LinkedHashSet<String>();
 		mediaTypes.add(configuration.getDefaultMediaType().toString());
 		mediaTypes.add(MediaType.APPLICATION_JSON_VALUE);
+		mediaTypes.add(MediaTypes.HAL_FORMS_JSON_VALUE);
+		mediaTypes.add(MediaTypes.COLLECTION_JSON_VALUE);
 
 		return new ProducesRequestCondition(mediaTypes.toArray(new String[mediaTypes.size()]));
 	}
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositorySearchController.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/RepositorySearchController.java
@@ -344,23 +344,20 @@ private Optional<Object> executeQueryMethod(final RepositoryInvoker invoker,
 		List<TypeInformation<?>> parameterTypeInformations = ClassTypeInformation.from(method.getDeclaringClass())
 				.getParameterTypes(method);
 
-		for (Entry<String, List<Object>> entry : parameters.entrySet()) {
+		parameters.entrySet().forEach(entry ->
 
-			MethodParameter parameter = methodParameters.getParameter(entry.getKey());
+			methodParameters.getParameter(entry.getKey()).ifPresent(parameter -> {
 
-			if (parameter == null) {
-				continue;
-			}
-
-			int parameterIndex = parameterList.indexOf(parameter);
-			TypeInformation<?> domainType = parameterTypeInformations.get(parameterIndex).getActualType();
+				int parameterIndex = parameterList.indexOf(parameter);
+				TypeInformation<?> domainType = parameterTypeInformations.get(parameterIndex).getActualType();
 
-			ResourceMetadata metadata = mappings.getMetadataFor(domainType.getType());
+				ResourceMetadata metadata = mappings.getMetadataFor(domainType.getType());
 
-			if (metadata != null && metadata.isExported()) {
-				result.put(parameter.getParameterName(), prepareUris(entry.getValue()));
+				if (metadata != null && metadata.isExported()) {
+					result.put(parameter.getParameterName(), prepareUris(entry.getValue()));
+				}
 			}
-		}
+		));
 
 		return invoker.invokeQueryMethod(method, result, pageable.getPageable(), sort);
 	}
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/alps/RootResourceInformationToAlpsDescriptorConverter.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/alps/RootResourceInformationToAlpsDescriptorConverter.java
@@ -122,7 +122,7 @@ public Alps convert(RootResourceInformation resourceInformation) {
 
 		descriptors.addAll(buildSearchResourceDescriptors(resourceInformation.getPersistentEntity()));
 
-		return Alps.alps().descriptors(descriptors).build();
+		return Alps.alps().descriptor(descriptors).build();
 	}
 
 	private Descriptor buildRepresentationDescriptor(Class<?> type) {
@@ -135,7 +135,7 @@ private Descriptor buildRepresentationDescriptor(Class<?> type) {
 				id(getRepresentationDescriptorId(metadata)).//
 				href(href).//
 				doc(getDocFor(metadata.getItemResourceDescription())).//
-				descriptors(buildPropertyDescriptors(type, metadata.getItemResourceRel())).//
+				descriptor(buildPropertyDescriptors(type, metadata.getItemResourceRel())).//
 				build();
 	}
 
@@ -155,7 +155,7 @@ private Descriptor buildCollectionResourceDescriptor(Class<?> type, RootResource
 				type(descriptorType).//
 				doc(getDocFor(metadata.getDescription())).//
 				rt("#" + representationDescriptor.getId()).//
-				descriptors(nestedDescriptors).build();
+				descriptor(nestedDescriptors).build();
 	}
 
 	/**
@@ -184,15 +184,15 @@ private Descriptor buildProjectionDescriptor(ResourceMetadata metadata) {
 							type(Type.SEMANTIC).//
 							name(projection.getKey()).//
 							doc(getDocFor(projectionDescription)).//
-							descriptors(createJacksonDescriptor(projection.getKey(), type)).//
+							descriptor(createJacksonDescriptor(projection.getKey(), type)).//
 							build());
 		}
 
 		return descriptor().//
 				type(Type.SEMANTIC).//
 				name(projectionParameterName).//
 				doc(getDocFor(SimpleResourceDescription.defaultFor(projectionParameterName))).//
-				descriptors(projectionDescriptors).build();
+				descriptor(projectionDescriptors).build();
 	}
 
 	private List<Descriptor> createJacksonDescriptor(String name, Class<?> type) {
@@ -231,7 +231,7 @@ private Descriptor buildItemResourceDescriptor(RootResourceInformation resourceI
 				type(getType(method)).//
 				doc(getDocFor(metadata.getItemResourceDescription())).//
 				rt("#".concat(representationDescriptor.getId())). //
-				descriptors(getProjectionDescriptor(entity.getType(), method)).//
+				descriptor(getProjectionDescriptor(entity.getType(), method)).//
 				build();
 	}
 
@@ -375,7 +375,7 @@ private Collection<Descriptor> buildSearchResourceDescriptors(PersistentEntity<?
 			descriptors.add(descriptor().//
 					type(Type.SAFE).//
 					name(methodMapping.getRel()).//
-					descriptors(parameterDescriptors).//
+					descriptor(parameterDescriptors).//
 					build());
 		}
 
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/config/RepositoryRestMvcConfiguration.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/config/RepositoryRestMvcConfiguration.java
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/json/PersistentEntityJackson2Module.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/json/PersistentEntityJackson2Module.java
diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/mapping/LinkCollector.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/mapping/LinkCollector.java
diff --git a/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/config/RepositoryRestMvConfigurationIntegrationTests.java b/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/config/RepositoryRestMvConfigurationIntegrationTests.java

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public static <T extends Plugin<S>, S> Java8PluginRegistry<T, S> empty() {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`public Optional<T> getPluginFor(S delimiter) {`
`49`		`- return Optional.ofNullable(registry.getPluginFor(delimiter));`
	`49`	`+ return registry.getPluginFor(delimiter);`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`public T getPluginOrDefaultFor(S delimiter, T fallback) {`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public void returnsLinksToSearchResources() {`
`99`	`99`
`100`	`100`	`assertThat(links.hasLink("firstname")).isTrue();`
`101`	`101`
`102`		`- Link firstnameLink = links.getLink("firstname");`
	`102`	`+ Link firstnameLink = links.getLink("firstname").orElse(null);`
`103`	`103`	`assertThat(firstnameLink.isTemplated()).isTrue();`
`104`	`104`	`assertThat(firstnameLink.getVariableNames()).contains("page", "size");`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public void addsSelfAndSingleResourceLinkToResourceByDefault() throws Exception`
`72`	`72`	`Links links = new Links(resource.getLinks());`
`73`	`73`
`74`	`74`	`assertThat(links).hasSize(2);`
`75`		`- assertThat(links.getLink("self").getVariables()).isEmpty();`
`76`		`- assertThat(links.getLink("user").getVariableNames()).contains("projection");`
	`75`	`+ assertThat(links.getLink("self").orElseThrow(() -> new RuntimeException("Unable to find 'self' link")).getVariables()).isEmpty();`
	`76`	`+ assertThat(links.getLink("user").orElseThrow(() -> new RuntimeException("Unable to find 'user' link")).getVariableNames()).contains("projection");`
`77`	`77`	`}`
`78`	`78`	`}`