com.datasift.client

Class DataSiftApiClient

java.lang.Object

com.datasift.client.DataSiftApiClient

Direct Known Subclasses:

DataSiftCore, DataSiftHistorics, DataSiftManagedSource, DataSiftPreview, DataSiftPush

public class DataSiftApiClient
extends Object

The API client is a base class which provides a common set of functionality to the other API classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSiftConfig	config

Constructor Summary

Constructors

Constructor and Description
DataSiftApiClient(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
io.higgs.http.client.Request	applyConfig(io.higgs.http.client.Request request)
ParamBuilder	newParams()
protected <T extends DataSiftResult> io.higgs.core.func.Function2<String,io.higgs.http.client.Response>	newRequestCallback(FutureData<T> future, T instance)
protected <T extends DataSiftResult,A extends DataSiftResult> void	unwrapFuture(FutureData<T> futureToUnwrap, FutureData<A> futureReturnedToUser, A expectedInstance, FutureResponse<T> responseToExecuteOnSuccess) To support futures being passed as parameters, this method adds a listener to the unprocessed future that has been passed as a parameter.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected DataSiftConfig config

Constructor Detail

DataSiftApiClient

public DataSiftApiClient(DataSiftConfig config)

Method Detail

applyConfig

public io.higgs.http.client.Request applyConfig(io.higgs.http.client.Request request)

newParams

public ParamBuilder newParams()

Returns:

a new ParamBuilder instance and automatically adds the required auth properties

newRequestCallback

protected <T extends DataSiftResult> io.higgs.core.func.Function2<String,io.higgs.http.client.Response> newRequestCallback(FutureData<T> future,
                                                                                                               T instance)

unwrapFuture

protected <T extends DataSiftResult,A extends DataSiftResult> void unwrapFuture(FutureData<T> futureToUnwrap,
                                                                    FutureData<A> futureReturnedToUser,
                                                                    A expectedInstance,
                                                                    FutureResponse<T> responseToExecuteOnSuccess)

To support futures being passed as parameters, this method adds a listener to the unprocessed future that has been passed as a parameter. Once that listener is invoked, the response of the unprocessed future is examined to see if the response was successful, if it was not then the expected future is passed the failed response If the result of the unprocessed future is successful then the response callback is applied.

Type Parameters:

T -

A -

Parameters:

futureToUnwrap - the unprocessed future which needs to be unwrapped

futureReturnedToUser - the future that has been returned to the user and which callbacks need to be triggered on

expectedInstance - the instance of the result type to use in failure scenarios

responseToExecuteOnSuccess - a future response object which contains the code which will execute once the wrapped future has been unwrapped and its result is successful