com.graphaware.runtime

Class ProductionRuntime

java.lang.Object

com.graphaware.runtime.BaseGraphAwareRuntime

com.graphaware.runtime.TxDrivenRuntime<TxDrivenModule>

com.graphaware.runtime.DatabaseRuntime

com.graphaware.runtime.ProductionRuntime

All Implemented Interfaces:

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

public class ProductionRuntime
extends DatabaseRuntime

DatabaseRuntime intended for production use.

Supports both TimerDrivenModule and TxDrivenModule RuntimeModules.

To use this GraphAwareRuntime, please construct it using GraphAwareRuntimeFactory.

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	ProductionRuntime(RuntimeConfiguration configuration, org.neo4j.graphdb.GraphDatabaseService database, TxDrivenModuleManager<TxDrivenModule> txDrivenModuleManager, TimerDrivenModuleManager timerDrivenModuleManager, Neo4jWriter writer) Construct a new runtime.

Method Summary

Modifier and Type	Method and Description
protected void	afterShutdown(org.neo4j.graphdb.GraphDatabaseService database) React to shutdown.
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.
protected void	doRegisterModule(RuntimeModule module) Perform the actual module registration after sanity checks have passed.
<M extends RuntimeModule> M	getModule(Class<M> clazz)
<M extends RuntimeModule> M	getModule(String moduleId, Class<M> clazz)
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.DatabaseRuntime

afterShutdown, getDatabaseWriter, getTxDrivenModuleManager

Methods inherited from class com.graphaware.runtime.TxDrivenRuntime

afterCommit, afterRollback, beforeCommit

Methods inherited from class com.graphaware.runtime.BaseGraphAwareRuntime

beforeShutdown, 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

Constructor Detail

ProductionRuntime

protected ProductionRuntime(RuntimeConfiguration configuration,
                            org.neo4j.graphdb.GraphDatabaseService database,
                            TxDrivenModuleManager<TxDrivenModule> txDrivenModuleManager,
                            TimerDrivenModuleManager timerDrivenModuleManager,
                            Neo4jWriter writer)

Construct a new runtime. Protected, please use GraphAwareRuntimeFactory.

Parameters:

configuration - config.

database - on which the runtime operates.

txDrivenModuleManager - manager for transaction-driven modules.

timerDrivenModuleManager - manager for timer-driven modules.

writer - to use when writing to the database.

Method Detail

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 TxDrivenRuntime<TxDrivenModule>

loadMetadata

protected Set<String> loadMetadata()

Load module metadata.

Overrides:

loadMetadata in class TxDrivenRuntime<TxDrivenModule>

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.

Overrides:

cleanupMetadata in class TxDrivenRuntime<TxDrivenModule>

Parameters:

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

checkNotAlreadyRegistered

protected void checkNotAlreadyRegistered(RuntimeModule module)

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

Overrides:

checkNotAlreadyRegistered in class TxDrivenRuntime<TxDrivenModule>

Parameters:

module - to check.

doRegisterModule

protected void doRegisterModule(RuntimeModule module)

Perform the actual module registration after sanity checks have passed.

Overrides:

doRegisterModule in class DatabaseRuntime

Parameters:

module - to register.

getModule

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

Specified by:

getModule in interface GraphAwareRuntime

Overrides:

getModule in class TxDrivenRuntime<TxDrivenModule>

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

Overrides:

getModule in class TxDrivenRuntime<TxDrivenModule>

Throws:

org.neo4j.graphdb.NotFoundException

shutdownModules

protected void shutdownModules()

Shutdown all modules.

Overrides:

shutdownModules in class TxDrivenRuntime<TxDrivenModule>

afterShutdown

protected void afterShutdown(org.neo4j.graphdb.GraphDatabaseService database)

React to shutdown.

Overrides:

afterShutdown in class DatabaseRuntime

Parameters:

database - which has been shut down.