org.openksavi.sponge.core.engine

Class BaseEngine

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.BaseEngine

All Implemented Interfaces:

org.openksavi.sponge.engine.Engine, org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.util.Manageable

Direct Known Subclasses:

DefaultEngine

public class BaseEngine
extends BaseEngineModule
implements org.openksavi.sponge.engine.Engine

Base engine implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openksavi.sponge.engine.ActionManager	actionManager Action manager.
protected org.openksavi.sponge.engine.ConfigurationManager	configurationManager Configuration manager.
protected org.openksavi.sponge.engine.EventQueueManager	eventQueueManager Event queue manager.
protected org.openksavi.sponge.spi.EventQueueProvider	eventQueueProvider Event queue provider.
protected org.openksavi.sponge.engine.event.EventScheduler	eventScheduler Event scheduler.
protected org.openksavi.sponge.engine.event.EventQueue	inputQueue Input event queue.
protected org.openksavi.sponge.kb.KnowledgeBaseFileProvider	knowledgeBaseFileProvider Knowledge base file provider.
protected List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider>	knowledgeBaseInterpreterFactoryProviders Knowledge base interpreter factory providers.
protected org.openksavi.sponge.engine.KnowledgeBaseManager	knowledgeBaseManager Knowledge base manager.
protected Lock	lock Lock.
protected org.openksavi.sponge.spi.EngineModuleProvider	moduleProvider Engine module provider.
protected org.openksavi.sponge.engine.PluginManager	pluginManager Plugin manager.
protected org.openksavi.sponge.engine.ProcessingUnitManager	processingUnitManager Processing Unit manager.
protected org.openksavi.sponge.spi.ProcessingUnitProvider	processingUnitProvider Processing unit provider.
protected org.openksavi.sponge.engine.ProcessorManager	processorManager Processor manager.
protected org.openksavi.sponge.engine.Session	session Session.
protected org.openksavi.sponge.engine.StatisticsManager	statisticsManager Statistics manager.
protected org.openksavi.sponge.engine.ThreadPoolManager	threadPoolManager Thread pool manager.

Constructor Summary

Constructors

Constructor and Description
BaseEngine() Creates a new engine.

Method Summary

Modifier and Type	Method and Description
void	addOnShutdownListener(org.openksavi.sponge.engine.OnShutdownListener onShutdownListener)
void	addOnStartupListener(org.openksavi.sponge.engine.OnStartupListener onStartupListener)
void	clearRememberedException() Clears remembered exception.
protected void	configureEngineModules() Configures engine modules.
void	doShutdown() Shuts down the engine.
void	doStartup() Starts up the engine.
protected void	ensureProvidersSet() Ensures that all providers are set.
org.openksavi.sponge.engine.ActionManager	getActionManager()
List<org.openksavi.sponge.action.ActionAdapter>	getActions() Returns the list of action adapters.
String	getConfigurationFilename()
org.openksavi.sponge.engine.ConfigurationManager	getConfigurationManager() Returns Configuration Manager.
List<org.openksavi.sponge.correlator.CorrelatorAdapterGroup>	getCorrelatorGroups() Returns the list of correlator adapter groups.
org.openksavi.sponge.engine.EngineParameters	getDefaultParameters()
String	getDescription() Returns the engine description.
Throwable	getError()
org.openksavi.sponge.engine.EventQueueManager	getEventQueueManager()
org.openksavi.sponge.engine.event.EventScheduler	getEventScheduler() Returns Event Scheduler.
org.openksavi.sponge.engine.processing.EventSetProcessorDurationStrategy	getEventSetProcessorDurationStrategy()
org.openksavi.sponge.engine.ExceptionHandler	getExceptionHandler()
org.openksavi.sponge.engine.processing.ProcessingUnit<org.openksavi.sponge.filter.FilterAdapter>	getFilterProcessingUnit()
List<org.openksavi.sponge.filter.FilterAdapter>	getFilters() Returns the list of filter adapters.
org.openksavi.sponge.engine.event.EventQueue	getInputQueue()
org.openksavi.sponge.kb.KnowledgeBaseFileProvider	getKnowledgeBaseFileProvider()
List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider>	getKnowledgeBaseInterpreterFactoryProviders()
org.openksavi.sponge.engine.KnowledgeBaseManager	getKnowledgeBaseManager() Returns knowledge base manager.
org.openksavi.sponge.engine.processing.MainProcessingUnit	getMainProcessingUnit()
org.openksavi.sponge.spi.EngineModuleProvider	getModuleProvider() Returns the module provider.
List<org.openksavi.sponge.engine.OnShutdownListener>	getOnShutdownListeners()
List<org.openksavi.sponge.engine.OnStartupListener>	getOnStartupListeners()
org.openksavi.sponge.kb.KnowledgeBaseEngineOperations	getOperations()
org.openksavi.sponge.util.PatternMatcher	getPatternMatcher()
org.openksavi.sponge.engine.PluginManager	getPluginManager() Returns Plugin Manager.
List<org.openksavi.sponge.plugin.Plugin>	getPlugins() Returns the list of plugins.
org.openksavi.sponge.engine.ProcessingUnitManager	getProcessingUnitManager() Returns Processing Unit Manager.
org.openksavi.sponge.engine.ProcessorManager	getProcessorManager()
AtomicReference<Throwable>	getRememberedException()
List<org.openksavi.sponge.rule.RuleAdapterGroup>	getRuleGroups() Returns the list of rule adapter groups.
org.openksavi.sponge.engine.Session	getSession()
org.openksavi.sponge.engine.StatisticsManager	getStatisticsManager() Returns Statistics Manager.
org.openksavi.sponge.engine.ThreadPoolManager	getThreadPoolManager() Returns Thread Pool Manager.
List<org.openksavi.sponge.trigger.TriggerAdapter>	getTriggers() Returns the list of trigger adapters.
String	getVersion() Returns the engine version.
void	handleError(org.openksavi.sponge.ProcessorAdapter<?> processorAdapter, Throwable e) Processes error.
protected void	handleError(String sourceName, Object sourceObject, Throwable exception)
void	handleError(String sourceName, Throwable e) Processes error.
void	init() Initializes the engine by creating providers and engine modules.
boolean	isError()
void	reload() Reloads script-based knowledge bases.
boolean	removeOnShutdownListener(org.openksavi.sponge.engine.OnShutdownListener onShutdownListener)
boolean	removeOnStartupListener(org.openksavi.sponge.engine.OnStartupListener onStartupListener)
void	requestReload()
void	requestShutdown()
protected void	safelyShutdownIfStartupError(org.openksavi.sponge.engine.EngineModule... modules)
void	setConfigurationFilename(String configurationFilename)
void	setEventQueueProvider(org.openksavi.sponge.spi.EventQueueProvider eventQueueProvider)
void	setEventSetProcessorDurationStrategy(org.openksavi.sponge.engine.processing.EventSetProcessorDurationStrategy durationStrategy)
void	setExceptionHandler(org.openksavi.sponge.engine.ExceptionHandler exceptionHandler)
void	setKnowledgeBaseFileProvider(org.openksavi.sponge.kb.KnowledgeBaseFileProvider knowledgeBaseFileProvider)
void	setKnowledgeBaseInterpreterFactoryProviders(List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)
void	setModuleProvider(org.openksavi.sponge.spi.EngineModuleProvider moduleProvider) Sets the module provider.
void	setPatternMatcher(org.openksavi.sponge.util.PatternMatcher patternMatcher)
void	setProcessingUnitProvider(org.openksavi.sponge.spi.ProcessingUnitProvider processingUnitProvider)
protected void	setupEngineName() Setup engine name.
protected void	tryRememberException(Throwable e) Remembers the first exception.

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getEngine, getName, getService, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setEngine, setName, shutdown, startup, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openksavi.sponge.engine.Engine

getName

Methods inherited from interface org.openksavi.sponge.engine.EngineModule

getEngine, setEngine, setName

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Field Detail

moduleProvider

protected org.openksavi.sponge.spi.EngineModuleProvider moduleProvider

Engine module provider.

knowledgeBaseInterpreterFactoryProviders

protected List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders

Knowledge base interpreter factory providers.

eventQueueProvider

protected org.openksavi.sponge.spi.EventQueueProvider eventQueueProvider

Event queue provider.

processingUnitProvider

protected org.openksavi.sponge.spi.ProcessingUnitProvider processingUnitProvider

Processing unit provider.

knowledgeBaseFileProvider

protected org.openksavi.sponge.kb.KnowledgeBaseFileProvider knowledgeBaseFileProvider

Knowledge base file provider.

eventScheduler

protected org.openksavi.sponge.engine.event.EventScheduler eventScheduler

Event scheduler.

eventQueueManager

protected org.openksavi.sponge.engine.EventQueueManager eventQueueManager

Event queue manager.

threadPoolManager

protected org.openksavi.sponge.engine.ThreadPoolManager threadPoolManager

Thread pool manager.

knowledgeBaseManager

protected org.openksavi.sponge.engine.KnowledgeBaseManager knowledgeBaseManager

Knowledge base manager.

pluginManager

protected org.openksavi.sponge.engine.PluginManager pluginManager

Plugin manager.

configurationManager

protected org.openksavi.sponge.engine.ConfigurationManager configurationManager

Configuration manager.

statisticsManager

protected org.openksavi.sponge.engine.StatisticsManager statisticsManager

Statistics manager.

session

protected org.openksavi.sponge.engine.Session session

Session. In the current implementation there is only one session for one engine.

lock

protected Lock lock

Lock.

processorManager

protected org.openksavi.sponge.engine.ProcessorManager processorManager

Processor manager.

processingUnitManager

protected org.openksavi.sponge.engine.ProcessingUnitManager processingUnitManager

Processing Unit manager.

actionManager

protected org.openksavi.sponge.engine.ActionManager actionManager

Action manager.

inputQueue

protected org.openksavi.sponge.engine.event.EventQueue inputQueue

Input event queue.

Constructor Detail

BaseEngine

public BaseEngine()

Creates a new engine. Engine module provider will be loaded using Java ServiceLoader.

Method Detail

getModuleProvider

public org.openksavi.sponge.spi.EngineModuleProvider getModuleProvider()

Returns the module provider.

Returns:

the moduleProvider

setModuleProvider

public void setModuleProvider(org.openksavi.sponge.spi.EngineModuleProvider moduleProvider)

Sets the module provider.

Specified by:

setModuleProvider in interface org.openksavi.sponge.engine.Engine

Parameters:

moduleProvider - the moduleProvider to set.

getKnowledgeBaseInterpreterFactoryProviders

public List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider> getKnowledgeBaseInterpreterFactoryProviders()

setKnowledgeBaseInterpreterFactoryProviders

public void setKnowledgeBaseInterpreterFactoryProviders(List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)

Specified by:

setKnowledgeBaseInterpreterFactoryProviders in interface org.openksavi.sponge.engine.Engine

setEventQueueProvider

public void setEventQueueProvider(org.openksavi.sponge.spi.EventQueueProvider eventQueueProvider)

Specified by:

setEventQueueProvider in interface org.openksavi.sponge.engine.Engine

setProcessingUnitProvider

public void setProcessingUnitProvider(org.openksavi.sponge.spi.ProcessingUnitProvider processingUnitProvider)

Specified by:

setProcessingUnitProvider in interface org.openksavi.sponge.engine.Engine

getExceptionHandler

public org.openksavi.sponge.engine.ExceptionHandler getExceptionHandler()

Specified by:

getExceptionHandler in interface org.openksavi.sponge.engine.Engine

setExceptionHandler

public void setExceptionHandler(org.openksavi.sponge.engine.ExceptionHandler exceptionHandler)

Specified by:

setExceptionHandler in interface org.openksavi.sponge.engine.Engine

getConfigurationFilename

public String getConfigurationFilename()

setConfigurationFilename

public void setConfigurationFilename(String configurationFilename)

Specified by:

setConfigurationFilename in interface org.openksavi.sponge.engine.Engine

init

public void init()

Initializes the engine by creating providers and engine modules.

Specified by:

init in interface org.openksavi.sponge.engine.Engine

ensureProvidersSet

protected void ensureProvidersSet()

Ensures that all providers are set.

doStartup

public void doStartup()

Starts up the engine.

Overrides:

doStartup in class BaseEngineModule

safelyShutdownIfStartupError

protected void safelyShutdownIfStartupError(org.openksavi.sponge.engine.EngineModule... modules)

setupEngineName

protected void setupEngineName()

Setup engine name.

doShutdown

public void doShutdown()

Shuts down the engine.

Overrides:

doShutdown in class BaseEngineModule

requestShutdown

public void requestShutdown()

Specified by:

requestShutdown in interface org.openksavi.sponge.engine.Engine

configureEngineModules

protected void configureEngineModules()

Configures engine modules.

getPluginManager

public org.openksavi.sponge.engine.PluginManager getPluginManager()

Returns Plugin Manager.

Specified by:

getPluginManager in interface org.openksavi.sponge.engine.Engine

Returns:

Plugin Manager.

getKnowledgeBaseManager

public org.openksavi.sponge.engine.KnowledgeBaseManager getKnowledgeBaseManager()

Returns knowledge base manager.

Specified by:

getKnowledgeBaseManager in interface org.openksavi.sponge.engine.Engine

Returns:

knowledge base Manager.

getConfigurationManager

public org.openksavi.sponge.engine.ConfigurationManager getConfigurationManager()

Returns Configuration Manager.

Specified by:

getConfigurationManager in interface org.openksavi.sponge.engine.Engine

Returns:

Configuration Manager.

getEventScheduler

public org.openksavi.sponge.engine.event.EventScheduler getEventScheduler()

Returns Event Scheduler.

Specified by:

getEventScheduler in interface org.openksavi.sponge.engine.Engine

Returns:

Event Scheduler.

getStatisticsManager

public org.openksavi.sponge.engine.StatisticsManager getStatisticsManager()

Returns Statistics Manager.

Specified by:

getStatisticsManager in interface org.openksavi.sponge.engine.Engine

Returns:

Statistics Manager.

getProcessingUnitManager

public org.openksavi.sponge.engine.ProcessingUnitManager getProcessingUnitManager()

Returns Processing Unit Manager.

Specified by:

getProcessingUnitManager in interface org.openksavi.sponge.engine.Engine

Returns:

Processing Unit Manager.

getThreadPoolManager

public org.openksavi.sponge.engine.ThreadPoolManager getThreadPoolManager()

Returns Thread Pool Manager.

Specified by:

getThreadPoolManager in interface org.openksavi.sponge.engine.Engine

Returns:

Thread Pool Manager.

getFilters

public List<org.openksavi.sponge.filter.FilterAdapter> getFilters()

Returns the list of filter adapters.

Specified by:

getFilters in interface org.openksavi.sponge.engine.Engine

Returns:

the list of filter adapters.

getTriggers

public List<org.openksavi.sponge.trigger.TriggerAdapter> getTriggers()

Returns the list of trigger adapters.

Specified by:

getTriggers in interface org.openksavi.sponge.engine.Engine

Returns:

the list of trigger adapters.

getRuleGroups

public List<org.openksavi.sponge.rule.RuleAdapterGroup> getRuleGroups()

Returns the list of rule adapter groups.

Specified by:

getRuleGroups in interface org.openksavi.sponge.engine.Engine

Returns:

the list of rule adapter groups.

getCorrelatorGroups

public List<org.openksavi.sponge.correlator.CorrelatorAdapterGroup> getCorrelatorGroups()

Returns the list of correlator adapter groups.

Specified by:

getCorrelatorGroups in interface org.openksavi.sponge.engine.Engine

Returns:

the list of correlator adapter groups.

getActions

public List<org.openksavi.sponge.action.ActionAdapter> getActions()

Returns the list of action adapters.

Specified by:

getActions in interface org.openksavi.sponge.engine.Engine

Returns:

the list of action adapters.

reload

public void reload()

Reloads script-based knowledge bases.

Specified by:

reload in interface org.openksavi.sponge.engine.Engine

requestReload

public void requestReload()

Specified by:

requestReload in interface org.openksavi.sponge.engine.Engine

handleError

public void handleError(org.openksavi.sponge.ProcessorAdapter<?> processorAdapter,
                        Throwable e)

Processes error.

Specified by:

handleError in interface org.openksavi.sponge.engine.Engine

Parameters:

processorAdapter - processor adapter.

e - exception.

handleError

public void handleError(String sourceName,
                        Throwable e)

Processes error.

Specified by:

handleError in interface org.openksavi.sponge.engine.Engine

Parameters:

sourceName - source name.

e - exception.

handleError

protected void handleError(String sourceName,
                           Object sourceObject,
                           Throwable exception)

getPlugins

public List<org.openksavi.sponge.plugin.Plugin> getPlugins()

Returns the list of plugins.

Specified by:

getPlugins in interface org.openksavi.sponge.engine.Engine

Returns:

the list of plugins.

getVersion

public String getVersion()

Returns the engine version.

Specified by:

getVersion in interface org.openksavi.sponge.engine.Engine

Returns:

the engine version.

getDescription

public String getDescription()

Returns the engine description.

Specified by:

getDescription in interface org.openksavi.sponge.engine.Engine

Returns:

the engine description.

tryRememberException

protected void tryRememberException(Throwable e)

Remembers the first exception.

Parameters:

e - exception.

clearRememberedException

public void clearRememberedException()

Clears remembered exception.

getEventQueueManager

public org.openksavi.sponge.engine.EventQueueManager getEventQueueManager()

Specified by:

getEventQueueManager in interface org.openksavi.sponge.engine.Engine

getFilterProcessingUnit

public org.openksavi.sponge.engine.processing.ProcessingUnit<org.openksavi.sponge.filter.FilterAdapter> getFilterProcessingUnit()

getMainProcessingUnit

public org.openksavi.sponge.engine.processing.MainProcessingUnit getMainProcessingUnit()

getProcessorManager

public org.openksavi.sponge.engine.ProcessorManager getProcessorManager()

Specified by:

getProcessorManager in interface org.openksavi.sponge.engine.Engine

getActionManager

public org.openksavi.sponge.engine.ActionManager getActionManager()

getInputQueue

public org.openksavi.sponge.engine.event.EventQueue getInputQueue()

getRememberedException

public AtomicReference<Throwable> getRememberedException()

isError

public boolean isError()

Specified by:

isError in interface org.openksavi.sponge.engine.Engine

getError

public Throwable getError()

Specified by:

getError in interface org.openksavi.sponge.engine.Engine

getOperations

public org.openksavi.sponge.kb.KnowledgeBaseEngineOperations getOperations()

Specified by:

getOperations in interface org.openksavi.sponge.engine.Engine

getSession

public org.openksavi.sponge.engine.Session getSession()

getKnowledgeBaseFileProvider

public org.openksavi.sponge.kb.KnowledgeBaseFileProvider getKnowledgeBaseFileProvider()

Specified by:

getKnowledgeBaseFileProvider in interface org.openksavi.sponge.engine.Engine

setKnowledgeBaseFileProvider

public void setKnowledgeBaseFileProvider(org.openksavi.sponge.kb.KnowledgeBaseFileProvider knowledgeBaseFileProvider)

Specified by:

setKnowledgeBaseFileProvider in interface org.openksavi.sponge.engine.Engine

addOnStartupListener

public void addOnStartupListener(org.openksavi.sponge.engine.OnStartupListener onStartupListener)

Specified by:

addOnStartupListener in interface org.openksavi.sponge.engine.Engine

removeOnStartupListener

public boolean removeOnStartupListener(org.openksavi.sponge.engine.OnStartupListener onStartupListener)

Specified by:

removeOnStartupListener in interface org.openksavi.sponge.engine.Engine

getOnStartupListeners

public List<org.openksavi.sponge.engine.OnStartupListener> getOnStartupListeners()

Specified by:

getOnStartupListeners in interface org.openksavi.sponge.engine.Engine

addOnShutdownListener

public void addOnShutdownListener(org.openksavi.sponge.engine.OnShutdownListener onShutdownListener)

Specified by:

addOnShutdownListener in interface org.openksavi.sponge.engine.Engine

removeOnShutdownListener

public boolean removeOnShutdownListener(org.openksavi.sponge.engine.OnShutdownListener onShutdownListener)

Specified by:

removeOnShutdownListener in interface org.openksavi.sponge.engine.Engine

getOnShutdownListeners

public List<org.openksavi.sponge.engine.OnShutdownListener> getOnShutdownListeners()

Specified by:

getOnShutdownListeners in interface org.openksavi.sponge.engine.Engine

getDefaultParameters

public org.openksavi.sponge.engine.EngineParameters getDefaultParameters()

Specified by:

getDefaultParameters in interface org.openksavi.sponge.engine.Engine

getEventSetProcessorDurationStrategy

public org.openksavi.sponge.engine.processing.EventSetProcessorDurationStrategy getEventSetProcessorDurationStrategy()

Specified by:

getEventSetProcessorDurationStrategy in interface org.openksavi.sponge.engine.Engine

setEventSetProcessorDurationStrategy

public void setEventSetProcessorDurationStrategy(org.openksavi.sponge.engine.processing.EventSetProcessorDurationStrategy durationStrategy)

Specified by:

setEventSetProcessorDurationStrategy in interface org.openksavi.sponge.engine.Engine

getPatternMatcher

public org.openksavi.sponge.util.PatternMatcher getPatternMatcher()

Specified by:

getPatternMatcher in interface org.openksavi.sponge.engine.Engine

setPatternMatcher

public void setPatternMatcher(org.openksavi.sponge.util.PatternMatcher patternMatcher)

Specified by:

setPatternMatcher in interface org.openksavi.sponge.engine.Engine