com.mambu.apisdk

Class MambuAPIFactory

java.lang.Object

com.mambu.apisdk.MambuAPIFactory

public class MambuAPIFactory
extends java.lang.Object

Factory for creating Mambu API Services in a singleton fashion.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_USER_AGENT_HEADER_VALUE

Method Summary

Modifier and Type	Method and Description
static AccountingService	getAccountingService() Get an instance of the AccountingService class
static ActivitiesService	getActivitiesService() Get an instance of the ActivitiesService class
static java.lang.String	getApplicationKey() Getter for an Application Key
static ClientsService	getClientService() Get an instance of the ClientService class
static CommentsService	getCommentsService() Get an instance of the CommentsService class
static CustomFieldValueService	getCustomFieldValueService() Get an instance of the CustomFieldValueService class
static CustomViewsService	getCustomViewsService() Get an instance of the CustomViewsService class
static DatabaseService	getDatabaseService() Get an instance of the DatabaseService class
static DocumentsService	getDocumentsService() Get an instance of the DocumentsService class
static DocumentTemplatesService	getDocumentTemplatesService() Get an instance of the DocumentTemplatesService class
static IntelligenceService	getIntelligenceService() Get an instance of the IntelligenceService class
static LinesOfCreditService	getLineOfCreditService() Get an instance of the LinesOfCreditService class
static LoansService	getLoanService() Get an instance of the LoanService class
static NotificationsService	getNotificationsService() Get an instance of the NotificationsService class
static OrganizationService	getOrganizationService() Get an instance of the OrganizationService class
static RepaymentsService	getRepaymentsService() Get an instance of the RepaymentsService class
static SavingsService	getSavingsService() Get an instance of the SavingsService class
static SearchService	getSearchService() Get an instance of the SearchService class
static TasksService	getTasksService() Get an instance of the TasksService class
static UsersService	getUsersService() Get an instance of the UsersService class
static void	setApplicationKey(java.lang.String appKey) Setter for an Application Key
static void	setUp(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
static void	setUp(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
static void	setUp(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.
static void	setUp(java.lang.String domain, java.lang.String username, java.lang.String password, java.lang.String userAgentHeaderValue) Convenience method for setting up the Guice Module with data required for accessing the remote server.
static void	setUpWithApiKey(Protocol protocol, java.lang.String domain, java.lang.String apiKey) Set up the Guice Module with data required for accessing the remote server
static void	setUpWithApiKey(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
static void	setUpWithApiKey(java.lang.String domain, java.lang.String apiKey) Convenience method for setting up the Guice Module with data required for accessing the remote server.
static void	setUpWithApiKey(java.lang.String domain, java.lang.String apiKey, java.lang.String userAgentHeaderValue) Convenience method for setting up the Guice Module with data required for accessing the remote server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USER_AGENT_HEADER_VALUE

public static final java.lang.String DEFAULT_USER_AGENT_HEADER_VALUE

See Also:

Constant Field Values

Method Detail

setUp

public static void setUp(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. 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

setUp

public static void setUp(java.lang.String domain,
                         java.lang.String username,
                         java.lang.String password,
                         java.lang.String userAgentHeaderValue)

Convenience method for setting up the Guice Module with data required for accessing the remote server. 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

userAgentHeaderValue - the user agent header value to be sent along with all request calls

setUp

public static void setUp(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

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

setUp

public static void setUp(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

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 sent along with all request calls

setUpWithApiKey

public static void setUpWithApiKey(java.lang.String domain,
                                   java.lang.String apiKey)

Convenience method for setting up the Guice Module with data required for accessing the remote server. 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

setUpWithApiKey

public static void setUpWithApiKey(java.lang.String domain,
                                   java.lang.String apiKey,
                                   java.lang.String userAgentHeaderValue)

Convenience method for setting up the Guice Module with data required for accessing the remote server. 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

userAgentHeaderValue - the user agent header value to be sent along with all request calls

setUpWithApiKey

public static void setUpWithApiKey(Protocol protocol,
                                   java.lang.String domain,
                                   java.lang.String apiKey)

Set up the Guice Module with data required for accessing the remote server

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

setUpWithApiKey

public static void setUpWithApiKey(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

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 sent along with all request calls

getClientService

public static ClientsService getClientService()
                                       throws MambuApiException

Get an instance of the ClientService class

Returns:

the obtained instance

Throws:

MambuApiException

getLoanService

public static LoansService getLoanService()
                                   throws MambuApiException

Get an instance of the LoanService class

Returns:

the obtained instance

Throws:

MambuApiException

getSavingsService

public static SavingsService getSavingsService()
                                        throws MambuApiException

Get an instance of the SavingsService class

Returns:

the obtained instance

Throws:

MambuApiException

getIntelligenceService

public static IntelligenceService getIntelligenceService()
                                                  throws MambuApiException

Get an instance of the IntelligenceService class

Returns:

the obtained instance

Throws:

MambuApiException

getRepaymentsService

public static RepaymentsService getRepaymentsService()
                                              throws MambuApiException

Get an instance of the RepaymentsService class

Returns:

the obtained instance

Throws:

MambuApiException

getOrganizationService

public static OrganizationService getOrganizationService()
                                                  throws MambuApiException

Get an instance of the OrganizationService class

Returns:

the obtained instance

Throws:

MambuApiException

getAccountingService

public static AccountingService getAccountingService()
                                              throws MambuApiException

Get an instance of the AccountingService class

Returns:

the obtained instance

Throws:

MambuApiException

getUsersService

public static UsersService getUsersService()
                                    throws MambuApiException

Get an instance of the UsersService class

Returns:

the obtained instance

Throws:

MambuApiException

getSearchService

public static SearchService getSearchService()
                                      throws MambuApiException

Get an instance of the SearchService class

Returns:

the obtained instance

Throws:

MambuApiException

getTasksService

public static TasksService getTasksService()
                                    throws MambuApiException

Get an instance of the TasksService class

Returns:

the obtained instance

Throws:

MambuApiException

getDocumentsService

public static DocumentsService getDocumentsService()
                                            throws MambuApiException

Get an instance of the DocumentsService class

Returns:

the obtained instance

Throws:

MambuApiException

getActivitiesService

public static ActivitiesService getActivitiesService()
                                              throws MambuApiException

Get an instance of the ActivitiesService class

Returns:

the obtained instance

Throws:

MambuApiException

getCommentsService

public static CommentsService getCommentsService()
                                          throws MambuApiException

Get an instance of the CommentsService class

Returns:

the obtained instance

Throws:

MambuApiException

getLineOfCreditService

public static LinesOfCreditService getLineOfCreditService()
                                                   throws MambuApiException

Get an instance of the LinesOfCreditService class

Returns:

the obtained instance

Throws:

MambuApiException

getCustomFieldValueService

public static CustomFieldValueService getCustomFieldValueService()
                                                          throws MambuApiException

Get an instance of the CustomFieldValueService class

Returns:

the obtained instance

Throws:

MambuApiException

getCustomViewsService

public static CustomViewsService getCustomViewsService()
                                                throws MambuApiException

Get an instance of the CustomViewsService class

Returns:

the obtained instance

Throws:

MambuApiException

getDocumentTemplatesService

public static DocumentTemplatesService getDocumentTemplatesService()
                                                            throws MambuApiException

Get an instance of the DocumentTemplatesService class

Returns:

the obtained instance

Throws:

MambuApiException

getDatabaseService

public static DatabaseService getDatabaseService()
                                          throws MambuApiException

Get an instance of the DatabaseService class

Returns:

the obtained instance

Throws:

MambuApiException

getNotificationsService

public static NotificationsService getNotificationsService()
                                                    throws MambuApiException

Get an instance of the NotificationsService class

Returns:

the obtained NotificationsService instance

Throws:

MambuApiException

setApplicationKey

public static void setApplicationKey(java.lang.String appKey)

Setter for an Application Key

Parameters:

appKey -

getApplicationKey

public static java.lang.String getApplicationKey()

Getter for an Application Key

Returns:

String