io.orchestrate.client

Class EventResource

java.lang.Object

io.orchestrate.client.EventResource

public class EventResource
extends java.lang.Object

The resource for the event features in the Orchestrate API.

Field Summary

Fields

Modifier and Type	Field and Description
protected OrchestrateClient	client The Orchestrate client to make requests with.
protected JacksonMapper	jacksonMapper
protected com.fasterxml.jackson.databind.ObjectMapper	mapper The object mapper used to deserialize JSON responses.

Method Summary

Modifier and Type	Method and Description
OrchestrateRequest<EventMetadata>	create(java.lang.Object value) Add an event to a key in the Orchestrate service.
EventResource	end(long end) The exclusive end of a time range to query.
<T> OrchestrateRequest<EventList<T>>	get(java.lang.Class<T> clazz) Fetch events for a key in the Orchestrate service.
SingleEventResource	ordinal(java.lang.String ordinal) Called to make operations for an individual event instance.
protected <T> OrchestrateRequest<T>	parseLink(java.lang.String name, com.fasterxml.jackson.databind.JsonNode jsonNode, io.orchestrate.client.ResponseConverter<T> clazz)
OrchestrateRequest<java.lang.Boolean>	put(java.lang.Object value) Deprecated. Use create(Object) for adding new events, and SingleEventResource's 'update' (via ordinal(String)) for updating existing event instances.
OrchestrateRequest<java.lang.Boolean>	put(java.lang.Object value, java.lang.Long timestamp) Deprecated. Use create(Object) for adding new events, and SingleEventResource's 'update' (via ordinal(String)) for updating existing event instances.
EventResource	start(long start) The inclusive start of a time range to query.
EventResource	timestamp(java.lang.Long timestamp) The timestamp for an event.
protected byte[]	toJsonBytes(java.lang.Object value)
protected com.fasterxml.jackson.databind.JsonNode	toJsonNode(org.glassfish.grizzly.http.HttpContent response)
protected com.fasterxml.jackson.databind.JsonNode	toJsonNodeOrNull(org.glassfish.grizzly.http.HttpContent response)
protected <T> KvObject<T>	toKvObject(org.glassfish.grizzly.http.HttpContent response, java.lang.String collection, java.lang.String key, java.lang.Class<T> clazz)
protected <T> KvObject<T>	toKvObject(com.fasterxml.jackson.databind.JsonNode result, java.lang.Class<T> clazz)
EventResource	type(java.lang.String type) The type for an event, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final OrchestrateClient client

The Orchestrate client to make requests with.

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

The object mapper used to deserialize JSON responses.

jacksonMapper

protected final JacksonMapper jacksonMapper

Method Detail

get

public <T> OrchestrateRequest<EventList<T>> get(java.lang.Class<T> clazz)

Fetch events for a key in the Orchestrate service.

Usage:

 
 EventList<DomainObject> events =
         client.event("someCollection", "someKey")
               .type("eventType")
               .get(DomainObject.class)
               .get();
 
 

Type Parameters:

T - The type to deserialize the result of the request to.

Parameters:

clazz - Type information for marshalling objects at runtime.

Returns:

The prepared get request.

put

public OrchestrateRequest<java.lang.Boolean> put(@NonNull
                                                 java.lang.Object value)

Deprecated. Use create(Object) for adding new events, and SingleEventResource's 'update' (via ordinal(String)) for updating existing event instances.

put(Object, Long).

Parameters:

value - The value for the event.

Returns:

The prepared put request.

put

public OrchestrateRequest<java.lang.Boolean> put(@NonNull
                                                 java.lang.Object value,
                                                 @Nullable
                                                 java.lang.Long timestamp)

Deprecated. Use create(Object) for adding new events, and SingleEventResource's 'update' (via ordinal(String)) for updating existing event instances.

Store an event to a key in the Orchestrate service.

Usage:

 
 DomainObject obj = new DomainObject(); // a POJO
 boolean result =
         client.event("someCollection", "someKey")
               .type("someType")
               .put(obj)
               .get();
 
 

Parameters:

value - The object to store as the event.

timestamp - The timestamp to store the event at.

Returns:

The prepared put request.

create

public OrchestrateRequest<EventMetadata> create(@NonNull
                                                java.lang.Object value)

Add an event to a key in the Orchestrate service.

Usage:

 
 DomainObject obj = new DomainObject(); // a POJO
 EventMetadata eventMeta =
         client.event("someCollection", "someKey")
               .type("someType")
               .create(obj)
               .get();
 
 

 To add an event to a specific timestamp:
 
 DomainObject obj = new DomainObject(); // a POJO
 EventMetadata eventMeta =
         client.event("someCollection", "someKey")
               .type("someType")
               .timestamp(someTimestamp)
               .create(obj)
               .get();
 
 

Parameters:

value - The object to store as the event.

Returns:

The prepared create request.

type

public EventResource type(java.lang.String type)

The type for an event, e.g. "update" or "tweet" etc.

Parameters:

type - The type of the event.

Returns:

The event resource.

timestamp

public EventResource timestamp(java.lang.Long timestamp)

The timestamp for an event.

Parameters:

timestamp - The timestamp of the event.

Returns:

The event resource.

ordinal

public SingleEventResource ordinal(java.lang.String ordinal)

Called to make operations for an individual event instance. type and timestamp must be called prior to calling this method.

Usage:

 
 // fetches a single event instance
 Event<String> event =
         client.event("someCollection", "someKey")
               .type("someType")
               .timestamp(someTimestamp)
               .ordinal(someOrdinal)
               .get(String.class)
               .get();
 
 

Parameters:

ordinal - The event instance's ordinal value.

Returns:

A SingleEventResource that can be used to perform operations for the individual event instance.

start

public EventResource start(long start)

The inclusive start of a time range to query.

Parameters:

start - The timestamp to get events from.

Returns:

The event resource.

end

public EventResource end(long end)

The exclusive end of a time range to query.

Parameters:

end - The timestamp to get events up to.

Returns:

The event resource.

toJsonBytes

protected byte[] toJsonBytes(java.lang.Object value)

toJsonNodeOrNull

protected com.fasterxml.jackson.databind.JsonNode toJsonNodeOrNull(org.glassfish.grizzly.http.HttpContent response)
                                                            throws java.io.IOException

Throws:

java.io.IOException

toJsonNode

protected com.fasterxml.jackson.databind.JsonNode toJsonNode(org.glassfish.grizzly.http.HttpContent response)
                                                      throws java.io.IOException

Throws:

java.io.IOException

toKvObject

protected <T> KvObject<T> toKvObject(com.fasterxml.jackson.databind.JsonNode result,
                                     java.lang.Class<T> clazz)
                              throws java.io.IOException

Throws:

java.io.IOException

toKvObject

protected <T> KvObject<T> toKvObject(org.glassfish.grizzly.http.HttpContent response,
                                     java.lang.String collection,
                                     java.lang.String key,
                                     java.lang.Class<T> clazz)
                              throws java.io.IOException

Throws:

java.io.IOException

parseLink

protected <T> OrchestrateRequest<T> parseLink(java.lang.String name,
                                              com.fasterxml.jackson.databind.JsonNode jsonNode,
                                              io.orchestrate.client.ResponseConverter<T> clazz)