com.xatkit.core.platform.action

Class RestAction<T extends RuntimePlatform>

java.lang.Object

com.xatkit.core.platform.action.RuntimeAction<T>

com.xatkit.core.platform.action.RestAction<T>

Type Parameters:

T - the RuntimePlatform subclass containing this RestAction

All Implemented Interfaces:

Callable<RuntimeActionResult>

Direct Known Subclasses:

RestGetAction, RestPostAction

public abstract class RestAction<T extends RuntimePlatform>
extends RuntimeAction<T>

A generic REST action.

This action provides the execution logic to compute GET and POST REST requests over a provided endpoint. Request parameters, headers, and body can be specified through the constructor parameters.

Note: this class assumes that the requested REST API expects nothing or JSON in the query body. This class also expects that the API response contains an empty body or a JsonElement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestAction.MethodKind The kind of REST methods supported by this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	headers A Map containing user-defined headers to include in the request.
protected com.google.gson.JsonElement	jsonContent The JsonElement to include in the request's body.
protected RestAction.MethodKind	method The RestAction.MethodKind of the request to perform.
protected Map<String,Object>	params A Map containing user-defined parameters to include in the request.
protected String	restEndpoint The REST API endpoint to request.

Fields inherited from class com.xatkit.core.platform.action.RuntimeAction

runtimePlatform, session

Constructor Summary

Constructors

Constructor and Description
RestAction(T runtimePlatform, XatkitSession session, RestAction.MethodKind method, Map<String,String> headers, String restEndpoint, Map<String,Object> params, com.google.gson.JsonElement jsonContent) Constructs a new RestAction.

Method Summary

Modifier and Type	Method and Description
protected Object	compute() Computes the REST request and returned the handled result.
static com.google.gson.JsonElement	getJsonBody(InputStream is) Extracts the JsonElement contained in the provided is.
static String	getStringBody(InputStream is) Extracts the String contained in the provided is.
protected abstract Object	handleResponse(com.mashape.unirest.http.Headers headers, int status, InputStream body) Handles the REST API response and computes the action's results

Methods inherited from class com.xatkit.core.platform.action.RuntimeAction

call, getSession, init

Methods inherited from class java.lang.Object

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

Field Detail

method

protected RestAction.MethodKind method

The RestAction.MethodKind of the request to perform.

headers

protected Map<String,String> headers

A Map containing user-defined headers to include in the request.

This Map is filled with the following template: header_name -> header_value.

restEndpoint

protected String restEndpoint

The REST API endpoint to request.

The provided REST endpoint url must be absolute. Relative endpoint urls are not supported for now.

params

protected Map<String,Object> params

A Map containing user-defined parameters to include in the request.

This Map is filled with the following template param_name -> param_value. Note that the Map's values are Objects in order to support multipart body.

jsonContent

protected com.google.gson.JsonElement jsonContent

The JsonElement to include in the request's body.

This element is only used for POST requests.

Constructor Detail

RestAction

public RestAction(T runtimePlatform,
                  XatkitSession session,
                  RestAction.MethodKind method,
                  @Nullable
                  Map<String,String> headers,
                  String restEndpoint,
                  @Nullable
                  Map<String,Object> params,
                  @Nullable
                  com.google.gson.JsonElement jsonContent)

Constructs a new RestAction.

This method doesn't perform the REST API request, this is done asynchronously in the compute() method.

Parameters:

runtimePlatform - the RuntimePlatform containing this action

session - the XatkitSession associated to this action

method - the REST method to use

headers - the Map of user-defined headers to include in the request

restEndpoint - the REST API endpoint to request

params - the Map of user-defined parameters to include in the request

jsonContent - the JsonElement to include in the request's body

Throws:

NullPointerException - if the provided runtimePlatform or session is null

IllegalArgumentException - if the provided method is null, or if the provided restEndpoint is null or empty

Method Detail

getJsonBody

public static com.google.gson.JsonElement getJsonBody(InputStream is)
                                               throws com.google.gson.JsonSyntaxException

Extracts the JsonElement contained in the provided is.

Parameters:

is - the InputStream to extract the JsonElement from

Returns:

the extracted JsonElement

Throws:

com.google.gson.JsonSyntaxException

getStringBody

public static String getStringBody(InputStream is)

Extracts the String contained in the provided is.

Parameters:

is - the InputStream to extract the String from

Returns:

the extracted String

compute

protected final Object compute()
                        throws Exception

Computes the REST request and returned the handled result.

This method performs the request over the defined REST API, and delegates the result computation to the handleResponse(Headers, int, InputStream) method.

Specified by:

compute in class RuntimeAction<T extends RuntimePlatform>

Returns:

the result of handling the REST API response

Throws:

Exception - if an error occurred when executing the REST request

See Also:

handleResponse(Headers, int, InputStream)

handleResponse

protected abstract Object handleResponse(com.mashape.unirest.http.Headers headers,
                                         int status,
                                         InputStream body)

Handles the REST API response and computes the action's results

This method is overridden in concrete subclasses to implement action-specific behaviors.

Parameters:

headers - the Headers returned by the REST API

status - the status code returned by the REST API

body - the InputStream containing the response body

Returns:

the action's result