Package org.springframework.data.rest.webmvc.alps

Class AlpsJacksonJsonHttpMessageConverter

java.lang.Object

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

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

org.springframework.http.converter.AbstractJacksonHttpMessageConverter<tools.jackson.databind.json.JsonMapper>

org.springframework.http.converter.json.JacksonJsonHttpMessageConverter

org.springframework.data.rest.webmvc.alps.AlpsJacksonJsonHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<Object>, SmartHttpMessageConverter<Object>, ResponseBodyAdvice<Object>

public class AlpsJacksonJsonHttpMessageConverter
extends JacksonJsonHttpMessageConverter
implements ResponseBodyAdvice<Object>

HttpMessageConverter to render Alps and RootResourceInformation instances as application/alps+json.

Since:

5.0

Author:

Mark Paluch, Oliver Gierke, Greg Turnquist

Field Summary

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

defaultMapper

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

logger

Constructor Summary

Constructors

Constructor	Description
AlpsJacksonJsonHttpMessageConverter(RootResourceInformationToAlpsDescriptorConverter converter)	Creates a new AlpsJacksonJsonHttpMessageConverter for the given RootResourceInformationToAlpsDescriptorConverter.
AlpsJacksonJsonHttpMessageConverter(tools.jackson.databind.json.JsonMapper objectMapper, RootResourceInformationToAlpsDescriptorConverter converter)	Creates a new AlpsJacksonJsonHttpMessageConverter for the given JsonMapper and RootResourceInformationToAlpsDescriptorConverter.

Method Summary

Modifier and Type	Method	Description
@Nullable Object	beforeBodyWrite(@Nullable Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response)
boolean	canRead(ResolvableType type, @Nullable MediaType mediaType)
boolean	canWrite(ResolvableType type, Class<?> clazz, @Nullable MediaType mediaType)
boolean	supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType)

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

getMediaTypesForProblemDetail, setJsonPrefix, setPrefixJson, writePrefix

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

customizeReader, customizeWriter, getCharset, getJavaType, getJsonEncoding, getMapper, getMappersForType, getSupportedMediaTypes, read, readInternal, registerMappersForType, setSupportedMediaTypes, supportsRepeatableWrites, writeInternal, writeSuffix

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

canRead, canWrite, supports, write, writeInternal

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

addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, 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

Methods inherited from interface org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice

determineWriteHints

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

read, write

Constructor Details

AlpsJacksonJsonHttpMessageConverter

public AlpsJacksonJsonHttpMessageConverter(RootResourceInformationToAlpsDescriptorConverter converter)

Creates a new AlpsJacksonJsonHttpMessageConverter for the given RootResourceInformationToAlpsDescriptorConverter.

Parameters:

converter - must not be null.

AlpsJacksonJsonHttpMessageConverter

public AlpsJacksonJsonHttpMessageConverter(tools.jackson.databind.json.JsonMapper objectMapper,
 RootResourceInformationToAlpsDescriptorConverter converter)

Creates a new AlpsJacksonJsonHttpMessageConverter for the given JsonMapper and RootResourceInformationToAlpsDescriptorConverter.

Parameters:

objectMapper - must not be null.

converter - must not be null.

Method Details

canWrite

public boolean canWrite(ResolvableType type,
 Class<?> clazz,
 @Nullable MediaType mediaType)

Specified by:

canWrite in interface SmartHttpMessageConverter<Object>

Overrides:

canWrite in class AbstractJacksonHttpMessageConverter<tools.jackson.databind.json.JsonMapper>

canRead

public boolean canRead(ResolvableType type,
 @Nullable MediaType mediaType)

Specified by:

canRead in interface SmartHttpMessageConverter<Object>

Overrides:

canRead in class AbstractJacksonHttpMessageConverter<tools.jackson.databind.json.JsonMapper>

beforeBodyWrite

public @Nullable Object beforeBodyWrite(@Nullable Object body,
 MethodParameter returnType,
 MediaType selectedContentType,
 Class<? extends HttpMessageConverter<?>> selectedConverterType,
 ServerHttpRequest request,
 ServerHttpResponse response)

Specified by:

beforeBodyWrite in interface ResponseBodyAdvice<Object>

supports

public boolean supports(MethodParameter returnType,
 Class<? extends HttpMessageConverter<?>> converterType)

Specified by:

supports in interface ResponseBodyAdvice<Object>