enableCertificatesValidation whether enable the SSL certificates validation, this for example when the certificate is a self-signed certificate to by-pass

errorResponse

open val errorResponse: String

errorResponse is the instance that contains error message from request

HMAC_SHA256_ALGORITHM

val HMAC_SHA256_ALGORITHM: String = "HmacSHA256"

HMAC_SHA256_ALGORITHM is constant that contains "HMAC SHA 256" algorithm type

HMAC_SHA512_ALGORITHM

val HMAC_SHA512_ALGORITHM: String = "HmacSHA512"

HMAC_SHA512_ALGORITHM is constant that contains "HMAC SHA 512" algorithm type

isSuccessfulRequest

private open var isSuccessfulRequest: Boolean

isSuccessfulRequest whether the request has been successful

MD5_ALGORITHM

val MD5_ALGORITHM: String = "MD5"

MD5_ALGORITHM is constant that contains "MD5" algorithm type

okHttpClient

private open var okHttpClient: OkHttpClient

**okHttpClient** -> the http client to execute the requests

request

private open var request: Request.Builder

request is the instance useful for the requests

response

open val response: String

response is the instance that contains response message from request to return

SHA1_ALGORITHM

val SHA1_ALGORITHM: String = "SHA-1"

SHA1_ALGORITHM is constant that contains "SHA-1" algorithm type

SHA256_ALGORITHM

val SHA256_ALGORITHM: String = "SHA-256"

SHA256_ALGORITHM is constant that contains "SHA-256" algorithm type

statusCode

private open var statusCode: Int

statusCode status code of a request

Functions

addHeader

private open fun <T> addHeader(headerKey: String, headerValue: T)

Method to set the headers of an "HTTP" request

assembleParamsList

@SafeVarargs

fun <T> assembleParamsList(separator: String, params: Array<T>): String

open fun <T> assembleParamsList(separator: String, params: ArrayList<T>): String

Method to concatenate a list of params

assembleSeparatedParamsList

@SafeVarargs

fun <T> assembleSeparatedParamsList(starterSeparator: String, enderSeparator: String, params: Array<T>): String

open fun <T> assembleSeparatedParamsList(starterSeparator: String, enderSeparator: String, params: ArrayList<T>): String

Method to concatenate a list of params

base64Digest

open fun base64Digest(data: Array<Byte>, algorithm: String): String

open fun base64Digest(data: String, algorithm: String): String

Method to get digest

checkToCreateDirs

private open fun checkToCreateDirs(pathName: String)

Method to check if the pathname (without the name and the suffix of the file to save) given by the user exists then if not exists create that pathname

concatenateParamsList

@SafeVarargs

fun <T> concatenateParamsList(initialChar: String, key: String, params: Array<T>): String

open fun <T> concatenateParamsList(initialChar: String, key: String, params: ArrayList<T>): String

Method to concatenate a series of same key param

createDataURIScheme

open fun createDataURIScheme(file: File): String

Method to create a data URI scheme

digest

open fun digest(data: Array<Byte>, algorithm: String): Array<Byte>

open fun digest(data: String, algorithm: String): Array<Byte>

Method to get digest

downloadFile

open fun downloadFile(url: String, pathName: String, save: Boolean): File

Method to download a file from an "URL" source

enableCertificatesValidation

open fun enableCertificatesValidation(enableCertificatesValidation: Boolean)

Method to set programmatically enableCertificatesValidation value

encodeAdditionalParams

open fun <T> encodeAdditionalParams(mandatoryParams: String, extraParams: APIRequest.Params): String

Method to assemble a query string params of an "HTTP" request

encodeBodyParams

open fun <T> encodeBodyParams(bodyParams: APIRequest.Params): String

Method to assemble a body params of an "HTTP" request

encodeQueryParams

open fun <T> encodeQueryParams(queryParams: APIRequest.Params): String

Method to assemble a query params for an "HTTP" request

getBase64Signature

open fun getBase64Signature(signatureKey: Array<Byte>, data: String, algorithm: String): String

open fun getBase64Signature(signatureKey: String, data: String, algorithm: String): String

Method to get params signature for an "HTTP" request

getJSONErrorResponse

open fun <T> getJSONErrorResponse(): T

Method to get the error response of the request No-any params required

getJSONResponse

open fun <T> getJSONResponse(): T

Method to get the response of the request No-any params required

getResponseStatusCode

open fun getResponseStatusCode(): Int

Method to get status response code of the request No-any params required

getSignature

open fun getSignature(signatureKey: String, data: String, algorithm: String): String

Method to get params signature for an "HTTP" request

isSuccessful

open fun isSuccessful(): Boolean

Method to get whether the response has been successful No-any params required

parseResponseAsJson

private open fun <T> parseResponseAsJson(response: String): T

Method to parse the response of the request and format it as "JSON"

performRequest

private open fun performRequest()

Method to get the response of an "HTTP" request No-any params required

printErrorResponse

open fun printErrorResponse()

Method to print the error response of the request No-any params required

printJSONErrorResponse

open fun <T> printJSONErrorResponse()

Method to print the error response of the request No-any params required

sendAPIRequest

open fun sendAPIRequest(requestUrl: String, method: APIRequest.RequestMethod)

open fun sendAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, queryParams: APIRequest.Params)

Method to send an api request

open fun sendAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headers: APIRequest.Headers)

open fun sendAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headers: APIRequest.Headers, queryParams: APIRequest.Params)

Method to send an api request with different headers

open fun <T> sendAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headerKey: String, headerValue: T)

open fun <T> sendAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headerKey: String, headerValue: T, queryParams: APIRequest.Params)

Method to send an api request with a single header

sendJSONPayloadedAPIRequest

open fun sendJSONPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, payload: APIRequest.Params)

Method to send an api request with a payload formatted in "JSON"

open fun sendJSONPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headers: APIRequest.Headers, payload: APIRequest.Params)

Method to send an api request with a payload formatted in "JSON" and with different headers

open fun <T> sendJSONPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headerKey: String, headerValue: T, payload: APIRequest.Params)

Method to send an api request with a payload formatted in "JSON" and with a single header

sendPayloadedAPIRequest

open fun sendPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, payload: APIRequest.Params)

open fun sendPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, payload: MultipartBody)

Method to send an api request with a payload

open fun sendPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headers: APIRequest.Headers, payload: APIRequest.Params)

open fun sendPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headers: APIRequest.Headers, payload: MultipartBody)

Method to send an api request with a payload and with different headers

open fun <T> sendPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headerKey: String, headerValue: T, payload: APIRequest.Params)

open fun <T> sendPayloadedAPIRequest(requestUrl: String, method: APIRequest.RequestMethod, headerKey: String, headerValue: T, payload: MultipartBody)

Method to send an api request with a payload and with a single header

setConnectionTimeout

open fun setConnectionTimeout(requestTimeout: Long)

Method to set programmatically timeout for the request

setContentType

open fun setContentType(contentType: String)

Method to set the content type of the payload of the request

setDefaultErrorResponse

open fun setDefaultErrorResponse(defaultErrorResponse: String)

Method to set programmatically default error message to return if is not request error

setHeaders

private open fun setHeaders(headers: APIRequest.Headers)

Method to set the headers of an "HTTP" request

setRequest

private open fun setRequest(requestUrl: String, method: APIRequest.RequestMethod)

private open fun setRequest(requestUrl: String, method: APIRequest.RequestMethod, payload: MultipartBody)

private open fun setRequest(requestUrl: String, method: APIRequest.RequestMethod, payload: APIRequest.Params, isJsonPayload: Boolean)

Method to set up the request details

stringDigest

open fun stringDigest(data: Array<Byte>, algorithm: String): String

open fun stringDigest(data: String, algorithm: String): String

Method to get digest

toString

open fun toString(): String

Returns a string representation of the object No-any params required

validateSelfSignedCertificate

open fun validateSelfSignedCertificate()

Method to validate a self-signed SLL certificate and bypass the checks of its validity No-any params required