org.drools.core
Class RuleBaseConfiguration

java.lang.Object
  org.drools.core.RuleBaseConfiguration

All Implemented Interfaces:

Externalizable, Serializable, org.kie.api.conf.KieBaseOptionsConfiguration, org.kie.api.KieBaseConfiguration, org.kie.api.PropertiesConfiguration

public class RuleBaseConfiguration
extends Object
implements org.kie.api.KieBaseConfiguration, Externalizable

Available configuration options:

 drools.maintainTms = <true|false>
 drools.sequential = <true|false>
 drools.sequential.agenda = <sequential|dynamic>
 drools.removeIdentities = <true|false>
 drools.shareAlphaNodes  = <true|false>
 drools.shareBetaNodes = <true|false>
 drools.alphaNodeHashingThreshold = <1...n>
 drools.compositeKeyDepth  =<1..3>
 drools.indexLeftBetaMemory = <true/false>
 drools.indexRightBetaMemory = <true/false>
 drools.equalityBehavior = <identity|equality>
 drools.executorService = <qualified class name>
 drools.conflictResolver = <qualified class name>
 drools.consequenceExceptionHandler = <qualified class name>
 drools.ruleBaseUpdateHandler = <qualified class name>
 drools.sessionClock = <qualified class name>
 drools.mbeans = <enabled|disabled>
 drools.classLoaderCacheEnabled = <true|false>
 drools.phreakEnabled = <true|false>
 drools.declarativeAgendaEnabled =  <true|false> 
 

See Also:

Serialized Form

Nested Class Summary

static class	RuleBaseConfiguration.AssertBehaviour
static class	RuleBaseConfiguration.LogicalOverride
static class	RuleBaseConfiguration.SequentialAgenda

Field Summary

static boolean	DEFAULT_PHREAK
static String	DEFAULT_SIGN_ON_SERIALIZATION
protected static org.slf4j.Logger	logger

Constructor Summary

RuleBaseConfiguration()
Creates a new rulebase with a default parent class loader set according to the following algorithm: If a Thread.currentThread().getContextClassLoader() returns a non-null class loader, it will be used as the parent class loader for this rulebase class loaders, otherwise, the RuleBaseConfiguration.class.getClassLoader() class loader will be used.

RuleBaseConfiguration(ClassLoader... classLoaders)
A constructor that sets the parent classloader to be used while dealing with this rule base

RuleBaseConfiguration(Properties properties)
Creates a new rulebase configuration using the provided properties as configuration options.

RuleBaseConfiguration(Properties properties, ClassLoader... classLoaders)
A constructor that sets the classloader to be used as the parent classloader of this rule base classloaders, and the properties to be used as base configuration options

RuleBaseConfiguration(Properties properties, org.kie.internal.utils.CompositeClassLoader classLoader)

Method Summary

void	addActivationListener(String name, ActivationListenerFactory factory)
ActivationListenerFactory	getActivationListenerFactory(String name)
AgendaGroupFactory	getAgendaGroupFactory()
int	getAlphaNodeHashingThreshold()
RuleBaseConfiguration.AssertBehaviour	getAssertBehaviour()
ClassLoader	getClassLoader()
ReteooComponentFactory	getComponentFactory()
int	getCompositeKeyDepth()
ConflictResolver	getConflictResolver()
String	getConsequenceExceptionHandler()
static RuleBaseConfiguration	getDefaultInstance()
org.kie.api.conf.EventProcessingOption	getEventProcessingMode()
String	getExecutorService()
org.kie.internal.conf.IndexPrecedenceOption	getIndexPrecedenceOption()
int	getMaxThreads() Returns the configured number of maximum threads to use for concurrent propagation when multi-thread evaluation is enabled.
<T extends org.kie.api.conf.SingleValueKieBaseOption> T	getOption(Class<T> option)
<T extends org.kie.api.conf.MultiValueKieBaseOption> T	getOption(Class<T> option, String key)
int	getPermGenThreshold()
String	getProperty(String name)
String	getRuleBaseUpdateHandler()
RuleBaseConfiguration.SequentialAgenda	getSequentialAgenda()
List<Map<String,Object>>	getWorkDefinitions()
boolean	isAdvancedProcessRuleIntegration()
boolean	isClassLoaderCacheEnabled()
boolean	isDeclarativeAgenda()
boolean	isImmutable() Returns true if this configuration object is immutable or false otherwise.
boolean	isIndexLeftBetaMemory()
boolean	isIndexRightBetaMemory()
boolean	isMaintainTms()
boolean	isMBeansEnabled() Returns true if the management and monitoring through MBeans is active
boolean	isMultithreadEvaluation() Returns true if the partitioning of the rulebase is enabled and false otherwise.
boolean	isPhreakEnabled()
boolean	isRemoveIdentities()
boolean	isSequential()
boolean	isShareAlphaNodes()
boolean	isShareBetaNodes()
void	makeImmutable() Makes the configuration object immutable.
void	readExternal(ObjectInput in)
void	setAdvancedProcessRuleIntegration(boolean advancedProcessRuleIntegration)
void	setAlphaNodeHashingThreshold(int alphaNodeHashingThreshold)
void	setAssertBehaviour(RuleBaseConfiguration.AssertBehaviour assertBehaviour)
void	setClassLoader(ClassLoader... classLoaders)
void	setClassLoaderCacheEnabled(boolean classLoaderCacheEnabled)
void	setComponentFactory(ReteooComponentFactory componentFactory)
void	setCompositeKeyDepth(int compositeKeyDepth)
void	setConflictResolver(ConflictResolver conflictResolver)
void	setConsequenceExceptionHandler(String consequenceExceptionHandler)
void	setDeclarativeAgendaEnabled(boolean enabled) Enable declarative agenda
void	setEventProcessingMode(org.kie.api.conf.EventProcessingOption mode)
void	setExecutorService(String executorService)
void	setIndexLeftBetaMemory(boolean indexLeftBetaMemory)
void	setIndexPrecedenceOption(org.kie.internal.conf.IndexPrecedenceOption precedence)
void	setIndexRightBetaMemory(boolean indexRightBetaMemory)
void	setMaintainTms(boolean maintainTms)
void	setMaxThreads(int maxThreads) If multi-thread evaluation is enabled, this parameter configures the maximum number of threads each session can use for concurrent Rete propagation.
void	setMBeansEnabled(boolean mbeansEnabled) Defines if the RuleBase should expose management and monitoring MBeans
void	setMultithreadEvaluation(boolean enableMultithread) Defines if the RuleBase should be executed using a pool of threads for evaluating the rules ("true"), or if the rulebase should work in classic single thread mode ("false").
<T extends org.kie.api.conf.KieBaseOption> void	setOption(T option)
void	setPermGenThreshold(int permGenThreshold)
void	setPhreakEnabled(boolean enabled) Enable Unlinking.
void	setProperty(String name, String value)
void	setRemoveIdentities(boolean removeIdentities)
void	setRuleBaseUpdateHandler(String ruleBaseUpdateHandler)
void	setSequential(boolean sequential)
void	setSequentialAgenda(RuleBaseConfiguration.SequentialAgenda sequentialAgenda)
void	setShareAlphaNodes(boolean shareAlphaNodes)
void	setShareBetaNodes(boolean shareBetaNodes)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PHREAK

public static final boolean DEFAULT_PHREAK

See Also:

Constant Field Values

DEFAULT_SIGN_ON_SERIALIZATION

public static final String DEFAULT_SIGN_ON_SERIALIZATION

See Also:

Constant Field Values

logger

protected static transient org.slf4j.Logger logger

Constructor Detail

RuleBaseConfiguration

public RuleBaseConfiguration(Properties properties)

Creates a new rulebase configuration using the provided properties as configuration options. Also, if a Thread.currentThread().getContextClassLoader() returns a non-null class loader, it will be used as the parent classloader for this rulebase class loaders, otherwise, the RuleBaseConfiguration.class.getClassLoader() class loader will be used.

Parameters:

properties -

RuleBaseConfiguration

public RuleBaseConfiguration()

Creates a new rulebase with a default parent class loader set according to the following algorithm: If a Thread.currentThread().getContextClassLoader() returns a non-null class loader, it will be used as the parent class loader for this rulebase class loaders, otherwise, the RuleBaseConfiguration.class.getClassLoader() class loader will be used.

RuleBaseConfiguration

public RuleBaseConfiguration(ClassLoader... classLoaders)

A constructor that sets the parent classloader to be used while dealing with this rule base

Parameters:

classLoaders -

RuleBaseConfiguration

public RuleBaseConfiguration(Properties properties,
                             ClassLoader... classLoaders)

A constructor that sets the classloader to be used as the parent classloader of this rule base classloaders, and the properties to be used as base configuration options

Parameters:

classLoaders -

properties -

RuleBaseConfiguration

public RuleBaseConfiguration(Properties properties,
                             org.kie.internal.utils.CompositeClassLoader classLoader)

Method Detail

getDefaultInstance

public static RuleBaseConfiguration getDefaultInstance()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

setProperty

public void setProperty(String name,
                        String value)

Specified by:

setProperty in interface org.kie.api.PropertiesConfiguration

getProperty

public String getProperty(String name)

Specified by:

getProperty in interface org.kie.api.PropertiesConfiguration

makeImmutable

public void makeImmutable()

Makes the configuration object immutable. Once it becomes immutable, there is no way to make it mutable again. This is done to keep consistency.

isImmutable

public boolean isImmutable()

Returns true if this configuration object is immutable or false otherwise.

Returns:

setSequential

public void setSequential(boolean sequential)

isSequential

public boolean isSequential()

isMaintainTms

public boolean isMaintainTms()

setMaintainTms

public void setMaintainTms(boolean maintainTms)

isRemoveIdentities

public boolean isRemoveIdentities()

setRemoveIdentities

public void setRemoveIdentities(boolean removeIdentities)

isShareAlphaNodes

public boolean isShareAlphaNodes()

setShareAlphaNodes

public void setShareAlphaNodes(boolean shareAlphaNodes)

isShareBetaNodes

public boolean isShareBetaNodes()

setShareBetaNodes

public void setShareBetaNodes(boolean shareBetaNodes)

getPermGenThreshold

public int getPermGenThreshold()

setPermGenThreshold

public void setPermGenThreshold(int permGenThreshold)

getAlphaNodeHashingThreshold

public int getAlphaNodeHashingThreshold()

setAlphaNodeHashingThreshold

public void setAlphaNodeHashingThreshold(int alphaNodeHashingThreshold)

getAssertBehaviour

public RuleBaseConfiguration.AssertBehaviour getAssertBehaviour()

setAssertBehaviour

public void setAssertBehaviour(RuleBaseConfiguration.AssertBehaviour assertBehaviour)

getEventProcessingMode

public org.kie.api.conf.EventProcessingOption getEventProcessingMode()

setEventProcessingMode

public void setEventProcessingMode(org.kie.api.conf.EventProcessingOption mode)

getCompositeKeyDepth

public int getCompositeKeyDepth()

setCompositeKeyDepth

public void setCompositeKeyDepth(int compositeKeyDepth)

isIndexLeftBetaMemory

public boolean isIndexLeftBetaMemory()

setIndexLeftBetaMemory

public void setIndexLeftBetaMemory(boolean indexLeftBetaMemory)

isIndexRightBetaMemory

public boolean isIndexRightBetaMemory()

setIndexRightBetaMemory

public void setIndexRightBetaMemory(boolean indexRightBetaMemory)

getIndexPrecedenceOption

public org.kie.internal.conf.IndexPrecedenceOption getIndexPrecedenceOption()

setIndexPrecedenceOption

public void setIndexPrecedenceOption(org.kie.internal.conf.IndexPrecedenceOption precedence)

getExecutorService

public String getExecutorService()

setExecutorService

public void setExecutorService(String executorService)

getConsequenceExceptionHandler

public String getConsequenceExceptionHandler()

setConsequenceExceptionHandler

public void setConsequenceExceptionHandler(String consequenceExceptionHandler)

getRuleBaseUpdateHandler

public String getRuleBaseUpdateHandler()

setRuleBaseUpdateHandler

public void setRuleBaseUpdateHandler(String ruleBaseUpdateHandler)

getAgendaGroupFactory

public AgendaGroupFactory getAgendaGroupFactory()

getSequentialAgenda

public RuleBaseConfiguration.SequentialAgenda getSequentialAgenda()

setSequentialAgenda

public void setSequentialAgenda(RuleBaseConfiguration.SequentialAgenda sequentialAgenda)

setMultithreadEvaluation

public void setMultithreadEvaluation(boolean enableMultithread)

Defines if the RuleBase should be executed using a pool of threads for evaluating the rules ("true"), or if the rulebase should work in classic single thread mode ("false").

Parameters:

enableMultithread - true for multi-thread or false for single-thread. Default is false.

isMultithreadEvaluation

public boolean isMultithreadEvaluation()

Returns true if the partitioning of the rulebase is enabled and false otherwise. Default is false.

Returns:

setMaxThreads

public void setMaxThreads(int maxThreads)

If multi-thread evaluation is enabled, this parameter configures the maximum number of threads each session can use for concurrent Rete propagation.

Parameters:

maxThreads - the maximum number of threads to use. If 0 or a negative number is set, the engine will use number of threads equal to the number of partitions in the rule base. Default number of threads is 0.

getMaxThreads

public int getMaxThreads()

Returns the configured number of maximum threads to use for concurrent propagation when multi-thread evaluation is enabled. Default is zero.

Returns:

isClassLoaderCacheEnabled

public boolean isClassLoaderCacheEnabled()

setClassLoaderCacheEnabled

public void setClassLoaderCacheEnabled(boolean classLoaderCacheEnabled)

isPhreakEnabled

public boolean isPhreakEnabled()

Returns:

whether or not Unlinking is enabled.

setPhreakEnabled

public void setPhreakEnabled(boolean enabled)

Enable Unlinking. It will also disable sequential mode and multithread evaluation as these are incompatible with L&R unlinking.

Parameters:

enabled -

isDeclarativeAgenda

public boolean isDeclarativeAgenda()

setDeclarativeAgendaEnabled

public void setDeclarativeAgendaEnabled(boolean enabled)

Enable declarative agenda

Parameters:

enabled -

getWorkDefinitions

public List<Map<String,Object>> getWorkDefinitions()

isAdvancedProcessRuleIntegration

public boolean isAdvancedProcessRuleIntegration()

setAdvancedProcessRuleIntegration

public void setAdvancedProcessRuleIntegration(boolean advancedProcessRuleIntegration)

addActivationListener

public void addActivationListener(String name,
                                  ActivationListenerFactory factory)

getActivationListenerFactory

public ActivationListenerFactory getActivationListenerFactory(String name)

setConflictResolver

public void setConflictResolver(ConflictResolver conflictResolver)

getConflictResolver

public ConflictResolver getConflictResolver()

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader... classLoaders)

getComponentFactory

public ReteooComponentFactory getComponentFactory()

setComponentFactory

public void setComponentFactory(ReteooComponentFactory componentFactory)

setMBeansEnabled

public void setMBeansEnabled(boolean mbeansEnabled)

Defines if the RuleBase should expose management and monitoring MBeans

Parameters:

mbeansEnabled - true for multi-thread or false for single-thread. Default is false.

isMBeansEnabled

public boolean isMBeansEnabled()

Returns true if the management and monitoring through MBeans is active

Returns:

getOption

public <T extends org.kie.api.conf.SingleValueKieBaseOption> T getOption(Class<T> option)

Specified by:

getOption in interface org.kie.api.conf.KieBaseOptionsConfiguration

setOption

public <T extends org.kie.api.conf.KieBaseOption> void setOption(T option)

Specified by:

setOption in interface org.kie.api.conf.KieBaseOptionsConfiguration

getOption

public <T extends org.kie.api.conf.MultiValueKieBaseOption> T getOption(Class<T> option,
                                                                        String key)

Specified by:

getOption in interface org.kie.api.conf.KieBaseOptionsConfiguration