Module io.helidon.http.media.jackson
Package io.helidon.http.media.jackson

Interface JacksonSupportConfig

All Superinterfaces:
MediaSupportConfig, Prototype.Api, Prototype.Factory<JacksonSupport>
All Known Implementing Classes:
JacksonSupportConfig.BuilderBase.JacksonSupportConfigImpl
public interface JacksonSupportConfig extends Prototype.Api, MediaSupportConfig
Configuration of the JacksonSupport.
See Also:

  • Method Details

    • builder

      static JacksonSupportConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static JacksonSupportConfig.Builder builder(JacksonSupportConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static JacksonSupportConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      @Deprecated static JacksonSupportConfig create(Config config)
      Deprecated.
      use create(io.helidon.config.Config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static JacksonSupportConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • objectMapper

      ObjectMapper objectMapper()
      Jackson ObjectMapper instance.
      Returns:
      jackson object mapper instance

    • properties

      Map<String,Boolean> properties()
      Jackson configuration properties. Properties are being ignored if specific JacksonSupport is set. Only boolean configuration values are supported.
      Returns:
      jackson config properties

    • name

      String name()
      Description copied from interface: MediaSupportConfig
      Name of the support. Each extension should provide its own default. This is to enable multiple instance of the same type.
      Specified by:
      name in interface MediaSupportConfig
      Returns:
      name of the support

    • acceptedMediaTypes

      Set<MediaType> acceptedMediaTypes()
      Types accepted by this media support. When server processes the response, it checks the Accept header, to choose the right media support, if there are more supports available for the provided entity object.

      Supported accepted types defaults to "application/json", and "application/json-patch+json".

      Specified by:
      acceptedMediaTypes in interface MediaSupportConfig
      Returns:
      accepted media types

    • contentType

      HttpMediaType contentType()
      Content type to use if not configured (in response headers for server, and in request headers for client).
      Specified by:
      contentType in interface MediaSupportConfig
      Returns:
      content type to use, defaults to HttpMediaTypes.JSON