io.getconnect.client

Class ConnectAPI

java.lang.Object

io.getconnect.client.ConnectAPI

public class ConnectAPI
extends java.lang.Object

API Client for pushing events to Connect API.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	API_BASE_URL
protected java.lang.String	apiKey
protected com.squareup.okhttp.OkHttpClient	client
protected java.lang.String	eventsUrl
protected static com.google.gson.Gson	gson
protected static com.squareup.okhttp.MediaType	JSON
protected java.lang.String	projectId

Constructor Summary

Constructors

Constructor and Description
ConnectAPI(java.lang.String projectId, java.lang.String apiKey) Creates a new Connect API client.
ConnectAPI(java.lang.String projectId, java.lang.String apiKey, java.lang.String baseUrl) Creates a new Connect API client.

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>>	buildResponseForBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> batch, com.squareup.okhttp.Response response)
protected com.squareup.okhttp.Request	generatePostRequest(java.lang.String url, java.lang.String json)
protected static java.util.Map<java.lang.String,java.lang.Object>	getDeserializedResponseBody(com.squareup.okhttp.Response response)
protected static ConnectException	getExceptionForBatchResponse(com.squareup.okhttp.Response response)
protected static ConnectException	getExceptionForResponse(com.squareup.okhttp.Response response)
void	pushEvent(java.lang.String collection, Event event) Pushes a single event to the Connect API synchronously.
void	pushEvent(java.lang.String collection, Event event, ConnectCallback callback) Pushes a single event to the Connect API asynchronously.
java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>>	pushEventBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> batch) Pushes a batch of events to the Connect API synchronously.
void	pushEventBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> batch, ConnectBatchCallback callback) Pushes a batch of events to the Connect API asynchronously.

Methods inherited from class java.lang.Object

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

Field Detail

API_BASE_URL

protected static final java.lang.String API_BASE_URL

See Also:

Constant Field Values

gson

protected static final com.google.gson.Gson gson

JSON

protected static final com.squareup.okhttp.MediaType JSON

projectId

protected final java.lang.String projectId

apiKey

protected final java.lang.String apiKey

eventsUrl

protected final java.lang.String eventsUrl

client

protected final com.squareup.okhttp.OkHttpClient client

Constructor Detail

ConnectAPI

public ConnectAPI(java.lang.String projectId,
          java.lang.String apiKey)

Creates a new Connect API client.

Parameters:

projectId - ID of the project to which to push events.

apiKey - API key used to access the project (this must be a push or push/query key).

ConnectAPI

public ConnectAPI(java.lang.String projectId,
          java.lang.String apiKey,
          java.lang.String baseUrl)

Creates a new Connect API client.

Parameters:

projectId - ID of the project to which to push events.

apiKey - API key used to access the project (this must be a push or push/query key).

baseUrl - Base URL of the Connect API.

Method Detail

pushEvent

public void pushEvent(java.lang.String collection,
             Event event)
               throws ConnectException

Pushes a single event to the Connect API synchronously.

Parameters:

collection - The name of the collection to push to.

event - The Event to send.

Throws:

ConnectException - When an error occurs. Will be InvalidEventException, or a generic ConnectException with an inner exception.

pushEvent

public void pushEvent(java.lang.String collection,
             Event event,
             ConnectCallback callback)

Pushes a single event to the Connect API asynchronously.

Parameters:

collection - The name of the collection to push to.

event - The Event to send.

callback - A ConnectCallback that will be invoked with the results of the request

pushEventBatch

public java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>> pushEventBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> batch)
                                                                                     throws ConnectException

Pushes a batch of events to the Connect API synchronously.

Parameters:

batch - The event batch as a Map keyed by collection name containing a collection of @{link Event}s.

Throws:

ConnectException - When an error occurs. Will be InvalidEventException, or a generic ConnectException with an inner exception.

pushEventBatch

public void pushEventBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> batch,
                  ConnectBatchCallback callback)

Pushes a batch of events to the Connect API asynchronously.

Parameters:

batch - The event batch as a Map keyed by collection name containing a collection of @{link Event}s.

callback - A ConnectBatchCallback that will be invoked with the results of the request

generatePostRequest

protected com.squareup.okhttp.Request generatePostRequest(java.lang.String url,
                                              java.lang.String json)

getExceptionForResponse

protected static ConnectException getExceptionForResponse(com.squareup.okhttp.Response response)

getExceptionForBatchResponse

protected static ConnectException getExceptionForBatchResponse(com.squareup.okhttp.Response response)

getDeserializedResponseBody

protected static java.util.Map<java.lang.String,java.lang.Object> getDeserializedResponseBody(com.squareup.okhttp.Response response)
                                                                                       throws java.io.IOException

Throws:

java.io.IOException

buildResponseForBatch

protected static java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>> buildResponseForBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> batch,
                                                                                          com.squareup.okhttp.Response response)
                                                                                                      throws java.io.IOException

Throws:

java.io.IOException