Module io.helidon.http.media.jsonp

Package io.helidon.http.media.jsonp

Class JsonpSupport

java.lang.Object

io.helidon.http.media.jsonp.JsonpSupport

All Implemented Interfaces:

RuntimeType.Api<JsonpSupportConfig>, NamedService, MediaSupport

public class JsonpSupport
extends Object
implements MediaSupport, RuntimeType.Api<JsonpSupportConfig>

Media support implementation for JSON Processing media support.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.http.media.MediaSupport

MediaSupport.ReaderResponse<T>, MediaSupport.SupportLevel, MediaSupport.WriterResponse<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final GenericType<JsonArray>	JSON_ARRAY_TYPE	Json array generic type.
static final GenericType<JsonObject>	JSON_OBJECT_TYPE	Json object generic type.

Method Summary

Modifier and Type	Method	Description
static JsonpSupportConfig.Builder	builder()	Creates a new builder.
static MediaSupport	create()	Creates a new JsonpSupport.
static MediaSupport	create(Config config)	Creates a new JsonpSupport.
static MediaSupport	create(Config config, String name)	Creates a new named JsonpSupport.
static JsonpSupport	create(JsonpSupportConfig jsonpSupportConfig)	Creates a new JsonpSupport based on the JsonpSupportConfig.
static JsonpSupport	create(Consumer<JsonpSupportConfig.Builder> consumer)	Creates a new customized JsonpSupport.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
JsonpSupportConfig	prototype()	The prototype as it was received when creating this runtime object instance.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders)	Reader for an entity.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)	Client response reader.
static <T extends JsonStructure> EntityReader<T>	serverRequestReader()	Server request reader direct access.
static <T extends JsonStructure> EntityWriter<T>	serverResponseWriter()	Server response writer direct access.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Server response writer.
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, WritableHeaders<?> requestHeaders)	Client request writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.http.media.MediaSupport

init

Field Details

JSON_OBJECT_TYPE

public static final GenericType<JsonObject> JSON_OBJECT_TYPE

Json object generic type.

JSON_ARRAY_TYPE

public static final GenericType<JsonArray> JSON_ARRAY_TYPE

Json array generic type.

Method Details

create

public static MediaSupport create()

Creates a new JsonpSupport.

Returns:

a new JsonpSupport

create

public static MediaSupport create(Config config)

Creates a new JsonpSupport.

Parameters:

config - must not be null

Returns:

a new JsonpSupport

create

public static MediaSupport create(Config config,
 String name)

Creates a new named JsonpSupport.

Parameters:

config - must not be null

name - name of the support

Returns:

a new JsonpSupport

create

public static JsonpSupport create(JsonpSupportConfig jsonpSupportConfig)

Creates a new JsonpSupport based on the JsonpSupportConfig.

Parameters:

jsonpSupportConfig - must not be null

Returns:

a new JsonpSupport

create

public static JsonpSupport create(Consumer<JsonpSupportConfig.Builder> consumer)

Creates a new customized JsonpSupport.

Parameters:

consumer - config builder consumer

Returns:

a new JsonpSupport

builder

public static JsonpSupportConfig.Builder builder()

Creates a new builder.

Returns:

a new builder instance

serverResponseWriter

public static <T extends JsonStructure>
EntityWriter<T> serverResponseWriter()

Server response writer direct access.

Type Parameters:

T - type to write

Returns:

a writer to write JSON-P objects

serverRequestReader

public static <T extends JsonStructure>
EntityReader<T> serverRequestReader()

Server request reader direct access.

Type Parameters:

T - type to read

Returns:

a reader to read JSON-P objects

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders)

Description copied from interface: MediaSupport

Reader for an entity.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - headers belonging to this entity (such as server request headers), expected to have content type

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 Headers requestHeaders,
 WritableHeaders<?> responseHeaders)

Description copied from interface: MediaSupport

Server response writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

writer response, whether this type is supported or not

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders,
 Headers responseHeaders)

Description copied from interface: MediaSupport

Client response reader.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 WritableHeaders<?> requestHeaders)

Description copied from interface: MediaSupport

Client request writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

Returns:

writer response, whether this type is supported or not

prototype

public JsonpSupportConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<JsonpSupportConfig>

Returns:

prototype object used to create this instance