Package org.springframework.hateoas.config

Interface HypermediaMappingInformation

All Known Implementing Classes:
HalMediaTypeConfiguration
public interface HypermediaMappingInformation
Interface for registering custom hypermedia handlers.
Author:
Greg Turnquist, Oliver Drotbohm

  • Method Summary

    Modifier and Type
    Method
    Description
    default com.fasterxml.jackson.databind.ObjectMapper
    configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
    Configure an ObjectMapper and register custom serializers and deserializers for the supported media types.
    default com.fasterxml.jackson.databind.Module
    getJacksonModule()
    Optionally return the Jackson Module to be used to customize the serialization of representation models.
    List<MediaType>
    getMediaTypes()
    All MediaTypes this hypermedia can handle.
    default Class<?>
    getRootType()
    Return the type that this hypermedia type is represented by.

  • Method Details

    • getMediaTypes

      List<MediaType> getMediaTypes()
      All MediaTypes this hypermedia can handle.
      Returns:

    • getRootType

      default Class<?> getRootType()
      Return the type that this hypermedia type is represented by. Default implementation returns RepresentationModel as it's the base class most media type serializations work with.
      Returns:
      the type that this hypermedia type is represented by.
      Since:
      1.1

    • configureObjectMapper

      default com.fasterxml.jackson.databind.ObjectMapper configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
      Configure an ObjectMapper and register custom serializers and deserializers for the supported media types. If all you want to do is register a Jackson Module, prefer implementing getJacksonModule().
      Returns:
      See Also:

    • getJacksonModule

      @Nullable default com.fasterxml.jackson.databind.Module getJacksonModule()
      Optionally return the Jackson Module to be used to customize the serialization of representation models. Override this if there's nothing but the module to be done to setup the ObjectMapper. For more advanced needs, see configureObjectMapper(ObjectMapper).
      Returns:
      See Also: