com.mambu.apisdk

Class MambuAPIServiceFactory

java.lang.Object

com.mambu.apisdk.MambuAPIServiceFactory

public final class MambuAPIServiceFactory
extends java.lang.Object

Factory for creating Mambu API Service objects that have fixed a tenant's Mambu credentials

Method Summary

Modifier and Type	Method and Description
AccountingService	getAccountingService() Get an instance of the AccountingService class, non-static version of MambuAPIFactory.getAccountingService()
ActivitiesService	getActivitiesService() Get an instance of the ActivitiesService class, non-static version of MambuAPIFactory.getActivitiesService()
ClientsService	getClientService() Get an instance of the ClientService class, non-static version of MambuAPIFactory.getClientService()
CommentsService	getCommentsService() Get an instance of the CommentsService class
CustomFieldValueService	getCustomFieldValueService() Get an instance of the CustomFieldValueService class
CustomViewsService	getCustomViewsService() Get an instance of the CustomViewsService class
DatabaseService	getDatabaseService() Get an instance of the DatabaseService class
DocumentsService	getDocumentsService() Get an instance of the DocumentsService class, non-static version of MambuAPIFactory.getDocumentsService()
DocumentTemplatesService	getDocumentTemplatesService() Get an instance of the DocumentTemplatesService class
static MambuAPIServiceFactory	getFactory(Protocol protocol, java.lang.String domain, java.lang.String username, java.lang.String password) Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in
static MambuAPIServiceFactory	getFactory(Protocol protocol, java.lang.String domain, java.lang.String username, java.lang.String password, java.lang.String userAgentHeaderValue) Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in
static MambuAPIServiceFactory	getFactory(java.lang.String domain, java.lang.String username, java.lang.String password) Convenience method for setting up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in.
static MambuAPIServiceFactory	getFactoryWithApiKey(Protocol protocol, java.lang.String domain, java.lang.String apiKey) Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in
static MambuAPIServiceFactory	getFactoryWithApiKey(Protocol protocol, java.lang.String domain, java.lang.String apiKey, java.lang.String userAgentHeaderValue) Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in
static MambuAPIServiceFactory	getFactoryWithApiKey(java.lang.String domain, java.lang.String apiKey) Convenience method for setting up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in.
IntelligenceService	getIntelligenceService() Get an instance of the IntelligenceService class, non-static version of MambuAPIFactory.getIntelligenceService()
LinesOfCreditService	getLineOfCreditService() Get an instance of the LinesOfCreditService class
LoansService	getLoanService() Get an instance of the LoanService class, non-static version of MambuAPIFactory.getLoanService()
NotificationsService	getNotificationsService() Get an instance of the NotificationsService class
OrganizationService	getOrganizationService() Get an instance of the OrganizationService class, non-static version of MambuAPIFactory.getOrganizationService()
RepaymentsService	getRepaymentsService() Get an instance of the RepaymentsService class, non-static version of MambuAPIFactory.getRepaymentsService()
SavingsService	getSavingsService() Get an instance of the SavingsService class, non-static version of MambuAPIFactory.getSavingsService()
SearchService	getSearchService() Get an instance of the SearchService class, non-static version of MambuAPIFactory.getSearchService()
TasksService	getTasksService() Get an instance of the TasksService class, non-static version of MambuAPIFactory.getTasksService()
UsersService	getUsersService() Get an instance of the UsersService class, non-static version of MambuAPIFactory.getUsersService()

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static MambuAPIServiceFactory getFactory(java.lang.String domain,
                                                java.lang.String username,
                                                java.lang.String password)

Convenience method for setting up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in. The application protocol that is used is HTTPS

Parameters:

domain - the domain where the server is found

username - the name of the user

password - the password used by the user

Returns:

factory object to create API service objects which are bound to the given credentials

getFactory

public static MambuAPIServiceFactory getFactory(Protocol protocol,
                                                java.lang.String domain,
                                                java.lang.String username,
                                                java.lang.String password)

Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in

Parameters:

protocol - the protocol used for communication

domain - the domain where the server is found

username - the name of the user

password - the password used by the user

Returns:

factory object to create API service objects which are bound to the given credentials

getFactory

public static MambuAPIServiceFactory getFactory(Protocol protocol,
                                                java.lang.String domain,
                                                java.lang.String username,
                                                java.lang.String password,
                                                java.lang.String userAgentHeaderValue)

Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in

Parameters:

protocol - the protocol used for communication

domain - the domain where the server is found

username - the name of the user

password - the password used by the user

userAgentHeaderValue - the user agent header value to be passed with all requests

Returns:

factory object to create API service objects which are bound to the given credentials

getFactoryWithApiKey

public static MambuAPIServiceFactory getFactoryWithApiKey(java.lang.String domain,
                                                          java.lang.String apiKey)

Convenience method for setting up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in. The application protocol that is used is HTTPS

Parameters:

domain - the domain where the server is found

apiKey - the ApiKey header for an ApiConsumer. @see https://support.mambu.com/docs/api-consumers

Returns:

factory object to create API service objects which are bound to the given credentials

getFactoryWithApiKey

public static MambuAPIServiceFactory getFactoryWithApiKey(Protocol protocol,
                                                          java.lang.String domain,
                                                          java.lang.String apiKey)

Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in

Parameters:

protocol - the protocol used for communication

domain - the domain where the server is found

apiKey - the ApiKey header for an ApiConsumer. @see https://support.mambu.com/docs/api-consumers

Returns:

factory object to create API service objects which are bound to the given credentials

getFactoryWithApiKey

public static MambuAPIServiceFactory getFactoryWithApiKey(Protocol protocol,
                                                          java.lang.String domain,
                                                          java.lang.String apiKey,
                                                          java.lang.String userAgentHeaderValue)

Set up the Guice Module with data required for accessing the remote server, returning a factory object to retrieve Mambu API services that have Mambu credentials built-in

Parameters:

protocol - the protocol used for communication

domain - the domain where the server is found

apiKey - the ApiKey header for an ApiConsumer. @see https://support.mambu.com/docs/api-consumers

userAgentHeaderValue - the user agent header value to be passed with all requests

Returns:

factory object to create API service objects which are bound to the given credentials

getClientService

public ClientsService getClientService()
                                throws MambuApiException

Get an instance of the ClientService class, non-static version of MambuAPIFactory.getClientService()

Returns:

the obtained instance

Throws:

MambuApiException

getLoanService

public LoansService getLoanService()
                            throws MambuApiException

Get an instance of the LoanService class, non-static version of MambuAPIFactory.getLoanService()

Returns:

the obtained instance

Throws:

MambuApiException

getSavingsService

public SavingsService getSavingsService()
                                 throws MambuApiException

Get an instance of the SavingsService class, non-static version of MambuAPIFactory.getSavingsService()

Returns:

the obtained instance

Throws:

MambuApiException

getIntelligenceService

public IntelligenceService getIntelligenceService()
                                           throws MambuApiException

Get an instance of the IntelligenceService class, non-static version of MambuAPIFactory.getIntelligenceService()

Returns:

the obtained instance

Throws:

MambuApiException

getRepaymentsService

public RepaymentsService getRepaymentsService()
                                       throws MambuApiException

Get an instance of the RepaymentsService class, non-static version of MambuAPIFactory.getRepaymentsService()

Returns:

the obtained instance

Throws:

MambuApiException

getOrganizationService

public OrganizationService getOrganizationService()
                                           throws MambuApiException

Get an instance of the OrganizationService class, non-static version of MambuAPIFactory.getOrganizationService()

Returns:

the obtained instance

Throws:

MambuApiException

getAccountingService

public AccountingService getAccountingService()
                                       throws MambuApiException

Get an instance of the AccountingService class, non-static version of MambuAPIFactory.getAccountingService()

Returns:

the obtained instance

Throws:

MambuApiException

getUsersService

public UsersService getUsersService()
                             throws MambuApiException

Get an instance of the UsersService class, non-static version of MambuAPIFactory.getUsersService()

Returns:

the obtained instance

Throws:

MambuApiException

getSearchService

public SearchService getSearchService()
                               throws MambuApiException

Get an instance of the SearchService class, non-static version of MambuAPIFactory.getSearchService()

Returns:

the obtained instance

Throws:

MambuApiException

getTasksService

public TasksService getTasksService()
                             throws MambuApiException

Get an instance of the TasksService class, non-static version of MambuAPIFactory.getTasksService()

Returns:

the obtained instance

Throws:

MambuApiException

getDocumentsService

public DocumentsService getDocumentsService()
                                     throws MambuApiException

Get an instance of the DocumentsService class, non-static version of MambuAPIFactory.getDocumentsService()

Returns:

the obtained instance

Throws:

MambuApiException

getActivitiesService

public ActivitiesService getActivitiesService()
                                       throws MambuApiException

Get an instance of the ActivitiesService class, non-static version of MambuAPIFactory.getActivitiesService()

Returns:

the obtained instance

Throws:

MambuApiException

getCommentsService

public CommentsService getCommentsService()
                                   throws MambuApiException

Get an instance of the CommentsService class

Returns:

the obtained instance

Throws:

MambuApiException

getLineOfCreditService

public LinesOfCreditService getLineOfCreditService()
                                            throws MambuApiException

Get an instance of the LinesOfCreditService class

Returns:

the obtained instance

Throws:

MambuApiException

getCustomFieldValueService

public CustomFieldValueService getCustomFieldValueService()
                                                   throws MambuApiException

Get an instance of the CustomFieldValueService class

Returns:

the obtained instance

Throws:

MambuApiException

getCustomViewsService

public CustomViewsService getCustomViewsService()
                                         throws MambuApiException

Get an instance of the CustomViewsService class

Returns:

the obtained instance

Throws:

MambuApiException

getDocumentTemplatesService

public DocumentTemplatesService getDocumentTemplatesService()
                                                     throws MambuApiException

Get an instance of the DocumentTemplatesService class

Returns:

the obtained instance

Throws:

MambuApiException

getDatabaseService

public DatabaseService getDatabaseService()
                                   throws MambuApiException

Get an instance of the DatabaseService class

Returns:

the obtained instance

Throws:

MambuApiException

getNotificationsService

public NotificationsService getNotificationsService()
                                             throws MambuApiException

Get an instance of the NotificationsService class

Returns:

newly obtained instance of NotificationsService

Throws:

MambuApiException