io.getconnect.client

Class ConnectClient

java.lang.Object

io.getconnect.client.ConnectClient

public class ConnectClient
extends java.lang.Object

Client for pushing events to Connect.

Constructor Summary

Constructors

Constructor and Description
ConnectClient(java.lang.String projectId, java.lang.String apiKey, java.lang.String baseUrl, EventStore eventStore) Creates a new Connect client.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> event) Add an event to the event store to be delivered later.
void	push(java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> event) Synchronously push an event to a collection in Connect.
void	pushAsync(java.lang.String collection, java.util.Map<java.lang.String,java.lang.Object> event, ConnectCallback callback) Asynchronously Push an event to a collection in Connect.
java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>>	pushBatch(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>[]> batch) Synchronously push a batch of events to Connect.
void	pushBatchAsync(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>[]> batch, ConnectBatchCallback callback) Asynchronously push a batch of events to Connect.
java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>>	pushPending() Push the pending events stored to Connect synchronously.
void	pushPendingAsync(ConnectBatchCallback callback) Push the pending events stored to Connect asynchronously.
protected void	updateStoreWithResponse(java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>> details)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectClient

public ConnectClient(java.lang.String projectId,
             java.lang.String apiKey,
             java.lang.String baseUrl,
             EventStore eventStore)

Creates a new Connect 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.

eventStore - EventStore used for persistence.

Method Detail

push

public void push(java.lang.String collection,
        java.util.Map<java.lang.String,java.lang.Object> event)
          throws ConnectException

Synchronously push an event to a collection in Connect.

Parameters:

collection - Name of the collection to which to push the event.

event - Event to push to the collection.

Throws:

InvalidEventException - If the server instructs that the event or its properties are invalid.

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

pushAsync

public void pushAsync(java.lang.String collection,
             java.util.Map<java.lang.String,java.lang.Object> event,
             ConnectCallback callback)

Asynchronously Push an event to a collection in Connect.

Parameters:

collection - Name of the collection to which to push the event.

event - Event to push to the collection.

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

pushBatch

public java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>> pushBatch(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>[]> batch)
                                                                                throws ConnectException

Synchronously push a batch of events to Connect.

Parameters:

batch - A Map of collection name to events for which to push to Connect.

Returns:

A Map of collection name to an array of responses to individual event pushes in the same order as the request.

Throws:

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

pushBatchAsync

public void pushBatchAsync(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>[]> batch,
                  ConnectBatchCallback callback)

Asynchronously push a batch of events to Connect.

Parameters:

batch - A Map with collection name as a key and event Maps as values.

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

add

public void add(java.lang.String collection,
       java.util.Map<java.lang.String,java.lang.Object> event)
         throws ConnectException

Add an event to the event store to be delivered later.

Parameters:

collection - Name of the collection to which to push the event.

event - Event to add to the collection.

Throws:

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

pushPending

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

Push the pending events stored to Connect synchronously.

Returns:

A Map of collection name to an array of responses to individual events pushed from the queue.

Throws:

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

pushPendingAsync

public void pushPendingAsync(ConnectBatchCallback callback)

Push the pending events stored to Connect asynchronously.

Parameters:

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

updateStoreWithResponse

protected void updateStoreWithResponse(java.util.Map<java.lang.String,java.lang.Iterable<EventPushResponse>> details)