io.getconnect.client

Class Event

java.lang.Object

io.getconnect.client.Event

public class Event
extends java.lang.Object

An object that contains the properties for events that are pushed to Connect.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	eventData
protected java.lang.String	eventStoreId
protected java.lang.String	reservedPrefix

Constructor Summary

Constructors

Constructor and Description
Event(java.util.Map<java.lang.String,java.lang.Object> eventData) Create a new event to push to Connect.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Iterable<Event>>	buildEventBatch(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>[]> events)
static Event	fromEventStore(java.lang.String eventJSON, java.lang.String eventStoreId)
java.util.Map<java.lang.String,java.lang.Object>	getEventData() Get the properties of the event.
java.lang.String	getEventJSON() Get the properties of the event as a JSON string.
java.lang.String	getEventStoreId() Gets the ID used for storing the event in the event store.
java.lang.String	getId() Get the ID of the event.
static java.lang.String	getJSONForEventBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> eventBatch)
protected void	setDefaultProperties()
protected void	validateProperties()

Methods inherited from class java.lang.Object

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

Field Detail

reservedPrefix

protected final java.lang.String reservedPrefix

See Also:

Constant Field Values

eventData

protected final java.util.Map<java.lang.String,java.lang.Object> eventData

eventStoreId

protected java.lang.String eventStoreId

Constructor Detail

Event

public Event(java.util.Map<java.lang.String,java.lang.Object> eventData)
      throws InvalidEventException

Create a new event to push to Connect. You can provide both reserved properties "id" and "timestamp" as a String and Date respectively. If you do not provide an "id", one will be generated for you. If you do not provide a "timestamp", the current date is used.

Parameters:

eventData - A Map containing the event properties to push to Connect.

Throws:

InvalidEventException

Method Detail

fromEventStore

public static Event fromEventStore(java.lang.String eventJSON,
                   java.lang.String eventStoreId)

getEventData

public java.util.Map<java.lang.String,java.lang.Object> getEventData()

Get the properties of the event.

Returns:

A Map containing the event properties.

getEventJSON

public java.lang.String getEventJSON()

Get the properties of the event as a JSON string.

Returns:

A string containing the event properties as JSON.

getId

public java.lang.String getId()

Get the ID of the event.

Returns:

A String containing the event ID.

getEventStoreId

public java.lang.String getEventStoreId()

Gets the ID used for storing the event in the event store.

Returns:

Event store ID for the event.

setDefaultProperties

protected void setDefaultProperties()

validateProperties

protected void validateProperties()
                           throws InvalidEventException

Throws:

InvalidEventException

buildEventBatch

public static java.util.Map<java.lang.String,java.lang.Iterable<Event>> buildEventBatch(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>[]> events)
                                                                                 throws InvalidEventException

Throws:

InvalidEventException

getJSONForEventBatch

public static java.lang.String getJSONForEventBatch(java.util.Map<java.lang.String,java.lang.Iterable<Event>> eventBatch)