com.mangopay.core.APIs

Class ApiBase

java.lang.Object

com.mangopay.core.APIs.ApiBase

Direct Known Subclasses:

AuthorizationTokenManager, BankingAliasApiImpl, CardApiImpl, CardPreAuthorizationApiImpl, CardRegistrationApiImpl, ClientApiImpl, DepositApiImpl, DisputeApiImpl, EventApiImpl, HookApiImpl, IdempotencyApiImpl, InstantConversionApiImpl, KycDocumentApiImpl, MandateApiImpl, OAuthApiImpl, PayInApiImpl, PayOutApiImpl, RefundApiImpl, RegulatoryApiImpl, ReportApiImpl, RepudiationApiImpl, SettlementApiImpl, TransferApiImpl, UboDeclarationApiImpl, UserApiImpl, WalletApiImpl

public abstract class ApiBase
extends java.lang.Object

Base class for all API classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected MangoPayApi	root Root/parent instance that holds the OAuthToken and Configuration instance.

Constructor Summary

Constructors

Constructor and Description
ApiBase(MangoPayApi root) Creates new API instance.

Method Summary

Modifier and Type	Method and Description
protected <T extends Dto,U extends Dto> T	createObject(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String methodKey, U entity) Creates the Dto instance.
protected <T extends Dto,U extends Dto> T	createObject(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String methodKey, U entity, java.lang.String entityId) Creates the Dto instance.
protected <T extends Dto,U extends Dto> T	createObject(java.lang.Class<T> classOfT, java.lang.String idempotencyKey, java.lang.String methodKey, U entity, java.lang.String entityId, java.lang.String secondEntityId) Creates the Dto instance.
protected <T extends Dto> java.util.List<T>	getList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination) Gets the array of Dto instances from API.
protected <T extends Dto> java.util.List<T>	getList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination, Sorting sorting) Gets the array of Dto instances from API.
protected <T extends Dto> java.util.List<T>	getList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination, java.lang.String entityId) Gets the array of Dto instances from API.
protected <T extends Dto> java.util.List<T>	getList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination, java.lang.String entityId, java.util.Map<java.lang.String,java.lang.String> filter, Sorting sorting)
protected <T extends Dto> java.util.List<T>	getList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination, java.lang.String entityId, Sorting sorting) Gets the array of Dto instances from API.
protected <T extends Dto> java.util.List<T>	getList(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination, java.lang.String entityId, java.lang.String secondEntityId, java.util.Map<java.lang.String,java.lang.String> filter, Sorting sorting) Gets the array of Dto instances from API.
protected <T extends Dto> java.util.List<T>	getListNoClientId(java.lang.Class<T[]> classOfT, java.lang.Class<T> classOfTItem, java.lang.String methodKey, Pagination pagination, Sorting sorting)
protected <T extends Dto> T	getObject(java.lang.Class<T> classOfT, java.lang.String methodKey, java.lang.Object... args)
protected <T extends Dto> T	getObjectNoClientId(java.lang.Class<T> classOfT, java.lang.String methodKey, java.lang.Object... args)
protected java.lang.String	getRequestType(java.lang.String key) Gets the HTTP request verb.
protected java.lang.String	getRequestUrl(java.lang.String key) Gets the URL of REST Mango Pay API.
protected MangoPayApi	getRoot()
protected <T extends Dto,U extends Dto> T	updateObject(java.lang.Class<T> classOfT, java.lang.String methodKey, U entity) Saves the Dto instance.
protected <T extends Dto,U extends Dto> T	updateObject(java.lang.Class<T> classOfT, java.lang.String methodKey, U entity, java.lang.String entityId) Saves the Dto instance.
protected <T extends Dto,U extends Dto> T	updateObject(java.lang.Class<T> classOfT, java.lang.String methodKey, U entity, java.lang.String entityId, java.lang.String secondEntityId) Saves the Dto instance.
protected <T extends Dto,U extends Dto> T	updateObject(java.lang.Class<T> classOfT, java.lang.String methodKey, U entity, java.lang.String entityId, java.lang.String secondEntityId, java.lang.String thirdEntityId) Saves the Dto instance.

Methods inherited from class java.lang.Object

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

Field Detail

root

protected MangoPayApi root

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

Constructor Detail

ApiBase

public ApiBase(MangoPayApi root)

Creates new API instance.

Parameters:

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

Method Detail

getRoot

protected MangoPayApi getRoot()

getRequestUrl

protected java.lang.String getRequestUrl(java.lang.String key)
                                  throws java.lang.Exception

Gets the URL of REST Mango Pay API.

Parameters:

key - The method key to get URL of.

Returns:

The URL string of given method.

Throws:

java.lang.Exception

getRequestType

protected java.lang.String getRequestType(java.lang.String key)

Gets the HTTP request verb.

Parameters:

key - The method key.

Returns:

One of the HTTP verbs: GET, PUT or POST.

createObject

protected <T extends Dto,U extends Dto> T createObject(java.lang.Class<T> classOfT,
                                                       java.lang.String idempotencyKey,
                                                       java.lang.String methodKey,
                                                       U entity,
                                                       java.lang.String entityId,
                                                       java.lang.String secondEntityId)
                                                throws java.lang.Exception

Creates the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

entityId - Entity identifier.

secondEntityId - Second entity identifier.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

createObject

protected <T extends Dto,U extends Dto> T createObject(java.lang.Class<T> classOfT,
                                                       java.lang.String idempotencyKey,
                                                       java.lang.String methodKey,
                                                       U entity,
                                                       java.lang.String entityId)
                                                throws java.lang.Exception

Creates the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

entityId - Entity identifier.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

createObject

protected <T extends Dto,U extends Dto> T createObject(java.lang.Class<T> classOfT,
                                                       java.lang.String idempotencyKey,
                                                       java.lang.String methodKey,
                                                       U entity)
                                                throws java.lang.Exception

Creates the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

getObject

protected <T extends Dto> T getObject(java.lang.Class<T> classOfT,
                                      java.lang.String methodKey,
                                      java.lang.Object... args)
                               throws java.lang.Exception

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.

methodKey - Relevant method key.

args - Arguments that will be set on the method

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

getObjectNoClientId

protected <T extends Dto> T getObjectNoClientId(java.lang.Class<T> classOfT,
                                                java.lang.String methodKey,
                                                java.lang.Object... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getList

protected <T extends Dto> java.util.List<T> getList(java.lang.Class<T[]> classOfT,
                                                    java.lang.Class<T> classOfTItem,
                                                    java.lang.String methodKey,
                                                    Pagination pagination,
                                                    java.lang.String entityId,
                                                    java.lang.String secondEntityId,
                                                    java.util.Map<java.lang.String,java.lang.String> filter,
                                                    Sorting sorting)
                                             throws java.lang.Exception

Gets the array of Dto instances from API.

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.

methodKey - Relevant method key.

pagination - Pagination object.

entityId - Entity identifier.

filter - Collection of key-value pairs of filter parameters.

sorting - Sorting instance.

Returns:

The array of Dto instances returned from API.

Throws:

java.lang.Exception

getListNoClientId

protected <T extends Dto> java.util.List<T> getListNoClientId(java.lang.Class<T[]> classOfT,
                                                              java.lang.Class<T> classOfTItem,
                                                              java.lang.String methodKey,
                                                              Pagination pagination,
                                                              Sorting sorting)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

getList

protected <T extends Dto> java.util.List<T> getList(java.lang.Class<T[]> classOfT,
                                                    java.lang.Class<T> classOfTItem,
                                                    java.lang.String methodKey,
                                                    Pagination pagination,
                                                    java.lang.String entityId,
                                                    java.util.Map<java.lang.String,java.lang.String> filter,
                                                    Sorting sorting)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getList

protected <T extends Dto> java.util.List<T> getList(java.lang.Class<T[]> classOfT,
                                                    java.lang.Class<T> classOfTItem,
                                                    java.lang.String methodKey,
                                                    Pagination pagination,
                                                    java.lang.String entityId,
                                                    Sorting sorting)
                                             throws java.lang.Exception

Gets the array of Dto instances from API.

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.

methodKey - Relevant method key.

pagination - Pagination object.

entityId - Entity identifier.

sorting - Sorting object.

Returns:

The array of Dto instances returned from API.

Throws:

java.lang.Exception

getList

protected <T extends Dto> java.util.List<T> getList(java.lang.Class<T[]> classOfT,
                                                    java.lang.Class<T> classOfTItem,
                                                    java.lang.String methodKey,
                                                    Pagination pagination,
                                                    java.lang.String entityId)
                                             throws java.lang.Exception

Gets the array of Dto instances from API.

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.

methodKey - Relevant method key.

pagination - Pagination object.

entityId - Entity identifier.

Returns:

The array of Dto instances returned from API.

Throws:

java.lang.Exception

getList

protected <T extends Dto> java.util.List<T> getList(java.lang.Class<T[]> classOfT,
                                                    java.lang.Class<T> classOfTItem,
                                                    java.lang.String methodKey,
                                                    Pagination pagination)
                                             throws java.lang.Exception

Gets the array of Dto instances from API.

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.

methodKey - Relevant method key.

pagination - Pagination object.

Returns:

The array of Dto instances returned from API.

Throws:

java.lang.Exception

getList

protected <T extends Dto> java.util.List<T> getList(java.lang.Class<T[]> classOfT,
                                                    java.lang.Class<T> classOfTItem,
                                                    java.lang.String methodKey,
                                                    Pagination pagination,
                                                    Sorting sorting)
                                             throws java.lang.Exception

Gets the array of Dto instances from API.

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.

methodKey - Relevant method key.

pagination - Pagination object.

sorting - Sorting object.

Returns:

The array of Dto instances returned from API.

Throws:

java.lang.Exception

updateObject

protected <T extends Dto,U extends Dto> T updateObject(java.lang.Class<T> classOfT,
                                                       java.lang.String methodKey,
                                                       U entity)
                                                throws java.lang.Exception

Saves the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

updateObject

protected <T extends Dto,U extends Dto> T updateObject(java.lang.Class<T> classOfT,
                                                       java.lang.String methodKey,
                                                       U entity,
                                                       java.lang.String entityId)
                                                throws java.lang.Exception

Saves the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

entityId - Entity identifier.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

updateObject

protected <T extends Dto,U extends Dto> T updateObject(java.lang.Class<T> classOfT,
                                                       java.lang.String methodKey,
                                                       U entity,
                                                       java.lang.String entityId,
                                                       java.lang.String secondEntityId)
                                                throws java.lang.Exception

Saves the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

entityId - Entity identifier.

secondEntityId - Second entity identifier.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception

updateObject

protected <T extends Dto,U extends Dto> T updateObject(java.lang.Class<T> classOfT,
                                                       java.lang.String methodKey,
                                                       U entity,
                                                       java.lang.String entityId,
                                                       java.lang.String secondEntityId,
                                                       java.lang.String thirdEntityId)
                                                throws java.lang.Exception

Saves the Dto instance.

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.

methodKey - Relevant method key.

entity - Dto instance that is going to be sent.

entityId - Entity identifier.

secondEntityId - Second entity identifier.

thirdEntityId - Third entity identifier.

Returns:

The Dto instance returned from API.

Throws:

java.lang.Exception