Package org.drools.ruleunit.executor

Class RuleUnitExecutorSession

java.lang.Object

org.drools.ruleunit.executor.RuleUnitExecutorSession

All Implemented Interfaces:

InternalRuleUnitExecutor, RuleUnitExecutor

public class RuleUnitExecutorSession
extends Object
implements InternalRuleUnitExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RuleUnitExecutorSession.RuleUnitGlobals

Constructor Summary

Constructors

Constructor	Description
RuleUnitExecutorSession()
RuleUnitExecutorSession(long id, boolean initInitFactHandle, org.drools.core.SessionConfiguration config, org.kie.api.runtime.Environment environment)
RuleUnitExecutorSession(long id, org.drools.core.spi.FactHandleFactory handleFactory, long propagationContext, org.drools.core.SessionConfiguration config, org.drools.core.common.InternalAgenda agenda, org.kie.api.runtime.Environment environment)
RuleUnitExecutorSession(org.kie.api.KieBase kiebase)
RuleUnitExecutorSession(org.kie.api.runtime.KieSession session)

Method Summary

Modifier and Type	Method	Description
org.kie.api.logger.KieRuntimeLogger	addConsoleLogger()
org.kie.api.logger.KieRuntimeLogger	addFileLogger(String fileName)
org.kie.api.logger.KieRuntimeLogger	addFileLogger(String fileName, int maxEventsInMemory)
org.kie.api.logger.KieRuntimeLogger	addThreadedFileLogger(String fileName, int interval)
RuleUnitExecutor	bind(org.kie.api.KieBase kiebase)	Bind this executor to a KieBase in order to execute the units defined in it.
void	bindDataSource(InternalDataSource dataSource)
RuleUnitExecutor	bindVariable(String name, Object value)	Binds a variable to this executor with a given name.
void	cancelActivation(org.drools.core.spi.Activation activation)
void	dispose()	Releases all the current executor resources, setting up the session for garbage collection.
RuleUnit	getCurrentRuleUnit()
org.kie.api.runtime.KieSession	getKieSession()	Returns the KieSession internally used by this executor.
RuleUnitFactory	getRuleUnitFactory()
Collection<?>	getSessionObjects()
Collection<?>	getSessionObjects(org.kie.api.runtime.ObjectFilter filter)
void	guardRuleUnit(Class<? extends RuleUnit> ruleUnitClass, org.drools.core.spi.Activation activation)
void	guardRuleUnit(RuleUnit ruleUnit, org.drools.core.spi.Activation activation)
void	halt()	Requests the executor to stop running units.
int	internalExecuteUnit(RuleUnit ruleUnit)
<T> DataSource<T>	newDataSource(String name, T... items)	Creates a DataSource, optionally containing some items, and bind it this executor with the given name.
void	onResume()
void	onSuspend()
int	run(Class<? extends RuleUnit> ruleUnitClass)	Runs a RuleUnit of the given class.
int	run(RuleUnit ruleUnit)	Runs a RuleUnit of the given class.
void	runUntilHalt(Class<? extends RuleUnit> ruleUnitClass)	Runs until halt a RuleUnit of the given class.
void	runUntilHalt(RuleUnit ruleUnit)	Runs until halt a RuleUnit of the given class.
void	switchToRuleUnit(Class<? extends RuleUnit> ruleUnitClass, org.drools.core.spi.Activation activation)
void	switchToRuleUnit(RuleUnit ruleUnit, org.drools.core.spi.Activation activation)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleUnitExecutorSession

public RuleUnitExecutorSession()

RuleUnitExecutorSession

public RuleUnitExecutorSession(org.kie.api.KieBase kiebase)

RuleUnitExecutorSession

public RuleUnitExecutorSession(org.kie.api.runtime.KieSession session)

RuleUnitExecutorSession

public RuleUnitExecutorSession(long id,
                               boolean initInitFactHandle,
                               org.drools.core.SessionConfiguration config,
                               org.kie.api.runtime.Environment environment)

RuleUnitExecutorSession

public RuleUnitExecutorSession(long id,
                               org.drools.core.spi.FactHandleFactory handleFactory,
                               long propagationContext,
                               org.drools.core.SessionConfiguration config,
                               org.drools.core.common.InternalAgenda agenda,
                               org.kie.api.runtime.Environment environment)

Method Detail

bind

public RuleUnitExecutor bind(org.kie.api.KieBase kiebase)

Description copied from interface: RuleUnitExecutor

Bind this executor to a KieBase in order to execute the units defined in it.

Specified by:

bind in interface RuleUnitExecutor

getKieSession

public org.kie.api.runtime.KieSession getKieSession()

Description copied from interface: RuleUnitExecutor

Returns the KieSession internally used by this executor.

Specified by:

getKieSession in interface RuleUnitExecutor

newDataSource

public <T> DataSource<T> newDataSource(String name,
                                       T... items)

Description copied from interface: RuleUnitExecutor

Creates a DataSource, optionally containing some items, and bind it this executor with the given name.

Specified by:

newDataSource in interface RuleUnitExecutor

Parameters:

name - the name with which the newly created DataSource will be bound to this executor.

items - the items contained in the DataSource.

getSessionObjects

public Collection<?> getSessionObjects()

Specified by:

getSessionObjects in interface InternalRuleUnitExecutor

getSessionObjects

public Collection<?> getSessionObjects(org.kie.api.runtime.ObjectFilter filter)

Specified by:

getSessionObjects in interface InternalRuleUnitExecutor

addConsoleLogger

public org.kie.api.logger.KieRuntimeLogger addConsoleLogger()

Specified by:

addConsoleLogger in interface InternalRuleUnitExecutor

addFileLogger

public org.kie.api.logger.KieRuntimeLogger addFileLogger(String fileName)

Specified by:

addFileLogger in interface InternalRuleUnitExecutor

addFileLogger

public org.kie.api.logger.KieRuntimeLogger addFileLogger(String fileName,
                                                         int maxEventsInMemory)

Specified by:

addFileLogger in interface InternalRuleUnitExecutor

addThreadedFileLogger

public org.kie.api.logger.KieRuntimeLogger addThreadedFileLogger(String fileName,
                                                                 int interval)

Specified by:

addThreadedFileLogger in interface InternalRuleUnitExecutor

run

public int run(Class<? extends RuleUnit> ruleUnitClass)

Description copied from interface: RuleUnitExecutor

Runs a RuleUnit of the given class.

Specified by:

run in interface RuleUnitExecutor

run

public int run(RuleUnit ruleUnit)

Description copied from interface: RuleUnitExecutor

Runs a RuleUnit of the given class.

Specified by:

run in interface RuleUnitExecutor

internalExecuteUnit

public int internalExecuteUnit(RuleUnit ruleUnit)

runUntilHalt

public void runUntilHalt(Class<? extends RuleUnit> ruleUnitClass)

Description copied from interface: RuleUnitExecutor

Runs until halt a RuleUnit of the given class.

Specified by:

runUntilHalt in interface RuleUnitExecutor

runUntilHalt

public void runUntilHalt(RuleUnit ruleUnit)

Description copied from interface: RuleUnitExecutor

Runs until halt a RuleUnit of the given class.

Specified by:

runUntilHalt in interface RuleUnitExecutor

halt

public void halt()

Description copied from interface: RuleUnitExecutor

Requests the executor to stop running units.

Specified by:

halt in interface RuleUnitExecutor

switchToRuleUnit

public void switchToRuleUnit(Class<? extends RuleUnit> ruleUnitClass,
                             org.drools.core.spi.Activation activation)

Specified by:

switchToRuleUnit in interface InternalRuleUnitExecutor

switchToRuleUnit

public void switchToRuleUnit(RuleUnit ruleUnit,
                             org.drools.core.spi.Activation activation)

Specified by:

switchToRuleUnit in interface InternalRuleUnitExecutor

guardRuleUnit

public void guardRuleUnit(Class<? extends RuleUnit> ruleUnitClass,
                          org.drools.core.spi.Activation activation)

Specified by:

guardRuleUnit in interface InternalRuleUnitExecutor

guardRuleUnit

public void guardRuleUnit(RuleUnit ruleUnit,
                          org.drools.core.spi.Activation activation)

Specified by:

guardRuleUnit in interface InternalRuleUnitExecutor

cancelActivation

public void cancelActivation(org.drools.core.spi.Activation activation)

Specified by:

cancelActivation in interface InternalRuleUnitExecutor

getCurrentRuleUnit

public RuleUnit getCurrentRuleUnit()

Specified by:

getCurrentRuleUnit in interface InternalRuleUnitExecutor

getRuleUnitFactory

public RuleUnitFactory getRuleUnitFactory()

bindVariable

public RuleUnitExecutor bindVariable(String name,
                                     Object value)

Description copied from interface: RuleUnitExecutor

Binds a variable to this executor with a given name. This named variable will be then injected into RuleUnits executed on this executor using a naming convention.

Specified by:

bindVariable in interface RuleUnitExecutor

Parameters:

name - the name with which the value will be bound to this executor.

value - the value to bind.

bindDataSource

public void bindDataSource(InternalDataSource dataSource)

Specified by:

bindDataSource in interface InternalRuleUnitExecutor

onSuspend

public void onSuspend()

Specified by:

onSuspend in interface InternalRuleUnitExecutor

onResume

public void onResume()

Specified by:

onResume in interface InternalRuleUnitExecutor

dispose

public void dispose()

Description copied from interface: RuleUnitExecutor

Releases all the current executor resources, setting up the session for garbage collection. This method must always be called after finishing using the executor, or the engine will not free the memory used by the executor.

Specified by:

dispose in interface RuleUnitExecutor