me.figo

Class FigoApi

java.lang.Object

me.figo.FigoApi

Direct Known Subclasses:

FigoConnection, FigoSession

public class FigoApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_FIGO_LIVE
protected static String	API_FIGO_STAGE

Constructor Summary

Constructors

Constructor and Description
FigoApi(String authorization, int timeout)
FigoApi(String apiEndpoint, String authorization, int timeout)

Method Summary

Modifier and Type	Method and Description
protected com.google.gson.Gson	createGson() Instantiate the GSON class.
String	getApiEndpoint()
int	getTimeout() The timeout used for queries.
protected <T> T	handleResponse(InputStream stream, Type typeOfT) Handle the response of a request by decoding its JSON payload
protected <T> T	processResponse(HttpURLConnection connection, Type typeOfT) Method to process the response.
<T> T	queryApi(String path, Object data, String method, Type typeOfT) Helper method for making a OAuth2-compliant API call
void	setProxy(Proxy proxy)
void	setTimeout(int timeout)
void	setTrustManager(X509TrustManager trustManager)
protected void	setupTrustManager(HttpURLConnection connection, X509TrustManager trustManager) Method to configure TrustManager.

Methods inherited from class java.lang.Object

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

Field Detail

API_FIGO_LIVE

protected static final String API_FIGO_LIVE

See Also:

Constant Field Values

API_FIGO_STAGE

protected static final String API_FIGO_STAGE

See Also:

Constant Field Values

Constructor Detail

FigoApi

public FigoApi(String apiEndpoint,
               String authorization,
               int timeout)

Parameters:

apiEndpoint -

authorization -

timeout -

FigoApi

public FigoApi(String authorization,
               int timeout)

Method Detail

setTrustManager

public void setTrustManager(X509TrustManager trustManager)

setProxy

public void setProxy(Proxy proxy)

queryApi

public <T> T queryApi(String path,
                      Object data,
                      String method,
                      Type typeOfT)
               throws IOException,
                      FigoException

Helper method for making a OAuth2-compliant API call

Type Parameters:

T - Type of expected response

Parameters:

path - path on the server to call

data - Payload of the request

method - the HTTP verb to use

typeOfT - Type of expected response

Returns:

the parsed result of the request

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

setupTrustManager

protected void setupTrustManager(HttpURLConnection connection,
                                 X509TrustManager trustManager)
                          throws IOException

Method to configure TrustManager.

Parameters:

connection -

Throws:

IOException - IOException

processResponse

protected <T> T processResponse(HttpURLConnection connection,
                                Type typeOfT)
                         throws IOException,
                                FigoException

Method to process the response.

Type Parameters:

T -

Parameters:

connection -

typeOfT -

Returns:

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

handleResponse

protected <T> T handleResponse(InputStream stream,
                               Type typeOfT)

Handle the response of a request by decoding its JSON payload

Parameters:

stream - Stream containing the JSON data

typeOfT - Type of the data to be expected

Returns:

Decoded data

createGson

protected com.google.gson.Gson createGson()

Instantiate the GSON class. Meant to be overridden in order to provide custom Gson settings.

Returns:

GSON instance

getApiEndpoint

public String getApiEndpoint()

getTimeout

public int getTimeout()

The timeout used for queries.

Returns:

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - the timeout used for queries