Index (orchestrate-java-client 0.3.0 API)

A B C D E F G H I J K L M O P R S T U

A

AsyncDao<T> - Interface in io.orchestrate.client.dao: Interface for generic Create, Read, Update, and Delete (CRUD) operations on a collection for the specified type.

B

build() - Method in class io.orchestrate.client.JacksonMapper.Builder: Creates a new JacksonMapper.
build() - Method in class io.orchestrate.client.OrchestrateClient.Builder
builder() - Static method in class io.orchestrate.client.JacksonMapper: A new builder to create a JacksonMapper with default settings.
builder(ObjectMapper) - Static method in class io.orchestrate.client.JacksonMapper: A new builder to create a JacksonMapper from the specified ObjectMapper.
builder(String) - Static method in class io.orchestrate.client.OrchestrateClient: A new builder to create an OrchestrateClient with default settings.

C

cancel(boolean) - Method in class io.orchestrate.client.OrchestrateRequest
checkArgument(boolean, String) - Static method in class io.orchestrate.client.Preconditions: Checks that the condition is true.
checkNoneEmpty(String[], String, String) - Static method in class io.orchestrate.client.Preconditions: Checks that the values are not empty.
checkNotNegative(int, String) - Static method in class io.orchestrate.client.Preconditions: Checks that the value is not negative.
checkNotNegative(long, String) - Static method in class io.orchestrate.client.Preconditions: + * Checks that the value is not negative.
checkNotNull(T, String) - Static method in class io.orchestrate.client.Preconditions: Checks that the value is not null.
checkNotNullOrEmpty(String, String) - Static method in class io.orchestrate.client.Preconditions: Checks that the value is not empty.
Client - Interface in io.orchestrate.client: A client used to read and write data to the Orchestrate.io service.
ClientException - Exception in io.orchestrate.client: An object that represents a failure to send a request from the Client.
close() - Method in interface io.orchestrate.client.Client: Stops the thread pool and closes all connections in use by all the operations.
close() - Method in class io.orchestrate.client.OrchestrateClient: Stops the thread pool and closes all connections in use by all the operations.
CollectionSearchResource - Class in io.orchestrate.client: The resource for the collection search features in the Orchestrate API.

D

DEFAULT_HOST - Static variable in class io.orchestrate.client.OrchestrateClient.Builder: The default host for the Orchestrate.io service.
DEFAULT_PORT - Static variable in class io.orchestrate.client.OrchestrateClient.Builder: The default port for the Orchestrate.io service.
DEFAULT_TIMEOUT - Static variable in class io.orchestrate.client.OrchestrateRequest: The default timeout length for a HTTP request to Orchestrate.
delete(String) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete the object with the specified key.
delete(String, Iterable<ResponseListener<Boolean>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete the object with the specified key and fire the listeners on the response.
delete(String, KvMetadata) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.
delete(String, KvMetadata, Iterable<ResponseListener<Boolean>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.
delete(String, String) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete the object with the specified key if and only if the currentRef matches the current stored ref.
delete(String, String, Iterable<ResponseListener<Boolean>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete the object with the specified key if and only if the currentRef matches the current stored ref.
delete(String) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete the object with the specified key.
delete(String, Iterable<ResponseListener<Boolean>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete the object with the specified key and fire the listeners on the response.
delete(String, KvMetadata) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.
delete(String, KvMetadata, Iterable<ResponseListener<Boolean>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.
delete(String, String) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete the object with the specified key if and only if the currentRef matches the current stored ref.
delete(String, String, Iterable<ResponseListener<Boolean>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete the object with the specified key if and only if the currentRef matches the current stored ref.
delete() - Method in class io.orchestrate.client.KvResource: KvResource.delete(boolean).
delete(boolean) - Method in class io.orchestrate.client.KvResource: Purge a KV object from a collection in the Orchestrate.io service.
deleteCollection(String) - Method in interface io.orchestrate.client.Client: Delete all KV objects from a collection in the Orchestrate service.
deleteCollection() - Method in interface io.orchestrate.client.dao.AsyncDao: Delete all objects in the collection.
deleteCollection(Iterable<ResponseListener<Boolean>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Delete all objects in the collection.
deleteCollection() - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete all objects in the collection.
deleteCollection(Iterable<ResponseListener<Boolean>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Delete all objects in the collection.
deleteCollection(String) - Method in class io.orchestrate.client.OrchestrateClient: Delete all KV objects from a collection in the Orchestrate service.
disable(DeserializationFeature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Disable the DeserializationFeature(s) in the mapper.
disable(MapperFeature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Disable the MapperFeature(s) in the mapper.
disable(SerializationFeature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Disable the SerializationFeature(s) in the mapper.
disable(JsonGenerator.Feature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Disable the JsonGenerator.Feature(s) in the mapper.
disable(JsonParser.Feature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Disable the JsonParser.Feature(s) in the mapper.

E

enable(DeserializationFeature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Enable the DeserializationFeature(s) in the mapper.
enable(MapperFeature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Enable the MapperFeature(s) in the mapper.
enable(SerializationFeature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Enable the SerializationFeature(s) in the mapper.
enable(JsonGenerator.Feature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Enable the JsonGenerator.Feature(s) in the mapper.
enable(JsonParser.Feature...) - Method in class io.orchestrate.client.JacksonMapper.Builder: Enable the JsonParser.Feature(s) in the mapper.
end(long) - Method in class io.orchestrate.client.EventResource: The exclusive end of a time range to query.
event(String, String) - Method in interface io.orchestrate.client.Client: The resource for the event features in the Orchestrate API.
Event<T> - Class in io.orchestrate.client: A container for the event and its associated KV data.
event(String, String) - Method in class io.orchestrate.client.OrchestrateClient: The resource for the event features in the Orchestrate API.
EventList<T> - Class in io.orchestrate.client: A container for event objects.
EventResource - Class in io.orchestrate.client: The resource for the event features in the Orchestrate API.

F

findOne(String) - Method in interface io.orchestrate.client.dao.AsyncDao: Return the KvObject for the object stored with the specified key.
findOne(String, Iterable<ResponseListener<KvObject<T>>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Find the object stored with the specified key and fire the listeners on the response.
findOne(String, KvMetadata) - Method in interface io.orchestrate.client.dao.AsyncDao: Return the KvObject for the object stored with the specified key and the version from the metadata.
findOne(String, KvMetadata, Iterable<ResponseListener<KvObject<T>>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Find the object stored with the specified key and the version from the metadata and fire the listeners on the response.
findOne(String, String) - Method in interface io.orchestrate.client.dao.AsyncDao: Return the KvObject for the object stored with the specified key and the version ref.
findOne(String, String, Iterable<ResponseListener<KvObject<T>>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Find the object stored with the specified key and the version ref and fire the listeners on the response.
findOne(String) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Return the KvObject for the object stored with the specified key.
findOne(String, Iterable<ResponseListener<KvObject<T>>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Find the object stored with the specified key and fire the listeners on the response.
findOne(String, KvMetadata) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Return the KvObject for the object stored with the specified key and the version from the metadata.
findOne(String, KvMetadata, Iterable<ResponseListener<KvObject<T>>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Find the object stored with the specified key and the version from the metadata and fire the listeners on the response.
findOne(String, String) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Return the KvObject for the object stored with the specified key and the version ref.
findOne(String, String, Iterable<ResponseListener<KvObject<T>>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Find the object stored with the specified key and the version ref and fire the listeners on the response.

G

GenericAsyncDao<T> - Class in io.orchestrate.client.dao: A generic object for CRUD data access operations.
GenericAsyncDao(Client, String, Class<T>) - Constructor for class io.orchestrate.client.dao.GenericAsyncDao: Create a data access object to store objects of type T to the specified collection using the client.
get(Class<T>, String) - Method in class io.orchestrate.client.CollectionSearchResource: Retrieve data from the Orchestrate service.
get(Class<T>) - Method in class io.orchestrate.client.EventResource: Fetch events for a key in the Orchestrate service.
get(Class<T>) - Method in class io.orchestrate.client.KvListResource: Fetch a paginated, lexicographically ordered list of items contained in a collection.
get(Class<T>) - Method in class io.orchestrate.client.KvResource: KvResource.get(Class).
get(Class<T>, String) - Method in class io.orchestrate.client.KvResource: Fetch an object by key from the Orchestrate service.
get() - Method in class io.orchestrate.client.OrchestrateRequest
get(long, TimeUnit) - Method in class io.orchestrate.client.OrchestrateRequest
get(Class<T>, String...) - Method in class io.orchestrate.client.RelationResource: Fetch objects related to a key in the Orchestrate service.
getCollection() - Method in class io.orchestrate.client.KvMetadata: Returns the collection this metadata belongs to.
getCount() - Method in class io.orchestrate.client.KvList: Returns the number of KV objects in the results.
getCount() - Method in class io.orchestrate.client.SearchResults: Returns the number of search results.
getEvents() - Method in class io.orchestrate.client.EventList: Returns the event objects from the response.
getKey() - Method in class io.orchestrate.client.KvMetadata: Returns the key of this metadata.
getKvObject() - Method in class io.orchestrate.client.Result: Returns the KV object for this search result.
getMessage() - Method in exception io.orchestrate.client.RequestException: Returns the HTTP content from the failed request.
getNext() - Method in class io.orchestrate.client.KvList: The URL for the next page of the KV objects.
getRawValue() - Method in class io.orchestrate.client.Event: Returns the raw JSON value of this event.
getRawValue() - Method in class io.orchestrate.client.KvObject: Returns the raw JSON value of this KV object.
getRef() - Method in class io.orchestrate.client.KvMetadata: Returns the reference (i.e.
getRelatedObjects() - Method in class io.orchestrate.client.RelationList: Returns the related objects from the response.
getRequestId() - Method in exception io.orchestrate.client.RequestException: Returns the HTTP response ID from the failed request.
getResults() - Method in class io.orchestrate.client.KvList: Returns the KV objects for this request.
getResults() - Method in class io.orchestrate.client.SearchResults: Returns the search results for this request.
getScore() - Method in class io.orchestrate.client.Result: Returns the score of this search results.
getStatusCode() - Method in exception io.orchestrate.client.RequestException: Returns the HTTP status code from the failed request.
getTimestamp() - Method in class io.orchestrate.client.Event: Returns the timestamp of this event.
getTotalCount() - Method in class io.orchestrate.client.SearchResults: Returns the total count of search results.
getValue() - Method in class io.orchestrate.client.Event: Returns the KV object for this event.
getValue() - Method in class io.orchestrate.client.KvObject: Returns the value of this KV object.

H

hasNext() - Method in class io.orchestrate.client.KvList: Whether there is a URL for the next page of the KV objects.
host(String) - Method in class io.orchestrate.client.OrchestrateClient.Builder: Set the hostname for the Orchestrate.io service, defaults to Builder.DEFAULT_HOST.

I

ifAbsent() - Method in class io.orchestrate.client.KvResource: Equivalent to this.ifAbsent(Boolean.TRUE).
ifAbsent(boolean) - Method in class io.orchestrate.client.KvResource: Whether to store the object if no key already exists.
ifMatch(String) - Method in class io.orchestrate.client.KvResource: The last known version of the stored object to match for the request to succeed.
inclusive() - Method in class io.orchestrate.client.KvListResource: Add the 'startKey' to the result set, equivalent to:
inclusive(boolean) - Method in class io.orchestrate.client.KvListResource: If inclusive is true the 'startKey' will be included in the result set.
invert() - Method in class io.orchestrate.client.RelationResource: Swap the "source" and "destination" in the request, equivalent to:
invert(boolean) - Method in class io.orchestrate.client.RelationResource: If invert is true the "source" and "destination" objects will be swapped in the request.
io.orchestrate.client - package io.orchestrate.client: A high performance, asynchronous Java client to query the Orchestrate.io service.
io.orchestrate.client.dao - package io.orchestrate.client.dao: A simple data access object framework to simplify building service components with the OrchestrateClient.
isCancelled() - Method in class io.orchestrate.client.OrchestrateRequest
isDone() - Method in class io.orchestrate.client.OrchestrateRequest
iterator() - Method in class io.orchestrate.client.EventList
iterator() - Method in class io.orchestrate.client.KvList
iterator() - Method in class io.orchestrate.client.RelationList
iterator() - Method in class io.orchestrate.client.SearchResults

J

JacksonMapper - Class in io.orchestrate.client: A utility object to configure a Jackson JSON ObjectMapper.
JacksonMapper() - Constructor for class io.orchestrate.client.JacksonMapper: Create a new JacksonMapper with default settings.
JacksonMapper.Builder - Class in io.orchestrate.client: Builder used to create JacksonMapper instances.

K

kv(String, String) - Method in interface io.orchestrate.client.Client: The resource for the KV features in the Orchestrate API.
kv(String, String) - Method in class io.orchestrate.client.OrchestrateClient: The resource for the KV features in the Orchestrate API.
KvList<T> - Class in io.orchestrate.client: A container for the KV objects with results.
KvListResource - Class in io.orchestrate.client: The resource for the KV list features in the Orchestrate API.
KvMetadata - Class in io.orchestrate.client: A container for metadata about a KV object.
KvObject<T> - Class in io.orchestrate.client: A container for a KV object.
KvResource - Class in io.orchestrate.client: The resource for the KV features in the Orchestrate API.

L

limit(int) - Method in class io.orchestrate.client.CollectionSearchResource: The number of search results to get in this query, this value cannot exceed 100.
limit(int) - Method in class io.orchestrate.client.KvListResource: The number of results to return.
listCollection(String) - Method in interface io.orchestrate.client.Client: The resource for the KV list features in the Orchestrate API.
listCollection(String) - Method in class io.orchestrate.client.OrchestrateClient: The resource for the KV list features in the Orchestrate API.

M

mapper(ObjectMapper) - Method in class io.orchestrate.client.OrchestrateClient.Builder: The Jackson JSON ObjectMapper to use when marshalling data to and from the service, defaults to JacksonMapper.builder().
mapper(JacksonMapper.Builder) - Method in class io.orchestrate.client.OrchestrateClient.Builder: A Builder used to build the JacksonMapper to use when marshalling data to and from the service.
mapper(JacksonMapper) - Method in class io.orchestrate.client.OrchestrateClient.Builder: A JacksonMapper to use when marshalling data to and from the service.
maxPoolSize(int) - Method in class io.orchestrate.client.OrchestrateClient.Builder: The maximum number of threads to use with the client, defaults to Integer.MAX_VALUE.

O

offset(int) - Method in class io.orchestrate.client.CollectionSearchResource: The position in the results list to start retrieving results from, this is useful for paginating results.
on(Iterable<ResponseListener<T>>) - Method in class io.orchestrate.client.OrchestrateRequest
on(ResponseListener<T>) - Method in class io.orchestrate.client.OrchestrateRequest
onFailure(Throwable) - Method in class io.orchestrate.client.ResponseAdapter: Invoked when the request associated with the OrchestrateRequest has failed.
onFailure(Throwable) - Method in interface io.orchestrate.client.ResponseListener: Invoked when the request associated with the OrchestrateRequest has failed.
onSuccess(T) - Method in class io.orchestrate.client.ResponseAdapter: Invoked when the request associated with the OrchestrateRequest has been completed.
onSuccess(T) - Method in interface io.orchestrate.client.ResponseListener: Invoked when the request associated with the OrchestrateRequest has been completed.
OrchestrateClient - Class in io.orchestrate.client: The client used to read and write data to the Orchestrate service.
OrchestrateClient(String) - Constructor for class io.orchestrate.client.OrchestrateClient: Create a new client with the specified apiKey and default JacksonMapper.
OrchestrateClient(String, ObjectMapper) - Constructor for class io.orchestrate.client.OrchestrateClient: Create a new client with the specified apiKey and objectMapper.
OrchestrateClient(String, JacksonMapper) - Constructor for class io.orchestrate.client.OrchestrateClient: Create a new client with the specified apiKey and mapper.
OrchestrateClient.Builder - Class in io.orchestrate.client: Builder used to create Client instances.
OrchestrateRequest<T> - Class in io.orchestrate.client

P

ping(String) - Method in interface io.orchestrate.client.Client: Health check that sends a ping to the Orchestrate service.
ping(String) - Method in class io.orchestrate.client.OrchestrateClient: Health check that sends a ping to the Orchestrate service.
poolSize(int) - Method in class io.orchestrate.client.OrchestrateClient.Builder: The initial number of threads to use with the client, defaults to Runtime.availableProcessors().
port(int) - Method in class io.orchestrate.client.OrchestrateClient.Builder: Set the port for the Orchestrate.io service, defaults to Builder.DEFAULT_PORT.
Preconditions - Class in io.orchestrate.client: A helper class to handle precondition checking in method calls.
Preconditions() - Constructor for class io.orchestrate.client.Preconditions
purge(String) - Method in class io.orchestrate.client.RelationResource: Remove a relationship between two objects in the Orchestrate service.
put(Object) - Method in class io.orchestrate.client.EventResource: EventResource.put(Object, Long).
put(Object, Long) - Method in class io.orchestrate.client.EventResource: Store an event to a key in the Orchestrate service.
put(Object) - Method in class io.orchestrate.client.KvResource: Store an object by key to the Orchestrate service.
put(String) - Method in class io.orchestrate.client.RelationResource: Store a relationship between two objects in the Orchestrate service.

R

registerModule(Module) - Method in class io.orchestrate.client.JacksonMapper.Builder: Register a new Module with the mapper.
relation(String, String) - Method in interface io.orchestrate.client.Client: The resource for the relation features in the Orchestrate API.
relation(String, String) - Method in class io.orchestrate.client.OrchestrateClient: The resource for the relation features in the Orchestrate API.
RelationList<T> - Class in io.orchestrate.client: A container for relation objects.
RelationResource - Class in io.orchestrate.client: The resource for the relation features in the Orchestrate API.
RequestException - Exception in io.orchestrate.client: An object that stores information about a failed Client request.
ResponseAdapter<T> - Class in io.orchestrate.client: An abstract adapter class for receiving client responses.
ResponseAdapter() - Constructor for class io.orchestrate.client.ResponseAdapter
ResponseListener<T> - Interface in io.orchestrate.client: The listener for receiving responses for HTTP requests.
Result<T> - Class in io.orchestrate.client: A container for the search result and its associated KV data.

S

save(String, T) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key.
save(String, T, Iterable<ResponseListener<KvMetadata>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key and fire the listeners on the response.
save(String, T, boolean) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.
save(String, T, boolean, Iterable<ResponseListener<KvMetadata>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.
save(String, T, KvMetadata) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.
save(String, T, KvMetadata, Iterable<ResponseListener<KvMetadata>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.
save(String, T, String) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key if and only if the currentRef matches the current stored ref.
save(String, T, String, Iterable<ResponseListener<KvMetadata>>) - Method in interface io.orchestrate.client.dao.AsyncDao: Save the specified value to the key if and only if the currentRef matches the current stored ref.
save(String, T) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key.
save(String, T, Iterable<ResponseListener<KvMetadata>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key and fire the listeners on the response.
save(String, T, boolean) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.
save(String, T, boolean, Iterable<ResponseListener<KvMetadata>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.
save(String, T, KvMetadata) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.
save(String, T, KvMetadata, Iterable<ResponseListener<KvMetadata>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.
save(String, T, String) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key if and only if the currentRef matches the current stored ref.
save(String, T, String, Iterable<ResponseListener<KvMetadata>>) - Method in class io.orchestrate.client.dao.GenericAsyncDao: Save the specified value to the key if and only if the currentRef matches the current stored ref.
searchCollection(String) - Method in interface io.orchestrate.client.Client: The resource for the collection search features in the Orchestrate API.
searchCollection(String) - Method in class io.orchestrate.client.OrchestrateClient: The resource for the collection search features in the Orchestrate API.
SearchResults<T> - Class in io.orchestrate.client: A container for the results from a search query.
start(long) - Method in class io.orchestrate.client.EventResource: The inclusive start of a time range to query.
startKey(String) - Method in class io.orchestrate.client.KvListResource: The start of the key range to paginate from including the specified value if it exists.

T

to(String, String) - Method in class io.orchestrate.client.RelationResource: The "destination" object to point the relationship to.
type(String) - Method in class io.orchestrate.client.EventResource: The type for an event, e.g.

U

userAgent(String) - Method in class io.orchestrate.client.OrchestrateClient.Builder: Set a custom value to be appended to the User-Agent header being sent to Orchestrate.
useSSL(boolean) - Method in class io.orchestrate.client.OrchestrateClient.Builder: Enable or disable SSL when connecting to the service, this value defaults to true.

A B C D E F G H I J K L M O P R S T U