com.mambu.apisdk.util

Class ServiceExecutor

java.lang.Object

com.mambu.apisdk.util.ServiceExecutor

public class ServiceExecutor
extends java.lang.Object

ServiceExecutor class provides services to build and execute API requests for other API Service classes. It uses supplied ApiDefintion for a particular request to build required URL, execute https request (with the specified method and the content type), to parse Mambu response into the requested type and to return the result to the caller. Other services can use ServiceExecutor methods to execute their API requests. A typical pattern for using ServiceExecutor could be: a) define the ApiDefintion for an API request b) call serviceExecutor.execute(apiDefintion, parameters...) Note that all ServiceExecutor execute...(...) methods are generic methods returning a generic type R. Invoking these methods can be done using either a parameterised type or using Java's target typing to infer the return type parameter of a generic method invocation. Examples below are using target typing, which infer the return R type from the statement. For example, in getLoanAccount() wrapper method specifies LoanAccount as a returned type then when using a statement: return serviceExecutor.execute(getAccount, params) within the getLoanAccount() Java infers type R to be LoanAccount and is equivalent to the following invocation: return serviceExecutor. execute(getAccount, accountId);. Similarly, from the assignment statement Client client = serviceExecutor.execute(...) Java infers the return type R for this execute() statement to be a Client class and is equivalent to Client client= serviceExecutor.execute(...) Usage Example: 1. If LoanService needs to execute GET Loan Account details request then: serviceExecutor = new ServiceExecutor(mambuAPIService) ApiDefinition getAccount = new ApiDefinition(ApiType.GET_ENTITY_DETAILS, LoanAccount.class); return serviceExecutor.execute(getAccount, accountId); 2. If Client Service needs to execute GET a list of Clients request then: serviceExecutor = new ServiceExecutor(mambuAPIService) ApiDefinition getClientsList = new ApiDefinition(ApiType.GET_LIST, Client.class); return serviceExecutor.execute(getClientsList, params);

Constructor Summary

Constructors

Constructor and Description
ServiceExecutor(MambuAPIService mambuAPIService) Create a new ServiceExecutor

Method Summary

Modifier and Type	Method and Description
<R> R	createEntity(java.lang.Class<R> entity) Create new entity
<T> T	createOwnedEntity(MambuEntityType parentEntity, java.lang.String parentId, T postEntity) Create new entity owned by a parent entity.
<R,T> R	createOwnedEntity(MambuEntityType parentEntity, java.lang.String parentId, T postEntity, java.lang.Class<?> resultClass) Create new entity owned by a parent entity.
<R> java.lang.Boolean	deleteEntity(MambuEntityType mambuEntity, java.lang.String entityId) Delete entity
<R> java.lang.Boolean	deleteOwnedEntity(MambuEntityType parentEntity, java.lang.String parentId, MambuEntityType ownedEntity, java.lang.String ownedEntityId) Delete owned entity.
<R> R	execute(ApiDefinition apiDefinition) Convenience method to execute API request using its ApiDefinition.
<R> R	execute(ApiDefinition apiDefinition, ParamsMap paramsMap) Convenience method to execute API Request using its ApiDefinition and params map.
<R> R	execute(ApiDefinition apiDefinition, java.lang.String objectId) Convenience method to execute API Request using its ApiDefinition and object ID.
<R> R	execute(ApiDefinition apiDefinition, java.lang.String objectId, ParamsMap paramsMap) Convenience method to Execute API Request without relatedEntityId parameter
<R> R	execute(ApiDefinition apiDefinition, java.lang.String objectId, java.lang.String relatedEntityId, ParamsMap paramsMap) Execute API Request using its ApiDefinition and supplied input data
<R,T> R	executeJson(ApiDefinition apiDefinition, T object) Convenience method for executing API JSON Post Request using its ApiDefinition and supplied object.
<R,T> R	executeJson(ApiDefinition apiDefinition, T object, java.lang.String objectId) Convenience method for executing API JSON Post Request using its ApiDefinition, supplied object and object ID.
<R,T> R	executeJson(ApiDefinition apiDefinition, T object, java.lang.String objectId, java.lang.String relatedEntityId, ParamsMap paramsMap) Execute API JSON Post Request using its ApiDefinition and supplied input data.
<R> R	executeJSONTransactionRequest(java.lang.String accountId, com.mambu.api.server.handler.loan.model.JSONTransactionRequest request, com.mambu.accounts.shared.model.Account.Type accountType, java.lang.String transactionTypeName) POST JSON Transaction Request
static java.lang.reflect.Type	getCollectionType(java.lang.Class<?> clazz) Get Type for the collection of objects returned by API for the specified class (e.g.
<R> R	getEntity(MambuEntityType mambuEntity, java.lang.String entityId) Get Mambu entity.
<R> java.util.List<R>	getList(MambuEntityType mambuEntity, ParamsMap params) Get a list of Mambu entities.
<R> R	getOwnedEntities(MambuEntityType parentEntity, java.lang.String parentId, MambuEntityType ownedEntity, java.lang.Integer offset, java.lang.Integer limit) Convenience method to Get a list of entities owned by a parent entity by specifying only pagination parameters offset and limit.
<R> R	getOwnedEntities(MambuEntityType parentEntity, java.lang.String parentId, MambuEntityType ownedEntity, java.lang.Integer offset, java.lang.Integer limit, boolean requiresFullDetails) Convenience method to Get a list of entities owned by a parent entity by specifying only pagination parameters offset and limit.
<R> R	getOwnedEntities(MambuEntityType parentEntity, java.lang.String parentId, MambuEntityType ownedEntity, java.lang.String relatedEntityId, ParamsMap params, boolean requiresFullDetails) Get a list of entities owned by a parent entity.
<R> R	getOwnedEntity(MambuEntityType parentEntity, java.lang.String parentId, MambuEntityType ownedEntity, java.lang.String ownedEntityId, ParamsMap params) Get owned entity.
<R> java.util.List<R>	getPaginatedList(MambuEntityType mambuEntity, java.lang.Integer offset, java.lang.Integer limit) Convenience method to GET a paginated list of Mambu entities.
<R> java.util.List<R>	getPaginatedList(MambuEntityType mambuEntity, java.lang.Integer offset, java.lang.Integer limit, boolean requiresFullDetails) Convenience method to GET a paginated list of Mambu entities.
<R> R	updateEntity(java.lang.Class<R> entity, java.lang.String entityId) Update entity
<R,T> R	updateOwnedEntity(MambuEntityType parentEntity, java.lang.String parentId, T ownedEntity, java.lang.String ownedEntityId) Update existent owned entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceExecutor

@Inject
public ServiceExecutor(MambuAPIService mambuAPIService)

Create a new ServiceExecutor

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

execute

public <R> R execute(ApiDefinition apiDefinition,
                     java.lang.String objectId,
                     java.lang.String relatedEntityId,
                     ParamsMap paramsMap)
              throws MambuApiException

Execute API Request using its ApiDefinition and supplied input data

Parameters:

apiDefinition - API definition for the request

objectId - api's object id (optional, must be null if not used)

relatedEntityId - an id of the relatedEntity (optional, must be null if not used)

paramsMap - map with API parameters

Returns:

object result object, which will be an API specific object or a list of objects

Throws:

MambuApiException

execute

public <R> R execute(ApiDefinition apiDefinition,
                     java.lang.String objectId,
                     ParamsMap paramsMap)
              throws MambuApiException

Convenience method to Execute API Request without relatedEntityId parameter

Parameters:

apiDefinition - API definition for the request

objectId - api's object id (optional, must be null if not used)

paramsMap - map with API parameters

Returns:

object result object, which will be an API specific object or a list of objects

Throws:

MambuApiException

execute

public <R> R execute(ApiDefinition apiDefinition,
                     java.lang.String objectId)
              throws MambuApiException

Convenience method to execute API Request using its ApiDefinition and object ID. This version of the execute method can be used when the API request doesn't use ParamsMap, for example get entity details API request

Parameters:

apiDefinition - API definition for the request

objectId - api's object id (optional, must be null if not used)

Returns:

object result object, which will be an API specific object or a list of objects

Throws:

MambuApiException

execute

public <R> R execute(ApiDefinition apiDefinition,
                     ParamsMap paramsMap)
              throws MambuApiException

Convenience method to execute API Request using its ApiDefinition and params map. This version of the execute method can be used when the API request doesn't use object ID (for example in get list requests)

Parameters:

apiDefinition - API definition for the request

paramsMap - map with API parameters

Returns:

object result object, which will be an API specific object or a list of objects

Throws:

MambuApiException

execute

public <R> R execute(ApiDefinition apiDefinition)
              throws MambuApiException

Convenience method to execute API request using its ApiDefinition. This version of the execute method can be used when the API request doesn't use ParamsMap and doesn't need an object Id, for example GET list of currencies

Parameters:

apiDefinition - API definition for the request

Returns:

object result object, which will be an API specific object or a list of objects

Throws:

MambuApiException

executeJson

public <R,T> R executeJson(ApiDefinition apiDefinition,
                           T object,
                           java.lang.String objectId,
                           java.lang.String relatedEntityId,
                           ParamsMap paramsMap)
                    throws MambuApiException

Execute API JSON Post Request using its ApiDefinition and supplied input data. Used for JSON create and update requests.

Parameters:

apiDefinition - API definition for the request

object - the Mambu object to be created. Currently (as of Mambu 3.7) only Client, LoanAccount, SavingsAccount and Document objects can be created using JSON API requests

objectId - object's id (optional, could be null if not used, for example for JSON create requests)

paramsMap - params map with additional parameters. could be null. Currently used to provided optional pagination params

Returns:

object a result object, which will be an API specific object

Throws:

MambuApiException

executeJson

public <R,T> R executeJson(ApiDefinition apiDefinition,
                           T object,
                           java.lang.String objectId)
                    throws MambuApiException

Convenience method for executing API JSON Post Request using its ApiDefinition, supplied object and object ID. Can be used for JSON requests which do not require related entity id

Parameters:

apiDefinition - API definition for the request

object - the Mambu object to be created.

objectId - object's id (optional, could be null if not used, for example for JSON create requests)

Returns:

object a result object, which will be an API specific object

Throws:

MambuApiException

executeJson

public <R,T> R executeJson(ApiDefinition apiDefinition,
                           T object)
                    throws MambuApiException

Convenience method for executing API JSON Post Request using its ApiDefinition and supplied object. Can be used for JSON requests which do not require objectId and related entity id parameters

Parameters:

apiDefinition - API definition for the request

object - the Mambu object to be created.

Returns:

object a result object, which will be an API specific object

Throws:

MambuApiException

getCollectionType

public static java.lang.reflect.Type getCollectionType(java.lang.Class<?> clazz)

Get Type for the collection of objects returned by API for the specified class (e.g. List> )

Parameters:

clazz - class name for the object associated with the collection

getOwnedEntities

public <R> R getOwnedEntities(MambuEntityType parentEntity,
                              java.lang.String parentId,
                              MambuEntityType ownedEntity,
                              java.lang.String relatedEntityId,
                              ParamsMap params,
                              boolean requiresFullDetails)
                       throws MambuApiException

Get a list of entities owned by a parent entity. For example GET all documents for a client or for a loan account

Parameters:

parentEntity - parent's MambuEntityType. Example MambuEntityType.CLIENT

parentId - encoded key or id of the parent entity

ownedEntity - Mambu owned entity. Example, MambuEntityType.COMMENT

relatedEntityId - related entity id. Can be null if not required

params - params map with filtering parameters

requiresFullDetails - boolean flag indicates whether the full or object is wanted

Returns:

list of owned entities

Throws:

MambuApiException

getOwnedEntities

public <R> R getOwnedEntities(MambuEntityType parentEntity,
                              java.lang.String parentId,
                              MambuEntityType ownedEntity,
                              java.lang.Integer offset,
                              java.lang.Integer limit,
                              boolean requiresFullDetails)
                       throws MambuApiException

Convenience method to Get a list of entities owned by a parent entity by specifying only pagination parameters offset and limit. For example GET all comments for a client or for a loan account with offset and limit

Parameters:

parentEntity - parent's MambuEntityType. Example MambuEntityType.CLIENT

parentId - encoded key or id of the parent entity

ownedEntity - Mambu owned entity. Example, MambuEntityType.COMMENT

offset - pagination offset

limit - pagination limit

requiresFullDetails - boolean flag indicating whether a full or basic object is wanted

Returns:

list of owned entities

Throws:

MambuApiException

getOwnedEntities

public <R> R getOwnedEntities(MambuEntityType parentEntity,
                              java.lang.String parentId,
                              MambuEntityType ownedEntity,
                              java.lang.Integer offset,
                              java.lang.Integer limit)
                       throws MambuApiException

Convenience method to Get a list of entities owned by a parent entity by specifying only pagination parameters offset and limit. For example GET all comments for a client or for a loan account with offset and limit

Parameters:

parentEntity - parent's MambuEntityType. Example MambuEntityType.CLIENT

parentId - encoded key or id of the parent entity

ownedEntity - Mambu owned entity. Example, MambuEntityType.COMMENT

offset - pagination offset

limit - pagination limit

Returns:

list of owned entities

Throws:

MambuApiException

getOwnedEntity

public <R> R getOwnedEntity(MambuEntityType parentEntity,
                            java.lang.String parentId,
                            MambuEntityType ownedEntity,
                            java.lang.String ownedEntityId,
                            ParamsMap params)
                     throws MambuApiException

Get owned entity. For example GET all documents for a client or for a loan account

Parameters:

parentEntity - parent's MambuEntityType. Example MambuEntityType.CLIENT

parentId - encoded key or id of the parent entity

ownedEntity - Mambu owned entity. Example, MambuEntityType.COMMENT

ownedEntityId - encoded key or id of the owned entity. Optional. Can be null. Example GET /api/loanproducts/{ID}/schedule

params - params map with filtering parameters. Optional. Can be null.

Returns:

owned entity

Throws:

MambuApiException

createOwnedEntity

public <T> T createOwnedEntity(MambuEntityType parentEntity,
                               java.lang.String parentId,
                               T postEntity)
                        throws MambuApiException

Create new entity owned by a parent entity. For example. Create new document for a client or for a loan account. This method is used for API returning objects of the same class as posted entity

Parameters:

parentEntity - parent entity

parentId - encoded key or id of the parent entity

postEntity - posted entity

Returns:

updated posted entity

Throws:

MambuApiException

createOwnedEntity

public <R,T> R createOwnedEntity(MambuEntityType parentEntity,
                                 java.lang.String parentId,
                                 T postEntity,
                                 java.lang.Class<?> resultClass)
                          throws MambuApiException

Create new entity owned by a parent entity. For example. Create new document for a client or for a loan account. This method is used for API returning objects of a different class than the posted entity's class. The class of returned object must be specified in the call

Parameters:

parentEntity - parent entity

parentId - encoded key or id of the parent entity

postEntity - posted entity

resultClass - the class of the Mambu model returned in response.

Returns:

updated posted entity

Throws:

MambuApiException

updateOwnedEntity

public <R,T> R updateOwnedEntity(MambuEntityType parentEntity,
                                 java.lang.String parentId,
                                 T ownedEntity,
                                 java.lang.String ownedEntityId)
                          throws MambuApiException

Update existent owned entity. For example. Update document for a client or for a loan account

Parameters:

parentEntity - parent entity

parentId - encoded key or id of the parent entity

ownedEntityId - the encoded key or id of the entity being patched

Returns:

updated owned entity

Throws:

MambuApiException

deleteOwnedEntity

public <R> java.lang.Boolean deleteOwnedEntity(MambuEntityType parentEntity,
                                               java.lang.String parentId,
                                               MambuEntityType ownedEntity,
                                               java.lang.String ownedEntityId)
                                        throws MambuApiException

Delete owned entity. For example. DELETE document for a client or for a loan account

Parameters:

parentEntity - parent entity

parentId - encoded key or id of the parent entity

ownedEntityId - the encoded key or id of the entity being patched

Returns:

true if successful

Throws:

MambuApiException

getEntity

public <R> R getEntity(MambuEntityType mambuEntity,
                       java.lang.String entityId)
                throws MambuApiException

Get Mambu entity. Example: GET api/clients/{entityId}

Parameters:

mambuEntity - Mambu entity

entityId - entity id or encoded key

Returns:

Mambu object

Throws:

MambuApiException

getList

public <R> java.util.List<R> getList(MambuEntityType mambuEntity,
                                     ParamsMap params)
                              throws MambuApiException

Get a list of Mambu entities. Example; GET /api/groups (by branch and centre and pagination params)

Parameters:

mambuEntity - Mambu entity

params - params map for getting a list of entities. The params map can contain all parameters specific to the API, for example, pagination parameters, filter setting, branch and credit officer is, etc.

Returns:

list of entities

Throws:

MambuApiException

getPaginatedList

public <R> java.util.List<R> getPaginatedList(MambuEntityType mambuEntity,
                                              java.lang.Integer offset,
                                              java.lang.Integer limit,
                                              boolean requiresFullDetails)
                                       throws MambuApiException

Convenience method to GET a paginated list of Mambu entities. Example; GET /api/clients?fullDetails=true with offset and limit

Parameters:

mambuEntity - Mambu entity

offset - offset

limit - limit

requiresFullDetails - flag indicating if is a full call if true then 'fullDetails=true' parameter will be added to the call

Returns:

list of entities for the requested page

Throws:

MambuApiException

getPaginatedList

public <R> java.util.List<R> getPaginatedList(MambuEntityType mambuEntity,
                                              java.lang.Integer offset,
                                              java.lang.Integer limit)
                                       throws MambuApiException

Convenience method to GET a paginated list of Mambu entities. Example; GET /api/clients with offset and limit

Parameters:

mambuEntity - Mambu entity

offset - offset

limit - limit

Returns:

list of entities for the requested page

Throws:

MambuApiException

createEntity

public <R> R createEntity(java.lang.Class<R> entity)
                   throws MambuApiException

Create new entity

Parameters:

entity - entity to create

Returns:

created entity

Throws:

MambuApiException

updateEntity

public <R> R updateEntity(java.lang.Class<R> entity,
                          java.lang.String entityId)
                   throws MambuApiException

Update entity

Parameters:

entity - entity to update

entityId - entity id or encoded key

Returns:

updated entity

Throws:

MambuApiException

deleteEntity

public <R> java.lang.Boolean deleteEntity(MambuEntityType mambuEntity,
                                          java.lang.String entityId)
                                   throws MambuApiException

Delete entity

Parameters:

mambuEntity - mambu entity to delete

entityId - id or encoded key of the entity to be deleted

Returns:

true if successfully deleted

Throws:

MambuApiException

executeJSONTransactionRequest

public <R> R executeJSONTransactionRequest(java.lang.String accountId,
                                           com.mambu.api.server.handler.loan.model.JSONTransactionRequest request,
                                           com.mambu.accounts.shared.model.Account.Type accountType,
                                           java.lang.String transactionTypeName)
                                    throws MambuApiException

POST JSON Transaction Request

Parameters:

accountId - account id or encoded key. Must not be null

request - JSON Transaction Request

accountType - account type, LOAN or SAVINGS

transactionTypeName - transaction type name. E.g. FEE, DISBURSEMENT, DEPOSIT

Returns:

loan transaction or savings transaction depending on accountType

Throws:

MambuApiException