com.graphaware.runtime

Class TxDrivenRuntime<T extends TxDrivenModule>

java.lang.Object

com.graphaware.runtime.BaseGraphAwareRuntime

com.graphaware.runtime.TxDrivenRuntime<T>

Type Parameters:

T - implementation of TxDrivenModule that this runtime supports.

All Implemented Interfaces:

GraphAwareRuntime, org.neo4j.graphdb.event.KernelEventHandler, org.neo4j.graphdb.event.TransactionEventHandler<Map<String,Object>>

Direct Known Subclasses:

DatabaseRuntime

public abstract class TxDrivenRuntime<T extends TxDrivenModule>
extends BaseGraphAwareRuntime
implements org.neo4j.graphdb.event.TransactionEventHandler<Map<String,Object>>

BaseGraphAwareRuntime that registers itself as a Neo4j TransactionEventHandler, translates TransactionData into ImprovedTransactionData and lets registered TxDrivenModules deal with the data before each transaction commits, in the order the modules were registered.

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.graphdb.event.TransactionEventHandler

org.neo4j.graphdb.event.TransactionEventHandler.Adapter<T>

Nested classes/interfaces inherited from interface org.neo4j.graphdb.event.KernelEventHandler

org.neo4j.graphdb.event.KernelEventHandler.ExecutionOrder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TxDrivenRuntime(RuntimeConfiguration configuration) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	afterCommit(org.neo4j.graphdb.event.TransactionData data, Map<String,Object> states)
void	afterRollback(org.neo4j.graphdb.event.TransactionData data, Map<String,Object> states)
Map<String,Object>	beforeCommit(org.neo4j.graphdb.event.TransactionData data)
protected void	checkNotAlreadyRegistered(RuntimeModule module) Check that the given module isn't already registered with the runtime.
protected void	cleanupMetadata(Set<String> usedModules) Perform cleanup of metadata potentially written to the graph by modules that aren't used any more.
<M extends RuntimeModule> M	getModule(Class<M> clazz)
<M extends RuntimeModule> M	getModule(String moduleId, Class<M> clazz)
protected abstract TxDrivenModuleManager<T>	getTxDrivenModuleManager() Get the manager for TxDrivenModules.
protected Set<String>	loadMetadata() Load module metadata.
protected void	shutdownModules() Shutdown all modules.
protected void	startModules() Perform the actual start of the runtime, being certain that it is the right time to do so.

Methods inherited from class com.graphaware.runtime.BaseGraphAwareRuntime

afterShutdown, beforeShutdown, doRegisterModule, getConfiguration, getResource, isStarted, kernelPanic, orderComparedTo, registerModule, start, waitUntilStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.graphaware.runtime.GraphAwareRuntime

getDatabaseWriter

Constructor Detail

TxDrivenRuntime

protected TxDrivenRuntime(RuntimeConfiguration configuration)

Create a new instance.

Parameters:

configuration - config.

Method Detail

getTxDrivenModuleManager

protected abstract TxDrivenModuleManager<T> getTxDrivenModuleManager()

Get the manager for TxDrivenModules.

Returns:

module manager.

checkNotAlreadyRegistered

protected void checkNotAlreadyRegistered(RuntimeModule module)

Check that the given module isn't already registered with the runtime.

Specified by:

checkNotAlreadyRegistered in class BaseGraphAwareRuntime

Parameters:

module - to check.

beforeCommit

public Map<String,Object> beforeCommit(org.neo4j.graphdb.event.TransactionData data)
                                throws Exception

Specified by:

beforeCommit in interface org.neo4j.graphdb.event.TransactionEventHandler<Map<String,Object>>

Throws:

Exception

afterCommit

public final void afterCommit(org.neo4j.graphdb.event.TransactionData data,
                              Map<String,Object> states)

Specified by:

afterCommit in interface org.neo4j.graphdb.event.TransactionEventHandler<Map<String,Object>>

afterRollback

public final void afterRollback(org.neo4j.graphdb.event.TransactionData data,
                                Map<String,Object> states)

Specified by:

afterRollback in interface org.neo4j.graphdb.event.TransactionEventHandler<Map<String,Object>>

getModule

public <M extends RuntimeModule> M getModule(String moduleId,
                                             Class<M> clazz)
                                      throws org.neo4j.graphdb.NotFoundException

Specified by:

getModule in interface GraphAwareRuntime

Throws:

org.neo4j.graphdb.NotFoundException

getModule

public <M extends RuntimeModule> M getModule(Class<M> clazz)
                                      throws org.neo4j.graphdb.NotFoundException

Specified by:

getModule in interface GraphAwareRuntime

Throws:

org.neo4j.graphdb.NotFoundException

loadMetadata

protected Set<String> loadMetadata()

Load module metadata.

Specified by:

loadMetadata in class BaseGraphAwareRuntime

Returns:

IDs of all modules registered with the runtime, no matter whether they previously had some metadata in the graph or not.

cleanupMetadata

protected void cleanupMetadata(Set<String> usedModules)

Perform cleanup of metadata potentially written to the graph by modules that aren't used any more.

Specified by:

cleanupMetadata in class BaseGraphAwareRuntime

Parameters:

usedModules - IDs of all the used modules (should be the same as returned by BaseGraphAwareRuntime.loadMetadata().

startModules

protected void startModules()

Perform the actual start of the runtime, being certain that it is the right time to do so.

Overrides:

startModules in class BaseGraphAwareRuntime

shutdownModules

protected void shutdownModules()

Shutdown all modules.

Specified by:

shutdownModules in class BaseGraphAwareRuntime