Support for HATEOAS-Links in Json-Views

.travis.yml

@@ -4,12 +4,11 @@ jdk:
 env:
   matrix:
     - PROFILE=non-existant
-    - PROFILE=spring41
-    - PROFILE=spring41-next
+    - PROFILE=spring42
     - PROFILE=spring42-next
 cache:
   directories:
     - $HOME/.m2
 sudo: false
 install: true
-script: "mvn clean dependency:list test -P${PROFILE} -Dsort"
+script: "mvn clean dependency:list test -P${PROFILE} -Dsort"

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>org.springframework.hateoas</groupId>
 	<artifactId>spring-hateoas</artifactId>
-	<version>0.18.0.BUILD-SNAPSHOT</version>
+	<version>0.20.0.BUILD-SNAPSHOT</version>
 
 	<name>Spring HATEOAS</name>
 	<url>http://github.com/SpringSource/spring-hateoas</url>
@@ -58,12 +58,12 @@
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-		<spring.version>4.0.9.RELEASE</spring.version>
+		<spring.version>4.1.7.RELEASE</spring.version>
 		<logback.version>1.1.3</logback.version>
 		<jackson.version>2.5.4</jackson.version>
-		<jaxrs.version>1.0</jaxrs.version>
-		<minidevjson.version>2.1.1</minidevjson.version>
-		<jsonpath.version>0.9.1</jsonpath.version>
+		<jaxrs.version>2.0.1</jaxrs.version>
+		<minidevjson.version>2.2</minidevjson.version>
+		<jsonpath.version>2.0.0</jsonpath.version>
 		<slf4j.version>1.7.12</slf4j.version>
 		<evo.version>1.2.1</evo.version>
 		<bundlor.failOnWarnings>true</bundlor.failOnWarnings>
@@ -73,42 +73,18 @@
 	<profiles>
 
 		<profile>
-			<id>spring40-next</id>
+			<id>spring42</id>
 			<properties>
-				<spring.version>4.0.10.BUILD-SNAPSHOT</spring.version>
+				<spring.version>4.2.1.RELEASE</spring.version>
+				<jackson.version>2.6.1</jackson.version>
 			</properties>
-			<repositories>
-				<repository>
-					<id>spring-libs-snapshot</id>
-					<url>http://repo.spring.io/libs-snapshot</url>
-				</repository>
-			</repositories>
-		</profile>
-
-		<profile>
-			<id>spring41</id>
-			<properties>
-				<spring.version>4.1.6.RELEASE</spring.version>
-			</properties>
-		</profile>
-
-		<profile>
-			<id>spring41-next</id>
-			<properties>
-				<spring.version>4.1.6.BUILD-SNAPSHOT</spring.version>
-			</properties>
-			<repositories>
-				<repository>
-					<id>spring-libs-snapshot</id>
-					<url>http://repo.spring.io/libs-snapshot</url>
-				</repository>
-			</repositories>
 		</profile>
 
 		<profile>
 			<id>spring42-next</id>
 			<properties>
-				<spring.version>4.2.0.BUILD-SNAPSHOT</spring.version>
+				<spring.version>4.2.2.BUILD-SNAPSHOT</spring.version>
+				<jackson.version>2.6.1</jackson.version>
 			</properties>
 			<repositories>
 				<repository>
@@ -167,7 +143,7 @@
 				<dependency>
 					<groupId>org.springframework.data.build</groupId>
 					<artifactId>spring-data-build-resources</artifactId>
-					<version>1.6.0.RELEASE</version>
+					<version>1.6.2.RELEASE</version>
 					<scope>provided</scope>
 					<type>zip</type>
 				</dependency>
@@ -223,12 +199,12 @@
 					<plugin>
 						<groupId>org.asciidoctor</groupId>
 						<artifactId>asciidoctor-maven-plugin</artifactId>
-						<version>1.5.2</version>
+						<version>1.5.2.1</version>
 						<dependencies>
 							<dependency>
 								<groupId>org.asciidoctor</groupId>
 								<artifactId>asciidoctorj-pdf</artifactId>
-								<version>1.5.0-alpha.6</version>
+								<version>1.5.0-alpha.8</version>
 							</dependency>
 							<dependency>
 								<groupId>org.asciidoctor</groupId>
@@ -355,7 +331,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-assembly-plugin</artifactId>
-						<version>2.5.4</version>
+						<version>2.5.5</version>
 						<executions>
 							<execution>
 								<id>static</id>
@@ -473,7 +449,7 @@
 
 		<dependency>
 			<groupId>javax.ws.rs</groupId>
-			<artifactId>jsr311-api</artifactId>
+			<artifactId>javax.ws.rs-api</artifactId>
 			<version>${jaxrs.version}</version>
 			<optional>true</optional>
 		</dependency>
@@ -495,7 +471,7 @@
 		<dependency>
 			<groupId>org.projectlombok</groupId>
 			<artifactId>lombok</artifactId>
-			<version>1.14.4</version>
+			<version>1.16.4</version>
 			<scope>provided</scope>
 		</dependency>
 
@@ -529,7 +505,7 @@
 		<dependency>
 			<groupId>junit</groupId>
 			<artifactId>junit</artifactId>
-			<version>4.11</version>
+			<version>4.12</version>
 			<scope>test</scope>
 		</dependency>
 
@@ -543,21 +519,21 @@
 		<dependency>
 			<groupId>org.mockito</groupId>
 			<artifactId>mockito-all</artifactId>
-			<version>1.9.5</version>
+			<version>1.10.19</version>
 			<scope>test</scope>
 		</dependency>
 
 		<dependency>
 			<groupId>joda-time</groupId>
 			<artifactId>joda-time</artifactId>
-			<version>2.3</version>
+			<version>2.8.1</version>
 			<scope>test</scope>
 		</dependency>
 
 		<dependency>
 			<groupId>xmlunit</groupId>
 			<artifactId>xmlunit</artifactId>
-			<version>1.5</version>
+			<version>1.6</version>
 			<scope>test</scope>
 		</dependency>
 
@@ -580,6 +556,36 @@
 	</dependencies>
 
 	<build>
+		<pluginManagement>
+			<plugins>
+				<plugin>
+					<groupId>org.eclipse.m2e</groupId>
+					<artifactId>lifecycle-mapping</artifactId>
+					<version>1.0.0</version>
+					<configuration>
+						<lifecycleMappingMetadata>
+							<pluginExecutions>
+								<pluginExecution>
+									<pluginExecutionFilter>
+										<groupId>com.springsource.bundlor</groupId>
+										<artifactId>com.springsource.bundlor.maven</artifactId>
+										<versionRange>[1.0,2.0)</versionRange>
+										<goals>
+											<goal>bundlor</goal>
+										</goals>
+									</pluginExecutionFilter>
+									<action>
+										<execute>
+											<runOnIncremental>true</runOnIncremental>
+										</execute>
+									</action>
+								</pluginExecution>
+							</pluginExecutions>
+						</lifecycleMappingMetadata>
+					</configuration>
+				</plugin>
+			</plugins>
+		</pluginManagement>	
 
 		<extensions>
 			<extension>
@@ -652,7 +658,7 @@
 					<additionalparam>-Xdoclint:none</additionalparam>
 					<stylesheetfile>${shared.resources}/javadoc/spring-javadoc.css</stylesheetfile>
 					<links>
-						<link>http://static.springframework.org/spring/docs/3.2.x/javadoc-api</link>
+						<link>http://static.springframework.org/spring/docs/4.1.x/javadoc-api</link>
 						<link>http://docs.oracle.com/javase/6/docs/api</link>
 					</links>
 				</configuration>

src/main/asciidoc/index.adoc

@@ -87,7 +87,7 @@ You can also easily access links contained in that resource:
 [source, java]
 ----
 Link selfLink = new Link("http://myhost/people");
-assertThat(resource.getId(), is(selfLink);
+assertThat(resource.getId(), is(selfLink));
 assertThat(resource.getLink(Link.SELF), is(selfLink));
 ----
 [[fundamentals.obtaining-links]]

src/main/java/org/springframework/hateoas/Link.java

@@ -32,6 +32,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonView;
 
 /**
  * Value object for links.
@@ -104,6 +105,7 @@ protected Link() {
 	 * 
 	 * @return
 	 */
+	@JsonView(ResourcesLinksVisible.class)
 	public String getHref() {
 		return href;
 	}
@@ -113,6 +115,7 @@ public String getHref() {
 	 * 
 	 * @return
 	 */
+	@JsonView(ResourcesLinksVisible.class)
 	public String getRel() {
 		return rel;
 	}

src/main/java/org/springframework/hateoas/MediaTypes.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-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.
@@ -21,8 +21,17 @@
  * Constants for well-known hypermedia types.
  * 
  * @author Oliver Gierke
+ * @author Przemek Nowak
  */
 public class MediaTypes {
 
-	public static final MediaType HAL_JSON = MediaType.valueOf("application/hal+json");
+	/**
+	 * A String equivalent of {@link MediaTypes#HAL_JSON}.
+	 */
+	public static final String HAL_JSON_VALUE = "application/hal+json";
+
+	/**
+	 * Public constant media type for {@code application/hal+json}.
+	 */
+	public static final MediaType HAL_JSON = MediaType.valueOf(HAL_JSON_VALUE);
 }

src/main/java/org/springframework/hateoas/Resource.java

@@ -24,6 +24,7 @@
 import org.springframework.util.Assert;
 
 import com.fasterxml.jackson.annotation.JsonUnwrapped;
+import com.fasterxml.jackson.annotation.JsonView;
 
 /**
  * A simple {@link Resource} wrapping a domain object and adding links to it.
@@ -73,6 +74,7 @@ public Resource(T content, Iterable<Link> links) {
 	 */
 	@JsonUnwrapped
 	@XmlAnyElement
+	@JsonView(ResourcesLinksVisible.class)
 	public T getContent() {
 		return content;
 	}

src/main/java/org/springframework/hateoas/ResourceSupport.java

@@ -25,6 +25,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonView;
 
 /**
  * Base class for DTOs to collect links.
@@ -105,6 +106,7 @@ public boolean hasLink(String rel) {
 	 */
 	@XmlElement(name = "link", namespace = Link.ATOM_NAMESPACE)
 	@JsonProperty("links")
+	@JsonView(ResourcesLinksVisible.class)
 	public List<Link> getLinks() {
 		return links;
 	}

src/main/java/org/springframework/hateoas/Resources.java

@@ -28,6 +28,7 @@
 import org.springframework.util.Assert;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonView;
 
 /**
  * General helper to easily create a wrapper for a collection of entities.
@@ -101,6 +102,7 @@ public static <T extends Resource<S>, S> Resources<T> wrap(Iterable<S> content)
 	@XmlAnyElement
 	@XmlElementWrapper
 	@JsonProperty("content")
+	@JsonView(ResourcesLinksVisible.class)
 	public Collection<T> getContent() {
 		return Collections.unmodifiableCollection(content);
 	}

src/main/java/org/springframework/hateoas/ResourcesLinksVisible.java

@@ -0,0 +1,32 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.hateoas;
+
+/**
+ * Parent interface to mark {@link Resource}(s) beans that {@link Link}s and Resource
+ * {@code content} are part of a JSON view.
+ * 
+ * Usage: subinterface and mark all view relevant properties of your bean
+ * {@code @JSonView(SubInterface.class)}. Then serialize bean of {@code new Resource<>(bean)} to
+ * JSON. Your ({@code content} with) relevant properties and all associated {@code labels} will be
+ * visible.
+ * 
+ * @see com.fasterxml.jackson.annotation.JsonView
+ * @since 0.18.0
+ *
+ * @author Karsten Tinnefeld
+ */
+public interface ResourcesLinksVisible {}