com.mangopay.core

Class RestTool

java.lang.Object

com.mangopay.core.RestTool

public class RestTool
extends java.lang.Object

Class used to build HTTP request, call the request and handle response.

Constructor Summary

Constructors

Constructor and Description
RestTool(MangoPayApi root, java.lang.Boolean authRequired, java.lang.Boolean clientIdRequired) Instantiates new RestTool object.

Method Summary

Modifier and Type	Method and Description
void	addRequestHttpHeader(java.util.Map<java.lang.String,java.lang.String> httpHeader) Adds HTTP headers as name/value pairs into the request.
void	addRequestHttpHeader(java.lang.String key, java.lang.String value) Adds HTTP header into the request.
<T> T	castResponseToEntity(java.lang.Class<T> classOfT, com.google.gson.JsonObject response)
<T extends Dto,U extends Dto> T	request(java.lang.Class<T> classOfT, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData, Pagination pagination, U entity) Makes a call to the MangoPay API.
<T extends Dto> T	request(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String urlMethod, java.lang.String requestType) Makes a call to the MangoPay API.
<T extends Dto> T	request(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData) Makes a call to the MangoPay API.
<T extends Dto> T	request(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData, Pagination pagination) Makes a call to the MangoPay API.
<T extends Dto,U extends Dto> T	request(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData, Pagination pagination, U entity) Makes a call to the MangoPay API.
<T extends Dto> java.util.List<T>	requestList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String urlMethod, java.lang.String requestType) Makes a call to the MangoPay API.
<T extends Dto> java.util.List<T>	requestList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData) Makes a call to the MangoPay API.
<T extends Dto> java.util.List<T>	requestList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData, Pagination pagination) Makes a call to the MangoPay API.
<T extends Dto> java.util.List<T>	requestList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String urlMethod, java.lang.String requestType, java.util.Map<java.lang.String,java.lang.String> requestData, Pagination pagination, java.util.Map<java.lang.String,java.lang.String> additionalUrlParams) Makes a call to the MangoPay API.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestTool

public RestTool(MangoPayApi root,
                java.lang.Boolean authRequired,
                java.lang.Boolean clientIdRequired)

Instantiates new RestTool object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance.

authRequired - Defines whether request authentication is required.

Method Detail

addRequestHttpHeader

public void addRequestHttpHeader(java.util.Map<java.lang.String,java.lang.String> httpHeader)

Adds HTTP headers as name/value pairs into the request.

Parameters:

httpHeader - Collection of headers name/value pairs.

addRequestHttpHeader

public void addRequestHttpHeader(java.lang.String key,
                                 java.lang.String value)

Adds HTTP header into the request.

Parameters:

key - Header name.

value - Header value.

request

public <T extends Dto,U extends Dto> T request(java.lang.Class<T> classOfT,
                                               java.lang.String urlMethod,
                                               java.lang.String requestType,
                                               java.util.Map<java.lang.String,java.lang.String> requestData,
                                               Pagination pagination,
                                               U entity)
                                        throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting single Dto instances. In order to process collections of objects, use requestList method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

urlMethod - Relevant method key.

requestType - HTTP request term, one of the GET, PUT or POST.

requestData - Collection of key-value pairs of request parameters.

pagination - Pagination object.

entity - Instance of Dto class that is going to be sent in case of PUTting or POSTing.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

request

public <T extends Dto,U extends Dto> T request(java.lang.Class<T> classOfT,
                                               java.lang.String idempotencyKey,
                                               java.lang.String urlMethod,
                                               java.lang.String requestType,
                                               java.util.Map<java.lang.String,java.lang.String> requestData,
                                               Pagination pagination,
                                               U entity)
                                        throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting single Dto instances. In order to process collections of objects, use requestList method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

idempotencyKey - idempotency key for this request.

urlMethod - Relevant method key.

requestType - HTTP request term, one of the GET, PUT or POST.

requestData - Collection of key-value pairs of request parameters.

pagination - Pagination object.

entity - Instance of Dto class that is going to be sent in case of PUTting or POSTing.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

request

public <T extends Dto> T request(java.lang.Class<T> classOfT,
                                 java.lang.String idempotencyKey,
                                 java.lang.String urlMethod,
                                 java.lang.String requestType)
                          throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting single Dto instances. In order to process collections of objects, use requestList method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

urlMethod - Relevant method key.

requestType - HTTP request term, one of the GET, PUT or POST.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

request

public <T extends Dto> T request(java.lang.Class<T> classOfT,
                                 java.lang.String idempotencyKey,
                                 java.lang.String urlMethod,
                                 java.lang.String requestType,
                                 java.util.Map<java.lang.String,java.lang.String> requestData)
                          throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting single Dto instances. In order to process collections of objects, use requestList method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

urlMethod - Relevant method key.

requestType - HTTP request term, one of the GET, PUT or POST.

requestData - Collection of key-value pairs of request parameters.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

request

public <T extends Dto> T request(java.lang.Class<T> classOfT,
                                 java.lang.String idempotencyKey,
                                 java.lang.String urlMethod,
                                 java.lang.String requestType,
                                 java.util.Map<java.lang.String,java.lang.String> requestData,
                                 Pagination pagination)
                          throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting single Dto instances. In order to process collections of objects, use requestList method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

urlMethod - Relevant method key.

requestType - HTTP request term, one of the GET, PUT or POST.

requestData - Collection of key-value pairs of request parameters.

pagination - Pagination object.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

requestList

public <T extends Dto> java.util.List<T> requestList(java.lang.Class<T[]> classOfT,
                                                     java.lang.Class<T> classOfTItem,
                                                     java.lang.String urlMethod,
                                                     java.lang.String requestType,
                                                     java.util.Map<java.lang.String,java.lang.String> requestData,
                                                     Pagination pagination,
                                                     java.util.Map<java.lang.String,java.lang.String> additionalUrlParams)
                                              throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting collections of Dto instances. In order to process single objects, use request method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

classOfTItem - The class of single item in array.

urlMethod - Relevant method key.

requestType - HTTP request term. For lists should be always GET.

requestData - Collection of key-value pairs of request parameters.

pagination - Pagination object.

additionalUrlParams -

Returns:

The collection of Dto instances returned from API.

Throws:

java.lang.Exception

requestList

public <T extends Dto> java.util.List<T> requestList(java.lang.Class<T[]> classOfT,
                                                     java.lang.Class<T> classOfTItem,
                                                     java.lang.String urlMethod,
                                                     java.lang.String requestType)
                                              throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting collections of Dto instances. In order to process single objects, use request method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

classOfTItem - The class of single item in array.

urlMethod - Relevant method key.

requestType - HTTP request term. For lists should be always GET.

Returns:

The collection of Dto instances returned from API.

Throws:

java.lang.Exception

requestList

public <T extends Dto> java.util.List<T> requestList(java.lang.Class<T[]> classOfT,
                                                     java.lang.Class<T> classOfTItem,
                                                     java.lang.String urlMethod,
                                                     java.lang.String requestType,
                                                     java.util.Map<java.lang.String,java.lang.String> requestData)
                                              throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting collections of Dto instances. In order to process single objects, use request method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

classOfTItem - The class of single item in array.

urlMethod - Relevant method key.

requestType - HTTP request term. For lists should be always GET.

requestData - Collection of key-value pairs of request parameters.

Returns:

The collection of Dto instances returned from API.

Throws:

java.lang.Exception

requestList

public <T extends Dto> java.util.List<T> requestList(java.lang.Class<T[]> classOfT,
                                                     java.lang.Class<T> classOfTItem,
                                                     java.lang.String urlMethod,
                                                     java.lang.String requestType,
                                                     java.util.Map<java.lang.String,java.lang.String> requestData,
                                                     Pagination pagination)
                                              throws java.lang.Exception

Makes a call to the MangoPay API.

This generic method handles calls targeting collections of Dto instances. In order to process single objects, use request method instead.

Type Parameters:

T - Type on behalf of which the request is being called.

Parameters:

classOfT - Type on behalf of which the request is being called.

classOfTItem - The class of single item in array.

urlMethod - Relevant method key.

requestType - HTTP request term. For lists should be always GET.

requestData - Collection of key-value pairs of request parameters.

pagination - Pagination object.

Returns:

The collection of Dto instances returned from API.

Throws:

java.lang.Exception

castResponseToEntity

public <T> T castResponseToEntity(java.lang.Class<T> classOfT,
                                  com.google.gson.JsonObject response)