Package org.springframework.hateoas.server.mvc

Class TypeConstrainedJacksonJsonHttpMessageConverter

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.hateoas.server.mvc.TypeConstrainedJacksonJsonHttpMessageConverter
All Implemented Interfaces:
org.springframework.http.converter.HttpMessageConverter<Object>, org.springframework.http.converter.SmartHttpMessageConverter<Object>
Direct Known Subclasses:
HalFormsHttpMessageConverter
public class TypeConstrainedJacksonJsonHttpMessageConverter extends org.springframework.http.converter.json.JacksonJsonHttpMessageConverter
Extension of MappingJackson2HttpMessageConverter to constrain the ability to read and write HTTP message based on the target type. Useful in case the JsonMapper about to be configured has customizations that shall only be applied to object trees of a certain base type.
Author:
Oliver Gierke

  • 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
    TypeConstrainedJacksonJsonHttpMessageConverter(Class<?> type)
    Creates a new TypeConstrainedMappingJackson2HttpMessageConverter for the given type.
    TypeConstrainedJacksonJsonHttpMessageConverter(Class<?> type, List<org.springframework.http.MediaType> supportedMediaTypes, tools.jackson.databind.json.JsonMapper mapper)
    Convenience constructor to supply all parameters at once.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canRead(Class<?> clazz, @Nullable org.springframework.http.MediaType mediaType)
     
    boolean
    canRead(org.springframework.core.ResolvableType type, @Nullable org.springframework.http.MediaType mediaType)
     
    boolean
    canWrite(org.springframework.core.ResolvableType type, Class<?> clazz, @Nullable org.springframework.http.MediaType mediaType)
     

    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

    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.http.converter.SmartHttpMessageConverter

    read, write

  • Constructor Details

    • TypeConstrainedJacksonJsonHttpMessageConverter

      public TypeConstrainedJacksonJsonHttpMessageConverter(Class<?> type)
      Creates a new TypeConstrainedMappingJackson2HttpMessageConverter for the given type.
      Parameters:
      type - must not be null.

    • TypeConstrainedJacksonJsonHttpMessageConverter

      public TypeConstrainedJacksonJsonHttpMessageConverter(Class<?> type, List<org.springframework.http.MediaType> supportedMediaTypes, tools.jackson.databind.json.JsonMapper mapper)
      Convenience constructor to supply all parameters at once.
      Parameters:
      type -
      supportedMediaTypes -
      mapper -

  • Method Details

    • canRead

      public boolean canRead(Class<?> clazz, @Nullable org.springframework.http.MediaType mediaType)
      Specified by:
      canRead in interface org.springframework.http.converter.HttpMessageConverter<Object>
      Specified by:
      canRead in interface org.springframework.http.converter.SmartHttpMessageConverter<Object>
      Overrides:
      canRead in class org.springframework.http.converter.AbstractSmartHttpMessageConverter<Object>

    • canRead

      public boolean canRead(org.springframework.core.ResolvableType type, @Nullable org.springframework.http.MediaType mediaType)
      Specified by:
      canRead in interface org.springframework.http.converter.SmartHttpMessageConverter<Object>
      Overrides:
      canRead in class org.springframework.http.converter.AbstractJacksonHttpMessageConverter<tools.jackson.databind.json.JsonMapper>

    • canWrite

      public boolean canWrite(org.springframework.core.ResolvableType type, Class<?> clazz, @Nullable org.springframework.http.MediaType mediaType)
      Specified by:
      canWrite in interface org.springframework.http.converter.SmartHttpMessageConverter<Object>
      Overrides:
      canWrite in class org.springframework.http.converter.AbstractJacksonHttpMessageConverter<tools.jackson.databind.json.JsonMapper>