Package org.springframework.hateoas.mediatype.hal

Class HalMediaTypeConfiguration

java.lang.Object

org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration

All Implemented Interfaces:

HypermediaMappingInformation

@Configuration(proxyBeanMethods=false)
public class HalMediaTypeConfiguration
extends Object
implements HypermediaMappingInformation

Spring configuration to set up HAL support.

Author:

Greg Turnquist, Oliver Drotbohm

Constructor Summary

Constructors

Constructor

Description

HalMediaTypeConfiguration(LinkRelationProvider relProvider, org.springframework.beans.factory.ObjectProvider<CurieProvider> curieProvider, org.springframework.beans.factory.ObjectProvider<HalConfiguration> halConfiguration, org.springframework.beans.factory.ObjectProvider<MediaTypeConfigurationCustomizer<HalConfiguration>> customizers, MessageResolver resolver, org.springframework.beans.factory.config.AutowireCapableBeanFactory beanFactory)

Method Summary

Modifier and Type	Method	Description
tools.jackson.databind.json.JsonMapper.Builder	configureJsonMapper(tools.jackson.databind.json.JsonMapper.Builder builder)	Configure an JsonMapper.Builder and register custom serializers and deserializers for the supported media types.
List<org.springframework.http.MediaType>	getMediaTypes()	All MediaTypes this hypermedia can handle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.hateoas.config.HypermediaMappingInformation

getJacksonModule, getRootType

Constructor Details

HalMediaTypeConfiguration

public HalMediaTypeConfiguration(LinkRelationProvider relProvider,
 org.springframework.beans.factory.ObjectProvider<CurieProvider> curieProvider,
 org.springframework.beans.factory.ObjectProvider<HalConfiguration> halConfiguration,
 org.springframework.beans.factory.ObjectProvider<MediaTypeConfigurationCustomizer<HalConfiguration>> customizers,
 MessageResolver resolver,
 org.springframework.beans.factory.config.AutowireCapableBeanFactory beanFactory)

Method Details

getMediaTypes

public List<org.springframework.http.MediaType> getMediaTypes()

Description copied from interface: HypermediaMappingInformation

All MediaTypes this hypermedia can handle.

Specified by:

getMediaTypes in interface HypermediaMappingInformation

Returns:

configureJsonMapper

public tools.jackson.databind.json.JsonMapper.Builder configureJsonMapper(tools.jackson.databind.json.JsonMapper.Builder builder)

Description copied from interface: HypermediaMappingInformation

Configure an JsonMapper.Builder and register custom serializers and deserializers for the supported media types. If all you want to do is register a Jackson Module, prefer implementing HypermediaMappingInformation.getJacksonModule().

Specified by:

configureJsonMapper in interface HypermediaMappingInformation

Parameters:

builder - will never be null.

Returns:

must not be null.

See Also:

• HypermediaMappingInformation.getJacksonModule()