com.graphaware.runtime

Class BaseGraphAwareRuntime

java.lang.Object

com.graphaware.runtime.BaseGraphAwareRuntime

All Implemented Interfaces:

GraphAwareRuntime, org.neo4j.graphdb.event.KernelEventHandler

Direct Known Subclasses:

TxDrivenRuntime

public abstract class BaseGraphAwareRuntime
extends Object
implements GraphAwareRuntime, org.neo4j.graphdb.event.KernelEventHandler

Abstract base-class for GraphAwareRuntime implementations. Handles lifecycle of the runtime and basic module-related sanity checks.

Nested Class Summary

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	BaseGraphAwareRuntime(RuntimeConfiguration configuration) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	afterShutdown() React to shutdown.
void	beforeShutdown()
protected abstract void	checkNotAlreadyRegistered(RuntimeModule module) Check that the given module isn't already registered with the runtime.
protected abstract void	cleanupMetadata(Set<String> usedModules) Perform cleanup of metadata potentially written to the graph by modules that aren't used any more.
protected abstract void	doRegisterModule(RuntimeModule module) Perform the actual module registration after sanity checks have passed.
RuntimeConfiguration	getConfiguration()
Object	getResource()
protected boolean	isStarted(ImprovedTransactionData transactionData) Checks to see if this GraphAwareRuntime is started.
void	kernelPanic(org.neo4j.graphdb.event.ErrorState error)
protected abstract Set<String>	loadMetadata() Load module metadata.
org.neo4j.graphdb.event.KernelEventHandler.ExecutionOrder	orderComparedTo(org.neo4j.graphdb.event.KernelEventHandler other)
void	registerModule(RuntimeModule module)
protected abstract void	shutdownModules() Shutdown all modules.
void	start()
protected void	startModules() Perform the actual start of the runtime, being certain that it is the right time to do so.
void	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, getModule, getModule

Constructor Detail

BaseGraphAwareRuntime

protected BaseGraphAwareRuntime(RuntimeConfiguration configuration)

Create a new instance.

Parameters:

configuration - config.

Method Detail

getConfiguration

public RuntimeConfiguration getConfiguration()

Specified by:

getConfiguration in interface GraphAwareRuntime

registerModule

public final void registerModule(RuntimeModule module)

Specified by:

registerModule in interface GraphAwareRuntime

checkNotAlreadyRegistered

protected abstract void checkNotAlreadyRegistered(RuntimeModule module)

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

Parameters:

module - to check.

Throws:

IllegalStateException - in case the module is already registered.

doRegisterModule

protected abstract void doRegisterModule(RuntimeModule module)

Perform the actual module registration after sanity checks have passed.

Parameters:

module - to register.

start

public final void start()

Specified by:

start in interface GraphAwareRuntime

startModules

protected void startModules()

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

loadMetadata

protected abstract Set<String> loadMetadata()

Load module metadata.

Returns:

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

cleanupMetadata

protected abstract void cleanupMetadata(Set<String> usedModules)

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

Parameters:

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

waitUntilStarted

public final void waitUntilStarted()

Specified by:

waitUntilStarted in interface GraphAwareRuntime

isStarted

protected final boolean isStarted(ImprovedTransactionData transactionData)

Checks to see if this GraphAwareRuntime is started. Blocks until it is started, unless one of the following conditions is met:

• it's already started, in which case the method returns true
• hasn't even started starting for more than 1s, in which case an exception is thrown
• hasn't been started yet, but the transaction triggering the call of this method isn't mutating, in which case it returns false
• it's starting but the caller is the thread that starts the runtime itself, in which case it returns false

Returns:

true iff the runtime is started. false iff the runtime isn't started but it is safe to proceed.

Throws:

IllegalStateException - in case the runtime hasn't been started at all.

beforeShutdown

public final void beforeShutdown()

Specified by:

beforeShutdown in interface org.neo4j.graphdb.event.KernelEventHandler

afterShutdown

protected void afterShutdown()

React to shutdown.

shutdownModules

protected abstract void shutdownModules()

Shutdown all modules.

kernelPanic

public final void kernelPanic(org.neo4j.graphdb.event.ErrorState error)

Specified by:

kernelPanic in interface org.neo4j.graphdb.event.KernelEventHandler

getResource

public final Object getResource()

Specified by:

getResource in interface org.neo4j.graphdb.event.KernelEventHandler

orderComparedTo

public final org.neo4j.graphdb.event.KernelEventHandler.ExecutionOrder orderComparedTo(org.neo4j.graphdb.event.KernelEventHandler other)

Specified by:

orderComparedTo in interface org.neo4j.graphdb.event.KernelEventHandler