com.cosmian

Class RestClient

java.lang.Object

com.cosmian.RestClient

public class RestClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
RestClient(String server_url, Optional<String> api_key) Instantiate a new REST Client with DEFAULT_CONNECT_TIMEOUT and DEFAULT_READ_TIMEOUT
RestClient(String server_url, Optional<String> api_key, int connection_timeout, int read_timeout) Instantiate a new REST Client

Method Summary

Modifier and Type	Method and Description
String	json_get(String path) Perform a GET request returning JSON
String	json_post(String path, String payload) Perform a JSON POST request returning JSON

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

RestClient

public RestClient(String server_url,
                  Optional<String> api_key,
                  int connection_timeout,
                  int read_timeout)

Instantiate a new REST Client

Parameters:

server_url - the REST Server URL e.g. http://localhost:9000

connection_timeout - Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.

read_timeout - Sets the read timeout to a specified timeout, in milliseconds.

api_key - The API Key to use to authenticate

RestClient

public RestClient(String server_url,
                  Optional<String> api_key)

Instantiate a new REST Client with DEFAULT_CONNECT_TIMEOUT and DEFAULT_READ_TIMEOUT

Parameters:

server_url - the REST Server URL e.g. http://localhost:9000

api_key - he optional API Key to use to authenticate

Method Detail

json_get

public String json_get(String path)
                throws RestException

Perform a GET request returning JSON

Parameters:

path - the REST service path and query parameters answering the GET request

Returns:

the JSON response

Throws:

RestException - on any REST error

json_post

public String json_post(String path,
                        String payload)
                 throws RestException

Perform a JSON POST request returning JSON

Parameters:

path - the REST service path and query parameters answering the POST request

payload - the JSON payload passed as the body of the POST request

Returns:

the JSON response

Throws:

RestException - on any REST error