Spring/spring-hateoas
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#125 - Polished curies in HAL and HAL rendering in general.

Browse Source 
Both _links and _embedded are now only rendered if there's actual content to be rendered. The curies link is now always rendered as array as specified.
This commit is contained in:
Oliver Gierke
2013-12-28 20:59:21 +01:00
parent dfa30398b6
commit 88da0672ab
2 changed files with 32 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/main/java/org/springframework/hateoas/hal/Jackson2HalModule.java
View File

@@ -120,9 +120,7 @@ public class Jackson2HalModule extends SimpleModule {
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.std.StdSerializer#serialize(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator,
* com.fasterxml.jackson.databind.SerializerProvider)
* @see com.fasterxml.jackson.databind.ser.std.StdSerializer#serialize(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)
*/
@Override
public void serialize(List<Link> value, JsonGenerator jgen, SerializerProvider provider) throws IOException,
@@ -145,7 +143,9 @@ public class Jackson2HalModule extends SimpleModule {
if (prefixingRequired) {
Object curieInformation = curieProvider.getCurieInformation();
sortedLinks.put("curies", Arrays.asList(curieInformation));
List<Object> curies = new ArrayList<Object>();
curies.add(Arrays.asList(curieInformation));
sortedLinks.put("curies", curies);
}
TypeFactory typeFactory = provider.getConfig().getTypeFactory();
@@ -161,9 +161,7 @@ public class Jackson2HalModule extends SimpleModule {
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.ContextualSerializer#createContextual(com.fasterxml.jackson.databind.SerializerProvider,
* com.fasterxml.jackson.databind.BeanProperty)
* @see com.fasterxml.jackson.databind.ser.ContextualSerializer#createContextual(com.fasterxml.jackson.databind.SerializerProvider, com.fasterxml.jackson.databind.BeanProperty)
*/
@Override
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property)
@@ -173,7 +171,6 @@ public class Jackson2HalModule extends SimpleModule {
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#getContentType()
*/
@Override
@@ -183,7 +180,6 @@ public class Jackson2HalModule extends SimpleModule {
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#getContentSerializer()
*/
@Override
@@ -193,29 +189,25 @@ public class Jackson2HalModule extends SimpleModule {
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#isEmpty(java.lang.Object)
*/
@Override
public boolean isEmpty(List<Link> value) {
return false;
return value.isEmpty();
}
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#hasSingleElement(java.lang.Object)
*/
@Override
public boolean hasSingleElement(List<Link> value) {
return false;
return value.size() == 1;
}
/*
* (non-Javadoc)
*
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#_withValueTypeSerializer(com.fasterxml.jackson.databind.jsontype.
* TypeSerializer)
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#_withValueTypeSerializer(com.fasterxml.jackson.databind.jsontype.TypeSerializer)
*/
@Override
protected ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts) {
@@ -287,25 +279,21 @@ public class Jackson2HalModule extends SimpleModule {
@Override
public JsonSerializer<?> getContentSerializer() {
// TODO Auto-generated method stub
return null;
}
@Override
public boolean isEmpty(Collection<?> value) {
// TODO Auto-generated method stub
return false;
return value.isEmpty();
}
@Override
public boolean hasSingleElement(Collection<?> value) {
// TODO Auto-generated method stub
return false;
return value.size() == 1;
}
@Override
protected ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts) {
// TODO Auto-generated method stub
return null;
}
}

31
src/test/java/org/springframework/hateoas/hal/Jackson2HalIntegrationTest.java
View File

@@ -54,13 +54,14 @@ public class Jackson2HalIntegrationTest extends AbstractJackson2MarshallingInteg
static final String LIST_EMBEDDED_RESOURCE_REFERENCE = "{\"_links\":{\"self\":{\"href\":\"localhost\"}},\"_embedded\":{\"content\":[{\"text\":\"test1\",\"number\":1,\"_links\":{\"self\":{\"href\":\"localhost\"}}},{\"text\":\"test2\",\"number\":2,\"_links\":{\"self\":{\"href\":\"localhost\"}}}]}}";
static final String ANNOTATED_EMBEDDED_RESOURCE_REFERENCE = "{\"_links\":{\"self\":{\"href\":\"localhost\"}},\"_embedded\":{\"pojo\":{\"text\":\"test1\",\"number\":1,\"_links\":{\"self\":{\"href\":\"localhost\"}}}}}";
static final String ANNOTATED_EMBEDDED_RESOURCES_REFERENCE = "{\"_links\":{},\"_embedded\":{\"pojos\":[{\"text\":\"test1\",\"number\":1,\"_links\":{\"self\":{\"href\":\"localhost\"}}},{\"text\":\"test2\",\"number\":2,\"_links\":{\"self\":{\"href\":\"localhost\"}}}]}}";
static final String ANNOTATED_EMBEDDED_RESOURCES_REFERENCE = "{\"_embedded\":{\"pojos\":[{\"text\":\"test1\",\"number\":1,\"_links\":{\"self\":{\"href\":\"localhost\"}}},{\"text\":\"test2\",\"number\":2,\"_links\":{\"self\":{\"href\":\"localhost\"}}}]}}";
static final String ANNOTATED_PAGED_RESOURCES = "{\"_links\":{\"next\":{\"href\":\"foo\"},\"prev\":{\"href\":\"bar\"}},\"_embedded\":{\"pojos\":[{\"text\":\"test1\",\"number\":1,\"_links\":{\"self\":{\"href\":\"localhost\"}}},{\"text\":\"test2\",\"number\":2,\"_links\":{\"self\":{\"href\":\"localhost\"}}}]},\"page\":{\"size\":2,\"totalElements\":4,\"totalPages\":2,\"number\":0}}";
static final Links PAGINATION_LINKS = new Links(new Link("foo", Link.REL_NEXT), new Link("bar", Link.REL_PREVIOUS));
static final String CURIED_DOCUMENT = "{\"_links\":{\"self\":{\"href\":\"foo\"},\"foo:myrel\":{\"href\":\"bar\"},\"curies\":{\"href\":\"htp://localhost:8080/rels/{rel}\",\"name\":\"foo\",\"templated\":true}},\"_embedded\":{}}";
static final String CURIED_DOCUMENT = "{\"_links\":{\"self\":{\"href\":\"foo\"},\"foo:myrel\":{\"href\":\"bar\"},\"curies\":[{\"href\":\"http://localhost:8080/rels/{rel}\",\"name\":\"foo\",\"templated\":true}]}}";
static final String EMPTY_DOCUMENT = "{}";
@Before
public void setUpModule() {
@@ -278,16 +279,17 @@ public class Jackson2HalIntegrationTest extends AbstractJackson2MarshallingInteg
@Test
public void rendersCuriesCorrectly() throws Exception {
CurieProvider curieProvider = new DefaultCurieProvider("foo", new UriTemplate("htp://localhost:8080/rels/{rel}"));
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new Jackson2HalModule());
mapper.setHandlerInstantiator(new HalHandlerInstantiator(new AnnotationRelProvider(), curieProvider));
Resources<Object> resources = new Resources<Object>(Collections.emptySet(), new Link("foo"), new Link("bar",
"myrel"));
assertThat(mapper.writeValueAsString(resources), is(CURIED_DOCUMENT));
assertThat(getCuriedObjectMapper().writeValueAsString(resources), is(CURIED_DOCUMENT));
}
@Test
public void doesNotRenderCuriesIfNoLinkIsPresent() throws Exception {
Resources<Object> resources = new Resources<Object>(Collections.emptySet());
assertThat(getCuriedObjectMapper().writeValueAsString(resources), is(EMPTY_DOCUMENT));
}
private static Resources<Resource<SimpleAnnotatedPojo>> setupAnnotatedPagedResources() {
@@ -316,4 +318,15 @@ public class Jackson2HalIntegrationTest extends AbstractJackson2MarshallingInteg
return new Resources<Resource<SimplePojo>>(content);
}
private static ObjectMapper getCuriedObjectMapper() {
CurieProvider curieProvider = new DefaultCurieProvider("foo", new UriTemplate("http://localhost:8080/rels/{rel}"));
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new Jackson2HalModule());
mapper.setHandlerInstantiator(new HalHandlerInstantiator(new AnnotationRelProvider(), curieProvider));
return mapper;
}
}