com.mambu.apisdk

Class MambuAPIService

java.lang.Object

com.mambu.apisdk.MambuAPIService

public class MambuAPIService
extends java.lang.Object

Mambu service to call the APIs

Constructor Summary

Constructors

Constructor and Description
MambuAPIService(java.lang.String domainName, java.lang.String username, java.lang.String password, java.lang.String apiKey, RequestExecutor executor, URLHelper urlHelper) Creates a Mambu API Service class

Method Summary

Modifier and Type	Method and Description
java.lang.String	createUrl(java.lang.String details) Creates the URL for the request executor
java.lang.String	createUrl(java.lang.String details, int offset, int limit) Returns an url containing limit/offset params.
java.io.ByteArrayOutputStream	executeRequest(java.lang.String urlString, ParamsMap params, ApiDefinition apiDefinition) Delegates the execution to a RequestExecutor.
java.lang.String	executeRequest(java.lang.String urlString, ParamsMap params, RequestExecutor.Method method) Executes the request for a given url and some parameters using a specified method See more info here: http://stackoverflow.com/questions/2793150/how-to-use-java -net-urlconnection-to-fire-and-handle-http-requests
java.lang.String	executeRequest(java.lang.String urlString, ParamsMap params, RequestExecutor.Method method, RequestExecutor.ContentType contentTypeFormat) Executes the request for a given url, some parameters using a specified method and also a specified contentType format.
java.lang.String	executeRequest(java.lang.String urlString, RequestExecutor.Method method) Executes the request for a given url string using a specified method See more info here: http://stackoverflow.com/questions/2793150/how-to-use-java -net-urlconnection-to-fire-and-handle-http-requests
java.lang.String	executeRequest(java.lang.String urlString, RequestExecutor.Method method, RequestExecutor.ContentType contentTypeFormat) Executes the request for a given url (with parameters) using a specified method and specified contentType format.

Methods inherited from class java.lang.Object

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

Constructor Detail

MambuAPIService

@Inject
public MambuAPIService(java.lang.String domainName,
                               java.lang.String username,
                               java.lang.String password,
                               java.lang.String apiKey,
                               RequestExecutor executor,
                               URLHelper urlHelper)

Creates a Mambu API Service class

Parameters:

username - username to connect with to the apis

password - password to connect with to the apis

domainName - based domain name for the tenant (eg: mytenant.mambu.com)

apiKey - the apiKey required for the authentication

Method Detail

executeRequest

public java.lang.String executeRequest(java.lang.String urlString,
                                       RequestExecutor.Method method)
                                throws MambuApiException

Executes the request for a given url string using a specified method See more info here: http://stackoverflow.com/questions/2793150/how-to-use-java -net-urlconnection-to-fire-and-handle-http-requests

Parameters:

urlString -

method -

Returns:

HTTP response String. The response string for the http request. It is either an application specific response (with the content being specific for each request) or an error response for the http request.

Throws:

MambuApiException

executeRequest

public java.lang.String executeRequest(java.lang.String urlString,
                                       ParamsMap params,
                                       RequestExecutor.Method method)
                                throws MambuApiException

Executes the request for a given url and some parameters using a specified method See more info here: http://stackoverflow.com/questions/2793150/how-to-use-java -net-urlconnection-to-fire-and-handle-http-requests

Parameters:

urlString -

params -

method -

Returns:

String

Throws:

MambuApiException

executeRequest

public java.lang.String executeRequest(java.lang.String urlString,
                                       ParamsMap params,
                                       RequestExecutor.Method method,
                                       RequestExecutor.ContentType contentTypeFormat)
                                throws MambuApiException

Executes the request for a given url, some parameters using a specified method and also a specified contentType format. See more info here: http://stackoverflow.com/questions/2793150/how-to-use-java -net-urlconnection-to-fire-and-handle-http-requests

Parameters:

urlString -

params -

method -

contentTypeFormat -

Returns:

String

Throws:

MambuApiException

executeRequest

public java.io.ByteArrayOutputStream executeRequest(java.lang.String urlString,
                                                    ParamsMap params,
                                                    ApiDefinition apiDefinition)
                                             throws MambuApiException

Delegates the execution to a RequestExecutor. Used for requests that requires downloading content through the API (like zip archives). It gets the InputStream from the response and converts it into a ByteArrayOutputStream for laster use.

Parameters:

urlString - The URL string

params - The parameters map

apiDefinition - The API definition

Returns:

ByteArrayOutputStream of the response content.

Throws:

MambuApiException

executeRequest

public java.lang.String executeRequest(java.lang.String urlString,
                                       RequestExecutor.Method method,
                                       RequestExecutor.ContentType contentTypeFormat)
                                throws MambuApiException

Executes the request for a given url (with parameters) using a specified method and specified contentType format. See more info here: http://stackoverflow.com/questions/2793150/how-to-use-java -net-urlconnection-to-fire-and-handle-http-requests

Parameters:

urlString -

method -

contentTypeFormat -

Returns:

String

Throws:

MambuApiException

createUrl

public java.lang.String createUrl(java.lang.String details)

Creates the URL for the request executor

Parameters:

details -

Returns:

String

createUrl

public java.lang.String createUrl(java.lang.String details,
                                  int offset,
                                  int limit)

Returns an url containing limit/offset params.

Parameters:

details - URL details

offset - offset to start from

limit - max. number of entries

Returns:

URL for a limited query