com.coscale.sdk.client

Class ApiClient

java.lang.Object

com.coscale.sdk.client.ApiClient

public class ApiClient
extends Object

ApiClient is used to make HTTP requests to CoScale API client

Author:

cristi

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_API_BASE_URL The default API base URL.
static String	DEFAULT_USER_AGENT The default user agent.

Constructor Summary

Constructors

Constructor and Description
ApiClient(String appId, Credentials credentials) ApiClient constructor.
ApiClient(String appId, Credentials credentials, String agentString) ApiClient Constructor.
ApiClient(String appId, Credentials credentials, String agentString, String apiBaseURL) ApiClient constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	call(String method, String url, Object obj, com.fasterxml.jackson.core.type.TypeReference<T> valueType, boolean auth, boolean binary) call is used to make a API call.
<T> T	callWithAuth(String method, String endpoint, Object obj, com.fasterxml.jackson.core.type.TypeReference<T> valueType) callWithAuth is used to make requests that require Authentication on CoScale API.
<T> T	callWithAuthBinary(String method, String endpoint, BinaryData data, com.fasterxml.jackson.core.type.TypeReference<T> valueType, boolean binary) callWithAuthBinary is used to make requests that require Authentication on CoScale API.
String	doHttpRequestBinary(String method, String uri, BinaryData payload, boolean authenticate) Do an HTTP request with a binary upload in it.
String	getApiPath() getApiPath is used to get the API path.
String	getApiVersion() getApiVersion is used to get the API version which will be used to build the request URL.
String	getAppRequestURL(String endpoint) getAppRequestURL will construct the URL for a request using the end point provided.
String	getBaseURL() getBaseURL is used to get the CoScale API domain.
int	getConnectionTimeout() return the default connection timeout in ms.
int	getDeserializationExceptions() getDeserializationExceptions is used to get the number of JSON deserialization errors.
String	getGlobalRequestURL(String endpoint) getGlobalRequestURL will construct the URL for a request using the end point provided.
int	getReadTimeout() return the default read timeout in ms.
String	getRequesUrl(String endpoint, Options options, boolean globalApi) getRequesUrl will build the URL for a request using the end point provided.
static String	getSource() Get the SOURCE String which mark the created resources.
void	setBaseURL(String url) setBaseURL is used to set a new API base URL.
void	setConnectionTimeout(int timeout) Change the default connection timeout.
void	setReadTimeout(int timeout) Change the default read timeout.
static void	setSource(String source) Set the Source String which mark the created resources.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_API_BASE_URL

public static final String DEFAULT_API_BASE_URL

The default API base URL.

See Also:

Constant Field Values

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

The default user agent.

See Also:

Constant Field Values

Constructor Detail

ApiClient

public ApiClient(String appId,
         Credentials credentials,
         String agentString,
         String apiBaseURL)

ApiClient constructor.

Parameters:

appId - The CoScale Application id.

credentials - Api authentication information.

agentString - HTTP "User-Agent" header.

apiBaseURL - The API base url, eg. https://api.coscale.com

ApiClient

public ApiClient(String appId,
         Credentials credentials,
         String agentString)

ApiClient Constructor.

Parameters:

appId - The CoScale Application id.

credentials - API authentication informations.

agentString - HTTP "User-Agent" header

ApiClient

public ApiClient(String appId,
         Credentials credentials)

ApiClient constructor.

Parameters:

appId - The CoScale Application id.

credentials - Api authentication informations.

Method Detail

getApiPath

public String getApiPath()

getApiPath is used to get the API path.

Returns:

String containing the API path.

getApiVersion

public String getApiVersion()

getApiVersion is used to get the API version which will be used to build the request URL.

Returns:

String containing the API version.

getBaseURL

public String getBaseURL()

getBaseURL is used to get the CoScale API domain.

Returns:

String containing the CoScale domain.

setBaseURL

public void setBaseURL(String url)

setBaseURL is used to set a new API base URL. Is for Testing purpose.

Parameters:

url -

getConnectionTimeout

public int getConnectionTimeout()

return the default connection timeout in ms.

Returns:

int connection timeout value.

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Change the default connection timeout.

Parameters:

timeout - in ms.

getReadTimeout

public int getReadTimeout()

return the default read timeout in ms.

Returns:

int read timeout value.

setReadTimeout

public void setReadTimeout(int timeout)

Change the default read timeout.

Parameters:

timeout - in ms.

getSource

public static String getSource()

Get the SOURCE String which mark the created resources.

Returns:

String source value.

setSource

public static void setSource(String source)

Set the Source String which mark the created resources.

Parameters:

source -

getDeserializationExceptions

public int getDeserializationExceptions()

getDeserializationExceptions is used to get the number of JSON deserialization errors.

Returns:

integer representing the number of JSON deserialization errors.

callWithAuth

public <T> T callWithAuth(String method,
                 String endpoint,
                 Object obj,
                 com.fasterxml.jackson.core.type.TypeReference<T> valueType)
               throws IOException

callWithAuth is used to make requests that require Authentication on CoScale API.

Parameters:

method - request HTTP method.

endpoint - The url for the request.

obj - object with data for the request. This parameter can be null.

valueType - is the type expected.

Returns:

The Object received as a result for the request.

Throws:

IOException

callWithAuthBinary

public <T> T callWithAuthBinary(String method,
                       String endpoint,
                       BinaryData data,
                       com.fasterxml.jackson.core.type.TypeReference<T> valueType,
                       boolean binary)
                     throws IOException

callWithAuthBinary is used to make requests that require Authentication on CoScale API.

Parameters:

method - request HTTP method.

endpoint - The url for the request.

data - object with data for the request. This parameter can be null.

valueType - is the type expected.

binary - is the action a binary upload.

Returns:

The Object received as a result for the request.

Throws:

IOException

call

public <T> T call(String method,
         String url,
         Object obj,
         com.fasterxml.jackson.core.type.TypeReference<T> valueType,
         boolean auth,
         boolean binary)
       throws IOException

call is used to make a API call.

Parameters:

method - request HTTP method.

url - for the request.

obj - object with data for the request. This parameter can be null.

valueType - is the type expected.

Returns:

The Object received as a result for the request.

Throws:

IOException

doHttpRequestBinary

public String doHttpRequestBinary(String method,
                         String uri,
                         BinaryData payload,
                         boolean authenticate)
                           throws IOException

Do an HTTP request with a binary upload in it.

Parameters:

method - The method

uri - The url

payload - The object with the data

authenticate - The authentication token.

Returns:

String response for the request.

Throws:

IOException

getAppRequestURL

public String getAppRequestURL(String endpoint)

getAppRequestURL will construct the URL for a request using the end point provided. This method will be used to construct the URL for a specific application since the resulted URL will contain the application Id.

Parameters:

endpoint - String representing the API end point of the request.

Returns:

String containing the URL.

getGlobalRequestURL

public String getGlobalRequestURL(String endpoint)

getGlobalRequestURL will construct the URL for a request using the end point provided. This will generate a URL for requests that doesn't contain the application Id. Should be used for example in login process.

Parameters:

endpoint - String representing the API end point of the request.

Returns:

String containing the URL.

getRequesUrl

public String getRequesUrl(String endpoint,
                  Options options,
                  boolean globalApi)

getRequesUrl will build the URL for a request using the end point provided.

Parameters:

endpoint - String representing the API end point of the request.

options - Optional query parameters

globalApi - if is set true, application Id will not be include into URL.

Returns:

String generated request url.