com.graphaware.runtime.manager

Interface ModuleManager<T extends RuntimeModule>

Type Parameters:

T - type of module this manager can manage.

All Known Subinterfaces:

TimerDrivenModuleManager, TxDrivenModuleManager<T>

All Known Implementing Classes:

BaseModuleManager, BaseTxDrivenModuleManager, ProductionTimerDrivenModuleManager, ProductionTxDrivenModuleManager

public interface ModuleManager<T extends RuntimeModule>

A manager of RuntimeModules, which takes care of their lifecycle.

Method Summary

Modifier and Type	Method and Description
void	checkNotAlreadyRegistered(RuntimeModule module) Check that the given module isn't already registered with the manager.
void	cleanupMetadata(Set<String> usedModules) Perform cleanup metadata written by modules that are no longer present.
<M extends RuntimeModule> M	getModule(Class<M> clazz) Get a module registered with the manager.
<M extends RuntimeModule> M	getModule(String moduleId, Class<M> clazz) Get a module registered with the manager.
Set<String>	loadMetadata() Load module metadata from wherever they are stored in between database restarts and do whatever is necessary to do with this metadata before the modules can be used.
void	registerModule(T module) Register a module with this manager.
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.

Method Detail

checkNotAlreadyRegistered

void checkNotAlreadyRegistered(RuntimeModule module)

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

Parameters:

module - to check.

Throws:

IllegalStateException - in case the module is already registered.

registerModule

void registerModule(T module)

Register a module with this manager.

Parameters:

module - to register.

Throws:

IllegalStateException - in case the module is already registered.

getModule

<M extends RuntimeModule> M getModule(String moduleId,
                                      Class<M> clazz)

Get a module registered with the manager.

Type Parameters:

M - type of the class above.

Parameters:

moduleId - module ID.

clazz - expected class of the module.

Returns:

module, null if no such module exists.

getModule

<M extends RuntimeModule> M getModule(Class<M> clazz)

Get a module registered with the manager.

Type Parameters:

M - type of the class above.

Parameters:

clazz - class of the module.

Returns:

module. null if no such module exists.

Throws:

IllegalStateException - if more than one module of the same type has been registered.

loadMetadata

Set<String> loadMetadata()

Load module metadata from wherever they are stored in between database restarts and do whatever is necessary to do with this metadata before the modules can be used.

Returns:

IDs of all modules registered with this manager.

cleanupMetadata

void cleanupMetadata(Set<String> usedModules)

Perform cleanup metadata written by modules that are no longer present.

Parameters:

usedModules - IDs of all modules that are known to be used by the runtime during the current run.

startModules

void startModules()

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

shutdownModules

void shutdownModules()

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