com.graphaware.runtime.manager

Class ProductionTxDrivenModuleManager

java.lang.Object

com.graphaware.runtime.manager.BaseModuleManager<TxDrivenModuleMetadata,T>

com.graphaware.runtime.manager.BaseTxDrivenModuleManager<TxDrivenModule>

com.graphaware.runtime.manager.ProductionTxDrivenModuleManager

All Implemented Interfaces:

ModuleManager<TxDrivenModule>, TxDrivenModuleManager<TxDrivenModule>

public class ProductionTxDrivenModuleManager
extends BaseTxDrivenModuleManager<TxDrivenModule>

BaseTxDrivenModuleManager backed by a GraphDatabaseService.

Field Summary

Fields inherited from class com.graphaware.runtime.manager.BaseModuleManager

metadataRepository, modules

Constructor Summary

Constructors

Constructor and Description
ProductionTxDrivenModuleManager(org.neo4j.graphdb.GraphDatabaseService database, ModuleMetadataRepository metadataRepository, StatsCollector statsCollector) Construct a new manager.

Method Summary

Modifier and Type	Method and Description
protected void	initialize(TxDrivenModule module) Initialize module.
protected void	reinitialize(TxDrivenModule module, TxDrivenModuleMetadata oldMetadata) Re-initialize module.
protected void	start(TxDrivenModule module) Start module.

Methods inherited from class com.graphaware.runtime.manager.BaseTxDrivenModuleManager

acknowledgeMetadata, afterCommit, afterRollback, beforeCommit, createFreshMetadata, handleCorruptMetadata, handleNoMetadata, startModules

Methods inherited from class com.graphaware.runtime.manager.BaseModuleManager

checkNotAlreadyRegistered, cleanupMetadata, getModule, getModule, loadMetadata, registerModule, shutdownModules

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.manager.ModuleManager

checkNotAlreadyRegistered, cleanupMetadata, getModule, getModule, loadMetadata, registerModule, shutdownModules

Constructor Detail

ProductionTxDrivenModuleManager

public ProductionTxDrivenModuleManager(org.neo4j.graphdb.GraphDatabaseService database,
                                       ModuleMetadataRepository metadataRepository,
                                       StatsCollector statsCollector)

Construct a new manager.

Parameters:

database - storing graph data.

metadataRepository - for storing module metadata.

Method Detail

start

protected void start(TxDrivenModule module)

Start module. This means preparing for doing the actual work. Call in a single-thread exactly once on each module every time the runtime starts.

Specified by:

start in class BaseTxDrivenModuleManager<TxDrivenModule>

Parameters:

module - to be started.

initialize

protected void initialize(TxDrivenModule module)

Initialize module. This means doing any work necessary for a module that has been registered for the first time on an existing database, or that has been previously registered with different configuration.

For example, a module that performs some in-graph caching needs to write information into the graph so that when the method returns, the graph is in the same state as it would be if the module has been running all the time since the graph was empty.

Note that for many modules, it might not be necessary to do anything.

Specified by:

initialize in class BaseTxDrivenModuleManager<TxDrivenModule>

Parameters:

module - to initialize.

reinitialize

protected void reinitialize(TxDrivenModule module,
                            TxDrivenModuleMetadata oldMetadata)

Re-initialize module. This means cleaning up all data this module might have ever written to the graph and doing any work necessary for a module that has been registered for the first time on an existing database, or that has been previously registered with different configuration.

For example, a module that performs some in-graph caching needs to write information into the graph so that when the method returns, the graph is in the same state as it would be if the module has been running all the time since the graph was empty.

Note that for many modules, it might not be necessary to do anything.

Specified by:

reinitialize in class BaseTxDrivenModuleManager<TxDrivenModule>

Parameters:

module - to initialize.

oldMetadata - metadata stored for this module from its previous run. Can be null in case metadata was corrupt or there was no metadata.