Package org.springframework.hateoas.mediatype.hal.forms

Class HalFormsHttpMessageConverter

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<T>

org.springframework.http.converter.AbstractGenericHttpMessageConverter<Object>

org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter

org.springframework.hateoas.mediatype.hal.forms.HalFormsHttpMessageConverter

All Implemented Interfaces:

GenericHttpMessageConverter<Object>, HttpMessageConverter<Object>

public class HalFormsHttpMessageConverter
extends TypeConstrainedMappingJackson2HttpMessageConverter

A TypeConstrainedMappingJackson2HttpMessageConverter that will inspect the returned RepresentationModel for affordances and flip the MediaType rendered back to MediaTypes.HAL_JSON if no templates have been registered.

Since:

2.4

Author:

Oliver Drotbohm

Field Summary

Fields inherited from class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

defaultObjectMapper

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor	Description
HalFormsHttpMessageConverter(BeanFactory factory, com.fasterxml.jackson.databind.ObjectMapper mapper)	Creates a new HalFormsHttpMessageConverter for the given BeanFactory and ObjectMapper

Method Summary

Modifier and Type	Method	Description
protected void	writeInternal(Object object, Type type, HttpOutputMessage outputMessage)

Methods inherited from class org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter

canRead, canRead, canWrite

Methods inherited from class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

getMediaTypesForProblemDetail, setJsonPrefix, setPrefixJson, writePrefix

Methods inherited from class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

customizeReader, customizeWriter, getCharset, getContentLength, getDefaultContentType, getJavaType, getJsonEncoding, getObjectMapper, getObjectMappersForType, getSupportedMediaTypes, logWarningIfNecessary, read, readInternal, registerObjectMappersForType, setObjectMapper, setPrettyPrint, setSupportedMediaTypes, supportsRepeatableWrites, writeSuffix

Methods inherited from class org.springframework.http.converter.AbstractGenericHttpMessageConverter

canWrite, supports, write, writeInternal

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canWrite, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter

getSupportedMediaTypes, read, write

Constructor Details

HalFormsHttpMessageConverter

public HalFormsHttpMessageConverter(BeanFactory factory,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a new HalFormsHttpMessageConverter for the given BeanFactory and ObjectMapper

Parameters:

factory - must not be null.

mapper - must not be null.

Method Details

writeInternal

protected void writeInternal(Object object,
 @Nullable
 Type type,
 HttpOutputMessage outputMessage)
                      throws IOException,
HttpMessageNotWritableException

Overrides:

writeInternal in class AbstractJackson2HttpMessageConverter

Throws:

IOException

HttpMessageNotWritableException