ApiDefinition

java.lang.Object
- com.mambu.apisdk.util.ApiDefinition

```
public class ApiDefinition
extends java.lang.Object
```
ApiDefinition is a helper class which allows service classes to provide a specification for a Mambu API request and then use ServiceHelper class to actually execute the API request with this ApiDefinition and with provided input parameters. This class allows users to define API format parameters required by a specific API request, including the URL path structure, the HTTP method and content type, and the specification for the expected Mambu response. ApiDefinition also allows optionally specifying custom JsonSerializers and JsonDeserializers to be used when generating API requests or processing Mambu responses as well as serialisation exclusion strategies For the URL path part of the specification, the API definition assumes the URL path to be build in the following format: endpoint[/objectId][/relatedEntity][/[relatedEntityID]], with all parts , except the endpoint, being optional. Examples: /loans, /savings/1234, clients/456/loans, /loans/4556/repayments, /groups/998878, /loans/9876/transactions, /clients/645/custominformation/field_id_777 For the HTTP part, the ApiDefinition allows users to specify such HTTP parameters as method (GET, POST, DELETE) and the content type For the expected response, the API definition allows users to specify what is returned by Mambu: the object's class and is it a single object or a collection returned by Mambu for this API request. ApiDefinition class provides a number of convenience constructors to be used to set the required parameters. ApiDefinition class also defines a number of typical Mambu API request types (see ApiType). These include standard Mambu API requests, such as Get Entity Details, Get a List of Entities, Create JSON Entity, Get Account Transactions, etc..). Constructor with an ApiType parameter derives the URL format and HTTP parameters from the ApiType, the user typically only needs to additionally specify the Mambu class to be used with this request. Examples: to define a specification for getting LoanDetails the user can specify a constructor in the following way: new ApiDefinition(ApiType.GetEntityDetails, LoanAccount.class); To provide a specification for Creating New client the user can create definition with new ApiDefinition(ApiType.Create, LoanAccountExpanded.class); Note, that the Api definition doesn't include any of the input parameters which can be supplied with an API request, this is to be provided as input params map in the service class' calls. The only exception is the ability to specify that the 'fullDetails' parameter is required, in this case the caller doesn't need to provide it as input. For example, when specifying the ApiType.GetEntityDetails type, the fullDetails parameter will be added automatically for this definition.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApiDefinition.ApiReturnFormat` ApiReturnFormat specifies if Mambu's returned JSON string represents a single object, a collection of objects or just a success/failure response
`static class`	`ApiDefinition.ApiType`

Constructor Summary

Constructors
Constructor and Description
`ApiDefinition(ApiDefinition.ApiType apiType, java.lang.Class<?> entityClass)` Constructor used with ApiType requests for which only one entity class needs to be specified, Example GET loans/123.
`ApiDefinition(ApiDefinition.ApiType apiType, java.lang.Class<?> entityClass, java.lang.Class<?> resultClass)` Constructor used with ApiType requests for which two entity classes need to be specified, Example GET clients/123/loans.
`ApiDefinition(ApiDefinition.ApiType apiType, java.lang.Class<?> entityClass, java.lang.Class<?> relatedEntity, java.lang.Class<?> resultClass)` Constructor which can be used with ApiType requests for which the result class must be specified independently of the related entity class.
`ApiDefinition(ApiDefinition.ApiType apiType, java.lang.String apiEndPoint, java.lang.Class<?> resultClass)` Constructor used with ApiType requests for which two api endpoints need to be specified and the api returns related entity associated with the second endpoint.
`ApiDefinition(java.lang.String urlPath, RequestExecutor.ContentType contentType, RequestExecutor.Method method, java.lang.Class<?> retrunClass, ApiDefinition.ApiReturnFormat returnFormt)` Make ApiDefintion by explicitly specifying all required HTTPS request parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addJsonDeserializer(java.lang.Class<?> clazz, com.google.gson.JsonDeserializer<?> deserializer)` Add JsonDeserializer for a specific class to the API definition
`void`	`addJsonSerializer(java.lang.Class<?> clazz, com.google.gson.JsonSerializer<?> serializer)` Add JsonSerializer for a specific class to the API definition
`void`	`addSerializationExclusionStrategy(com.google.gson.ExclusionStrategy exclusionStrategy)` Add serialization ExclusionStrategy to the API definition
`static java.lang.String`	`getApiEndPoint(java.lang.Class<?> entityClass)`
`ApiDefinition.ApiReturnFormat`	`getApiReturnFormat()`
`ApiDefinition.ApiType`	`getApiType()`
`RequestExecutor.ContentType`	`getContentType()`
`java.lang.String`	`getEndPoint()`
`java.lang.String`	`getJsonDateTimeFormat()`
`java.util.HashMap<java.lang.Class<?>,com.google.gson.JsonDeserializer<?>>`	`getJsonDeserializers()` Get JsonDeserializers specified in the API definition
`java.util.HashMap<java.lang.Class<?>,com.google.gson.JsonSerializer<?>>`	`getJsonSerializers()` Get JsonSerializers specified in the API definition
`RequestExecutor.Method`	`getMethod()`
`java.lang.String`	`getRelatedEntity()`
`java.lang.Class<?>`	`getReturnClass()`
`java.util.List<com.google.gson.ExclusionStrategy>`	`getSerializationExclusionStrategies()` Get serialization ExclusionStrategy specified in the API definition
`java.lang.String`	`getUrlPath()`
`boolean`	`getWithFullDetails()`
`boolean`	`isObjectIdNeeded()`
`void`	`setApiReturnFormat(ApiDefinition.ApiReturnFormat returnFormat)`
`void`	`setApiType(ApiDefinition.ApiType apiType)`
`void`	`setContentType(RequestExecutor.ContentType contentType)`
`void`	`setEndPoint(java.lang.String endPoint)`
`void`	`setJsonDateTimeFormat(java.lang.String dateTimeFormat)`
`void`	`setMethod(RequestExecutor.Method method)`
`void`	`setRequiresObjectId(boolean requires)`
`void`	`setUrlPath(java.lang.String urlPath)`
`void`	`setWithFullDetails(boolean isWithFullDetails)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiDefinition
```
public ApiDefinition(ApiDefinition.ApiType apiType,
                     java.lang.Class<?> entityClass)
```
    Constructor used with ApiType requests for which only one entity class needs to be specified, Example GET loans/123.
    
    Parameters:
    
    entityClass - determines API's endpoint (e.g. LoanAccount for loans/)
  - ApiDefinition
```
public ApiDefinition(ApiDefinition.ApiType apiType,
                     java.lang.Class<?> entityClass,
                     java.lang.Class<?> resultClass)
```
    Constructor used with ApiType requests for which two entity classes need to be specified, Example GET clients/123/loans.
    
    Parameters:
    
    entityClass - determines API's endpoint (e.g. LoanAccount for loans/)
    
    resultClass - determines the entity to be retrieved. E.g. loans in the API calls GET clients/333/loans
  - ApiDefinition
```
public ApiDefinition(ApiDefinition.ApiType apiType,
                     java.lang.String apiEndPoint,
                     java.lang.Class<?> resultClass)
```
    Constructor used with ApiType requests for which two api endpoints need to be specified and the api returns related entity associated with the second endpoint. Example GET api/settings/iddocumenttemplates, GET api/loans/transactions This constructor accepts the first api endpoint as a string but otherwise is identical to the
    
    Parameters:
    
    apiType - the API type
    
    apiEndPoint - determines API's endpoint string directly . E.g "settings" as in /api/settings
    
    resultClass - determines the entity to be retrieved. E.g. Organization in the API calls GET api/setting/organization
    
    See Also:
    
    This constructor can be used in cased when there is no Mambu class to map to the api endpoint. Example GET settings/iddocumenttemplates.
  - ApiDefinition
```
public ApiDefinition(java.lang.String urlPath,
                     RequestExecutor.ContentType contentType,
                     RequestExecutor.Method method,
                     java.lang.Class<?> retrunClass,
                     ApiDefinition.ApiReturnFormat returnFormt)
```
    Make ApiDefintion by explicitly specifying all required HTTPS request parameters.
    
    Parameters:
    
    urlPath - full URL path (without the https prefix). Example settings/branding/log
    
    contentType - content type
    
    method - method
    
    retrunClass - returned object's class
    
    returnFormt - returned format type
  - ApiDefinition
```
public ApiDefinition(ApiDefinition.ApiType apiType,
                     java.lang.Class<?> entityClass,
                     java.lang.Class<?> relatedEntity,
                     java.lang.Class<?> resultClass)
```
    Constructor which can be used with ApiType requests for which the result class must be specified independently of the related entity class. For example, when getting client's profile picture which returns a string object ( GET api/clients/\{ID\}/documents/PROFILE_PICTURE) or posting a profile picture, which returns a Boolean (POST api/clients/\{ID\}/documents/PROFILE_PICTURE)
    
    Parameters:
    
    entityClass - determines API's endpoint (e.g. LoanAccount for loans/)
    
    relatedEntity - related entity name class
    
    resultClass - determines the entity to be retrieved.
- Method Detail
  - getApiEndPoint
```
public static java.lang.String getApiEndPoint(java.lang.Class<?> entityClass)
```
  - getApiType
```
public ApiDefinition.ApiType getApiType()
```
  - getEndPoint
```
public java.lang.String getEndPoint()
```
  - isObjectIdNeeded
```
public boolean isObjectIdNeeded()
```
  - getMethod
```
public RequestExecutor.Method getMethod()
```
  - getContentType
```
public RequestExecutor.ContentType getContentType()
```
  - getRelatedEntity
```
public java.lang.String getRelatedEntity()
```
  - getApiReturnFormat
```
public ApiDefinition.ApiReturnFormat getApiReturnFormat()
```
  - getWithFullDetails
```
public boolean getWithFullDetails()
```
  - getReturnClass
```
public java.lang.Class<?> getReturnClass()
```
  - setApiType
```
public void setApiType(ApiDefinition.ApiType apiType)
```
  - setEndPoint
```
public void setEndPoint(java.lang.String endPoint)
```
  - setApiReturnFormat
```
public void setApiReturnFormat(ApiDefinition.ApiReturnFormat returnFormat)
```
  - setWithFullDetails
```
public void setWithFullDetails(boolean isWithFullDetails)
```
  - setContentType
```
public void setContentType(RequestExecutor.ContentType contentType)
```
  - setMethod
```
public void setMethod(RequestExecutor.Method method)
```
  - setJsonDateTimeFormat
```
public void setJsonDateTimeFormat(java.lang.String dateTimeFormat)
```
  - getJsonDateTimeFormat
```
public java.lang.String getJsonDateTimeFormat()
```
  - setRequiresObjectId
```
public void setRequiresObjectId(boolean requires)
```
  - getUrlPath
```
public java.lang.String getUrlPath()
```
  - setUrlPath
```
public void setUrlPath(java.lang.String urlPath)
```
  - addSerializationExclusionStrategy
```
public void addSerializationExclusionStrategy(com.google.gson.ExclusionStrategy exclusionStrategy)
```
    Add serialization ExclusionStrategy to the API definition
    
    Parameters:
    
    exclusionStrategy - exclusion strategy
  - getSerializationExclusionStrategies
```
public java.util.List<com.google.gson.ExclusionStrategy> getSerializationExclusionStrategies()
```
    Get serialization ExclusionStrategy specified in the API definition
    
    Returns:
    
    exclusion strategy
  - addJsonSerializer
```
public void addJsonSerializer(java.lang.Class<?> clazz,
                              com.google.gson.JsonSerializer<?> serializer)
```
    Add JsonSerializer for a specific class to the API definition
    
    Parameters:
    
    clazz - class
    
    serializer - JsonSerializer
  - getJsonSerializers
```
public java.util.HashMap<java.lang.Class<?>,com.google.gson.JsonSerializer<?>> getJsonSerializers()
```
    Get JsonSerializers specified in the API definition
    
    Returns:
    
    map of classes to JsonSerializer for these classes
  - addJsonDeserializer
```
public void addJsonDeserializer(java.lang.Class<?> clazz,
                                com.google.gson.JsonDeserializer<?> deserializer)
```
    Add JsonDeserializer for a specific class to the API definition
    
    Parameters:
    
    clazz - class
    
    deserializer - Json Deserializer
  - getJsonDeserializers
```
public java.util.HashMap<java.lang.Class<?>,com.google.gson.JsonDeserializer<?>> getJsonDeserializers()
```
    Get JsonDeserializers specified in the API definition
    
    Returns:
    
    map of classes to JsonDeserializers for these classes

Class ApiDefinition

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiDefinition

ApiDefinition

ApiDefinition

ApiDefinition

ApiDefinition

Method Detail

getApiEndPoint

getApiType

getEndPoint

isObjectIdNeeded

getMethod

getContentType

getRelatedEntity

getApiReturnFormat

getWithFullDetails

getReturnClass

setApiType

setEndPoint

setApiReturnFormat

setWithFullDetails

setContentType

setMethod

setJsonDateTimeFormat

getJsonDateTimeFormat

setRequiresObjectId

getUrlPath

setUrlPath

addSerializationExclusionStrategy

getSerializationExclusionStrategies

addJsonSerializer

getJsonSerializers

addJsonDeserializer

getJsonDeserializers