public interface SpongeEngine extends EngineModule
| Modifier and Type | Method and Description |
|---|---|
void |
addCategories(CategoryMeta... categoryMeta)
Adds or updates categories.
|
void |
addCategory(CategoryMeta categoryMeta)
Adds or updates a category.
|
void |
addEventType(String eventTypeName,
RecordType dataType)
Registers an event type as a record.
|
void |
addOnShutdownListener(OnShutdownListener onShutdownListener)
Adds the OnShutdown listener.
|
void |
addOnStartupListener(OnStartupListener onStartupListener)
Adds the OnStartup listener.
|
<T extends DataType<?>> |
addType(String registeredTypeName,
DataTypeSupplier<T> typeSupplier)
Registers a data type.
|
void |
clearError()
Clears the error that occurred during engine processing.
|
ProcessInstance |
createProcessInstance(ProcessConfiguration configuration)
Creates a new process instance but doesn't run it.
|
ActionManager |
getActionManager()
Returns the Action Manager.
|
ActionMeta |
getActionMeta(String actionName)
Returns the action metadata.
|
List<ActionAdapter> |
getActions()
Returns the list of action adapters.
|
List<CategoryMeta> |
getCategories()
Returns all categories.
|
CategoryMeta |
getCategory(String categoryName)
Returns a category.
|
ConfigurationManager |
getConfigurationManager()
Returns the Configuration Manager.
|
List<CorrelatorAdapterGroup> |
getCorrelatorGroups()
Returns the list of correlator adapter groups.
|
CorrelatorMeta |
getCorrelatorMeta(String correlatorName)
Returns the correlator metadata.
|
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.
|
RecordType |
getEventType(String eventTypeName)
Returns an event type.
|
Map<String,RecordType> |
getEventTypes()
Returns all registered event types.
|
ExceptionHandler |
getExceptionHandler()
Returns the exception handler.
|
FilterMeta |
getFilterMeta(String filterName)
Returns the filter metadata.
|
List<FilterAdapter> |
getFilters()
Returns the list of filter adapters.
|
String |
getInfo()
Returns the engine info.
|
KnowledgeBaseFileProvider |
getKnowledgeBaseFileProvider()
Returns the knowledge base file provider.
|
List<KnowledgeBaseInterpreterFactoryProvider> |
getKnowledgeBaseInterpreterFactoryProviders()
Returns the supported knowledge base interpreter factory providers.
|
KnowledgeBaseManager |
getKnowledgeBaseManager()
Returns the Knowledge Base Manager.
|
String |
getLicense()
Returns the engine license.
|
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<ProcessorAdapter> |
getProcessors() |
List<RuleAdapterGroup> |
getRuleGroups()
Returns the list of rule adapter groups.
|
RuleMeta |
getRuleMeta(String ruleName)
Returns the rule metadata.
|
StatisticsManager |
getStatisticsManager()
Returns the Statistics Manager.
|
ThreadPoolManager |
getThreadPoolManager()
Returns the Thread Pool Manager.
|
TriggerMeta |
getTriggerMeta(String triggerName)
Returns the trigger metadata.
|
List<TriggerAdapter> |
getTriggers()
Returns the list of trigger adapters.
|
<T extends DataType<?>> |
getType(String registeredTypeName)
Returns a new instance of the registered data type.
|
<T extends DataType<?>> |
getType(String registeredTypeName,
String locationName)
Returns a new instance of the registered data type.
|
Map<String,DataType> |
getTypes()
Returns the unmodifiable map of registered data types.
|
String |
getUuid()
Returns this engine UUID.
|
String |
getVersion()
Returns the engine version.
|
void |
handleError(ProcessorAdapter<?> processorAdapter,
Throwable e)
Handles the error.
|
void |
handleError(String sourceName,
Throwable e)
Handles the error.
|
boolean |
hasCategory(String categoryName)
Returns
true if the category is registered. |
boolean |
hasEventType(String eventTypeName)
Returns
true if the event type is registered. |
boolean |
hasType(String registeredTypeName)
Returns
true if the type is registered. |
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.
|
CategoryMeta |
removeCategory(String categoryName)
Removes a category.
|
boolean |
removeEventType(String eventTypeName)
Removes the registered event type.
|
boolean |
removeOnShutdownListener(OnShutdownListener onShutdownListener)
Removes the OnShutdown listener.
|
boolean |
removeOnStartupListener(OnStartupListener onStartupListener)
Removes the OnStartup listener.
|
boolean |
removeType(String registeredTypeName)
Removes the registered data type.
|
void |
requestReload()
Reloads script-based knowledge bases using another thread.
|
void |
requestShutdown()
Shuts down the engine using another thread.
|
void |
selectCategory(String categoryName,
ProcessorPredicate predicate)
Dynamically selects processors of all types that are to assigned to the category.
|
void |
selectCategory(String categoryName,
ProcessorType processorType,
ProcessorPredicate predicate)
Dynamically selects processors that are to assigned to the category.
|
void |
setConfigurationFilename(String configurationFilename)
Sets the configuration filename.
|
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 |
setLicense(String license)
Sets the engine license.
|
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.
|
isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startupgetDescription, getLabel, setDescription, setLabel, setNameString getUuid()
String getName()
null.getName in interface Descriptivevoid init()
ActionManager getActionManager()
PluginManager getPluginManager()
KnowledgeBaseManager getKnowledgeBaseManager()
ConfigurationManager getConfigurationManager()
ProcessingUnitManager getProcessingUnitManager()
EventQueueManager getEventQueueManager()
EventScheduler getEventScheduler()
ThreadPoolManager getThreadPoolManager()
ProcessorManager getProcessorManager()
StatisticsManager getStatisticsManager()
List<FilterAdapter> getFilters()
List<TriggerAdapter> getTriggers()
List<RuleAdapterGroup> getRuleGroups()
List<CorrelatorAdapterGroup> getCorrelatorGroups()
List<ActionAdapter> getActions()
List<ProcessorAdapter> getProcessors()
void handleError(ProcessorAdapter<?> processorAdapter, Throwable e)
processorAdapter - the processor adapter.e - the exception.void handleError(String sourceName, Throwable e)
sourceName - the source name.e - the exception.void reload()
void requestReload()
String getVersion()
String getLicense()
void setLicense(String license)
license - the engine license.String getInfo()
void requestShutdown()
boolean isError()
true if an error occurred during engine processing.Throwable getError()
null if no error occurred.void clearError()
KnowledgeBaseEngineOperations getOperations()
KnowledgeBaseFileProvider getKnowledgeBaseFileProvider()
List<KnowledgeBaseInterpreterFactoryProvider> getKnowledgeBaseInterpreterFactoryProviders()
void addOnStartupListener(OnStartupListener onStartupListener)
onStartupListener - the OnStartup listener.List<OnStartupListener> getOnStartupListeners()
boolean removeOnStartupListener(OnStartupListener onStartupListener)
onStartupListener - the OnStartup listener.true if there was such OnStartup listener.void addOnShutdownListener(OnShutdownListener onShutdownListener)
onShutdownListener - the OnShutdown listener.List<OnShutdownListener> getOnShutdownListeners()
boolean removeOnShutdownListener(OnShutdownListener onShutdownListener)
onShutdownListener - the OnShutdown listener.true if there was such OnShutdown listener.ExceptionHandler getExceptionHandler()
void setExceptionHandler(ExceptionHandler exceptionHandler)
exceptionHandler - the new exception handler.EngineParameters getDefaultParameters()
ConfigurationManager.void setConfigurationFilename(String configurationFilename)
configurationFilename - the configuration filename.void setProcessingUnitProvider(ProcessingUnitProvider processingUnitProvider)
processingUnitProvider - the processing unit provider.void setKnowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)
knowledgeBaseInterpreterFactoryProviders - the knowledge base interpreter factory providers.void setModuleProvider(EngineModuleProvider moduleProvider)
moduleProvider - the module provider.void setEventQueueProvider(EventQueueProvider eventQueueProvider)
eventQueueProvider - the event queue provider.void setKnowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)
knowledgeBaseFileProvider - the knowledge base file provider.EventSetProcessorDurationStrategy getEventSetProcessorDurationStrategy()
void setEventSetProcessorDurationStrategy(EventSetProcessorDurationStrategy durationStrategy)
durationStrategy - the duration strategy.PatternMatcher getPatternMatcher()
void setPatternMatcher(PatternMatcher patternMatcher)
patternMatcher - the pattern matcher.void addCategory(CategoryMeta categoryMeta)
categoryMeta - the category metadata.void addCategories(CategoryMeta... categoryMeta)
categoryMeta - the category metadata array.CategoryMeta getCategory(String categoryName)
categoryName - the category name.boolean hasCategory(String categoryName)
true if the category is registered.categoryName - the category name.true if the category is registered.CategoryMeta removeCategory(String categoryName)
categoryName - the category name.null.List<CategoryMeta> getCategories()
void selectCategory(String categoryName, ProcessorType processorType, ProcessorPredicate predicate)
categoryName - the category name.processorType - the processor type. If null, all processor types will be considered.predicate - the processor predicate.void selectCategory(String categoryName, ProcessorPredicate predicate)
categoryName - the category name.predicate - the processor predicate.ActionMeta getActionMeta(String actionName)
actionName - the action name.FilterMeta getFilterMeta(String filterName)
filterName - the filter name.TriggerMeta getTriggerMeta(String triggerName)
triggerName - the trigger name.CorrelatorMeta getCorrelatorMeta(String correlatorName)
correlatorName - the correlator name.RuleMeta getRuleMeta(String ruleName)
ruleName - the rule name.<T extends DataType<?>> void addType(String registeredTypeName, DataTypeSupplier<T> typeSupplier)
T - a data type.registeredTypeName - the registered type name.typeSupplier - the type supplier.<T extends DataType<?>> T getType(String registeredTypeName)
T - a data type.registeredTypeName - the registered type name.<T extends DataType<?>> T getType(String registeredTypeName, String locationName)
T - a data type.registeredTypeName - the registered type name.locationName - the returned type location name (corresponds to the withName type method).Map<String,DataType> getTypes()
boolean hasType(String registeredTypeName)
true if the type is registered.registeredTypeName - the type name.true if the type is registered.boolean removeType(String registeredTypeName)
registeredTypeName - the registered type name.true if the data type was registered.void addEventType(String eventTypeName, RecordType dataType)
eventTypeName - the registered event type name.dataType - the data type.RecordType getEventType(String eventTypeName)
eventTypeName - the registered event type name.boolean hasEventType(String eventTypeName)
true if the event type is registered.eventTypeName - the event type name.true if the event type is registered.Map<String,RecordType> getEventTypes()
boolean removeEventType(String eventTypeName)
eventTypeName - the registered event type name.true if the event type was registered.ProcessInstance createProcessInstance(ProcessConfiguration configuration)
configuration - the process configuration.Copyright © 2016–2020 Softelnet. All rights reserved.