com.xatkit.core.server

Class JsonRestHandler

java.lang.Object

com.xatkit.core.server.RestHandler<com.google.gson.JsonElement>

com.xatkit.core.server.JsonRestHandler

public abstract class JsonRestHandler
extends RestHandler<com.google.gson.JsonElement>

A handler that receives HTTP requests containing JSON and process them.

This class can be used to define REST endpoints from RuntimePlatforms. The endpoint can be registered using the following code:

 
 XatkitServer xatkitServer = [...]
 String restEndpointURI = "/myEndpoint";
 xatkitServer.registerRestEndpoint(HttpMethod.GET, restEndpointURI, RestHandlerFactory.createJsonRestHandler(
  (headers, params, content) -> {
     // Handle the request
     // return an Object that will be embedded in the HTTP response
 }
 
 

See Also:

XatkitServer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonRestHandler.JsonHelper A static class containing utility methods to manipulate Json contents.

Constructor Summary

Constructors

Constructor and Description
JsonRestHandler()

Method Summary

Modifier and Type	Method and Description
boolean	acceptContentType(String contentType) Returns true if the provided contentType represents a Json content, false otherwise.
abstract com.google.gson.JsonElement	handleParsedContent(List<org.apache.http.Header> headers, List<org.apache.http.NameValuePair> params, com.google.gson.JsonElement content) Handles the received headers, params, and JsonElement parsed from the request payload.
protected com.google.gson.JsonElement	parseContent(Object content) Parses the provided raw HTTP request content into a JsonElement.

Methods inherited from class com.xatkit.core.server.RestHandler

getAccessControlAllowHeaders, getHeaderValue, handleContent

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRestHandler

public JsonRestHandler()

Method Detail

acceptContentType

public final boolean acceptContentType(String contentType)

Returns true if the provided contentType represents a Json content, false otherwise.

Specified by:

acceptContentType in class RestHandler<com.google.gson.JsonElement>

Parameters:

contentType - the content type to check

Returns:

true if the provided contentType represents a Json content, false otherwise

parseContent

protected final com.google.gson.JsonElement parseContent(Object content)

Parses the provided raw HTTP request content into a JsonElement.

This method is internally used to fill the handleParsedContent(List, List, JsonElement) parameter with the JsonElement constructed from the raw request content.

Specified by:

parseContent in class RestHandler<com.google.gson.JsonElement>

Parameters:

content - the raw HTTP request content to parse

Returns:

a JsonElement representing the raw request content

Throws:

XatkitException - if the provided content is cannot be parsed by the JsonParser.

See Also:

handleParsedContent(List, List, JsonElement)

handleParsedContent

public abstract com.google.gson.JsonElement handleParsedContent(@Nonnull
                                                                List<org.apache.http.Header> headers,
                                                                @Nonnull
                                                                List<org.apache.http.NameValuePair> params,
                                                                @Nullable
                                                                com.google.gson.JsonElement content)
                                                         throws RestHandlerException

Handles the received headers, params, and JsonElement parsed from the request payload.

Specified by:

handleParsedContent in class RestHandler<com.google.gson.JsonElement>

Parameters:

headers - the HTTP headers of the received request

params - the request parameters

content - the JsonElement representing the content of the HTTP request

Returns:

the JsonElement containing the endpoint response, or null

Throws:

RestHandlerException - if an error occurred when handling the request

See Also:

RestHandler.parseContent(Object), HttpEntityHelper.createHttpEntity(Object)