io.cortical.services.api.client

Class ApiInvoker

java.lang.Object

io.cortical.services.api.client.ApiInvoker

public class ApiInvoker
extends Object

Generated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiInvoker.NestedContent

Constructor Summary

Constructors

Constructor and Description
ApiInvoker()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefaultHeader(String key, String value) Allows adding default headers to requests.
static Object	deserialize(String json, String containerType, Class cls, ApiInvoker.NestedContent nestedContent) Deserialize a received response String.
String	escapeString(String str) String escaping.
static ApiInvoker	getInstance() Allows retrieving an instance of ApiInvoker.
Object	invokeAPI(String host, String path, String method, Map<String,String> queryParams, Object body, Map<String,String> headerParams, String contentType) Serialize an Object.
static String	serialize(Object obj) Serialize an Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiInvoker

public ApiInvoker()

Method Detail

getInstance

public static ApiInvoker getInstance()

Allows retrieving an instance of ApiInvoker.

Returns:

a ApiInvoker object.

addDefaultHeader

public void addDefaultHeader(String key,
                    String value)

Allows adding default headers to requests.

Parameters:

key - the key

value - the value

escapeString

public String escapeString(String str)

String escaping.

Parameters:

str - the String to escape

deserialize

public static Object deserialize(String json,
                 String containerType,
                 Class cls,
                 ApiInvoker.NestedContent nestedContent)
                          throws ApiException

Deserialize a received response String.

Parameters:

json - the received json String

containerType - the containerType

cls - the class of the object

nestedContent - contains the name of the Pojo, contained in a List of Lists. null if no nested content is present.

Throws:

APIException - if an exception occurs during deserialization

ApiException

serialize

public static String serialize(Object obj)
                        throws ApiException

Serialize an Object.

Parameters:

obj - the Object to serialize

Throws:

APIException - if an exception occurs during serialization

ApiException

invokeAPI

public Object invokeAPI(String host,
               String path,
               String method,
               Map<String,String> queryParams,
               Object body,
               Map<String,String> headerParams,
               String contentType)
                 throws ApiException

Serialize an Object.

Parameters:

host - the targeted host

path - the targeted rest endpoint

method - the HTTP method

queryParams - the query parameters

body - the obligatory body of a post

headerParams - the HTTP header parameters

contentType - the content type

Throws:

APIException - if an exception occurs during querying of the API.

ApiException