com.apruve

Class ApruveClient

java.lang.Object

com.apruve.ApruveClient

public class ApruveClient
extends Object

A convenient class for integrating to the Apruve API. Implemented as a Singleton. Initialize with: ApruveClient.init(apiKey, Environment); More documentation at https://www.apruve.com/doc

Author:

https://github.com/nealtovsen

Field Summary

Fields

Modifier and Type	Field and Description
protected static ApruveClient	client

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApruveClient(String apiKey, ApruveEnvironment env)

Method Summary

Modifier and Type	Method and Description
<T> ApruveResponse<T>	delete(String path, Class<T> responseType)
<T> ApruveResponse<T>	get(String path, Class<T> resultType) Issues a GET request against to the Apruve REST API, using the specified path.
String	getApiKey()
ApruveEnvironment	getEnvironment()
static ApruveClient	getInstance()
<T> ApruveResponse<List<T>>	index(String path, javax.ws.rs.core.GenericType<List<T>> resultType) As get(), but specialized to return lists of objects for REST index operations
static void	init(String apiKey, ApruveEnvironment env) Provides a single point of initialization for the ApruveClient library.
static void	initToNull() Intended for use in unit testing only.
<T,RT> ApruveResponse<RT>	post(String path, T payload, Class<RT> responseType)
<T,RT> ApruveResponse<RT>	put(String path, T payload, Class<RT> responseType)
protected javax.ws.rs.client.Invocation.Builder	restRequest(String path)

Methods inherited from class java.lang.Object

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

Field Detail

client

protected static ApruveClient client

Constructor Detail

ApruveClient

protected ApruveClient(String apiKey,
                       ApruveEnvironment env)

Parameters:

apiKey -

env -

Method Detail

getInstance

public static ApruveClient getInstance()

Returns:

init

public static void init(String apiKey,
                        ApruveEnvironment env)

Provides a single point of initialization for the ApruveClient library.

Parameters:

apiKey - An API Key from your user account. Create on for your test account on https://test.apruve.com/merchants, or create one for live transactions at https://www.apruve.com/merchants. We recommend that you create a unique API Key for each merchant account.

env - com.apruve.ApruveClient.Environment.PROD or com.apruve.ApruveClient.Environment.TEST, as appropriate.

getApiKey

public String getApiKey()

Returns:

getEnvironment

public ApruveEnvironment getEnvironment()

Returns:

initToNull

public static void initToNull()

Intended for use in unit testing only.

restRequest

protected javax.ws.rs.client.Invocation.Builder restRequest(String path)

index

public <T> ApruveResponse<List<T>> index(String path,
                                         javax.ws.rs.core.GenericType<List<T>> resultType)

As get(), but specialized to return lists of objects for REST index operations

Parameters:

path - The path to issue the GET against

resultType - A GenericType instance that determines the type of list returned

Returns:

List of objects of a type as determined by resultType

get

public <T> ApruveResponse<T> get(String path,
                                 Class<T> resultType)

Issues a GET request against to the Apruve REST API, using the specified path.

Parameters:

path - The path to issue the GET against

resultType - The type of the response

Returns:

A single object of type resultType

post

public <T,RT> ApruveResponse<RT> post(String path,
                                      T payload,
                                      Class<RT> responseType)

put

public <T,RT> ApruveResponse<RT> put(String path,
                                     T payload,
                                     Class<RT> responseType)

delete

public <T> ApruveResponse<T> delete(String path,
                                    Class<T> responseType)