com.graphaware.runtime.metadata

Interface TxDrivenModuleMetadata

All Superinterfaces:

ModuleMetadata

All Known Implementing Classes:

DefaultTxDrivenModuleMetadata

public interface TxDrivenModuleMetadata
extends ModuleMetadata

ModuleMetadata for TxDrivenModules.

Method Summary

Modifier and Type	Method and Description
TxDrivenModuleConfiguration	getConfig() Get the configuration of the module.
TxDrivenModuleMetadata	markedNeedingInitialization() Create a new instance of this class with needsInitialization() returning true.
boolean	needsInitialization() Does the module need initialization?
long	problemTimestamp() Get the time in milliseconds since 1/1/1970 of the first occurrence of a problem that caused the needsInitialization() method to return true.

Method Detail

getConfig

TxDrivenModuleConfiguration getConfig()

Get the configuration of the module. It is part of the TxDrivenModuleMetadata in order to detect configuration changes after a restart.

Returns:

configuration.

needsInitialization

boolean needsInitialization()

Does the module need initialization?

Returns:

true iff the module needs initialization. This is usually the case when something out-of-sync has been detected during the last run of the database.

problemTimestamp

long problemTimestamp()

Get the time in milliseconds since 1/1/1970 of the first occurrence of a problem that caused the needsInitialization() method to return true.

Returns:

timestamp of the first problem occurrence, -1 if needsInitialization() returns false.

markedNeedingInitialization

TxDrivenModuleMetadata markedNeedingInitialization()

Create a new instance of this class with needsInitialization() returning true. This must cause problemTimestamp() to return time representing the instant when this method was called. Same instance of the implementation of this class should be returned when needsInitialization() already returns true.

Returns:

new instance of this class with needsInitialization() returning true, same instance if that's already the case.