com.cordys.bre.engine

Interface RuleEngine

public interface RuleEngine

The rule engine factory will provide an implementation of the rule engine interface with which clients can create and evaluate rule sessions.
The rule engine can be created with a rule repository or configuration object.
The configuration xml node has the format

 <configurations>
   <user>cn=SYSTEM,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</user>
   <organization>o=system,cn=cordys,o=vanenburg.com</organization>
   <configuration htmfile="/cordys/ruleengine/admin/ruleengineConfig.htm" implementation="com.cordys.bre.ws.RuleService">
     <classpath xmlns="http://schemas.cordys.com/1.0/xmlstore">
       <location>/bin/bre.jar</location>
     </classpath>
     <component name="Rule Repository ConnectionPool">
       <xmlEncoding>false</xmlEncoding>
       <precedence/>
       <cursorCacheSize>50</cursorCacheSize>
       <cursorCacheRefreshInterval>3600</cursorCacheRefreshInterval>
       <queryCacheSize>50</queryCacheSize>
       <queryCacheRefreshInterval>3600</queryCacheRefreshInterval>
       <maximumWriteConnections>5</maximumWriteConnections>
       <maximumReadConnections>5</maximumReadConnections>
       <minimumReadConnections>1</minimumReadConnections>
       <minimumWriteConnections>1</minimumWriteConnections>
       <connectionPoolRefreshInterval>3600</connectionPoolRefreshInterval>
       <multithreaded>true</multithreaded>
       <sharedPool>false</sharedPool>
       <xsiNilForNullData>false</xsiNilForNullData>
       <datasource>
         <type>Relational</type>
         <name>Cordys System#system</name>
       </datasource>
       <reconnectionAttempts>1</reconnectionAttempts>
       <requestThreshold>1000</requestThreshold>
     </component>
     <component name="Rule Engine">
       <ruleAudit>false</ruleAudit>
       <threadPoolSize>5</threadPoolSize>
       <maxDispatcherQueueSize>50000</maxDispatcherQueueSize>
     </component>
   </configuration>
 </configurations>
 

To create rule engine and register action handlers, sample code is below. parentManagedComponent is the parent managed component used to create the DBConnectionPool

 RuleEngine ruleEngine = ruleEngineFactory.createRuleEngine(parentManagedComponent);
 
 OR
 
 Configuration ruleConfiguration = new Configuration(ruleConfigurationNode, parentManagedComponent);
 // This can be used for connecting by creating dso node instead of managed component. 
 // If parentManagedComponent passed is null, this option is automatically set.
 ruleConfiguration.connectUsingDSO();  
 RuleEngineFactory ruleEngineFactory = RuleEngineFactory.getInstance();
 RuleEngine ruleEngine = ruleEngineFactory.createRuleEngine(ruleConfiguration);
 
 OR
 
 RuleRepository ruleRepository = ruleEngineFactory.createRuleRepository(ruleConfiguration); 
 RuleEngine ruleEngine = ruleEngineFactory.createRuleEngine(ruleRepository); 
 
 //Additional behavior added to RuleEngine instance once it's initialized 
 ruleEngine.setHostIdentifier("host framework name"); //For example, this can be coboc, bpm, wsapps, bam etc...
 ruleEngine.setAuditListner(new RuleAuditManager()); //required for publishing audit information to the host program.
 ruleEngine.setPreconditionProcessor(preProcessor); //preProcessor is an object of type com.cordys.bre.engine.PreconditionProcessor
 ruleEngine.registerActionHandlerClass("insert", com.cordys.coboc.ruleengine.action.InsertAction.class);
 ruleEngine.registerActionHandlerClass("update", com.cordys.coboc.ruleengine.action.UpdateAction.class);
 ruleEngine.registerActionHandlerClass("delete", com.cordys.coboc.ruleengine.action.DeleteAction.class);
 //the handler class for the action which is an implementation of com.cordys.bre.engine.Action class
 
 Then create a rule session, set user, object context and transaction context
 on the session, and execute rules
 RuleSession ruleSession = ruleEngine.createRuleSession(uriBinding, triggerType, triggerEvent);
 ruleSession.setUser(user); 
 ruleSession.setTriggerObject(xObject);
 ruleSession.setTransactionContext(transaction);
 ruleSession.executeRules();
 
 //Finally cleanup
 ruleSession.cleanUp();
 

Also end the transaction passed to the rule session.

Method Summary

Modifier and Type	Method and Description
void	closeRuleEngineResources() This method should be called to close the system resource rule engine uses.
RuleSession	createRuleSession() Deprecated.
RuleSession	createRuleSession(IRule[] rules) Deprecated. Use createRuleSession(IRule[], String) Instead
RuleSession	createRuleSession(IRule[] rules, java.lang.String user) Create a RuleSession for given set of Rules.
RuleSession	createRuleSession(java.lang.String decisionCaseId) Deprecated. Use createRuleSession(String, String) Instead
RuleSession	createRuleSession(java.lang.String decisionCaseId, java.lang.String user) Create the RuleSession for executing a particular decision case.
RuleSession	createRuleSession(java.lang.String uriBinding, java.lang.String ruleType, int triggerEvent) Deprecated. Use #createRuleSession(String, String, TriggerEvents, String, String) Instead
RuleSession	createRuleSession(java.lang.String uriBinding, java.lang.String ruleType, TriggerEvents event) Deprecated. Use createRuleSession(String, String, TriggerEvents, String) instead
RuleSession	createRuleSession(java.lang.String uriBinding, java.lang.String ruleType, TriggerEvents event, java.lang.String user) Create the RuleSession for the given URI binding between the design time and the runtime.
void	disablePublishAudit() Disables publish audit
void	disableRuleAudit() Disables the reporting of the rule execution with in the rule repository.
void	enablePublishAudit() Enables publish audit, when publish audit is enabled , rule engine will give rule monitor data to the AuditListner of host.
void	enableRuleAudit() Enables the reporting of the rule execution with in the rule repository.
Action	getActionHandlerInstance(java.lang.String actionName, int ruleActionNode, IRule rule, RuleSession ruleSession) Creates an action handler instance for the given action name , action node, rule and rule session -use internal
AuditListner	getAuditListner() Gets the audit listener for the engine
java.lang.String	getHostIdentifier() This methods gets the host identifier
PreconditionProcessor	getPreconditionProcessor() Gets the precondition processor
RuleRepository	getRuleRepository() Returns the RuleRepository associated with this RuleEngine
boolean	isPublishAuditEnabled() Retrieves the current publish audit state
boolean	isRuleAuditEnabled() Retrieves the current rule audit state
void	registerActionHandlerClass(java.lang.String actionName, java.lang.Class<? extends Action> clazz) Registers an action handler class for the given action name.
void	setAuditListner(AuditListner _auditListner) Deprecated. Use #registerRuleMonitorListener(AuditListner) instead
void	setHostIdentifier(java.lang.String hostIdentifier) This methods sets the host identifier, according to the which the configuration set up for the host will be read and initialized.
void	setPreconditionProcessor(PreconditionProcessor preConditionProcessor) Sets the precondition processor
void	unregisterActionHandlerClass(java.lang.String actionName) Unregisters action handler class for given action name

Method Detail

getHostIdentifier

java.lang.String getHostIdentifier()

This methods gets the host identifier

Returns:

string host identifier

setHostIdentifier

void setHostIdentifier(java.lang.String hostIdentifier)

This methods sets the host identifier, according to the which the configuration set up for the host will be read and initialized.

Parameters:

hostIdentifier - - eg "coboc" , "wsappsserver" etc

setAuditListner

@Deprecated
void setAuditListner(AuditListner _auditListner)

Deprecated. Use #registerRuleMonitorListener(AuditListner) instead

For audit information to be given back to the host environment the host can set the audit listner

Parameters:

_auditListner - AuditListner

getAuditListner

AuditListner getAuditListner()

Gets the audit listener for the engine

Returns:

_auditListner AuditListner

enablePublishAudit

void enablePublishAudit()

Enables publish audit, when publish audit is enabled , rule engine will give rule monitor data to the AuditListner of host.

disablePublishAudit

void disablePublishAudit()

Disables publish audit

isPublishAuditEnabled

boolean isPublishAuditEnabled()

Retrieves the current publish audit state

Returns:

current publish audit state

enableRuleAudit

void enableRuleAudit()

Enables the reporting of the rule execution with in the rule repository.

disableRuleAudit

void disableRuleAudit()

Disables the reporting of the rule execution with in the rule repository.

isRuleAuditEnabled

boolean isRuleAuditEnabled()

Retrieves the current rule audit state

Returns:

current rule audit state

registerActionHandlerClass

void registerActionHandlerClass(java.lang.String actionName,
                                java.lang.Class<? extends Action> clazz)
                         throws java.lang.NoSuchMethodException

Registers an action handler class for the given action name. This method also checks the class is an instance of com.cordys.bre.engine.Action class and has constructor taking rulesession ,ruleaction and int action node.

Parameters:

actionName - the unique identifier of the action which is the root tag name for the action defined in xml

Class - the handler class for the action which is an implementation of Action class

Throws:

java.lang.NoSuchMethodException

unregisterActionHandlerClass

void unregisterActionHandlerClass(java.lang.String actionName)

Unregisters action handler class for given action name

getActionHandlerInstance

Action getActionHandlerInstance(java.lang.String actionName,
                                int ruleActionNode,
                                IRule rule,
                                RuleSession ruleSession)
                         throws java.lang.Exception

Creates an action handler instance for the given action name , action node, rule and rule session -use internal

Parameters:

actionName - the unique identifier of the action which is the root tag name for the action defined in xml

rule - the rule IRule to which the current action belongs to

ruleSession - the rule session RuleSession on which the action handler has to be created.

Throws:

java.lang.Exception

setPreconditionProcessor

void setPreconditionProcessor(PreconditionProcessor preConditionProcessor)

Sets the precondition processor

Parameters:

preConditionProcessor - PreconditionProcessor

getPreconditionProcessor

PreconditionProcessor getPreconditionProcessor()

Gets the precondition processor

Returns:

the PreconditionProcessor if one is set

createRuleSession

@Deprecated
RuleSession createRuleSession(java.lang.String uriBinding,
                                           java.lang.String ruleType,
                                           TriggerEvents event)

Deprecated. Use createRuleSession(String, String, TriggerEvents, String) instead

Create the RuleSession for the given URI binding between the design time and the runtime.

Parameters:

uriBinding - the association of the design time rules to the runtime ruleset.

ruleType - the type of rule applicable to this rule execution cycle

triggerEvent - com.cordys.bre.base.RuleTrigger.INSERT/ RuleTrigger.UPDATE/ RuleTrigger.DELETE

Returns:

the runtime rule execution session

createRuleSession

RuleSession createRuleSession(java.lang.String uriBinding,
                              java.lang.String ruleType,
                              TriggerEvents event,
                              java.lang.String user)

Create the RuleSession for the given URI binding between the design time and the runtime.

Parameters:

uriBinding - the association of the design time rules to the runtime ruleset.

ruleType - the type of rule applicable to this rule execution cycle

triggerEvent - com.cordys.bre.base.RuleTrigger.INSERT/ RuleTrigger.UPDATE/ RuleTrigger.DELETE

user - the user context for the current rule execution cycle. User should be a valid LDAP user
For example, user = "cn=john,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com".

Returns:

the runtime rule execution session

createRuleSession

@Deprecated
RuleSession createRuleSession(java.lang.String uriBinding,
                                           java.lang.String ruleType,
                                           int triggerEvent)

Deprecated. Use #createRuleSession(String, String, TriggerEvents, String, String) Instead

Create the RuleSession for the given URI binding between the design time and the runtime.

Parameters:

uriBinding - the association of the design time rules to the runtime ruleset.

ruleType - the type of rule applicable to this rule execution cycle

triggerEvent - the type of the trigger applicable to this rule execution cycle, the possible values are {1-INSERT/2-UPDATE/3-DELETE}

Returns:

the runtime rule execution session

createRuleSession

@Deprecated
RuleSession createRuleSession(IRule[] rules)

Deprecated. Use createRuleSession(IRule[], String) Instead

Create a RuleSession for given set of Rules.

Parameters:

rules - the list of rules defined on schema.

Returns:

the runtime rule execution session

createRuleSession

RuleSession createRuleSession(IRule[] rules,
                              java.lang.String user)

Create a RuleSession for given set of Rules.

Parameters:

rules - the list of rules defined on schema.

user - the user context for the current rule execution cycle.User should be a valid LDAP user
For example, user = "cn=john,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com"

Returns:

the runtime rule execution session

createRuleSession

@Deprecated
RuleSession createRuleSession(java.lang.String decisionCaseId)

Deprecated. Use createRuleSession(String, String) Instead

Create the RuleSession for executing a particular decision case.

Parameters:

decisionCaseId - id of the decision case needs to be executed

Returns:

the runtime rule execution session

createRuleSession

RuleSession createRuleSession(java.lang.String decisionCaseId,
                              java.lang.String user)

Create the RuleSession for executing a particular decision case.

Parameters:

decisionCaseId - id of the decision case needs to be executed

user - the user context for the current rule execution cycle. User should be a valid LDAP user
For example, user = "cn=john,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com"

Returns:

the runtime rule execution session

createRuleSession

@Deprecated
RuleSession createRuleSession()

Deprecated.

Create the empty RuleSession for executing rules, this method is provided only for test cases.

Returns:

the runtime rule execution session

getRuleRepository

RuleRepository getRuleRepository()

Returns the RuleRepository associated with this RuleEngine

Returns:

the RuleRepository configured to the database as given in the Configuration details.

closeRuleEngineResources

void closeRuleEngineResources()

This method should be called to close the system resource rule engine uses. specifically the port used in state synch up.