Module io.helidon.http.media.json

Package io.helidon.http.media.json

Interface JsonSupportConfig

All Superinterfaces:

MediaSupportConfig, Prototype.Api, Prototype.Factory<JsonSupport>

All Known Implementing Classes:

JsonSupportConfig.BuilderBase.JsonSupportConfigImpl

public interface JsonSupportConfig
extends Prototype.Api, MediaSupportConfig

Configuration of Helidon JSON media support.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JsonSupportConfig.Builder	Fluent API builder for JsonSupport.
static class	JsonSupportConfig.BuilderBase<BUILDER extends JsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JsonSupportConfig>	Fluent API builder base for JsonSupportConfig.

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	acceptedMediaTypes()	Types accepted by this media support.
static JsonSupportConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static JsonSupportConfig.Builder	builder(JsonSupportConfig instance)	Create a new fluent API builder from an existing instance.
HttpMediaType	contentType()	Content type to use if not configured (in response headers for server, and in request headers for client).
static JsonSupportConfig	create()	Create a new instance with default values.
static JsonSupportConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static JsonSupportConfig	create(Config config)	Create a new instance from configuration.
String	name()	Name of the support.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Method Details

builder

static JsonSupportConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static JsonSupportConfig.Builder builder(JsonSupportConfig 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 JsonSupportConfig 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 JsonSupportConfig 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 JsonSupportConfig create()

Create a new instance with default values.

Returns:

a new 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_UTF_8