org.openksavi.sponge.core

Class BaseEngineOperations

java.lang.Object

org.openksavi.sponge.core.BaseEngineOperations

All Implemented Interfaces:

org.openksavi.sponge.EngineOperations

Direct Known Subclasses:

BaseKnowledgeBaseEngineOperations

public class BaseEngineOperations
extends Object
implements org.openksavi.sponge.EngineOperations

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseEngine	engine

Constructor Summary

Constructors

Constructor and Description
BaseEngineOperations(BaseEngine engine)

Method Summary

Modifier and Type	Method and Description
Object	call(String actionName, Object... args) Calls registered action with arguments.
org.openksavi.sponge.event.EventDefinition	event(org.openksavi.sponge.event.Event event)
org.openksavi.sponge.event.EventDefinition	event(String name)
org.openksavi.sponge.event.EventDefinition	event(String name, org.openksavi.sponge.event.EventClonePolicy policy)
boolean	existsAction(String name)
boolean	existsCorrelator(String name)
boolean	existsFilter(String name)
boolean	existsRule(String name)
boolean	existsTrigger(String name)
boolean	existsVariable(String name)
String	getDescription() Returns the engine description.
BaseEngine	getEngine()
<T extends org.openksavi.sponge.plugin.Plugin> T	getPlugin(Class<T> cls)
org.openksavi.sponge.plugin.Plugin	getPlugin(String name) Returns the plugin that has the specified name or null if there is no such plugin.
<T extends org.openksavi.sponge.plugin.Plugin> T	getPlugin(String name, Class<T> cls)
String	getStatisticsSummary() Returns the engine statistics summary.
<T> T	getVariable(Class<T> cls, String name)
<T> T	getVariable(Class<T> cls, String name, T defaultValue)
Object	getVariable(String name)
<T> T	getVariable(String name, T defaultValue)
String	getVersion() Returns the engine version.
org.openksavi.sponge.event.Event	makeEvent(String name) Creates a new named event with default clone policy.
org.openksavi.sponge.event.Event	makeEvent(String name, org.openksavi.sponge.event.EventClonePolicy policy) Creates a new named event with specified clone policy.
void	reload()
boolean	removeEvent(org.openksavi.sponge.event.EventSchedulerEntry entry) Removes event from Event Scheduler.
void	removeVariable(String name)
void	requestReload()
void	requestShutdown()
org.openksavi.sponge.event.Event	send(org.openksavi.sponge.event.Event event)
org.openksavi.sponge.event.Event	send(String eventName)
org.openksavi.sponge.event.EventSchedulerEntry	sendAfter(org.openksavi.sponge.event.Event event, long delay)
org.openksavi.sponge.event.EventSchedulerEntry	sendAfter(org.openksavi.sponge.event.Event event, long delay, long interval)
org.openksavi.sponge.event.EventSchedulerEntry	sendAfter(String name, long delay)
org.openksavi.sponge.event.EventSchedulerEntry	sendAfter(String name, long delay, long interval)
org.openksavi.sponge.event.EventSchedulerEntry	sendAt(org.openksavi.sponge.event.Event event, long milliseconds)
org.openksavi.sponge.event.EventSchedulerEntry	sendAt(org.openksavi.sponge.event.Event event, long milliseconds, long interval)
org.openksavi.sponge.event.EventSchedulerEntry	sendAt(org.openksavi.sponge.event.Event event, String crontabSpec)
org.openksavi.sponge.event.EventSchedulerEntry	sendAt(String name, long milliseconds)
org.openksavi.sponge.event.EventSchedulerEntry	sendAt(String name, long milliseconds, long interval)
org.openksavi.sponge.event.EventSchedulerEntry	sendAt(String name, String crontabSpec)
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 BaseEngine engine

Constructor Detail

BaseEngineOperations

public BaseEngineOperations(BaseEngine engine)

Method Detail

getEngine

public BaseEngine getEngine()

Specified by:

getEngine in interface org.openksavi.sponge.EngineOperations

call

public Object call(String actionName,
                   Object... args)

Calls registered action with arguments.

Specified by:

call in interface org.openksavi.sponge.EngineOperations

Parameters:

actionName - name of the action.

args - arguments to pass to action.

send

public org.openksavi.sponge.event.Event send(org.openksavi.sponge.event.Event event)

Specified by:

send in interface org.openksavi.sponge.EngineOperations

send

public org.openksavi.sponge.event.Event send(String eventName)

Specified by:

send in interface org.openksavi.sponge.EngineOperations

sendAfter

public org.openksavi.sponge.event.EventSchedulerEntry sendAfter(String name,
                                                                long delay)

Specified by:

sendAfter in interface org.openksavi.sponge.EngineOperations

sendAfter

public org.openksavi.sponge.event.EventSchedulerEntry sendAfter(String name,
                                                                long delay,
                                                                long interval)

Specified by:

sendAfter in interface org.openksavi.sponge.EngineOperations

sendAfter

public org.openksavi.sponge.event.EventSchedulerEntry sendAfter(org.openksavi.sponge.event.Event event,
                                                                long delay)

Specified by:

sendAfter in interface org.openksavi.sponge.EngineOperations

sendAfter

public org.openksavi.sponge.event.EventSchedulerEntry sendAfter(org.openksavi.sponge.event.Event event,
                                                                long delay,
                                                                long interval)

Specified by:

sendAfter in interface org.openksavi.sponge.EngineOperations

sendAt

public org.openksavi.sponge.event.EventSchedulerEntry sendAt(String name,
                                                             long milliseconds)

Specified by:

sendAt in interface org.openksavi.sponge.EngineOperations

sendAt

public org.openksavi.sponge.event.EventSchedulerEntry sendAt(String name,
                                                             long milliseconds,
                                                             long interval)

Specified by:

sendAt in interface org.openksavi.sponge.EngineOperations

sendAt

public org.openksavi.sponge.event.EventSchedulerEntry sendAt(org.openksavi.sponge.event.Event event,
                                                             long milliseconds)

Specified by:

sendAt in interface org.openksavi.sponge.EngineOperations

sendAt

public org.openksavi.sponge.event.EventSchedulerEntry sendAt(org.openksavi.sponge.event.Event event,
                                                             long milliseconds,
                                                             long interval)

Specified by:

sendAt in interface org.openksavi.sponge.EngineOperations

sendAt

public org.openksavi.sponge.event.EventSchedulerEntry sendAt(org.openksavi.sponge.event.Event event,
                                                             String crontabSpec)

Specified by:

sendAt in interface org.openksavi.sponge.EngineOperations

sendAt

public org.openksavi.sponge.event.EventSchedulerEntry sendAt(String name,
                                                             String crontabSpec)

Specified by:

sendAt in interface org.openksavi.sponge.EngineOperations

removeEvent

public boolean removeEvent(org.openksavi.sponge.event.EventSchedulerEntry entry)

Removes event from Event Scheduler.

Specified by:

removeEvent in interface org.openksavi.sponge.EngineOperations

Parameters:

entry - scheduled event entry.

Returns:

informs whether the specified event has been scheduled.

getPlugin

public org.openksavi.sponge.plugin.Plugin getPlugin(String name)

Returns the plugin that has the specified name or null if there is no such plugin.

Specified by:

getPlugin in interface org.openksavi.sponge.EngineOperations

Parameters:

name - plugin name.

Returns:

plugin.

getPlugin

public <T extends org.openksavi.sponge.plugin.Plugin> T getPlugin(String name,
                                                                  Class<T> cls)

Specified by:

getPlugin in interface org.openksavi.sponge.EngineOperations

getPlugin

public <T extends org.openksavi.sponge.plugin.Plugin> T getPlugin(Class<T> cls)

Specified by:

getPlugin in interface org.openksavi.sponge.EngineOperations

getVersion

public String getVersion()

Returns the engine version.

Specified by:

getVersion in interface org.openksavi.sponge.EngineOperations

Returns:

the engine version.

getDescription

public String getDescription()

Returns the engine description.

Specified by:

getDescription in interface org.openksavi.sponge.EngineOperations

Returns:

the engine description.

getStatisticsSummary

public String getStatisticsSummary()

Returns the engine statistics summary.

Specified by:

getStatisticsSummary in interface org.openksavi.sponge.EngineOperations

Returns:

the engine statistics summary.

makeEvent

public org.openksavi.sponge.event.Event makeEvent(String name)

Creates a new named event with default clone policy.

Specified by:

makeEvent in interface org.openksavi.sponge.EngineOperations

Parameters:

name - event name.

Returns:

a new event.

makeEvent

public org.openksavi.sponge.event.Event makeEvent(String name,
                                                  org.openksavi.sponge.event.EventClonePolicy policy)

Creates a new named event with specified clone policy.

Specified by:

makeEvent in interface org.openksavi.sponge.EngineOperations

Parameters:

name - event name.

policy - event clone policy.

Returns:

a new event.

event

public org.openksavi.sponge.event.EventDefinition event(String name)

Specified by:

event in interface org.openksavi.sponge.EngineOperations

event

public org.openksavi.sponge.event.EventDefinition event(String name,
                                                        org.openksavi.sponge.event.EventClonePolicy policy)

Specified by:

event in interface org.openksavi.sponge.EngineOperations

event

public org.openksavi.sponge.event.EventDefinition event(org.openksavi.sponge.event.Event event)

Specified by:

event in interface org.openksavi.sponge.EngineOperations

shutdown

public void shutdown()

Specified by:

shutdown in interface org.openksavi.sponge.EngineOperations

requestShutdown

public void requestShutdown()

Specified by:

requestShutdown in interface org.openksavi.sponge.EngineOperations

reload

public void reload()

Specified by:

reload in interface org.openksavi.sponge.EngineOperations

requestReload

public void requestReload()

Specified by:

requestReload in interface org.openksavi.sponge.EngineOperations

existsAction

public boolean existsAction(String name)

Specified by:

existsAction in interface org.openksavi.sponge.EngineOperations

existsFilter

public boolean existsFilter(String name)

Specified by:

existsFilter in interface org.openksavi.sponge.EngineOperations

existsTrigger

public boolean existsTrigger(String name)

Specified by:

existsTrigger in interface org.openksavi.sponge.EngineOperations

existsRule

public boolean existsRule(String name)

Specified by:

existsRule in interface org.openksavi.sponge.EngineOperations

existsCorrelator

public boolean existsCorrelator(String name)

Specified by:

existsCorrelator in interface org.openksavi.sponge.EngineOperations

setVariable

public void setVariable(String name,
                        Object value)

Specified by:

setVariable in interface org.openksavi.sponge.EngineOperations

getVariable

public Object getVariable(String name)

Specified by:

getVariable in interface org.openksavi.sponge.EngineOperations

getVariable

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

Specified by:

getVariable in interface org.openksavi.sponge.EngineOperations

getVariable

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

Specified by:

getVariable in interface org.openksavi.sponge.EngineOperations

getVariable

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

Specified by:

getVariable in interface org.openksavi.sponge.EngineOperations

existsVariable

public boolean existsVariable(String name)

Specified by:

existsVariable in interface org.openksavi.sponge.EngineOperations

removeVariable

public void removeVariable(String name)

Specified by:

removeVariable in interface org.openksavi.sponge.EngineOperations

setVariableIfNone

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

Specified by:

setVariableIfNone in interface org.openksavi.sponge.EngineOperations

updateVariable

public void updateVariable(String name)

Specified by:

updateVariable in interface org.openksavi.sponge.EngineOperations