io.orchestrate.client

Class RelationResource

java.lang.Object

io.orchestrate.client.RelationResource

public class RelationResource
extends java.lang.Object

The resource for the relation 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
<T> OrchestrateRequest<RelationList<T>>	get(java.lang.Class<T> clazz, java.lang.String... kinds) Fetch objects related to a key in the Orchestrate service.
OrchestrateRequest<Relation>	get(java.lang.String kind, java.lang.String destCollection, java.lang.String destKey) Retrieve a Relation object.
RelationResource	ifAbsent() Equivalent to this.ifAbsent(Boolean.TRUE).
RelationResource	ifAbsent(boolean ifAbsent) Whether to store the object if no such relation already exists.
RelationResource	ifMatch(java.lang.String objectRef) The last known version of the stored object to match for the request to succeed.
RelationResource	invert() Swap the "source" and "destination" in the request, equivalent to:
RelationResource	invert(boolean invert) If invert is true the "source" and "destination" objects will be swapped in the request.
RelationResource	limit(int limit) The number of relation results to get in this query, this value cannot exceed 100.
RelationResource	offset(int offset) The position in the results list to start retrieving results from, this is useful for paginating results.
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>	purge(java.lang.String kind) Remove a relationship between two objects in the Orchestrate service.
OrchestrateRequest<java.lang.Boolean>	put(java.lang.String kind) Store a relationship between two objects in the Orchestrate service.
OrchestrateRequest<RelationMetadata>	put(java.lang.String kind, com.fasterxml.jackson.databind.JsonNode properties) Store a relationship, with an associated JSON property object, between two objects in the Orchestrate service.
RelationResource	to(java.lang.String collection, java.lang.String key) The "destination" object to point the relationship to.
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)

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

ifAbsent

public RelationResource ifAbsent()

Equivalent to this.ifAbsent(Boolean.TRUE).

Returns:

This RelationResource.

See Also:

ifAbsent(boolean)

ifAbsent

public RelationResource ifAbsent(boolean ifAbsent)

Whether to store the object if no such relation already exists.

Parameters:

ifAbsent - If true

Returns:

This RelationResource.

ifMatch

public RelationResource ifMatch(@NonNull
                                java.lang.String objectRef)

The last known version of the stored object to match for the request to succeed.

Parameters:

objectRef - The last known version of the stored object.

Returns:

This RelationResource.

get

public OrchestrateRequest<Relation> get(java.lang.String kind,
                                        java.lang.String destCollection,
                                        java.lang.String destKey)

Retrieve a Relation object.

Usage:

 
 Relation relation =
         client.relation("someCollection", "someKey")
               .get("someKind", "otherCollection", "otherKey")
               .get();
 
 

Parameters:

kind - String The name of the relationship.

destCollection - String The name of destination collection.

destKey - String The name of destination key.

Returns:

A prepared get request.

get

public <T> OrchestrateRequest<RelationList<T>> get(java.lang.Class<T> clazz,
                                                   java.lang.String... kinds)

Fetch objects related to a key in the Orchestrate service.

Usage:

 
 RelationList<String> relatedObjects =
         client.relation("someCollection", "someKey")
               .get(String.class, "someKind")
               .get();
 
 

Type Parameters:

T - The type to deserialize the response from the request to.

Parameters:

clazz - Type information for deserializing to type T at runtime.

kinds - The name of the relationships to traverse to the related objects.

Returns:

A prepared get request.

put

public OrchestrateRequest<java.lang.Boolean> put(java.lang.String kind)

Store a relationship between two objects in the Orchestrate service.

Usage:

 
 boolean result =
         client.relation("someCollection", "someKey")
               .to("anotherCollection", "anotherKey")
               .put(kind)
               .get();
 
 

Parameters:

kind - The name of the relationship to create.

Returns:

A prepared put request.

put

public OrchestrateRequest<RelationMetadata> put(java.lang.String kind,
                                                com.fasterxml.jackson.databind.JsonNode properties)

Store a relationship, with an associated JSON property object, between two objects in the Orchestrate service.

Usage:

 
 JsonNode properties = new ObjectMapper().readTree("{ \"foo\" : \"bar\" }");
 RelationMetadata result =
         client.relation("someCollection", "someKey")
               .to("anotherCollection", "anotherKey")
               .put(kind, properties)
               .get();
 
 

Parameters:

kind - The name of the relationship to create.

properties - A json object representing the properties of this relationship.

Returns:

A prepared create request.

purge

public OrchestrateRequest<java.lang.Boolean> purge(java.lang.String kind)

Remove a relationship between two objects in the Orchestrate service.

 
 boolean result =
         client.relation("someCollection", "someKey")
               .to("anotherCollection", "anotherKey")
               .purge(kind)
               .get();
 
 

Parameters:

kind - The name of the relationship to delete.

Returns:

A prepared delete request.

to

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

The "destination" object to point the relationship to.

Parameters:

collection - The collection containing the destination key.

key - The destination key to add the relation to.

Returns:

This relation resource.

invert

public RelationResource invert()

Swap the "source" and "destination" in the request, equivalent to:

 
 this.invert(Boolean.TRUE);
 
 

Returns:

This relation resource.

See Also:

invert(boolean)

invert

public RelationResource invert(boolean invert)

If invert is true the "source" and "destination" objects will be swapped in the request. This is useful for designing a bi-directional relationship.

Parameters:

invert - Whether to invert the request.

Returns:

This relation resource.

limit

public RelationResource limit(int limit)

The number of relation results to get in this query, this value cannot exceed 100. This property is ignored in #put(...) and #purge(...) requests.

Parameters:

limit - The number of search results in this query.

Returns:

This request.

offset

public RelationResource offset(int offset)

The position in the results list to start retrieving results from, this is useful for paginating results. This property is ignored in #put(...) and #purge(...) requests.

Parameters:

offset - The position to start retrieving results from.

Returns:

This request.

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)