com.mambu.apisdk.util

Class RequestExecutorImpl

java.lang.Object

com.mambu.apisdk.util.RequestExecutorImpl

All Implemented Interfaces:

RequestExecutor

public class RequestExecutorImpl
extends java.lang.Object
implements RequestExecutor

Implementation of executing url requests with basic authorization

Nested Class Summary

Nested classes/interfaces inherited from interface com.mambu.apisdk.util.RequestExecutor

RequestExecutor.ContentType, RequestExecutor.Method

Constructor Summary

Constructors

Constructor and Description
RequestExecutorImpl(HttpClientProvider httpClientProvider, URLHelper urlHelper)

Method Summary

Modifier and Type	Method and Description
java.io.ByteArrayOutputStream	executeRequest(java.lang.String urlString, ParamsMap params, ApiDefinition apiDefinition) Gets the InputStream from the response and converts it into a ByteArrayOutputStream for laster use.
java.lang.String	executeRequest(java.lang.String urlString, ParamsMap params, RequestExecutor.Method method) Executes a request with given url, some params and a request method.
java.lang.String	executeRequest(java.lang.String urlString, ParamsMap params, RequestExecutor.Method method, RequestExecutor.ContentType contentTypeFormat) Executes a request with given url and specifying the contentType, with some params and a request method.
java.lang.String	executeRequest(java.lang.String urlString, RequestExecutor.Method method) Executes a request with given url and request method
java.lang.String	executeRequest(java.lang.String urlString, RequestExecutor.Method method, RequestExecutor.ContentType contentTypeFormat) Executes a request with given url and specifying the contentType, (without params) and a request method.
void	setAuthorization(java.lang.String apiKey)
void	setAuthorization(java.lang.String username, java.lang.String password) Set the credentials required for the server authorization

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestExecutorImpl

@Inject
public RequestExecutorImpl(HttpClientProvider httpClientProvider,
                                   URLHelper urlHelper)

Method Detail

executeRequest

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

Description copied from interface: RequestExecutor

Executes a request with given url and request method

Specified by:

executeRequest in interface RequestExecutor

Parameters:

urlString - the url to execute on. eg: https://demo.mambu.com/api/clients

Returns:

Mambu Response String

Throws:

MambuApiException

executeRequest

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

Description copied from interface: RequestExecutor

Executes a request with given url, some params and a request method. Defaults the content Type to WWW_FORM ("application/x-www-form-urlencoded; charset=UTF-8")

Specified by:

executeRequest in interface RequestExecutor

Parameters:

urlString - the url to execute on. eg: https://demo.mambu.com/api/clients

params - the parameters eg: {clientId=id}

method - the method (e.g. GET or PUT)

Returns:

Mambu Response String

Throws:

MambuApiException

executeRequest

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

Description copied from interface: RequestExecutor

Executes a request with given url and specifying the contentType, (without params) and a request method.

Specified by:

executeRequest in interface RequestExecutor

Parameters:

urlString - the url to execute on. eg: https://demo.mambu.com/api/clients

method - the method (e.g. GET or PUT)

contentTypeFormat - enum for the content type string (e.g WWW_FORM or JSON: will be using respectively the "application/x-www-form-urlencoded; charset=UTF-8" or "application/json; charset=UTF-8";)

Returns:

Mambu Response String

Throws:

MambuApiException

executeRequest

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

Description copied from interface: RequestExecutor

Executes a request with given url and specifying the contentType, with some params and a request method.

Specified by:

executeRequest in interface RequestExecutor

Parameters:

urlString - the url to execute on. eg: https://demo.mambu.com/api/clients

params - the parameters eg: {clientId=id}, {JSON=jsonString}

method - the method (e.g. GET or PUT)

contentTypeFormat - enum for the content type string (e.g WWW_FORM or JSON: will be using respectively the "application/x-www-form-urlencoded; charset=UTF-8" or "application/json; charset=UTF-8";)

Returns:

Mambu Response String

Throws:

MambuApiException

executeRequest

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

Gets the InputStream from the response and converts it into a ByteArrayOutputStream for laster use. (i.e executes a request in order to download content and returns it as a ByteArrayOutputStream)

Specified by:

executeRequest in interface RequestExecutor

Parameters:

urlString - the url to execute on. eg: https://demo.mambu.com/api/database/backup/LATEST

params - the parameters eg: {clientId=id}, {JSON=jsonString}

apiDefinition - the ApiDefinition holding details like HTTP method, content type and API return type

Returns:

A ByteArrayOutputStream from the InputStream of the HTTP response.

Throws:

MambuApiException

setAuthorization

public void setAuthorization(java.lang.String username,
                             java.lang.String password)

Description copied from interface: RequestExecutor

Set the credentials required for the server authorization

Specified by:

setAuthorization in interface RequestExecutor

setAuthorization

public void setAuthorization(java.lang.String apiKey)

Specified by:

setAuthorization in interface RequestExecutor