com.xatkit.core.platform.action

Class RestGetAction<T extends RuntimePlatform>

java.lang.Object

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

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

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

Type Parameters:

T - the RuntimePlatform subclass containing this RestGetAction

All Implemented Interfaces:

Callable<RuntimeActionResult>

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

A generic REST GET action.

This class extends the generic RestAction and provides an utility constructor to create GET request.

Nested Class Summary

Nested classes/interfaces inherited from class com.xatkit.core.platform.action.RestAction

RestAction.MethodKind

Field Summary

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

headers, jsonContent, method, params, restEndpoint

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

runtimePlatform, session

Constructor Summary

Constructors

Constructor and Description
RestGetAction(T runtimePlatform, XatkitSession session, Map<String,String> headers, String restEndpoint, Map<String,Object> params) Constructs a new RestGetAction.

Method Summary

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

compute, getJsonBody, getStringBody, handleResponse

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

Constructor Detail

RestGetAction

public RestGetAction(T runtimePlatform,
                     XatkitSession session,
                     Map<String,String> headers,
                     String restEndpoint,
                     Map<String,Object> params)

Constructs a new RestGetAction.

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

Parameters:

runtimePlatform - the RuntimePlatform containing this action

session - the XatkitSession associated to this action

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

Throws:

NullPointerException - if the provided runtimePlatform or session is null

IllegalArgumentException - if the provided restEndpoint is null or empty