Module io.helidon.http.media.json.binding
Package io.helidon.http.media.json.binding

Interface JsonBindingSupportConfig

All Superinterfaces:
MediaSupportConfig, Prototype.Api, Prototype.Factory<JsonBindingSupport>
All Known Implementing Classes:
JsonBindingSupportConfig.BuilderBase.JsonBindingSupportConfigImpl
public interface JsonBindingSupportConfig extends Prototype.Api, MediaSupportConfig
Configuration for Helidon JSON Binding media support.

This interface defines the configuration options for the Helidon JSON binding media support, which provides JSON serialization and deserialization capabilities for HTTP requests and responses.

See Also:

  • Method Details

    • builder

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

    • builder

      static JsonBindingSupportConfig.Builder builder(JsonBindingSupportConfig 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 JsonBindingSupportConfig 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 JsonBindingSupportConfig 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 JsonBindingSupportConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • jsonBinding

      JsonBinding jsonBinding()
      JSON binding instance to use for serialization and deserialization.
      Returns:
      JSON binding instance

    • 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