Skip to content

Custom media type registration #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package org.springframework.hateoas.config;

import org.springframework.hateoas.MediaTypes;
import org.springframework.http.MediaType;

import java.util.Arrays;
import java.util.List;

/**
* Default implementation of {@link HateoasConfigurer}.
*
* @author Alexander Morozov
*/
public class DefaultHateoasConfigurer implements HateoasConfigurer {

@Override
public List<MediaType> getSupportedMediaTypes() {
return Arrays.asList(MediaTypes.HAL_JSON);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package org.springframework.hateoas.config;

import org.springframework.http.MediaType;

import java.util.List;

/**
* Configures HATEOAS environment.
*
* @author Alexander Morozov
* @see DefaultHateoasConfigurer
*/
public interface HateoasConfigurer {

/**
* @return list of supported {@link MediaType}
*/
public List<MediaType> getSupportedMediaTypes();

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package org.springframework.hateoas.config;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.util.Assert;

/**
* @author Alexander Morozov
*/
final class HateoasConfigurerResolver {

private HateoasConfigurerResolver() {
// empty
}

public static HateoasConfigurer resolveHateoasConfigurer(BeanFactory beanFactory) {
Assert.notNull(beanFactory, "Bean factory is required.");
HateoasConfigurer configurer = null;
try {
configurer = beanFactory.getBean(HateoasConfigurer.class);
} catch (NoSuchBeanDefinitionException ex) {
// nop
}
if (configurer == null) {
configurer = new DefaultHateoasConfigurer();
}
return configurer;
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import static org.springframework.beans.factory.support.BeanDefinitionBuilder.*;
import static org.springframework.beans.factory.support.BeanDefinitionReaderUtils.*;
import static org.springframework.hateoas.MediaTypes.*;

import java.util.ArrayList;
import java.util.Arrays;
Expand Down Expand Up @@ -297,9 +296,10 @@ private List<HttpMessageConverter<?>> potentiallyRegisterModule(List<HttpMessage
halObjectMapper.setHandlerInstantiator(new Jackson2HalModule.HalHandlerInstantiator(relProvider, curieProvider,
linkRelationMessageSource, beanFactory));

HateoasConfigurer hateoasConfigurer = HateoasConfigurerResolver.resolveHateoasConfigurer(beanFactory);
MappingJackson2HttpMessageConverter halConverter = new TypeConstrainedMappingJackson2HttpMessageConverter(
ResourceSupport.class);
halConverter.setSupportedMediaTypes(Arrays.asList(HAL_JSON));
halConverter.setSupportedMediaTypes(hateoasConfigurer.getSupportedMediaTypes());
halConverter.setObjectMapper(halObjectMapper);

List<HttpMessageConverter<?>> result = new ArrayList<HttpMessageConverter<?>>(converters.size());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static org.junit.Assert.*;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

Expand All @@ -42,6 +43,7 @@
import org.springframework.hateoas.core.DelegatingRelProvider;
import org.springframework.hateoas.hal.HalLinkDiscoverer;
import org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.test.util.ReflectionTestUtils;
Expand Down Expand Up @@ -133,6 +135,21 @@ public void registersHttpMessageConvertersForRestTemplate() {
context.close();
}

/**
* @see #263
*/
@Test
public void registerCustomMediaType() {

AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(CustomMediaTypeConfig.class);
RestTemplate template = context.getBean(RestTemplate.class);

assertThat(template.getMessageConverters().get(0).getSupportedMediaTypes(),
hasItem(CustomMediaTypeConfig.CUSTOM_TYPE));
context.close();
}

/**
* @see #341
*/
Expand Down Expand Up @@ -219,6 +236,26 @@ static class ExtendedHalConfig extends HalConfig {

}

@Configuration
static class CustomMediaTypeConfig extends HalConfig {

public static final MediaType CUSTOM_TYPE = MediaType.parseMediaType("application/vnd.vendor.resource+json");

@Bean
public HateoasConfigurer hateoasConfigurer()
{
return new HateoasConfigurer() {

@Override
public List<MediaType> getSupportedMediaTypes() {
return Arrays.asList(CUSTOM_TYPE);
}

};
}

}

@Configuration
@EnableHypermediaSupport(type = HypermediaType.HAL)
static class DelegateConfig {
Expand Down