Package io.helidon.webserver.json

Class JsonSupport

java.lang.Object

io.helidon.webserver.json.JsonSupport

All Implemented Interfaces:

io.helidon.webserver.Handler, io.helidon.webserver.Service, java.util.function.BiConsumer<io.helidon.webserver.ServerRequest,io.helidon.webserver.ServerResponse>

public final class JsonSupport
extends java.lang.Object
implements io.helidon.webserver.Service, io.helidon.webserver.Handler

It provides contains JSON-P (javax.json) support for WebServer's Routing. It is intended to provide readers and writers for javax.json objects such as JsonObject or JsonArray. If registered on the Web Server Routing, then all Handlers can use ServerRequest.content(). as(...) and ServerResponse.send() with JSON objects.

Get Instance

Use factory methods get() or create(Map) to acquire an instance.

Usage with Routing

JsonSupport should be registered on the routing before any business logic handlers.

 Routing.builder()
        .register(JsonSupport.get())
        .etc.... // Business logic related handlers
 

Instance behaves also as a routing filter. It means that it can be registered on any routing rule (for example HTTP method) and then it can be used in following handlers with compatible rules.

 // Register JsonSupport only for POST of 'foo'
 Routing.builder()
        .post("/foo/{}", JsonSupport.get())
        .post("/foo/bar", ...) // It can use JSON structures
        .get("/foo/bar", ...);  // It can NOT use JSON structures
 

See Also:

Routing, JsonStructure, JsonReader, JsonWriter

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.Handler

io.helidon.webserver.Handler.EntityHandler<T extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
void	accept(io.helidon.webserver.ServerRequest request, io.helidon.webserver.ServerResponse response)	It registers reader and writer for JsonSupport on ServerRequest/ServerResponse on provided routing criteria.
static JsonSupport	create(java.util.Map<java.lang.String,?> config)	Returns an instance of JsonSupport with provided configuration.
static JsonSupport	get()	Returns a singleton instance of JsonSupport with default configuration.
io.helidon.common.http.Reader<javax.json.JsonStructure>	reader()	Returns a function (reader) converting Publisher of ByteBuffers to a JSON-P object.
io.helidon.common.http.Reader<javax.json.JsonStructure>	reader(java.nio.charset.Charset charset)	Returns a function (reader) converting Publisher of ByteBuffers to a JSON-P object.
void	update(io.helidon.webserver.Routing.Rules routingRules)	It registers reader and writer for JsonSupport on ServerRequest/ServerResponse for any HTTP method.
java.util.function.Function<javax.json.JsonStructure,io.helidon.common.reactive.Flow.Publisher<io.helidon.common.http.DataChunk>>	writer()	Returns a function (writer) converting JsonStructure to the Publisher of DataChunks.
java.util.function.Function<javax.json.JsonStructure,io.helidon.common.reactive.Flow.Publisher<io.helidon.common.http.DataChunk>>	writer(java.nio.charset.Charset charset)	Returns a function (writer) converting JsonStructure to the Publisher of DataChunks.

Methods inherited from interface java.util.function.BiConsumer

andThen

Methods inherited from interface io.helidon.webserver.Handler

of, of

Methods inherited from class java.lang.Object

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

Method Detail

update

public void update(io.helidon.webserver.Routing.Rules routingRules)

It registers reader and writer for JsonSupport on ServerRequest/ServerResponse for any HTTP method.

This method is called from Routing during build process. The user should register whole class ot the routing: Routing.builder().register(JsonSupport.get()).

Specified by:

update in interface io.helidon.webserver.Service

Parameters:

routingRules - a routing configuration where JSON support should be registered

See Also:

Routing

accept

public void accept(io.helidon.webserver.ServerRequest request,
                   io.helidon.webserver.ServerResponse response)

It registers reader and writer for JsonSupport on ServerRequest/ServerResponse on provided routing criteria.

This method is called from Routing during build process. The user should register whole class ot the routing criteria. For example: Routing.builder(). post("/foo", JsonSupport.get()).

It calls ServerRequest.next() method to invoke following handlers with particular business logic.

Specified by:

accept in interface java.util.function.BiConsumer<io.helidon.webserver.ServerRequest,io.helidon.webserver.ServerResponse>

Specified by:

accept in interface io.helidon.webserver.Handler

Parameters:

request - a server request

response - a server response

See Also:

Routing

reader

public io.helidon.common.http.Reader<javax.json.JsonStructure> reader(java.nio.charset.Charset charset)

Returns a function (reader) converting Publisher of ByteBuffers to a JSON-P object.

It is intended for derivation of others, more specific readers.

Parameters:

charset - a charset to use or null for default charset

Returns:

the byte array content reader that transforms a publisher of byte buffers to a completion stage that might end exceptionally with a IllegalArgumentException in case of I/O error or a JsonException

reader

public io.helidon.common.http.Reader<javax.json.JsonStructure> reader()

Returns a function (reader) converting Publisher of ByteBuffers to a JSON-P object.

It is intended for derivation of others, more specific readers.

Returns:

the byte array content reader that transforms a publisher of byte buffers to a completion stage that might end exceptionally with a IllegalArgumentException in case of I/O error or a JsonException

writer

public java.util.function.Function<javax.json.JsonStructure,io.helidon.common.reactive.Flow.Publisher<io.helidon.common.http.DataChunk>> writer(java.nio.charset.Charset charset)

Returns a function (writer) converting JsonStructure to the Publisher of DataChunks.

Parameters:

charset - a charset to use or null for default charset

Returns:

created function

writer

public java.util.function.Function<javax.json.JsonStructure,io.helidon.common.reactive.Flow.Publisher<io.helidon.common.http.DataChunk>> writer()

Returns a function (writer) converting JsonStructure to the Publisher of DataChunks.

Returns:

created function

get

public static JsonSupport get()

Returns a singleton instance of JsonSupport with default configuration.

Use create(Map) method to create a new instance with specific configuration.

Returns:

a singleton instance with default configuration

create

public static JsonSupport create(java.util.Map<java.lang.String,?> config)

Returns an instance of JsonSupport with provided configuration. If configuration is null or empty then returns a singleton.

Parameters:

config - a configuration for Json factory methods

Returns:

an instance with provided configuration