com.mambu.apisdk.util

Class URLHelper

java.lang.Object

com.mambu.apisdk.util.URLHelper

public class URLHelper
extends java.lang.Object

Helper class for operations with the URL adresses

Constructor Summary

Constructors

Constructor and Description
URLHelper(java.lang.String protocol, java.lang.String domainName, java.lang.String userAgentHeaderValue)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addDetailsParam(java.lang.String urlString, RequestExecutor.Method method, RequestExecutor.ContentType contentTypeFormat, ParamsMap params) Appends the details level query param to a given URL in case exist
java.lang.String	addJsonPaginationParams(java.lang.String urlString, RequestExecutor.Method method, RequestExecutor.ContentType contentTypeFormat, ParamsMap params) Add pagination params to a given URL String for POST with application/json content type.
java.lang.String	createUrl(java.lang.String details) Creates an URL String with an protocol, a domainName and some given details
java.lang.String	createUrlWithParams(java.lang.String urlString, ParamsMap paramsMap) Appends some params to a given URL String NOTE: this non-static version is used in SDK Mockito tests (see MambuAPIServiceTest).
static java.lang.String	makeUrlWithParams(java.lang.String urlString, ParamsMap paramsMap) Static helper to Append URL params to a given URL String
java.lang.String	userAgentHeaderValue() Gets the user agent header value as set once with the factory initialization

Methods inherited from class java.lang.Object

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

Constructor Detail

URLHelper

@Inject
public URLHelper(java.lang.String protocol,
                         java.lang.String domainName,
                         java.lang.String userAgentHeaderValue)

Method Detail

createUrl

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

Creates an URL String with an protocol, a domainName and some given details

Parameters:

details - the extra details

Returns:

the created URL String in url-encoded format

createUrlWithParams

public java.lang.String createUrlWithParams(java.lang.String urlString,
                                            ParamsMap paramsMap)

Appends some params to a given URL String NOTE: this non-static version is used in SDK Mockito tests (see MambuAPIServiceTest). Mockito cannot use static methods

Parameters:

urlString - the already created URL String

paramsMap - the params which must be added

Returns:

the complete URL

makeUrlWithParams

public static java.lang.String makeUrlWithParams(java.lang.String urlString,
                                                 ParamsMap paramsMap)

Static helper to Append URL params to a given URL String

Parameters:

urlString - the already created URL String

paramsMap - the params which must be added

Returns:

the complete URL

addJsonPaginationParams

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

Add pagination params to a given URL String for POST with application/json content type. Pagination parameters shall be be added to the URL string. See MBU-8975. Only "offset" and "limit" parameters are added. For example, in API call POST {JSONFilterConstraints} /api/loans/search?offset=0&limit=5

Parameters:

urlString - original URL string

method - method

contentTypeFormat - content type format

params - input parameters. If pagination parameters are added to the URL string then they are removed from the original params map

Returns:

URL string with pagination parameters added for POST with application/json content type

addDetailsParam

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

Appends the details level query param to a given URL in case exist

Parameters:

urlString - the String URL where the details level will be appended

method - the HTTP method of the request

contentTypeFormat - the content type of the request

params - the params of the request

Returns:

the appended URL

userAgentHeaderValue

public java.lang.String userAgentHeaderValue()

Gets the user agent header value as set once with the factory initialization

Returns:

String value representing the user agent header value