EngineOperations (Sponge - API 1.10.0 API)

All Known Subinterfaces:

KnowledgeBaseEngineOperations
```
public interface EngineOperations
```
An engine operations.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCategories(CategoryMeta... categoryMeta)` Adds or updates categories.
`void`	`addCategory(CategoryMeta categoryMeta)` Adds or updates a category.
`<T extends DataType<?>> void`	`addType(String registeredTypeName, DataTypeSupplier<T> typeSupplier)` Registers a data type.
`<T> T`	`call(Class<T> resultClass, String actionName)` Calls the registered action with no arguments.
`<T> T`	`call(Class<T> resultClass, String actionName, List<Object> args)` Calls the registered action with arguments.
`Object`	`call(String actionName)` Calls the registered action with no arguments.
`Object`	`call(String actionName, List<Object> args)` Calls the registered action with arguments.
`<T> ValueHolder<T>`	`callIfExists(Class<T> resultClass, String actionName)` Calls the action if it exists.
`<T> ValueHolder<T>`	`callIfExists(Class<T> resultClass, String actionName, List<Object> args)` Calls the action if it exists.
`ValueHolder<Object>`	`callIfExists(String actionName)` Calls the action if it exists.
`ValueHolder<Object>`	`callIfExists(String actionName, List<Object> args)` Calls the action if it exists.
`EventDefinition`	`event(Event event)` Creates a new event definition.
`EventDefinition`	`event(String name)` Creates a new event definition.
`EventDefinition`	`event(String name, EventClonePolicy policy)` Creates a new event definition.
`boolean`	`existsAction(String name)` Returns `true` if an action named `name` exists.
`boolean`	`existsCorrelator(String name)` Returns `true` if a correlator named `name` exists.
`boolean`	`existsFilter(String name)` Returns `true` if a filter named `name` exists.
`boolean`	`existsRule(String name)` Returns `true` if a rule named `name` exists.
`boolean`	`existsTrigger(String name)` Returns `true` if a trigger named `name` exists.
`boolean`	`existsVariable(String name)` Returns `true` if the engine scope variable named `name` exists.
`ActionMeta`	`getActionMeta(String actionName)` Returns the action metadata.
`List<CategoryMeta>`	`getCategories()` Returns all categories.
`CategoryMeta`	`getCategory(String categoryName)` Returns a category.
`CorrelatorMeta`	`getCorrelatorMeta(String correlatorName)` Returns the correlator metadata.
`SpongeEngine`	`getEngine()` Returns the engine.
`FilterMeta`	`getFilterMeta(String filterName)` Returns the filter metadata.
`String`	`getHome()` Returns the home directory for the engine.
`String`	`getInfo()` Returns the engine info.
`<T extends Plugin> T`	`getPlugin(Class<T> cls)` Returns the plugin that has the specified type or `null` if there is no such plugin.
`<T extends Plugin> T`	`getPlugin(Class<T> cls, String name)` Returns the plugin that has the specified name and type or `null` if there is no such plugin.
`<T extends Plugin> T`	`getPlugin(String name)` Returns the plugin that has the specified name or `null` if there is no such plugin.
`String`	`getProperty(String name)` Returns the configuration property value.
`String`	`getProperty(String name, String defaultValue)` Returns the configuration property value or `defaultValue` if not found.
`RuleMeta`	`getRuleMeta(String ruleName)` Returns the rule metadata.
`String`	`getStatisticsSummary()` Returns the engine statistics summary.
`TriggerMeta`	`getTriggerMeta(String triggerName)` Returns the trigger metadata.
`<T extends DataType<?>> T`	`getType(String registeredTypeName)` Returns a new instance of the registered data type.
`<T extends DataType<?>> T`	`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.
`<T> T`	`getVariable(Class<T> cls, String name)` Returns the value of the engine scope variable.
`<T> T`	`getVariable(Class<T> cls, String name, T defaultValue)` Returns the value of the engine scope variable or `defaultValue` if not found.
`<T> T`	`getVariable(String name)` Returns the value of the engine scope variable.
`<T> T`	`getVariable(String name, T defaultValue)` Returns the value of the engine scope variable or `defaultValue` if not found.
`String`	`getVersion()` Returns the engine version.
`ProcessDefinition`	`process(ProcessConfiguration processConfiguration)` Create a new process definition.
`ProcessDefinition`	`process(ProcessConfigurationBuilder processConfigurationBuilder)` Create a new process definition.
`Map<String,ProvidedValue<?>>`	`provideActionArgs(String actionName)` Returns the provided values along with value sets of the action arguments.
`Map<String,ProvidedValue<?>>`	`provideActionArgs(String actionName, List<String> argNames)` Returns the provided values along with value sets of the action arguments.
`Map<String,ProvidedValue<?>>`	`provideActionArgs(String actionName, List<String> argNames, Map<String,Object> current)` Returns the provided values along with value sets of the action arguments.
`void`	`reload()` Reloads script-based knowledge bases.
`CategoryMeta`	`removeCategory(String categoryName)` Removes a category.
`boolean`	`removeEvent(EventSchedulerEntry entry)` Removes scheduled event.
`boolean`	`removeType(String registeredTypeName)` Removes the registered data type.
`void`	`removeVariable(String name)` Removes the engine scope variable.
`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`	`setVariable(String name, Object value)` Sets the engine scope variable.
`<T> void`	`setVariableIfNone(String name, Supplier<T> supplier)` Sets the engine scope variable if not set already.
`void`	`shutdown()` Shuts down the engine using the current thread.
`void`	`updateVariable(String name)` Updates the engine scope variable.

- Method Detail
  - getEngine
```
SpongeEngine getEngine()
```
    Returns the engine.
    
    Returns:
    
    the engine.
  - call
```
Object call(String actionName,
            List<Object> args)
```
    Calls the registered action with arguments. Throws ProcessorNotFoundException when such action is not registered.
    
    Parameters:
    
    actionName - actionName the action name.
    
    args - arguments to pass to action.
    
    Returns:
    
    result of action called for specified arguments.
  - call
```
<T> T call(Class<T> resultClass,
           String actionName,
           List<Object> args)
```
    Calls the registered action with arguments. Throws ProcessorNotFoundException when such action is not registered.
    
    Type Parameters:
    
    T - result type.
    
    Parameters:
    
    resultClass - result class.
    
    actionName - actionName the action name.
    
    args - arguments to pass to action.
    
    Returns:
    
    result of action called for specified arguments.
  - call
```
Object call(String actionName)
```
    Calls the registered action with no arguments. Throws ProcessorNotFoundException when such action is not registered.
    
    Parameters:
    
    actionName - actionName the action name.
    
    Returns:
    
    result of action called for specified arguments.
  - call
```
<T> T call(Class<T> resultClass,
           String actionName)
```
    Calls the registered action with no arguments. Throws ProcessorNotFoundException when such action is not registered.
    
    Type Parameters:
    
    T - result type.
    
    Parameters:
    
    resultClass - result class.
    
    actionName - actionName the action name.
    
    Returns:
    
    result of action called for specified arguments.
  - callIfExists
```
ValueHolder<Object> callIfExists(String actionName,
                                 List<Object> args)
```
    Calls the action if it exists.
    
    Parameters:
    
    actionName - actionName the action name.
    
    args - arguments to pass to action.
    
    Returns:
    
    the action result wrapped in a value holder or null if the action is not registered.
  - callIfExists
```
<T> ValueHolder<T> callIfExists(Class<T> resultClass,
                                String actionName,
                                List<Object> args)
```
    Calls the action if it exists.
    
    Type Parameters:
    
    T - result type.
    
    Parameters:
    
    resultClass - result class.
    
    actionName - actionName the action name.
    
    args - arguments to pass to action.
    
    Returns:
    
    the action result wrapped in a value holder or null if the action is not registered.
  - callIfExists
```
ValueHolder<Object> callIfExists(String actionName)
```
    Calls the action if it exists.
    
    Parameters:
    
    actionName - actionName the action name.
    
    Returns:
    
    the action result wrapped in a value holder or null if the action is not registered.
  - callIfExists
```
<T> ValueHolder<T> callIfExists(Class<T> resultClass,
                                String actionName)
```
    Calls the action if it exists.
    
    Type Parameters:
    
    T - result type.
    
    Parameters:
    
    resultClass - result class.
    
    actionName - actionName the action name.
    
    Returns:
    
    the action result wrapped in a value holder or null if the action is not registered.
  - provideActionArgs
```
Map<String,ProvidedValue<?>> provideActionArgs(String actionName,
                                               List<String> argNames,
                                               Map<String,Object> current)
```
    Returns the provided values along with value sets of the action arguments.
    
    Parameters:
    
    actionName - the action name.
    
    argNames - the list of argument names that are to be provided.
    
    current - the map of argument names and their current values passed from a client code. The map is required to contain values of those arguments that the arguments specified in the names depend on.
    
    Returns:
    
    the map of argument names and values (value sets).
  - provideActionArgs
```
Map<String,ProvidedValue<?>> provideActionArgs(String actionName,
                                               List<String> argNames)
```
    Returns the provided values along with value sets of the action arguments.
    
    Parameters:
    
    actionName - the action name.
    
    argNames - the list of argument names.
    
    Returns:
    
    the map of argument names and values (value sets).
  - provideActionArgs
```
Map<String,ProvidedValue<?>> provideActionArgs(String actionName)
```
    Returns the provided values along with value sets of the action arguments.
    
    Parameters:
    
    actionName - the action name.
    
    Returns:
    
    the map of argument names and values (value sets).
  - shutdown
```
void shutdown()
```
    Shuts down the engine using the current thread.
  - requestShutdown
```
void requestShutdown()
```
    Shuts down the engine using another thread.
  - reload
```
void reload()
```
    Reloads script-based knowledge bases.
  - requestReload
```
void requestReload()
```
    Reloads script-based knowledge bases using another thread.
  - removeEvent
```
boolean removeEvent(EventSchedulerEntry entry)
```
    Removes scheduled event.
    
    Parameters:
    
    entry - scheduled event entry.
    
    Returns:
    
    informs whether the specified event has been scheduled.
  - getPlugin
```
<T extends Plugin> T getPlugin(String name)
```
    Returns the plugin that has the specified name or null if there is no such plugin.
    
    Type Parameters:
    
    T - Plugin type.
    
    Parameters:
    
    name - plugin name.
    
    Returns:
    
    plugin.
  - getPlugin
```
<T extends Plugin> T getPlugin(Class<T> cls,
                               String name)
```
    Returns the plugin that has the specified name and type or null if there is no such plugin.
    
    Type Parameters:
    
    T - Plugin type.
    
    Parameters:
    
    cls - plugin class.
    
    name - plugin name.
    
    Returns:
    
    plugin.
  - getPlugin
```
<T extends Plugin> T getPlugin(Class<T> cls)
```
    Returns the plugin that has the specified type or null if there is no such plugin.
    
    Type Parameters:
    
    T - Plugin type.
    
    Parameters:
    
    cls - plugin class.
    
    Returns:
    
    plugin.
  - getVersion
```
String getVersion()
```
    Returns the engine version.
    
    Returns:
    
    the engine version.
  - getInfo
```
String getInfo()
```
    Returns the engine info.
    
    Returns:
    
    the engine info.
  - getStatisticsSummary
```
String getStatisticsSummary()
```
    Returns the engine statistics summary.
    
    Returns:
    
    the engine statistics summary.
  - event
```
EventDefinition event(String name)
```
    Creates a new event definition.
    
    Parameters:
    
    name - event name.
    
    Returns:
    
    a new event definition.
  - event
```
EventDefinition event(String name,
                      EventClonePolicy policy)
```
    Creates a new event definition.
    
    Parameters:
    
    name - event name.
    
    policy - event clone policy.
    
    Returns:
    
    a new event definition.
  - event
```
EventDefinition event(Event event)
```
    Creates a new event definition.
    
    Parameters:
    
    event - an event.
    
    Returns:
    
    a new event definition.
  - existsAction
```
boolean existsAction(String name)
```
    Returns true if an action named name exists.
    
    Parameters:
    
    name - action name.
    
    Returns:
    
    true if an action named name exists.
  - existsFilter
```
boolean existsFilter(String name)
```
    Returns true if a filter named name exists.
    
    Parameters:
    
    name - filter name.
    
    Returns:
    
    true if a filter named name exists.
  - existsTrigger
```
boolean existsTrigger(String name)
```
    Returns true if a trigger named name exists.
    
    Parameters:
    
    name - trigger name.
    
    Returns:
    
    true if a trigger named name exists.
  - existsRule
```
boolean existsRule(String name)
```
    Returns true if a rule named name exists.
    
    Parameters:
    
    name - rule name.
    
    Returns:
    
    true if a rule named name exists.
  - existsCorrelator
```
boolean existsCorrelator(String name)
```
    Returns true if a correlator named name exists.
    
    Parameters:
    
    name - correlator name.
    
    Returns:
    
    true if a correlator named name exists.
  - setVariable
```
void setVariable(String name,
                 Object value)
```
    Sets the engine scope variable.
    
    Parameters:
    
    name - variable name.
    
    value - variable value.
  - getVariable
```
<T> T getVariable(String name)
```
    Returns the value of the engine scope variable. Throws exception if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    name - variable name.
    
    Returns:
    
    variable value.
  - getVariable
```
<T> T getVariable(Class<T> cls,
                  String name)
```
    Returns the value of the engine scope variable. Throws exception if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    cls - variable class.
    
    name - variable name.
    
    Returns:
    
    variable value.
  - getVariable
```
<T> T getVariable(String name,
                  T defaultValue)
```
    Returns the value of the engine scope variable or defaultValue if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    name - variable name.
    
    defaultValue - default value.
    
    Returns:
    
    variable value.
  - getVariable
```
<T> T getVariable(Class<T> cls,
                  String name,
                  T defaultValue)
```
    Returns the value of the engine scope variable or defaultValue if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    cls - variable class.
    
    name - variable name.
    
    defaultValue - default value.
    
    Returns:
    
    variable value.
  - removeVariable
```
void removeVariable(String name)
```
    Removes the engine scope variable.
    
    Parameters:
    
    name - variable name.
  - existsVariable
```
boolean existsVariable(String name)
```
    Returns true if the engine scope variable named name exists.
    
    Parameters:
    
    name - variable name.
    
    Returns:
    
    true if the engine scope variable named name exists.
  - setVariableIfNone
```
<T> void setVariableIfNone(String name,
                           Supplier<T> supplier)
```
    Sets the engine scope variable if not set already.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    name - variable name.
    
    supplier - variable value supplier.
  - updateVariable
```
void updateVariable(String name)
```
    Updates the engine scope variable.
    
    Parameters:
    
    name - variable name.
  - getProperty
```
String getProperty(String name)
```
    Returns the configuration property value. Throws exception if not found.
    
    Parameters:
    
    name - the configuration property name.
    
    Returns:
    
    the configuration property value.
  - getProperty
```
String getProperty(String name,
                   String defaultValue)
```
    Returns the configuration property value or defaultValue if not found.
    
    Parameters:
    
    name - the configuration property name.
    
    defaultValue - the default value
    
    Returns:
    
    the configuration property value.
  - getHome
```
String getHome()
```
    Returns the home directory for the engine.
    
    Returns:
    
    the home directory for the engine.
  - process
```
ProcessDefinition process(ProcessConfiguration processConfiguration)
```
    Create a new process definition.
    
    Parameters:
    
    processConfiguration - the process configuration.
    
    Returns:
    
    a new process definition.
  - process
```
ProcessDefinition process(ProcessConfigurationBuilder processConfigurationBuilder)
```
    Create a new process definition.
    
    Parameters:
    
    processConfigurationBuilder - the process configuration builder.
    
    Returns:
    
    a new process definition.
  - addCategory
```
void addCategory(CategoryMeta categoryMeta)
```
    Adds or updates a category.
    
    Parameters:
    
    categoryMeta - the category metadata.
  - addCategories
```
void addCategories(CategoryMeta... categoryMeta)
```
    Adds or updates categories.
    
    Parameters:
    
    categoryMeta - the category metadata array.
  - getCategory
```
CategoryMeta getCategory(String categoryName)
```
    Returns a category.
    
    Parameters:
    
    categoryName - the category name.
    
    Returns:
    
    the category metadata or null.
  - removeCategory
```
CategoryMeta removeCategory(String categoryName)
```
    Removes a category. Throws an exception if this category is being used.
    
    Parameters:
    
    categoryName - the category name.
    
    Returns:
    
    the removed category metadata or null.
  - getCategories
```
List<CategoryMeta> getCategories()
```
    Returns all categories.
    
    Returns:
    
    the categories.
  - selectCategory
```
void selectCategory(String categoryName,
                    ProcessorType processorType,
                    ProcessorPredicate predicate)
```
    Dynamically selects processors that are to assigned to the category.
    
    Parameters:
    
    categoryName - the category name.
    
    processorType - the processor type. If null, all processor types will be considered.
    
    predicate - the processor predicate.
  - selectCategory
```
void selectCategory(String categoryName,
                    ProcessorPredicate predicate)
```
    Dynamically selects processors of all types that are to assigned to the category.
    
    Parameters:
    
    categoryName - the category name.
    
    predicate - the processor predicate.
  - getActionMeta
```
ActionMeta getActionMeta(String actionName)
```
    Returns the action metadata.
    
    Parameters:
    
    actionName - the action name.
    
    Returns:
    
    the action metadata.
  - getFilterMeta
```
FilterMeta getFilterMeta(String filterName)
```
    Returns the filter metadata.
    
    Parameters:
    
    filterName - the filter name.
    
    Returns:
    
    the filter metadata.
  - getTriggerMeta
```
TriggerMeta getTriggerMeta(String triggerName)
```
    Returns the trigger metadata.
    
    Parameters:
    
    triggerName - the trigger name.
    
    Returns:
    
    the trigger metadata.
  - getCorrelatorMeta
```
CorrelatorMeta getCorrelatorMeta(String correlatorName)
```
    Returns the correlator metadata.
    
    Parameters:
    
    correlatorName - the correlator name.
    
    Returns:
    
    the correlator metadata.
  - getRuleMeta
```
RuleMeta getRuleMeta(String ruleName)
```
    Returns the rule metadata.
    
    Parameters:
    
    ruleName - the rule name.
    
    Returns:
    
    the rule metadata.
  - addType
```
<T extends DataType<?>> void addType(String registeredTypeName,
                                     DataTypeSupplier<T> typeSupplier)
```
    Registers a data type.
    
    Type Parameters:
    
    T - a data type.
    
    Parameters:
    
    registeredTypeName - the registered type name.
    
    typeSupplier - the type supplier.
  - getType
```
<T extends DataType<?>> T getType(String registeredTypeName)
```
    Returns a new instance of the registered data type.
    
    Type Parameters:
    
    T - a data type.
    
    Parameters:
    
    registeredTypeName - the registered type name.
    
    Returns:
    
    the data type.
  - getType
```
<T extends DataType<?>> T getType(String registeredTypeName,
                                  String locationName)
```
    Returns a new instance of the registered data type.
    
    Type Parameters:
    
    T - a data type.
    
    Parameters:
    
    registeredTypeName - the registered type name.
    
    locationName - the returned type location name (corresponds to the withName type method).
    
    Returns:
    
    the data type.
  - getTypes
```
Map<String,DataType> getTypes()
```
    Returns the unmodifiable map of registered data types.
    
    Returns:
    
    the unmodifiable map of registered data types.
  - removeType
```
boolean removeType(String registeredTypeName)
```
    Removes the registered data type.
    
    Parameters:
    
    registeredTypeName - the registered type name.
    
    Returns:
    
    true if the data type was registered.

Interface EngineOperations

Method Summary

Method Detail

getEngine

call

call

call

call

callIfExists

callIfExists

callIfExists

callIfExists

provideActionArgs

provideActionArgs

provideActionArgs

shutdown

requestShutdown

reload

requestReload

removeEvent

getPlugin

getPlugin

getPlugin

getVersion

getInfo

getStatisticsSummary

event

event

event

existsAction

existsFilter

existsTrigger

existsRule

existsCorrelator

setVariable

getVariable

getVariable

getVariable

getVariable

removeVariable

existsVariable

setVariableIfNone

updateVariable

getProperty

getProperty

getHome

process

process

addCategory

addCategories

getCategory

removeCategory

getCategories

selectCategory

selectCategory

getActionMeta

getFilterMeta

getTriggerMeta

getCorrelatorMeta

getRuleMeta

addType

getType

getType

getTypes

removeType