org.openksavi.sponge.core

Class BaseEngineOperations

java.lang.Object

org.openksavi.sponge.core.BaseEngineOperations

All Implemented Interfaces:

EngineOperations

Direct Known Subclasses:

BaseKnowledgeBaseEngineOperations

public class BaseEngineOperations
extends Object
implements EngineOperations

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseSpongeEngine	engine

Constructor Summary

Constructors

Constructor and Description
BaseEngineOperations(BaseSpongeEngine engine)

Method Summary

Modifier and Type	Method and Description
void	addCategories(CategoryMeta... categoryMeta)
void	addCategory(CategoryMeta categoryMeta)
void	addEventType(String eventTypeName, RecordType dataType)
<T extends DataType<?>> void	addType(String registeredTypeName, DataTypeSupplier<T> typeSupplier)
<T> T	call(Class<T> resultClass, String actionName)
<T> T	call(Class<T> resultClass, String actionName, List<Object> args)
<T> T	call(Class<T> resultClass, String actionName, Map<String,?> args)
Object	call(String actionName)
Object	call(String actionName, List<Object> args)
Object	call(String actionName, Map<String,?> args)
<T> ValueHolder<T>	callIfExists(Class<T> resultClass, String actionName)
<T> ValueHolder<T>	callIfExists(Class<T> resultClass, String actionName, List<Object> args)
<T> ValueHolder<T>	callIfExists(Class<T> resultClass, String actionName, Map<String,?> args)
ValueHolder<Object>	callIfExists(String actionName)
ValueHolder<Object>	callIfExists(String actionName, List<Object> args)
ValueHolder<Object>	callIfExists(String actionName, Map<String,?> args)
EventDefinition	event(Event event)
EventDefinition	event(String name)
EventDefinition	event(String name, EventClonePolicy policy)
ActionMeta	getActionMeta(String actionName)
List<CategoryMeta>	getCategories()
CategoryMeta	getCategory(String categoryName)
CorrelatorMeta	getCorrelatorMeta(String correlatorName)
String	getDescription()
BaseSpongeEngine	getEngine()
RecordType	getEventType(String eventTypeName)
Map<String,RecordType>	getEventTypes()
FilterMeta	getFilterMeta(String filterName)
String	getHome()
String	getInfo() Returns the engine info.
String	getLabel()
String	getLicense()
String	getName()
<T extends Plugin> T	getPlugin(Class<T> cls)
<T extends Plugin> T	getPlugin(Class<T> cls, String name)
<T extends Plugin> T	getPlugin(String name)
String	getProperty(String name)
String	getProperty(String name, String defaultValue)
protected String	getProperty(String name, String defaultValue, boolean throwException)
RuleMeta	getRuleMeta(String ruleName)
String	getStatisticsSummary() Returns the engine statistics summary.
TriggerMeta	getTriggerMeta(String triggerName)
<T extends DataType<?>> T	getType(String registeredTypeName)
<T extends DataType<?>> T	getType(String registeredTypeName, String locationName)
Map<String,DataType>	getTypes()
<T> T	getVariable(Class<T> cls, String name)
<T> T	getVariable(Class<T> cls, String name, T defaultValue)
<T> T	getVariable(String name)
<T> T	getVariable(String name, T defaultValue)
String	getVersion() Returns the engine version.
boolean	hasAction(String name)
boolean	hasCategory(String categoryName)
boolean	hasCorrelator(String name)
boolean	hasEventType(String eventTypeName)
boolean	hasFilter(String name)
<T extends Plugin> boolean	hasPlugin(Class<T> cls)
<T extends Plugin> boolean	hasPlugin(Class<T> cls, String name)
boolean	hasPlugin(String name)
boolean	hasProperty(String name)
boolean	hasRule(String name)
boolean	hasTrigger(String name)
boolean	hasType(String registeredTypeName)
boolean	hasVariable(String name)
boolean	isActionActive(String actionName, IsActionActiveContext context)
ProcessInstanceBuilder	process(ProcessConfiguration configuration)
ProcessInstanceBuilder	process(String executable, String... arguments)
Map<String,ProvidedValue<?>>	provideActionArgs(String actionName, ProvideArgsParameters parameters)
void	reload()
CategoryMeta	removeCategory(String categoryName)
boolean	removeEvent(EventSchedulerEntry entry) Removes event from Event Scheduler.
boolean	removeEventType(String eventTypeName)
boolean	removeType(String registeredTypeName)
void	removeVariable(String name)
void	requestReload()
void	requestShutdown()
void	selectCategory(String categoryName, ProcessorPredicate predicate)
void	selectCategory(String categoryName, ProcessorType processorType, ProcessorPredicate predicate)
void	setVariable(String name, Object value)
<T> void	setVariableIfNone(String name, Supplier<T> supplier)
void	shutdown()
void	updateVariable(String name)

Methods inherited from class java.lang.Object

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

Field Detail

engine

protected BaseSpongeEngine engine

Constructor Detail

BaseEngineOperations

public BaseEngineOperations(BaseSpongeEngine engine)

Method Detail

getEngine

public BaseSpongeEngine getEngine()

Specified by:

getEngine in interface EngineOperations

call

public Object call(String actionName,
                   List<Object> args)

Specified by:

call in interface EngineOperations

call

public <T> T call(Class<T> resultClass,
                  String actionName,
                  List<Object> args)

Specified by:

call in interface EngineOperations

call

public Object call(String actionName)

Specified by:

call in interface EngineOperations

call

public <T> T call(Class<T> resultClass,
                  String actionName)

Specified by:

call in interface EngineOperations

callIfExists

public ValueHolder<Object> callIfExists(String actionName,
                                        List<Object> args)

Specified by:

callIfExists in interface EngineOperations

callIfExists

public <T> ValueHolder<T> callIfExists(Class<T> resultClass,
                                       String actionName,
                                       List<Object> args)

Specified by:

callIfExists in interface EngineOperations

callIfExists

public ValueHolder<Object> callIfExists(String actionName)

Specified by:

callIfExists in interface EngineOperations

callIfExists

public <T> ValueHolder<T> callIfExists(Class<T> resultClass,
                                       String actionName)

Specified by:

callIfExists in interface EngineOperations

isActionActive

public boolean isActionActive(String actionName,
                              IsActionActiveContext context)

Specified by:

isActionActive in interface EngineOperations

provideActionArgs

public Map<String,ProvidedValue<?>> provideActionArgs(String actionName,
                                                      ProvideArgsParameters parameters)

Specified by:

provideActionArgs in interface EngineOperations

removeEvent

public boolean removeEvent(EventSchedulerEntry entry)

Removes event from Event Scheduler.

Specified by:

removeEvent in interface EngineOperations

Parameters:

entry - scheduled event entry.

Returns:

informs whether the specified event has been scheduled.

getPlugin

public <T extends Plugin> T getPlugin(String name)

Specified by:

getPlugin in interface EngineOperations

getPlugin

public <T extends Plugin> T getPlugin(Class<T> cls,
                                      String name)

Specified by:

getPlugin in interface EngineOperations

getPlugin

public <T extends Plugin> T getPlugin(Class<T> cls)

Specified by:

getPlugin in interface EngineOperations

hasPlugin

public boolean hasPlugin(String name)

Specified by:

hasPlugin in interface EngineOperations

hasPlugin

public <T extends Plugin> boolean hasPlugin(Class<T> cls,
                                            String name)

Specified by:

hasPlugin in interface EngineOperations

hasPlugin

public <T extends Plugin> boolean hasPlugin(Class<T> cls)

Specified by:

hasPlugin in interface EngineOperations

getVersion

public String getVersion()

Returns the engine version.

Specified by:

getVersion in interface EngineOperations

Returns:

the engine version.

getName

public String getName()

Specified by:

getName in interface EngineOperations

getLabel

public String getLabel()

Specified by:

getLabel in interface EngineOperations

getDescription

public String getDescription()

Specified by:

getDescription in interface EngineOperations

getLicense

public String getLicense()

Specified by:

getLicense in interface EngineOperations

getInfo

public String getInfo()

Returns the engine info.

Specified by:

getInfo in interface EngineOperations

Returns:

the engine info.

getStatisticsSummary

public String getStatisticsSummary()

Returns the engine statistics summary.

Specified by:

getStatisticsSummary in interface EngineOperations

Returns:

the engine statistics summary.

event

public EventDefinition event(String name)

Specified by:

event in interface EngineOperations

event

public EventDefinition event(String name,
                             EventClonePolicy policy)

Specified by:

event in interface EngineOperations

event

public EventDefinition event(Event event)

Specified by:

event in interface EngineOperations

shutdown

public void shutdown()

Specified by:

shutdown in interface EngineOperations

requestShutdown

public void requestShutdown()

Specified by:

requestShutdown in interface EngineOperations

reload

public void reload()

Specified by:

reload in interface EngineOperations

requestReload

public void requestReload()

Specified by:

requestReload in interface EngineOperations

hasAction

public boolean hasAction(String name)

Specified by:

hasAction in interface EngineOperations

hasFilter

public boolean hasFilter(String name)

Specified by:

hasFilter in interface EngineOperations

hasTrigger

public boolean hasTrigger(String name)

Specified by:

hasTrigger in interface EngineOperations

hasRule

public boolean hasRule(String name)

Specified by:

hasRule in interface EngineOperations

hasCorrelator

public boolean hasCorrelator(String name)

Specified by:

hasCorrelator in interface EngineOperations

setVariable

public void setVariable(String name,
                        Object value)

Specified by:

setVariable in interface EngineOperations

getVariable

public <T> T getVariable(String name)

Specified by:

getVariable in interface EngineOperations

getVariable

public <T> T getVariable(Class<T> cls,
                         String name)

Specified by:

getVariable in interface EngineOperations

getVariable

public <T> T getVariable(String name,
                         T defaultValue)

Specified by:

getVariable in interface EngineOperations

getVariable

public <T> T getVariable(Class<T> cls,
                         String name,
                         T defaultValue)

Specified by:

getVariable in interface EngineOperations

hasVariable

public boolean hasVariable(String name)

Specified by:

hasVariable in interface EngineOperations

removeVariable

public void removeVariable(String name)

Specified by:

removeVariable in interface EngineOperations

setVariableIfNone

public <T> void setVariableIfNone(String name,
                                  Supplier<T> supplier)

Specified by:

setVariableIfNone in interface EngineOperations

updateVariable

public void updateVariable(String name)

Specified by:

updateVariable in interface EngineOperations

getProperty

protected String getProperty(String name,
                             String defaultValue,
                             boolean throwException)

getProperty

public String getProperty(String name)

Specified by:

getProperty in interface EngineOperations

getProperty

public String getProperty(String name,
                          String defaultValue)

Specified by:

getProperty in interface EngineOperations

hasProperty

public boolean hasProperty(String name)

Specified by:

hasProperty in interface EngineOperations

getHome

public String getHome()

Specified by:

getHome in interface EngineOperations

process

public ProcessInstanceBuilder process(ProcessConfiguration configuration)

Specified by:

process in interface EngineOperations

process

public ProcessInstanceBuilder process(String executable,
                                      String... arguments)

Specified by:

process in interface EngineOperations

addCategory

public void addCategory(CategoryMeta categoryMeta)

Specified by:

addCategory in interface EngineOperations

addCategories

public void addCategories(CategoryMeta... categoryMeta)

Specified by:

addCategories in interface EngineOperations

getCategory

public CategoryMeta getCategory(String categoryName)

Specified by:

getCategory in interface EngineOperations

hasCategory

public boolean hasCategory(String categoryName)

Specified by:

hasCategory in interface EngineOperations

removeCategory

public CategoryMeta removeCategory(String categoryName)

Specified by:

removeCategory in interface EngineOperations

getCategories

public List<CategoryMeta> getCategories()

Specified by:

getCategories in interface EngineOperations

selectCategory

public void selectCategory(String categoryName,
                           ProcessorType processorType,
                           ProcessorPredicate predicate)

Specified by:

selectCategory in interface EngineOperations

selectCategory

public void selectCategory(String categoryName,
                           ProcessorPredicate predicate)

Specified by:

selectCategory in interface EngineOperations

getActionMeta

public ActionMeta getActionMeta(String actionName)

Specified by:

getActionMeta in interface EngineOperations

getFilterMeta

public FilterMeta getFilterMeta(String filterName)

Specified by:

getFilterMeta in interface EngineOperations

getTriggerMeta

public TriggerMeta getTriggerMeta(String triggerName)

Specified by:

getTriggerMeta in interface EngineOperations

getCorrelatorMeta

public CorrelatorMeta getCorrelatorMeta(String correlatorName)

Specified by:

getCorrelatorMeta in interface EngineOperations

getRuleMeta

public RuleMeta getRuleMeta(String ruleName)

Specified by:

getRuleMeta in interface EngineOperations

addType

public <T extends DataType<?>> void addType(String registeredTypeName,
                                            DataTypeSupplier<T> typeSupplier)

Specified by:

addType in interface EngineOperations

getType

public <T extends DataType<?>> T getType(String registeredTypeName)

Specified by:

getType in interface EngineOperations

getType

public <T extends DataType<?>> T getType(String registeredTypeName,
                                         String locationName)

Specified by:

getType in interface EngineOperations

getTypes

public Map<String,DataType> getTypes()

Specified by:

getTypes in interface EngineOperations

hasType

public boolean hasType(String registeredTypeName)

Specified by:

hasType in interface EngineOperations

removeType

public boolean removeType(String registeredTypeName)

Specified by:

removeType in interface EngineOperations

addEventType

public void addEventType(String eventTypeName,
                         RecordType dataType)

Specified by:

addEventType in interface EngineOperations

getEventType

public RecordType getEventType(String eventTypeName)

Specified by:

getEventType in interface EngineOperations

hasEventType

public boolean hasEventType(String eventTypeName)

Specified by:

hasEventType in interface EngineOperations

getEventTypes

public Map<String,RecordType> getEventTypes()

Specified by:

getEventTypes in interface EngineOperations

removeEventType

public boolean removeEventType(String eventTypeName)

Specified by:

removeEventType in interface EngineOperations

call

public Object call(String actionName,
                   Map<String,?> args)

Specified by:

call in interface EngineOperations

call

public <T> T call(Class<T> resultClass,
                  String actionName,
                  Map<String,?> args)

Specified by:

call in interface EngineOperations

callIfExists

public ValueHolder<Object> callIfExists(String actionName,
                                        Map<String,?> args)

Specified by:

callIfExists in interface EngineOperations

callIfExists

public <T> ValueHolder<T> callIfExists(Class<T> resultClass,
                                       String actionName,
                                       Map<String,?> args)

Specified by:

callIfExists in interface EngineOperations