com.kontakt.sdk.android.http

Class CommandApiAccessorImpl

java.lang.Object

com.kontakt.sdk.android.http.CommandApiAccessorImpl

All Implemented Interfaces:

CommandApiAccessor, java.io.Closeable, java.lang.AutoCloseable

public class CommandApiAccessorImpl
extends java.lang.Object
implements CommandApiAccessor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandApiAccessorImpl(java.lang.String apiKey, java.lang.String apiUrl) Instantiates a new Abstract api client delegate.

Method Summary

Modifier and Type	Method and Description
void	close()
protected <T> HttpResult<T>	createAndTransform(java.lang.String uri, AbstractEntityData entityData, SDKFunction<JSONObject,T> convertFunction) Create and transform.
protected <K,T> HttpResult<T>	createAndTransform(java.lang.String uri, AbstractEntityData entityData, SDKThrowableFunction<com.squareup.okhttp.ResponseBody,K,java.lang.Exception> convertFunction, SDKFunction<K,T> buildFunction) Create and transform convenience method.
protected <T> HttpResult<T>	createAndTransform(java.lang.String uri, RequestDescription requestDescription, SDKFunction<JSONObject,T> convertFunction) Create and transform convenience method.
protected <T> HttpResult<T>	getAndTransform(java.lang.String uri, RequestDescription requestDescription, SDKFunction<JSONObject,T> convertFunction) Gets and transform.
protected <T> HttpResult<T>	getAndTransformByteArray(java.lang.String uri, RequestDescription requestDescription, SDKFunction<byte[],T> convertFunction) Gets and transform byte array.
protected <T> HttpResult<java.util.List<T>>	getAndTransformToList(java.lang.String uri, RequestDescription requestDescription, int[] expectedStatuses, java.lang.String jsonEntry, SDKFunction<JSONObject,T> function)
protected <K,T> HttpResult<T>	getAndTransformToList(java.lang.String uri, RequestDescription requestDescription, SDKThrowableFunction<com.squareup.okhttp.ResponseBody,K,java.lang.Exception> convertFunction, SDKFunction<K,T> buildFunction) Gets and transform to list convenience method.
protected <T> HttpResult<java.util.List<T>>	getAndTransformToList(java.lang.String uri, RequestDescription requestDescription, java.lang.String jsonEntry, SDKFunction<JSONObject,T> function) Gets and transform to list.
HttpResult<java.util.List<SecureCommandResponse>>	getSecureCommand(java.util.Collection<java.lang.String> beaconUniqueIds, SecureCommandType secureCommandType)
void	getSecureCommand(java.util.Collection<java.lang.String> beaconUniqueIds, SecureCommandType secureCommandType, ResultApiCallback<java.util.List<SecureCommandResponse>> apiCallback)
protected static int	httpStatusCode(com.squareup.okhttp.Response httpResponse) Returns http status code from HTTP response and closes it quietly.
protected int	postAndReturnHttpStatus(java.lang.String uri, RequestDescription requestDescription) Post and return http status convenience method.
protected <T> HttpResult<java.util.List<T>>	postAndTransformToList(java.lang.String uri, RequestDescription requestDescription, int[] expectedStatuses, java.lang.String jsonEntry, SDKFunction<JSONObject,T> function)
protected <T> HttpResult<T>	selectFirstOrReturnAbsent(HttpResult<java.util.List<T>> listedRecordsResult, SDKPredicate<T> predicate) Select first or return absent.
protected static <K,T> HttpResult<T>	transform(com.squareup.okhttp.Response response, int[] expectedSuccessHttpStatus, SDKThrowableFunction<com.squareup.okhttp.ResponseBody,K,java.lang.Exception> extractFunction, SDKFunction<K,T> buildFunction) Transforms Http Response to desired entity by extracting the content to desired format and then to build the entity from it provided that Http Response status is equal to the expected one.
protected static <T> HttpResult<T>	transformByteArrayToHttpResult(com.squareup.okhttp.Response response, int expectedSuccessHttpStatus, SDKFunction<byte[],T> buildFunction) Transforms Http Response's entity to byte array and then converts to desired type.
protected static <T> HttpResult<T>	transformJSONToEntity(com.squareup.okhttp.Response response, int expectedSuccessHttpStatus, SDKFunction<JSONObject,T> buildFunction) Transforms Http Response's body to JSONObject and then converts to desired type.
protected static <T> HttpResult<java.util.List<T>>	transformJSONToList(com.squareup.okhttp.Response response, int[] expectedSucceddHttpStatuses, java.lang.String jsonEntry, SDKFunction<JSONObject,T> buildFunction)
protected static <T> HttpResult<java.util.List<T>>	transformJSONToList(com.squareup.okhttp.Response httpResponse, int expectedSuccessHttpStatus, java.lang.String jsonEntry, SDKFunction<JSONObject,T> buildFunction) Transform HttpResponse with JSON content to list.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandApiAccessorImpl

protected CommandApiAccessorImpl(java.lang.String apiKey,
                                 java.lang.String apiUrl)

Instantiates a new Abstract api client delegate.

Parameters:

apiKey - the api key

apiUrl - the api url

Method Detail

getSecureCommand

public HttpResult<java.util.List<SecureCommandResponse>> getSecureCommand(java.util.Collection<java.lang.String> beaconUniqueIds,
                                                                          SecureCommandType secureCommandType)
                                                                   throws ClientException

Specified by:

getSecureCommand in interface CommandApiAccessor

Throws:

ClientException

getSecureCommand

public void getSecureCommand(java.util.Collection<java.lang.String> beaconUniqueIds,
                             SecureCommandType secureCommandType,
                             ResultApiCallback<java.util.List<SecureCommandResponse>> apiCallback)

Specified by:

getSecureCommand in interface CommandApiAccessor

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

transformJSONToEntity

protected static <T> HttpResult<T> transformJSONToEntity(com.squareup.okhttp.Response response,
                                                         int expectedSuccessHttpStatus,
                                                         SDKFunction<JSONObject,T> buildFunction)
                                                  throws ClientException

Transforms Http Response's body to org.json.JSONObject and then converts to desired type.

Type Parameters:

T - the type parameter

Parameters:

response - the response

expectedSuccessHttpStatus - the expected success http status

buildFunction - the build function

Returns:

the result

Throws:

ClientException - the client exception

transformJSONToList

protected static <T> HttpResult<java.util.List<T>> transformJSONToList(com.squareup.okhttp.Response httpResponse,
                                                                       int expectedSuccessHttpStatus,
                                                                       java.lang.String jsonEntry,
                                                                       SDKFunction<JSONObject,T> buildFunction)

Transform HttpResponse with JSON content to list.

Type Parameters:

T - the type parameter

Parameters:

httpResponse - the http response

expectedSuccessHttpStatus - the expected success http status

jsonEntry - the json entry

buildFunction - the build function

Returns:

the http result

transformJSONToList

protected static <T> HttpResult<java.util.List<T>> transformJSONToList(com.squareup.okhttp.Response response,
                                                                       int[] expectedSucceddHttpStatuses,
                                                                       java.lang.String jsonEntry,
                                                                       SDKFunction<JSONObject,T> buildFunction)

transformByteArrayToHttpResult

protected static <T> HttpResult<T> transformByteArrayToHttpResult(com.squareup.okhttp.Response response,
                                                                  int expectedSuccessHttpStatus,
                                                                  SDKFunction<byte[],T> buildFunction)
                                                           throws ClientException

Transforms Http Response's entity to byte array and then converts to desired type.

Type Parameters:

T - the type parameter

Parameters:

response - the response

expectedSuccessHttpStatus - the expected success http status

buildFunction - the build function

Returns:

the result

Throws:

ClientException - the client exception

transform

protected static <K,T> HttpResult<T> transform(com.squareup.okhttp.Response response,
                                               int[] expectedSuccessHttpStatus,
                                               SDKThrowableFunction<com.squareup.okhttp.ResponseBody,K,java.lang.Exception> extractFunction,
                                               SDKFunction<K,T> buildFunction)
                                        throws ClientException

Transforms Http Response to desired entity by extracting the content to desired format and then to build the entity from it provided that Http Response status is equal to the expected one.

Type Parameters:

K - the generic extract parameter

T - the generic build parameter

Parameters:

response - the response

expectedSuccessHttpStatus - the expected success http status

extractFunction - the extract function

buildFunction - the build function

Returns:

the result

Throws:

ClientException - thrown if transformation fails.

httpStatusCode

protected static int httpStatusCode(com.squareup.okhttp.Response httpResponse)

Returns http status code from HTTP response and closes it quietly.

Parameters:

httpResponse - the http response

Returns:

Http Status code

getAndTransform

protected <T> HttpResult<T> getAndTransform(java.lang.String uri,
                                            RequestDescription requestDescription,
                                            SDKFunction<JSONObject,T> convertFunction)
                                     throws ClientException

Gets and transform.

Parameters:

uri - the uri

requestDescription - the request description

convertFunction - the convert function

Returns:

the and transform

Throws:

ClientException - the client exception

getAndTransformByteArray

protected <T> HttpResult<T> getAndTransformByteArray(java.lang.String uri,
                                                     RequestDescription requestDescription,
                                                     SDKFunction<byte[],T> convertFunction)
                                              throws ClientException

Gets and transform byte array.

Parameters:

uri - the uri

requestDescription - the request description

convertFunction - the convert function

Returns:

the and transform byte array

Throws:

ClientException - the client exception

selectFirstOrReturnAbsent

protected <T> HttpResult<T> selectFirstOrReturnAbsent(HttpResult<java.util.List<T>> listedRecordsResult,
                                                      SDKPredicate<T> predicate)

Select first or return absent.

Type Parameters:

T - the type parameter

Parameters:

listedRecordsResult - the listed records result

predicate - the predicate

Returns:

the http result

getAndTransformToList

protected <T> HttpResult<java.util.List<T>> getAndTransformToList(java.lang.String uri,
                                                                  RequestDescription requestDescription,
                                                                  java.lang.String jsonEntry,
                                                                  SDKFunction<JSONObject,T> function)
                                                           throws ClientException

Gets and transform to list.

Parameters:

uri - the uri

requestDescription - the request description

jsonEntry - the json entry

function - the function

Returns:

the and transform to list

Throws:

ClientException - the client exception

getAndTransformToList

protected <T> HttpResult<java.util.List<T>> getAndTransformToList(java.lang.String uri,
                                                                  RequestDescription requestDescription,
                                                                  int[] expectedStatuses,
                                                                  java.lang.String jsonEntry,
                                                                  SDKFunction<JSONObject,T> function)
                                                           throws ClientException

Throws:

ClientException

postAndTransformToList

protected <T> HttpResult<java.util.List<T>> postAndTransformToList(java.lang.String uri,
                                                                   RequestDescription requestDescription,
                                                                   int[] expectedStatuses,
                                                                   java.lang.String jsonEntry,
                                                                   SDKFunction<JSONObject,T> function)
                                                            throws ClientException

Throws:

ClientException

createAndTransform

protected <T> HttpResult<T> createAndTransform(java.lang.String uri,
                                               AbstractEntityData entityData,
                                               SDKFunction<JSONObject,T> convertFunction)
                                        throws ClientException

Create and transform.

Type Parameters:

T - the type parameter

Parameters:

uri - the uri

entityData - the entity data

convertFunction - the convert function

Returns:

the http result

Throws:

ClientException - the client exception

createAndTransform

protected <T> HttpResult<T> createAndTransform(java.lang.String uri,
                                               RequestDescription requestDescription,
                                               SDKFunction<JSONObject,T> convertFunction)
                                        throws ClientException

Create and transform convenience method.

Type Parameters:

T - the type parameter

Parameters:

uri - the uri

requestDescription - the request description

convertFunction - the convert function

Returns:

the http result

Throws:

ClientException - the client exception

createAndTransform

protected <K,T> HttpResult<T> createAndTransform(java.lang.String uri,
                                                 AbstractEntityData entityData,
                                                 SDKThrowableFunction<com.squareup.okhttp.ResponseBody,K,java.lang.Exception> convertFunction,
                                                 SDKFunction<K,T> buildFunction)
                                          throws ClientException

Create and transform convenience method.

Type Parameters:

K - the type parameter

T - the type parameter

Parameters:

uri - the uri

entityData - the entity data

convertFunction - the convert function

buildFunction - the build function

Returns:

the http result

Throws:

ClientException - the client exception

getAndTransformToList

protected <K,T> HttpResult<T> getAndTransformToList(java.lang.String uri,
                                                    RequestDescription requestDescription,
                                                    SDKThrowableFunction<com.squareup.okhttp.ResponseBody,K,java.lang.Exception> convertFunction,
                                                    SDKFunction<K,T> buildFunction)
                                             throws ClientException

Gets and transform to list convenience method.

Parameters:

uri - the uri

requestDescription - the request description

convertFunction - the convert function

buildFunction - the build function

Returns:

the and transform to list

Throws:

ClientException - the client exception

postAndReturnHttpStatus

protected int postAndReturnHttpStatus(java.lang.String uri,
                                      RequestDescription requestDescription)
                               throws ClientException

Post and return http status convenience method.

Parameters:

uri - the uri

requestDescription - the request description

Returns:

the int

Throws:

ClientException - the client exception