org.hawkular.inventory.impl.tinkerpop.spi

Interface GraphProvider<G extends com.tinkerpop.blueprints.TransactionalGraph>

public interface GraphProvider<G extends com.tinkerpop.blueprints.TransactionalGraph>

This is a service interface that the Tinkerpop implementation will use to get a configured and initialized instance of a blueprints graph.

This level of indirection is needed because many graph databases provide configuration and management features that are not accessible through plain Blueprints API.

Since:

0.0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
default void	commit(G graph, InventoryBackend.Transaction t) Commits the transaction in the graph.
void	ensureIndices(G graph, IndexSpec... indexSpecs) Makes sure all the indexes needed for good performance.
G	instantiateGraph(Configuration configuration) Given provided configuration, tries to instantiate a graph to be used by the inventory.
default void	rollback(G graph, InventoryBackend.Transaction t) Rolls back the transaction in the graph.
default InventoryBackend.Transaction	startTransaction(G graph, boolean mutating) Starts a new transaction in the graph.

Method Detail

instantiateGraph

G instantiateGraph(Configuration configuration)

Given provided configuration, tries to instantiate a graph to be used by the inventory.

Parameters:

configuration - the configuration of the graph

Returns:

a configured instance of the graph or null if not possible

ensureIndices

void ensureIndices(G graph,
                   IndexSpec... indexSpecs)

Makes sure all the indexes needed for good performance.

The provided set of indexes is what the implementation thinks the indices should be. The graph provider is free to make more indexes if they choose so to support the "core" set of indices.

Parameters:

graph - the graph instance (coming from the instantiateGraph(org.hawkular.inventory.api.Configuration) call) to index

indexSpecs - the core set of indices to define

startTransaction

default InventoryBackend.Transaction startTransaction(G graph,
                                                      boolean mutating)

Starts a new transaction in the graph.

The default implementation returns a new instance of InventoryBackend.Transaction with the provided mutating flag.

Parameters:

graph - the graph to start the transaction in

mutating - whether the transaction will mutate the storage or not

Returns:

a transaction handle

commit

default void commit(G graph,
                    InventoryBackend.Transaction t)

Commits the transaction in the graph.

The default implementation merely calls TransactionalGraph.commit().

Parameters:

graph - the graph to commit the transaction to

t - the transaction

rollback

default void rollback(G graph,
                      InventoryBackend.Transaction t)

Rolls back the transaction in the graph.

The default implementation merely calls TransactionalGraph.rollback().

Parameters:

graph - the graph to rollback the transaction from

t - the transaction