Module io.helidon.media.jsonp.server

Package io.helidon.media.jsonp.server

Class JsonSupport

java.lang.Object

io.helidon.media.jsonp.server.JsonSupport

All Implemented Interfaces:

Handler, Service, BiConsumer<ServerRequest,ServerResponse>

public final class JsonSupport
extends Object
implements Service, 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 create() or create(io.helidon.media.jsonp.common.JsonProcessing) to acquire an instance.

Usage with Routing

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

 Routing.builder()
        .register(JsonSupport.create())
        .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.create())
        .post("/foo/bar", ...) // It can use JSON structures
        .get("/foo/bar", ...);  // It can NOT use JSON structures
 

See Also:

Routing, JsonStructure, JsonpBodyReader, JsonpBodyWriter

Nested Class Summary

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

Handler.EntityHandler<T>

Method Summary

Modifier and Type	Method	Description
void	accept(ServerRequest request, ServerResponse response)	Handles request and response usually called from the Routing.
static JsonSupport	create()	Returns a singleton instance of JsonSupport with default configuration.
static JsonSupport	create(JsonProcessing processing)	Create a JsonSupport with customized processing configuration.
void	update(Routing.Rules rules)	Updates Routing.Rules with handlers representing this service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiConsumer

andThen

Method Detail

update

public void update(Routing.Rules rules)

Description copied from interface: Service

Updates Routing.Rules with handlers representing this service.

Specified by:

update in interface Service

Parameters:

rules - a routing rules to update

accept

public void accept(ServerRequest request,
                   ServerResponse response)

Description copied from interface: Handler

Handles request and response usually called from the Routing.

Specified by:

accept in interface BiConsumer<ServerRequest,ServerResponse>

Specified by:

accept in interface Handler

Parameters:

request - an HTTP server request.

response - an HTTP server response.

create

public static JsonSupport create()

Returns a singleton instance of JsonSupport with default configuration.

Use create(io.helidon.media.jsonp.common.JsonProcessing) method to create a new instance with specific configuration.

Returns:

a singleton instance with default configuration

create

public static JsonSupport create(JsonProcessing processing)

Create a JsonSupport with customized processing configuration.

Parameters:

processing - processing to get JSON-P readers and writers

Returns:

JsonSupport to register with web server

See Also:

JsonProcessing.builder()