Package com.hyperwallet.clientsdk.util

Class HyperwalletApiClient

java.lang.Object

com.hyperwallet.clientsdk.util.HyperwalletApiClient

public class HyperwalletApiClient
extends Object

The Hyperwallet API Client

Constructor Summary

Constructors

Constructor	Description
HyperwalletApiClient(String username, String password, String version, HyperwalletEncryption hyperwalletEncryption, int connectionTimeout, int readTimeout)	Create a instance of the API client

Method Summary

Modifier and Type	Method	Description
protected void	checkErrorResponse(cc.protea.util.http.Response response)	Evaluates the Response contains Api Server error when HTTP status from 4.x.x and raise HyperwalletException
<T> T	get(String url, com.fasterxml.jackson.core.type.TypeReference<T> type)	Perform a GET call to the Hyperwallet API server
<T> T	get(String url, Class<T> type)	Perform a GET call to the Hyperwallet API server
Proxy	getProxy()	Returns Proxy setting for Authentication
String	getProxyPassword()	Returns Proxy Password for Authentication
String	getProxyUsername()	Returns Proxy Username for Authentication
<T> T	post(String url, Object bodyObject, Class<T> type)	Perform a POST call to the Hyperwallet API server to upload Object
<T> T	post(String url, Object bodyObject, Class<T> type, HashMap<String,String> header)	Perform a POST call to the Hyperwallet API server to upload Object
<T> T	put(String url, Multipart uploadData, Class<T> type)	Perform a PUT call to the Hyperwallet API server to upload Multipart
<T> T	put(String url, Object bodyObject, Class<T> type)	Perform a PUT call to the Hyperwallet API server to upload Object
void	setProxy(String url, Integer port)	Create Proxy setting for API Client instance
void	setProxy(Proxy proxy)	Create Proxy setting for API Client instance
void	setProxyPassword(String proxyPassword)	Create Proxy Password setting for Authentication
void	setProxyUsername(String proxyUsername)	Create Proxy Username for Authentication
Boolean	usesProxy()	Checks if current API Client instance uses a proxy

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperwalletApiClient

public HyperwalletApiClient(String username,
                            String password,
                            String version,
                            HyperwalletEncryption hyperwalletEncryption,
                            int connectionTimeout,
                            int readTimeout)

Create a instance of the API client

Parameters:

username - the API username

password - the API password

version - the SDK version

hyperwalletEncryption - the HyperwalletEncryption

connectionTimeout - the timeout value that will be used for making new connections to the Hyperwallet API (in milliseconds).

readTimeout - the timeout value that will be used when reading data from an established connection to the Hyperwallet API (in milliseconds).

Method Detail

get

public <T> T get(String url,
                 Class<T> type)

Perform a GET call to the Hyperwallet API server

Type Parameters:

T - Response class type

Parameters:

url - The api endpoint to call

type - The response class type

Returns:

an instance of response class type

get

public <T> T get(String url,
                 com.fasterxml.jackson.core.type.TypeReference<T> type)

Perform a GET call to the Hyperwallet API server

Type Parameters:

T - Response class type

Parameters:

url - The api endpoint to call

type - The response TypeReference type

Returns:

an instance of TypeReference

put

public <T> T put(String url,
                 Multipart uploadData,
                 Class<T> type)

Perform a PUT call to the Hyperwallet API server to upload Multipart

Type Parameters:

T - Response class type

Parameters:

url - The api endpoint to call

uploadData - The Multipart

type - The response class type

Returns:

an instance of response class type

put

public <T> T put(String url,
                 Object bodyObject,
                 Class<T> type)

Perform a PUT call to the Hyperwallet API server to upload Object

Type Parameters:

T - Response class type

Parameters:

url - The api endpoint to call

bodyObject - The Object body

type - The response class type

Returns:

an instance of response class type

post

public <T> T post(String url,
                  Object bodyObject,
                  Class<T> type)

Perform a POST call to the Hyperwallet API server to upload Object

Type Parameters:

T - Response class type

Parameters:

url - The api endpoint to call

bodyObject - The Object body

type - The response class type

Returns:

an instance of response class type

post

public <T> T post(String url,
                  Object bodyObject,
                  Class<T> type,
                  HashMap<String,String> header)

Perform a POST call to the Hyperwallet API server to upload Object

Type Parameters:

T - Response class type

Parameters:

url - The api endpoint to call

bodyObject - The Object body

type - The response class type

header - HTTP header properties

Returns:

an instance of response class type

usesProxy

public Boolean usesProxy()

Checks if current API Client instance uses a proxy

Returns:

Boolean if client has a proxy config

setProxy

public void setProxy(String url,
                     Integer port)

Create Proxy setting for API Client instance

Parameters:

url - url of Proxy

port - port of Proxy

getProxy

public Proxy getProxy()

Returns Proxy setting for Authentication

Returns:

Proxy current Proxy config of client

setProxy

public void setProxy(Proxy proxy)

Create Proxy setting for API Client instance

Parameters:

proxy - value of Proxy

getProxyUsername

public String getProxyUsername()

Returns Proxy Username for Authentication

Returns:

current ProxyUsername

setProxyUsername

public void setProxyUsername(String proxyUsername)

Create Proxy Username for Authentication

Parameters:

proxyUsername - username of Proxy

getProxyPassword

public String getProxyPassword()

Returns Proxy Password for Authentication

Returns:

current ProxyUsername

setProxyPassword

public void setProxyPassword(String proxyPassword)

Create Proxy Password setting for Authentication

Parameters:

proxyPassword - username of Proxy

checkErrorResponse

protected void checkErrorResponse(cc.protea.util.http.Response response)

Evaluates the Response contains Api Server error when HTTP status from 4.x.x and raise HyperwalletException

Parameters:

response - the Response

Throws:

HyperwalletException - a HyperwalletException