com.graphaware.runtime.manager

Class ProductionTimerDrivenModuleManager

java.lang.Object

com.graphaware.runtime.manager.BaseModuleManager<TimerDrivenModuleMetadata,TimerDrivenModule>

com.graphaware.runtime.manager.ProductionTimerDrivenModuleManager

All Implemented Interfaces:

ModuleManager<TimerDrivenModule>, TimerDrivenModuleManager

public class ProductionTimerDrivenModuleManager
extends BaseModuleManager<TimerDrivenModuleMetadata,TimerDrivenModule>
implements TimerDrivenModuleManager

Production implementation of TimerDrivenModuleManager. Must be backed by a GraphDatabaseService, as there is no support for using TimerDrivenModules in batch mode (i.e. with org.neo4j.unsafe.batchinsert.BatchInserters).

Field Summary

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

metadataRepository, modules

Constructor Summary

Constructors

Constructor and Description
ProductionTimerDrivenModuleManager(org.neo4j.graphdb.GraphDatabaseService database, ModuleMetadataRepository metadataRepository, TimingStrategy timingStrategy, StatsCollector statsCollector) Constructs a new ProductionTimerDrivenModuleManager based on the given arguments.

Method Summary

Modifier and Type	Method and Description
protected TimerDrivenModuleMetadata	acknowledgeMetadata(TimerDrivenModule module, TimerDrivenModuleMetadata metadata) Acknowledge module metadata after it has been created afresh or successfully loaded from a ModuleMetadataRepository.
protected TimerDrivenModuleMetadata	createFreshMetadata(TimerDrivenModule module) Create new metadata for a module.
void	shutdownModules() Bring all modules to an orderly shutdown, when the database is stopped.
void	startModules() Perform work needed to make modules start doing their job.

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

checkNotAlreadyRegistered, cleanupMetadata, getModule, getModule, handleCorruptMetadata, handleNoMetadata, loadMetadata, registerModule

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

Constructor Detail

ProductionTimerDrivenModuleManager

public ProductionTimerDrivenModuleManager(org.neo4j.graphdb.GraphDatabaseService database,
                                          ModuleMetadataRepository metadataRepository,
                                          TimingStrategy timingStrategy,
                                          StatsCollector statsCollector)

Constructs a new ProductionTimerDrivenModuleManager based on the given arguments.

Parameters:

database - storing graph data.

metadataRepository - for storing module metadata.

timingStrategy - the TimingStrategy to use for scheduling the timer-driven modules.

Method Detail

createFreshMetadata

protected TimerDrivenModuleMetadata createFreshMetadata(TimerDrivenModule module)

Create new metadata for a module.

Specified by:

createFreshMetadata in class BaseModuleManager<TimerDrivenModuleMetadata,TimerDrivenModule>

Parameters:

module - for which to create metadata.

Returns:

fresh metadata.

acknowledgeMetadata

protected TimerDrivenModuleMetadata acknowledgeMetadata(TimerDrivenModule module,
                                                        TimerDrivenModuleMetadata metadata)

Acknowledge module metadata after it has been created afresh or successfully loaded from a ModuleMetadataRepository. The implementation can, for example, choose to let the module know about its own metadata. This method also gives the subclasses the opportunity to modify the metadata before it is persisted to the database.

Specified by:

acknowledgeMetadata in class BaseModuleManager<TimerDrivenModuleMetadata,TimerDrivenModule>

Parameters:

module - for which to acknowledge metadata.

metadata - to acknowledge.

Returns:

the acknowledged metadata (possibly modified).

startModules

public void startModules()

Perform work needed to make modules start doing their job. Called exactly once each time the database is started.

Specified by:

startModules in interface ModuleManager<TimerDrivenModule>

Overrides:

startModules in class BaseModuleManager<TimerDrivenModuleMetadata,TimerDrivenModule>

shutdownModules

public void shutdownModules()

Bring all modules to an orderly shutdown, when the database is stopped.

Specified by:

shutdownModules in interface ModuleManager<TimerDrivenModule>

Overrides:

shutdownModules in class BaseModuleManager<TimerDrivenModuleMetadata,TimerDrivenModule>