io.orchestrate.client

Class OrchestrateClient

java.lang.Object

io.orchestrate.client.OrchestrateClient

All Implemented Interfaces:

Client

public class OrchestrateClient
extends java.lang.Object
implements Client

The client used to read and write data to the Orchestrate service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrchestrateClient.Builder Builder used to create Client instances.

Constructor Summary

Constructors

Constructor and Description
OrchestrateClient(java.lang.String apiKey) Create a new client with the specified apiKey and default JacksonMapper.
OrchestrateClient(java.lang.String apiKey, JacksonMapper mapper) Create a new client with the specified apiKey and mapper.
OrchestrateClient(java.lang.String apiKey, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Create a new client with the specified apiKey and objectMapper.

Method Summary

Modifier and Type	Method and Description
static OrchestrateClient.Builder	builder(java.lang.String apiKey) A new builder to create an OrchestrateClient with default settings.
void	close() Stops the thread pool and closes all connections in use by all the operations.
OrchestrateRequest<java.lang.Boolean>	deleteCollection(java.lang.String collection) Delete all KV objects from a collection in the Orchestrate service.
EventResource	event(java.lang.String collection, java.lang.String key) The resource for the event features in the Orchestrate API.
KvResource	kv(java.lang.String collection, java.lang.String key) The resource for the KV features in the Orchestrate API.
KvListResource	listCollection(java.lang.String collection) The resource for the KV list features in the Orchestrate API.
void	ping() Health check that sends a ping to the Orchestrate service.
void	ping(java.lang.String collection) Deprecated.
OrchestrateRequest<KvMetadata>	postValue(java.lang.String collection, java.lang.Object value) Store an object by value in the collection specified to the Orchestrate service which will auto-generate a key for it.
RelationResource	relation(java.lang.String collection, java.lang.String key) The resource for the relation features in the Orchestrate API.
CollectionSearchResource	searchCollection(java.lang.String collection) The resource for the collection search features in the Orchestrate API.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrchestrateClient

public OrchestrateClient(java.lang.String apiKey)

Create a new client with the specified apiKey and default JacksonMapper.

Equivalent to:

 
 Client client = OrchestrateClient.builder("your api key").build();
 
 

Parameters:

apiKey - An API key for the Orchestrate.io service.

OrchestrateClient

public OrchestrateClient(java.lang.String apiKey,
                         com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Create a new client with the specified apiKey and objectMapper.

Parameters:

apiKey - An API key for the Orchestrate.io service.

objectMapper - The Jackson JSON mapper to marshall data with.

OrchestrateClient

public OrchestrateClient(java.lang.String apiKey,
                         JacksonMapper mapper)

Create a new client with the specified apiKey and mapper.

Parameters:

apiKey - An API key for the Orchestrate.io service.

mapper - The mapper to marshall data with.

Method Detail

close

public void close()
           throws java.io.IOException

Stops the thread pool and closes all connections in use by all the operations.

Specified by:

close in interface Client

Throws:

java.io.IOException - If resources couldn't be stopped.

deleteCollection

public OrchestrateRequest<java.lang.Boolean> deleteCollection(java.lang.String collection)

Delete all KV objects from a collection in the Orchestrate service.

Usage:

 
 client.deleteCollection("someCollection").get();
 
 

Specified by:

deleteCollection in interface Client

Parameters:

collection - The name of collection to delete.

Returns:

The prepared request object.

event

public EventResource event(java.lang.String collection,
                           java.lang.String key)

The resource for the event features in the Orchestrate API.

Specified by:

event in interface Client

Parameters:

collection - The name of the collection.

key - The name of the key with events.

Returns:

The event resource.

kv

public KvResource kv(java.lang.String collection,
                     java.lang.String key)

The resource for the KV features in the Orchestrate API.

Specified by:

kv in interface Client

Parameters:

collection - The name of the collection.

key - The name of a key.

Returns:

The KV resource.

listCollection

public KvListResource listCollection(java.lang.String collection)

The resource for the KV list features in the Orchestrate API.

Specified by:

listCollection in interface Client

Parameters:

collection - The name of the collection.

Returns:

The KV list resource.

ping

public void ping()
          throws java.io.IOException

Health check that sends a ping to the Orchestrate service.

Specified by:

ping in interface Client

Throws:

java.io.IOException - If the health check failed.

ping

@Deprecated
public void ping(java.lang.String collection)
                      throws java.io.IOException

Deprecated.

Specified by:

ping in interface Client

Parameters:

collection - The name of the collection.

Throws:

java.io.IOException - If the ping request failed.

See Also:

Client.ping()

postValue

public OrchestrateRequest<KvMetadata> postValue(java.lang.String collection,
                                                java.lang.Object value)
                                         throws java.io.IOException

Store an object by value in the collection specified to the Orchestrate service which will auto-generate a key for it.

Usage:

 
 DomainObject obj = new DomainObject();
 KvMetadata kvMetadata =
         client.postValue("someCollection", obj).get();
 
 

Specified by:

postValue in interface Client

Parameters:

collection - The name of the collection.

value - The object to store.

Returns:

The prepared put request.

Throws:

java.io.IOException - If the request failed.

relation

public RelationResource relation(java.lang.String collection,
                                 java.lang.String key)

The resource for the relation features in the Orchestrate API.

Specified by:

relation in interface Client

Parameters:

collection - The name of the collection.

key - The name of the key.

Returns:

The relation resource.

searchCollection

public CollectionSearchResource searchCollection(java.lang.String collection)

The resource for the collection search features in the Orchestrate API.

Specified by:

searchCollection in interface Client

Parameters:

collection - The name of the collection to search.

Returns:

The collection search resource.

builder

public static OrchestrateClient.Builder builder(java.lang.String apiKey)

A new builder to create an OrchestrateClient with default settings.

Parameters:

apiKey - An API key for the Orchestrate.io service.

Returns:

A new Builder with default settings.