Engine (Sponge - API 1.0.0 API)

All Superinterfaces:

EngineModule, Manageable
```
public interface Engine
extends EngineModule
```
The engine. This is the main interface of the system. An instance of this interface manages all main components.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addOnShutdownListener(OnShutdownListener onShutdownListener)` Adds OnShutdown listener.
`void`	`addOnStartupListener(OnStartupListener onStartupListener)` Adds OnStartup listener.
`List<ActionAdapter>`	`getActions()` Returns the list of action adapters.
`ConfigurationManager`	`getConfigurationManager()` Returns Configuration Manager.
`List<CorrelatorAdapterGroup>`	`getCorrelatorGroups()` Returns the list of correlator adapter groups.
`EngineParameters`	`getDefaultParameters()` Returns default parameters.
`String`	`getDescription()` Returns the engine description.
`Throwable`	`getError()` Returns the error that occurred during engine processing or `null` if no error occurred.
`EventQueueManager`	`getEventQueueManager()` Returns Event Queue Manager.
`EventScheduler`	`getEventScheduler()` Returns Event Scheduler.
`EventSetProcessorDurationStrategy`	`getEventSetProcessorDurationStrategy()` Returns a strategy for handling an event set processor duration timeout.
`ExceptionHandler`	`getExceptionHandler()` Returns an exception handler.
`List<FilterAdapter>`	`getFilters()` Returns the list of filter adapters.
`KnowledgeBaseFileProvider`	`getKnowledgeBaseFileProvider()` Returns a knowledge base file provider.
`KnowledgeBaseManager`	`getKnowledgeBaseManager()` Returns Knowledge Base Manager.
`String`	`getName()` Returns this engine name.
`List<OnShutdownListener>`	`getOnShutdownListeners()` Returns all OnShutdown listeners.
`List<OnStartupListener>`	`getOnStartupListeners()` Returns all OnStartup listeners.
`KnowledgeBaseEngineOperations`	`getOperations()` Returns engine operations.
`PluginManager`	`getPluginManager()` Returns Plugin Manager.
`List<Plugin>`	`getPlugins()` Returns the list of plugins.
`ProcessingUnitManager`	`getProcessingUnitManager()` Returns Processing Unit Manager.
`ProcessorManager`	`getProcessorManager()` Returns processor manager.
`List<RuleAdapterGroup>`	`getRuleGroups()` Returns the list of rule adapter groups.
`StatisticsManager`	`getStatisticsManager()` Returns Statistics Manager.
`ThreadPoolManager`	`getThreadPoolManager()` Returns thread pool manager.
`List<TriggerAdapter>`	`getTriggers()` Returns the list of trigger adapters.
`String`	`getVersion()` Returns the engine version.
`void`	`handleError(ProcessorAdapter<?> processorAdapter, Throwable e)` Handles an error.
`void`	`handleError(String sourceName, Throwable e)` Handles an error.
`void`	`init()` Initializes the engine (before starting up).
`boolean`	`isError()` Checks if an error occurred during engine processing.
`void`	`reload()` Reloads script-based knowledge bases.
`boolean`	`removeOnShutdownListener(OnShutdownListener onShutdownListener)` Removes OnShutdown listener.
`boolean`	`removeOnStartupListener(OnStartupListener onStartupListener)` Removes OnStartup listener.
`void`	`requestReload()` Reloads script-based knowledge bases using another thread.
`void`	`requestShutdown()` Shuts down the engine using another thread.
`void`	`setConfigurationFilename(String configurationFilename)` Sets a configuration file name.
`void`	`setEventQueueProvider(EventQueueProvider eventQueueProvider)` Sets an event queue provider.
`void`	`setEventSetProcessorDurationStrategy(EventSetProcessorDurationStrategy durationStrategy)` Sets a strategy for handling an event set processor duration timeout.
`void`	`setExceptionHandler(ExceptionHandler exceptionHandler)` Sets an exception handler.
`void`	`setKnowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)` Sets a knowledge base file provider.
`void`	`setKnowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)` Sets a knowledge base interpreter factory providers.
`void`	`setModuleProvider(EngineModuleProvider moduleProvider)` Sets a module provider.
`void`	`setProcessingUnitProvider(ProcessingUnitProvider processingUnitProvider)` Sets a processing unit provider.

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

- Method Detail
  - getName
```
String getName()
```
    Returns this engine name. May be null.
    
    Specified by:
    
    getName in interface EngineModule
    
    Returns:
    
    this engine name.
  - init
```
void init()
```
    Initializes the engine (before starting up).
  - getPluginManager
```
PluginManager getPluginManager()
```
    Returns Plugin Manager.
    
    Returns:
    
    Plugin Manager.
  - getKnowledgeBaseManager
```
KnowledgeBaseManager getKnowledgeBaseManager()
```
    Returns Knowledge Base Manager.
    
    Returns:
    
    Knowledge Base Manager.
  - getConfigurationManager
```
ConfigurationManager getConfigurationManager()
```
    Returns Configuration Manager.
    
    Returns:
    
    Configuration Manager.
  - getProcessingUnitManager
```
ProcessingUnitManager getProcessingUnitManager()
```
    Returns Processing Unit Manager.
    
    Returns:
    
    Processing Unit Manager.
  - getEventQueueManager
```
EventQueueManager getEventQueueManager()
```
    Returns Event Queue Manager.
    
    Returns:
    
    Event Queue Manager.
  - getEventScheduler
```
EventScheduler getEventScheduler()
```
    Returns Event Scheduler.
    
    Returns:
    
    Event Scheduler.
  - getThreadPoolManager
```
ThreadPoolManager getThreadPoolManager()
```
    Returns thread pool manager.
    
    Returns:
    
    thread pool manager.
  - getProcessorManager
```
ProcessorManager getProcessorManager()
```
    Returns processor manager.
    
    Returns:
    
    processor manager.
  - getStatisticsManager
```
StatisticsManager getStatisticsManager()
```
    Returns Statistics Manager.
    
    Returns:
    
    Statistics Manager.
  - getFilters
```
List<FilterAdapter> getFilters()
```
    Returns the list of filter adapters.
    
    Returns:
    
    the list of filter adapters.
  - getTriggers
```
List<TriggerAdapter> getTriggers()
```
    Returns the list of trigger adapters.
    
    Returns:
    
    the list of trigger adapters.
  - getRuleGroups
```
List<RuleAdapterGroup> getRuleGroups()
```
    Returns the list of rule adapter groups.
    
    Returns:
    
    the list of rule adapter groups.
  - getCorrelatorGroups
```
List<CorrelatorAdapterGroup> getCorrelatorGroups()
```
    Returns the list of correlator adapter groups.
    
    Returns:
    
    the list of correlator adapter groups.
  - getActions
```
List<ActionAdapter> getActions()
```
    Returns the list of action adapters.
    
    Returns:
    
    the list of action adapters.
  - handleError
```
void handleError(ProcessorAdapter<?> processorAdapter,
                 Throwable e)
```
    Handles an error.
    
    Parameters:
    
    processorAdapter - processor adapter.
    
    e - exception.
  - handleError
```
void handleError(String sourceName,
                 Throwable e)
```
    Handles an error.
    
    Parameters:
    
    sourceName - source name.
    
    e - exception.
  - getPlugins
```
List<Plugin> getPlugins()
```
    Returns the list of plugins.
    
    Returns:
    
    the list of plugins.
  - reload
```
void reload()
```
    Reloads script-based knowledge bases.
  - requestReload
```
void requestReload()
```
    Reloads script-based knowledge bases using another thread.
  - getVersion
```
String getVersion()
```
    Returns the engine version.
    
    Returns:
    
    the engine version.
  - getDescription
```
String getDescription()
```
    Returns the engine description.
    
    Returns:
    
    the engine description.
  - requestShutdown
```
void requestShutdown()
```
    Shuts down the engine using another thread.
  - isError
```
boolean isError()
```
    Checks if an error occurred during engine processing.
    
    Returns:
    
    true if an error occurred during engine processing.
  - getError
```
Throwable getError()
```
    Returns the error that occurred during engine processing or null if no error occurred.
    
    Returns:
    
    the error.
  - getOperations
```
KnowledgeBaseEngineOperations getOperations()
```
    Returns engine operations.
    
    Returns:
    
    engine operations.
  - getKnowledgeBaseFileProvider
```
KnowledgeBaseFileProvider getKnowledgeBaseFileProvider()
```
    Returns a knowledge base file provider.
    
    Returns:
    
    a knowledge base file provider.
  - addOnStartupListener
```
void addOnStartupListener(OnStartupListener onStartupListener)
```
    Adds OnStartup listener.
    
    Parameters:
    
    onStartupListener - OnStartup listener.
  - getOnStartupListeners
```
List<OnStartupListener> getOnStartupListeners()
```
    Returns all OnStartup listeners.
    
    Returns:
    
    all OnStartup listeners.
  - removeOnStartupListener
```
boolean removeOnStartupListener(OnStartupListener onStartupListener)
```
    Removes OnStartup listener.
    
    Parameters:
    
    onStartupListener - OnStartup listener.
    
    Returns:
    
    true if there was such OnStartup listener.
  - addOnShutdownListener
```
void addOnShutdownListener(OnShutdownListener onShutdownListener)
```
    Adds OnShutdown listener.
    
    Parameters:
    
    onShutdownListener - OnShutdown listener.
  - getOnShutdownListeners
```
List<OnShutdownListener> getOnShutdownListeners()
```
    Returns all OnShutdown listeners.
    
    Returns:
    
    all OnShutdown listeners.
  - removeOnShutdownListener
```
boolean removeOnShutdownListener(OnShutdownListener onShutdownListener)
```
    Removes OnShutdown listener.
    
    Parameters:
    
    onShutdownListener - OnShutdown listener.
    
    Returns:
    
    true if there was such OnShutdown listener.
  - getExceptionHandler
```
ExceptionHandler getExceptionHandler()
```
    Returns an exception handler.
    
    Returns:
    
    an exception handler.
  - setExceptionHandler
```
void setExceptionHandler(ExceptionHandler exceptionHandler)
```
    Sets an exception handler.
    
    Parameters:
    
    exceptionHandler - the new exception handler.
  - getDefaultParameters
```
EngineParameters getDefaultParameters()
```
    Returns default parameters. Notice that they are only default values. Current parameter values are provided by ConfigurationManager.
    
    Returns:
    
    default parameters.
  - setConfigurationFilename
```
void setConfigurationFilename(String configurationFilename)
```
    Sets a configuration file name.
    
    Parameters:
    
    configurationFilename - a configuration file name.
  - setProcessingUnitProvider
```
void setProcessingUnitProvider(ProcessingUnitProvider processingUnitProvider)
```
    Sets a processing unit provider.
    
    Parameters:
    
    processingUnitProvider - a processing unit provider.
  - setKnowledgeBaseInterpreterFactoryProviders
```
void setKnowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)
```
    Sets a knowledge base interpreter factory providers.
    
    Parameters:
    
    knowledgeBaseInterpreterFactoryProviders - a knowledge base interpreter factory providers.
  - setModuleProvider
```
void setModuleProvider(EngineModuleProvider moduleProvider)
```
    Sets a module provider.
    
    Parameters:
    
    moduleProvider - a module provider.
  - setEventQueueProvider
```
void setEventQueueProvider(EventQueueProvider eventQueueProvider)
```
    Sets an event queue provider.
    
    Parameters:
    
    eventQueueProvider - an event queue provider.
  - setKnowledgeBaseFileProvider
```
void setKnowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)
```
    Sets a knowledge base file provider.
    
    Parameters:
    
    knowledgeBaseFileProvider - a knowledge base file provider.
  - getEventSetProcessorDurationStrategy
```
EventSetProcessorDurationStrategy getEventSetProcessorDurationStrategy()
```
    Returns a strategy for handling an event set processor duration timeout.
    
    Returns:
    
    a duration strategy.
  - setEventSetProcessorDurationStrategy
```
void setEventSetProcessorDurationStrategy(EventSetProcessorDurationStrategy durationStrategy)
```
    Sets a strategy for handling an event set processor duration timeout.
    
    Parameters:
    
    durationStrategy - a duration strategy.

Interface Engine

Method Summary

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

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

Method Detail

getName

init

getPluginManager

getKnowledgeBaseManager

getConfigurationManager

getProcessingUnitManager

getEventQueueManager

getEventScheduler

getThreadPoolManager

getProcessorManager

getStatisticsManager

getFilters

getTriggers

getRuleGroups

getCorrelatorGroups

getActions

handleError

handleError

getPlugins

reload

requestReload

getVersion

getDescription

requestShutdown

isError

getError

getOperations

getKnowledgeBaseFileProvider

addOnStartupListener

getOnStartupListeners

removeOnStartupListener

addOnShutdownListener

getOnShutdownListeners

removeOnShutdownListener

getExceptionHandler

setExceptionHandler

getDefaultParameters

setConfigurationFilename

setProcessingUnitProvider

setKnowledgeBaseInterpreterFactoryProviders

setModuleProvider

setEventQueueProvider

setKnowledgeBaseFileProvider

getEventSetProcessorDurationStrategy

setEventSetProcessorDurationStrategy