SpongeEngine (Sponge - API 1.6.0 API)

All Superinterfaces:

Descriptive, EngineModule, HasEngine, Manageable
```
public interface SpongeEngine
extends EngineModule
```
The Sponge 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 the OnShutdown listener.
`void`	`addOnStartupListener(OnStartupListener onStartupListener)` Adds the OnStartup listener.
`void`	`clearError()` Clears the error that occurred during engine processing.
`ActionManager`	`getActionManager()` Returns the Action Manager.
`List<ActionAdapter>`	`getActions()` Returns the list of action adapters.
`ConfigurationManager`	`getConfigurationManager()` Returns the Configuration Manager.
`List<CorrelatorAdapterGroup>`	`getCorrelatorGroups()` Returns the list of correlator adapter groups.
`EngineParameters`	`getDefaultParameters()` Returns default parameters.
`Throwable`	`getError()` Returns the error that occurred during engine processing or `null` if no error occurred.
`EventQueueManager`	`getEventQueueManager()` Returns the Event Queue Manager.
`EventScheduler`	`getEventScheduler()` Returns the Event Scheduler.
`EventSetProcessorDurationStrategy`	`getEventSetProcessorDurationStrategy()` Returns the strategy for handling an event set processor duration timeout.
`ExceptionHandler`	`getExceptionHandler()` Returns the exception handler.
`List<FilterAdapter>`	`getFilters()` Returns the list of filter adapters.
`String`	`getInfo()` Returns the engine info.
`KnowledgeBaseFileProvider`	`getKnowledgeBaseFileProvider()` Returns the knowledge base file provider.
`KnowledgeBaseManager`	`getKnowledgeBaseManager()` Returns the 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 the engine operations.
`PatternMatcher`	`getPatternMatcher()` Returns the pattern matcher.
`PluginManager`	`getPluginManager()` Returns the Plugin Manager.
`List<Plugin>`	`getPlugins()` Returns the list of plugins.
`ProcessingUnitManager`	`getProcessingUnitManager()` Returns the Processing Unit Manager.
`ProcessorManager`	`getProcessorManager()` Returns the Processor Manager.
`List<RuleAdapterGroup>`	`getRuleGroups()` Returns the list of rule adapter groups.
`StatisticsManager`	`getStatisticsManager()` Returns the Statistics Manager.
`ThreadPoolManager`	`getThreadPoolManager()` Returns the 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 the error.
`void`	`handleError(String sourceName, Throwable e)` Handles the 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 the OnShutdown listener.
`boolean`	`removeOnStartupListener(OnStartupListener onStartupListener)` Removes the 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 the configuration file name.
`void`	`setEventQueueProvider(EventQueueProvider eventQueueProvider)` Sets the event queue provider.
`void`	`setEventSetProcessorDurationStrategy(EventSetProcessorDurationStrategy durationStrategy)` Sets the strategy for handling an event set processor duration timeout.
`void`	`setExceptionHandler(ExceptionHandler exceptionHandler)` Sets the exception handler.
`void`	`setKnowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)` Sets the knowledge base file provider.
`void`	`setKnowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)` Sets the knowledge base interpreter factory providers.
`void`	`setModuleProvider(EngineModuleProvider moduleProvider)` Sets the module provider.
`void`	`setPatternMatcher(PatternMatcher patternMatcher)` Sets the pattern matcher.
`void`	`setProcessingUnitProvider(ProcessingUnitProvider processingUnitProvider)` Sets the processing unit provider.

Methods inherited from interface org.openksavi.sponge.util.Manageable
isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Methods inherited from interface org.openksavi.sponge.util.Descriptive
getDescription, getDisplayName, setDescription, setDisplayName, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine
getEngine, setEngine

- Method Detail
  - getName
```
String getName()
```
    Returns this engine name. May be null.
    
    Specified by:
    
    getName in interface Descriptive
    
    Returns:
    
    this engine name.
  - init
```
void init()
```
    Initializes the engine (before starting up).
  - getActionManager
```
ActionManager getActionManager()
```
    Returns the Action Manager.
    
    Returns:
    
    the Action Manager.
  - getPluginManager
```
PluginManager getPluginManager()
```
    Returns the Plugin Manager.
    
    Returns:
    
    the Plugin Manager.
  - getKnowledgeBaseManager
```
KnowledgeBaseManager getKnowledgeBaseManager()
```
    Returns the Knowledge Base Manager.
    
    Returns:
    
    the Knowledge Base Manager.
  - getConfigurationManager
```
ConfigurationManager getConfigurationManager()
```
    Returns the Configuration Manager.
    
    Returns:
    
    the Configuration Manager.
  - getProcessingUnitManager
```
ProcessingUnitManager getProcessingUnitManager()
```
    Returns the Processing Unit Manager.
    
    Returns:
    
    the Processing Unit Manager.
  - getEventQueueManager
```
EventQueueManager getEventQueueManager()
```
    Returns the Event Queue Manager.
    
    Returns:
    
    the Event Queue Manager.
  - getEventScheduler
```
EventScheduler getEventScheduler()
```
    Returns the Event Scheduler.
    
    Returns:
    
    the Event Scheduler.
  - getThreadPoolManager
```
ThreadPoolManager getThreadPoolManager()
```
    Returns the Thread Pool Manager.
    
    Returns:
    
    the Thread Pool Manager.
  - getProcessorManager
```
ProcessorManager getProcessorManager()
```
    Returns the Processor Manager.
    
    Returns:
    
    the Processor Manager.
  - getStatisticsManager
```
StatisticsManager getStatisticsManager()
```
    Returns the Statistics Manager.
    
    Returns:
    
    the 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 the error.
    
    Parameters:
    
    processorAdapter - the processor adapter.
    
    e - the exception.
  - handleError
```
void handleError(String sourceName,
                 Throwable e)
```
    Handles the error.
    
    Parameters:
    
    sourceName - the source name.
    
    e - the 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.
  - getInfo
```
String getInfo()
```
    Returns the engine info.
    
    Returns:
    
    the engine info.
  - 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.
  - clearError
```
void clearError()
```
    Clears the error that occurred during engine processing.
  - getOperations
```
KnowledgeBaseEngineOperations getOperations()
```
    Returns the engine operations.
    
    Returns:
    
    the engine operations.
  - getKnowledgeBaseFileProvider
```
KnowledgeBaseFileProvider getKnowledgeBaseFileProvider()
```
    Returns the knowledge base file provider.
    
    Returns:
    
    the knowledge base file provider.
  - addOnStartupListener
```
void addOnStartupListener(OnStartupListener onStartupListener)
```
    Adds the OnStartup listener.
    
    Parameters:
    
    onStartupListener - the OnStartup listener.
  - getOnStartupListeners
```
List<OnStartupListener> getOnStartupListeners()
```
    Returns all OnStartup listeners.
    
    Returns:
    
    all OnStartup listeners.
  - removeOnStartupListener
```
boolean removeOnStartupListener(OnStartupListener onStartupListener)
```
    Removes the OnStartup listener.
    
    Parameters:
    
    onStartupListener - the OnStartup listener.
    
    Returns:
    
    true if there was such OnStartup listener.
  - addOnShutdownListener
```
void addOnShutdownListener(OnShutdownListener onShutdownListener)
```
    Adds the OnShutdown listener.
    
    Parameters:
    
    onShutdownListener - the OnShutdown listener.
  - getOnShutdownListeners
```
List<OnShutdownListener> getOnShutdownListeners()
```
    Returns all OnShutdown listeners.
    
    Returns:
    
    all OnShutdown listeners.
  - removeOnShutdownListener
```
boolean removeOnShutdownListener(OnShutdownListener onShutdownListener)
```
    Removes the OnShutdown listener.
    
    Parameters:
    
    onShutdownListener - the OnShutdown listener.
    
    Returns:
    
    true if there was such OnShutdown listener.
  - getExceptionHandler
```
ExceptionHandler getExceptionHandler()
```
    Returns the exception handler.
    
    Returns:
    
    the exception handler.
  - setExceptionHandler
```
void setExceptionHandler(ExceptionHandler exceptionHandler)
```
    Sets the 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 the configuration file name.
    
    Parameters:
    
    configurationFilename - the configuration file name.
  - setProcessingUnitProvider
```
void setProcessingUnitProvider(ProcessingUnitProvider processingUnitProvider)
```
    Sets the processing unit provider.
    
    Parameters:
    
    processingUnitProvider - the processing unit provider.
  - setKnowledgeBaseInterpreterFactoryProviders
```
void setKnowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)
```
    Sets the knowledge base interpreter factory providers.
    
    Parameters:
    
    knowledgeBaseInterpreterFactoryProviders - the knowledge base interpreter factory providers.
  - setModuleProvider
```
void setModuleProvider(EngineModuleProvider moduleProvider)
```
    Sets the module provider.
    
    Parameters:
    
    moduleProvider - the module provider.
  - setEventQueueProvider
```
void setEventQueueProvider(EventQueueProvider eventQueueProvider)
```
    Sets the event queue provider.
    
    Parameters:
    
    eventQueueProvider - the event queue provider.
  - setKnowledgeBaseFileProvider
```
void setKnowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)
```
    Sets the knowledge base file provider.
    
    Parameters:
    
    knowledgeBaseFileProvider - the knowledge base file provider.
  - getEventSetProcessorDurationStrategy
```
EventSetProcessorDurationStrategy getEventSetProcessorDurationStrategy()
```
    Returns the strategy for handling an event set processor duration timeout.
    
    Returns:
    
    the duration strategy.
  - setEventSetProcessorDurationStrategy
```
void setEventSetProcessorDurationStrategy(EventSetProcessorDurationStrategy durationStrategy)
```
    Sets the strategy for handling an event set processor duration timeout.
    
    Parameters:
    
    durationStrategy - the duration strategy.
  - getPatternMatcher
```
PatternMatcher getPatternMatcher()
```
    Returns the pattern matcher.
    
    Returns:
    
    the pattern matcher.
  - setPatternMatcher
```
void setPatternMatcher(PatternMatcher patternMatcher)
```
    Sets the pattern matcher.
    
    Parameters:
    
    patternMatcher - the pattern matcher.

Interface SpongeEngine

Method Summary

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

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

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

Method Detail

getName

init

getActionManager

getPluginManager

getKnowledgeBaseManager

getConfigurationManager

getProcessingUnitManager

getEventQueueManager

getEventScheduler

getThreadPoolManager

getProcessorManager

getStatisticsManager

getFilters

getTriggers

getRuleGroups

getCorrelatorGroups

getActions

handleError

handleError

getPlugins

reload

requestReload

getVersion

getInfo

requestShutdown

isError

getError

clearError

getOperations

getKnowledgeBaseFileProvider

addOnStartupListener

getOnStartupListeners

removeOnStartupListener

addOnShutdownListener

getOnShutdownListeners

removeOnShutdownListener

getExceptionHandler

setExceptionHandler

getDefaultParameters

setConfigurationFilename

setProcessingUnitProvider

setKnowledgeBaseInterpreterFactoryProviders

setModuleProvider

setEventQueueProvider

setKnowledgeBaseFileProvider

getEventSetProcessorDurationStrategy

setEventSetProcessorDurationStrategy

getPatternMatcher

setPatternMatcher