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

#288 - Introduced HalConfiguration to allow customizations of rendering options.

Browse Source 
We now expose HalConfiguration to be defined as Spring bean in user configuration to control certain aspects of the HAL rendering. Initially we allow to control whether links shall always be rendered as collection. If no user-provided bean is available, we register a default instance.

Original pull request: #295
Related issues: #291
This commit is contained in:
Greg Turnquist
2017-05-22 14:48:59 -05:00
committed by Oliver Gierke
parent ab54e56f01
commit 5eee30127d
7 changed files with 197 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/main/java/org/springframework/hateoas/RenderSingleLinks.java Normal file
View File

@@ -0,0 +1,32 @@
/*
* Copyright 2017 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;
/**
* Whether to render a single {@link Link} as either a single entry or a collection.
*/
public enum RenderSingleLinks {
/**
* A single {@link Link} is rendered as a JSON object.
*/
AS_SINGLE,
/**
* A single {@link Link} is rendered as a JSON Array.
*/
AS_ARRAY
}

3
src/main/java/org/springframework/hateoas/config/EnableHypermediaSupport.java
View File

@@ -25,6 +25,7 @@ import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Import;
import org.springframework.hateoas.EntityLinks;
import org.springframework.hateoas.LinkDiscoverer;
import org.springframework.hateoas.RenderSingleLinks;
/**
* Activates hypermedia support in the {@link ApplicationContext}. Will register infrastructure beans available for
@@ -58,7 +59,7 @@ public @interface EnableHypermediaSupport {
*
* @author Oliver Gierke
*/
static enum HypermediaType {
enum HypermediaType {
/**
* HAL - Hypermedia Application Language.

23
src/main/java/org/springframework/hateoas/config/HypermediaSupportBeanDefinitionRegistrar.java
View File

@@ -46,6 +46,7 @@ import org.springframework.hateoas.EntityLinks;
import org.springframework.hateoas.LinkDiscoverer;
import org.springframework.hateoas.LinkDiscoverers;
import org.springframework.hateoas.RelProvider;
import org.springframework.hateoas.RenderSingleLinks;
import org.springframework.hateoas.ResourceSupport;
import org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType;
import org.springframework.hateoas.core.AnnotationRelProvider;
@@ -53,6 +54,7 @@ import org.springframework.hateoas.core.DefaultRelProvider;
import org.springframework.hateoas.core.DelegatingRelProvider;
import org.springframework.hateoas.core.EvoInflectorRelProvider;
import org.springframework.hateoas.hal.CurieProvider;
import org.springframework.hateoas.hal.HalConfiguration;
import org.springframework.hateoas.hal.HalLinkDiscoverer;
import org.springframework.hateoas.hal.Jackson2HalModule;
import org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter;
@@ -76,7 +78,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
*
* @author Oliver Gierke
*/
class HypermediaSupportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
class HypermediaSupportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, BeanFactoryAware {
private static final String DELEGATING_REL_PROVIDER_BEAN_NAME = "_relProvider";
private static final String LINK_DISCOVERER_REGISTRY_BEAN_NAME = "_linkDiscovererRegistry";
@@ -89,8 +91,10 @@ class HypermediaSupportBeanDefinitionRegistrar implements ImportBeanDefinitionRe
private static final boolean EVO_PRESENT = ClassUtils.isPresent("org.atteo.evo.inflector.English", null);
private final ImportBeanDefinitionRegistrar linkBuilderBeanDefinitionRegistrar = new LinkBuilderBeanDefinitionRegistrar();
private BeanFactory beanFactory;
/*
/*
* (non-Javadoc)
* @see org.springframework.context.annotation.ImportBeanDefinitionRegistrar#registerBeanDefinitions(org.springframework.core.type.AnnotationMetadata, org.springframework.beans.factory.support.BeanDefinitionRegistry)
*/
@@ -125,6 +129,16 @@ class HypermediaSupportBeanDefinitionRegistrar implements ImportBeanDefinitionRe
BeanDefinitionBuilder builder = rootBeanDefinition(Jackson2ModuleRegisteringBeanPostProcessor.class);
registerSourcedBeanDefinition(builder, metadata, registry);
}
try {
this.beanFactory.getBean(HalConfiguration.class);
} catch (BeansException e) {
// If no HalConfiguration bean, create a default one.
BeanDefinitionBuilder defaultHalConfiguration = rootBeanDefinition(HalConfiguration.class);
defaultHalConfiguration.addPropertyValue("renderSingleLinks", RenderSingleLinks.AS_SINGLE);
registerSourcedBeanDefinition(defaultHalConfiguration, metadata, registry);
}
}
if (!types.isEmpty()) {
@@ -143,6 +157,11 @@ class HypermediaSupportBeanDefinitionRegistrar implements ImportBeanDefinitionRe
registerRelProviderPluginRegistryAndDelegate(registry);
}
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
this.beanFactory = beanFactory;
}
/**
* Registers bean definitions for a {@link PluginRegistry} to capture {@link RelProvider} instances. Wraps the
* registry into a {@link DelegatingRelProvider} bean definition backed by the registry.

35
src/main/java/org/springframework/hateoas/hal/HalConfiguration.java Normal file
View File

@@ -0,0 +1,35 @@
/*
* Copyright 2017 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.hal;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.Wither;
import org.springframework.hateoas.HypermediaConfiguration;
import org.springframework.hateoas.RenderSingleLinks;
/**
* @author Greg Turnquist
*/
@AllArgsConstructor
@NoArgsConstructor
public class HalConfiguration implements HypermediaConfiguration {
private @Wither @Getter @Setter RenderSingleLinks renderSingleLinks;
}

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

@@ -32,6 +32,7 @@ import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.Links;
import org.springframework.hateoas.RelProvider;
import org.springframework.hateoas.RenderSingleLinks;
import org.springframework.hateoas.Resource;
import org.springframework.hateoas.ResourceSupport;
import org.springframework.hateoas.Resources;
@@ -123,13 +124,14 @@ public class Jackson2HalModule extends SimpleModule {
private final CurieProvider curieProvider;
private final EmbeddedMapper mapper;
private final MessageSourceAccessor accessor;
private final HalConfiguration halConfiguration;
public HalLinkListSerializer(CurieProvider curieProvider, EmbeddedMapper mapper, MessageSourceAccessor accessor) {
this(null, curieProvider, mapper, accessor);
public HalLinkListSerializer(CurieProvider curieProvider, EmbeddedMapper mapper, MessageSourceAccessor accessor, HalConfiguration halConfiguration) {
this(null, curieProvider, mapper, accessor, halConfiguration);
}
public HalLinkListSerializer(BeanProperty property, CurieProvider curieProvider, EmbeddedMapper mapper,
MessageSourceAccessor accessor) {
MessageSourceAccessor accessor, HalConfiguration halConfiguration) {
super(TypeFactory.defaultInstance().constructType(List.class));
@@ -137,6 +139,7 @@ public class Jackson2HalModule extends SimpleModule {
this.curieProvider = curieProvider;
this.mapper = mapper;
this.accessor = accessor;
this.halConfiguration = halConfiguration;
}
/*
@@ -198,7 +201,7 @@ public class Jackson2HalModule extends SimpleModule {
JavaType mapType = typeFactory.constructMapType(HashMap.class, keyType, valueType);
MapSerializer serializer = MapSerializer.construct(new String[] {}, mapType, true, null,
provider.findKeySerializer(keyType, null), new OptionalListJackson2Serializer(property), null);
provider.findKeySerializer(keyType, null), new OptionalListJackson2Serializer(property, halConfiguration), null);
serializer.serialize(sortedLinks, jgen, provider);
}
@@ -246,7 +249,7 @@ public class Jackson2HalModule extends SimpleModule {
@Override
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property)
throws JsonMappingException {
return new HalLinkListSerializer(property, curieProvider, mapper, accessor);
return new HalLinkListSerializer(property, curieProvider, mapper, accessor, halConfiguration);
}
/*
@@ -267,15 +270,7 @@ public class Jackson2HalModule extends SimpleModule {
return null;
}
/*
* (non-Javadoc)
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#isEmpty(java.lang.Object)
*/
public boolean isEmpty(List<Link> value) {
return isEmpty(null, value);
}
/*
/*
* (non-Javadoc)
* @see com.fasterxml.jackson.databind.JsonSerializer#isEmpty(com.fasterxml.jackson.databind.SerializerProvider, java.lang.Object)
*/
@@ -368,10 +363,6 @@ public class Jackson2HalModule extends SimpleModule {
return null;
}
public boolean isEmpty(Collection<?> value) {
return isEmpty(null, value);
}
public boolean isEmpty(SerializerProvider provider, Collection<?> value) {
return value.isEmpty();
}
@@ -401,9 +392,14 @@ public class Jackson2HalModule extends SimpleModule {
private final BeanProperty property;
private final Map<Class<?>, JsonSerializer<Object>> serializers;
private final HalConfiguration halConfiguration;
public OptionalListJackson2Serializer() {
this(null);
this(null, new HalConfiguration().withRenderSingleLinks(RenderSingleLinks.AS_SINGLE));
}
public OptionalListJackson2Serializer(BeanProperty property) {
this(property, new HalConfiguration().withRenderSingleLinks(RenderSingleLinks.AS_SINGLE));
}
/**
@@ -411,12 +407,13 @@ public class Jackson2HalModule extends SimpleModule {
*
* @param property
*/
public OptionalListJackson2Serializer(BeanProperty property) {
public OptionalListJackson2Serializer(BeanProperty property, HalConfiguration halConfiguration) {
super(TypeFactory.defaultInstance().constructType(List.class));
this.property = property;
this.serializers = new HashMap<Class<?>, JsonSerializer<Object>>();
this.halConfiguration = halConfiguration;
}
/*
@@ -434,7 +431,7 @@ public class Jackson2HalModule extends SimpleModule {
*/
@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider)
throws IOException, JsonGenerationException {
throws IOException {
List<?> list = (List<?>) value;
@@ -442,7 +439,7 @@ public class Jackson2HalModule extends SimpleModule {
return;
}
if (list.size() == 1) {
if (list.size() == 1 && this.halConfiguration.getRenderSingleLinks() == RenderSingleLinks.AS_SINGLE) {
serializeContents(list.iterator(), jgen, provider);
return;
}
@@ -506,15 +503,7 @@ public class Jackson2HalModule extends SimpleModule {
return false;
}
/*
* (non-Javadoc)
* @see com.fasterxml.jackson.databind.ser.ContainerSerializer#isEmpty(java.lang.Object)
*/
public boolean isEmpty(Object value) {
return isEmpty(null, value);
}
/*
/*
* (non-Javadoc)
* @see com.fasterxml.jackson.databind.JsonSerializer#isEmpty(com.fasterxml.jackson.databind.SerializerProvider, java.lang.Object)
*/
@@ -577,7 +566,7 @@ public class Jackson2HalModule extends SimpleModule {
while (!JsonToken.END_OBJECT.equals(jp.nextToken())) {
if (!JsonToken.FIELD_NAME.equals(jp.getCurrentToken())) {
throw new JsonParseException("Expected relation name", jp.getCurrentLocation());
throw new JsonParseException(jp, "Expected relation name", jp.getCurrentLocation());
}
// save the relation in case the link does not contain it
@@ -653,7 +642,7 @@ public class Jackson2HalModule extends SimpleModule {
while (!JsonToken.END_OBJECT.equals(jp.nextToken())) {
if (!JsonToken.FIELD_NAME.equals(jp.getCurrentToken())) {
throw new JsonParseException("Expected relation name", jp.getCurrentLocation());
throw new JsonParseException(jp, "Expected relation name", jp.getCurrentLocation());
}
if (JsonToken.START_ARRAY.equals(jp.nextToken())) {
@@ -702,8 +691,16 @@ public class Jackson2HalModule extends SimpleModule {
* @param beanFactory can be {@literal null}
*/
public HalHandlerInstantiator(RelProvider provider, CurieProvider curieProvider, MessageSourceAccessor accessor,
AutowireCapableBeanFactory beanFactory) {
this(provider, curieProvider, accessor, true, beanFactory);
AutowireCapableBeanFactory beanFactory, HalConfiguration halConfiguration) {
this(provider, curieProvider, accessor, true, beanFactory, halConfiguration);
}
public HalHandlerInstantiator(RelProvider provider, CurieProvider curieProvider, MessageSourceAccessor messageSourceAccessor, AutowireCapableBeanFactory beanFactory) {
this(provider, curieProvider, messageSourceAccessor, beanFactory, beanFactory.getBean(HalConfiguration.class));
}
public HalHandlerInstantiator(RelProvider provider, CurieProvider curieProvider, MessageSourceAccessor messageSourceAccessor) {
this(provider, curieProvider, messageSourceAccessor, new HalConfiguration().withRenderSingleLinks(RenderSingleLinks.AS_SINGLE));
}
/**
@@ -716,8 +713,8 @@ public class Jackson2HalModule extends SimpleModule {
* @param messageSourceAccessor can be {@literal null}.
*/
public HalHandlerInstantiator(RelProvider provider, CurieProvider curieProvider,
MessageSourceAccessor messageSourceAccessor) {
this(provider, curieProvider, messageSourceAccessor, true);
MessageSourceAccessor messageSourceAccessor, HalConfiguration halConfiguration) {
this(provider, curieProvider, messageSourceAccessor, true, halConfiguration);
}
/**
@@ -732,12 +729,12 @@ public class Jackson2HalModule extends SimpleModule {
* @param enforceEmbeddedCollections
*/
public HalHandlerInstantiator(RelProvider provider, CurieProvider curieProvider, MessageSourceAccessor accessor,
boolean enforceEmbeddedCollections) {
this(provider, curieProvider, accessor, enforceEmbeddedCollections, null);
boolean enforceEmbeddedCollections, HalConfiguration halConfiguration) {
this(provider, curieProvider, accessor, enforceEmbeddedCollections, null, halConfiguration);
}
private HalHandlerInstantiator(RelProvider provider, CurieProvider curieProvider, MessageSourceAccessor accessor,
boolean enforceEmbeddedCollections, AutowireCapableBeanFactory delegate) {
boolean enforceEmbeddedCollections, AutowireCapableBeanFactory delegate, HalConfiguration halConfiguration) {
Assert.notNull(provider, "RelProvider must not be null!");
@@ -746,7 +743,7 @@ public class Jackson2HalModule extends SimpleModule {
this.delegate = delegate;
this.serializers.put(HalResourcesSerializer.class, new HalResourcesSerializer(mapper));
this.serializers.put(HalLinkListSerializer.class, new HalLinkListSerializer(curieProvider, mapper, accessor));
this.serializers.put(HalLinkListSerializer.class, new HalLinkListSerializer(curieProvider, mapper, accessor, halConfiguration));
}
/*
@@ -820,14 +817,6 @@ public class Jackson2HalModule extends SimpleModule {
}
/*
* (non-Javadoc)
* @see com.fasterxml.jackson.databind.JsonSerializer#isEmpty(java.lang.Object)
*/
public boolean isEmpty(Boolean value) {
return isEmpty(null, value);
}
/*
* (non-Javadoc)
* @see com.fasterxml.jackson.databind.JsonSerializer#isEmpty(com.fasterxml.jackson.databind.SerializerProvider, java.lang.Object)
*/