org.jboss.soa.esb.services.rules
Interface RuleService


public interface RuleService

RulesEngine Interface. Separates implementation from the runtime, allowing the ESB to support different implementations of rule engines.

Author:
jdelong@redhat.com

Method Summary
 Message continueStatefulRulesExecution(StatefulRuleInfo info, Message msg)
           
 Message continueStatefulRulesExecution(java.lang.String rules, boolean dispose, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use continueStatefulRulesExecution(StatefulRuleInfo, Message) instead.
 Message executeStatefulRules(StatefulRuleInfo info, Message msg)
           
 Message executeStatefulRules(java.lang.String ruleSet, java.lang.String dsl, boolean ruleReload, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use #executeStatefulRules(RuleInfo, Message) instead.
 Message executeStatefulRulesFromDecisionTable(StatefulRuleInfo info, Message msg)
           
 Message executeStatefulRulesFromDecisionTable(java.lang.String decisionTable, boolean ruleReload, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use #executeStatefulRulesFromDecisionTable(RuleInfo, Message) instead.
 Message executeStatefulRulesFromRuleAgent(StatefulRuleInfo info, Message msg)
           
 Message executeStatefulRulesFromRuleAgent(java.lang.String ruleAgentProperties, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use #executeStatefulRulesFromRuleAgent(RuleInfo, Message) instead.
 Message executeStatelessRules(RuleInfo ruleInfo, Message message)
           
 Message executeStatelessRules(java.lang.String ruleSet, java.lang.String dsl, boolean ruleReload, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use executeStatelessRules(RuleInfo, Message) instead.
 Message executeStatelessRulesFromDecisionTable(RuleInfo ruleInfo, Message message)
           
 Message executeStatelessRulesFromDecisionTable(java.lang.String decisionTable, boolean ruleReload, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use executeStatelessRulesFromDecisionTable(RuleInfo, Message) instead.
 Message executeStatelessRulesFromRuleAgent(RuleInfo ruleInfo, Message message)
           
 Message executeStatelessRulesFromRuleAgent(java.lang.String ruleAgentProperties, Message message, java.util.Map<java.lang.String,java.lang.Object> globals, java.util.List<java.lang.Object> objectList)
          Deprecated. Please use executeStatelessRulesFromRuleAgent(RuleInfo, Message) instead.
 void setConfigTree(ConfigTree configTree)
           
 

Method Detail

setConfigTree

void setConfigTree(ConfigTree configTree)

executeStatelessRules

Message executeStatelessRules(java.lang.String ruleSet,
                              java.lang.String dsl,
                              boolean ruleReload,
                              Message message,
                              java.util.Map<java.lang.String,java.lang.Object> globals,
                              java.util.List<java.lang.Object> objectList)
                              throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use executeStatelessRules(RuleInfo, Message) instead.

Execute rules using a certain ruleSet and domain specific language using the Stateless rule engine API

Parameters:
ruleSet - - String reference to a file which contains a ruleSet.
dsl - - String reference to a file which contains a custom rule language definition
ruleReload - - if set to true, a ruleSet update should result in reloading the ruleSet.
message - - Message that is updated with the results.
objectList - - a list with additional objects (typically pulled from the message) to be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatelessRules

Message executeStatelessRules(RuleInfo ruleInfo,
                              Message message)
                              throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatelessRulesFromDecisionTable

Message executeStatelessRulesFromDecisionTable(java.lang.String decisionTable,
                                               boolean ruleReload,
                                               Message message,
                                               java.util.Map<java.lang.String,java.lang.Object> globals,
                                               java.util.List<java.lang.Object> objectList)
                                               throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use executeStatelessRulesFromDecisionTable(RuleInfo, Message) instead.

Execute rules from a decision table using the Stateless rule engine API

Parameters:
decisionTable - - String reference to a file which contains a spreadsheet of rules
ruleReload - - if set to true, a ruleSet update should result in reloading the ruleSet.
message - - Message that is updated with the results.
objectList - - a list with additional objects (typically pulled from the message) to be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatelessRulesFromDecisionTable

Message executeStatelessRulesFromDecisionTable(RuleInfo ruleInfo,
                                               Message message)
                                               throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatelessRulesFromRuleAgent

Message executeStatelessRulesFromRuleAgent(java.lang.String ruleAgentProperties,
                                           Message message,
                                           java.util.Map<java.lang.String,java.lang.Object> globals,
                                           java.util.List<java.lang.Object> objectList)
                                           throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use executeStatelessRulesFromRuleAgent(RuleInfo, Message) instead.

Execute rules using a rule package retrieved via the Rule Agent from a URL of local file system using the Stateless rule engine API

Parameters:
ruleAgentProperties - - String reference to a file which contains properties used by the RuleAgent to locate a rule package.
message - - Message that is updated with the results.
objectList - - a list with additional objects (typically pulled from the message) to be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatelessRulesFromRuleAgent

Message executeStatelessRulesFromRuleAgent(RuleInfo ruleInfo,
                                           Message message)
                                           throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatefulRules

Message executeStatefulRules(java.lang.String ruleSet,
                             java.lang.String dsl,
                             boolean ruleReload,
                             Message message,
                             java.util.Map<java.lang.String,java.lang.Object> globals,
                             java.util.List<java.lang.Object> objectList)
                             throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use #executeStatefulRules(RuleInfo, Message) instead.

Execute rules using a certain ruleSet and domain specific language using the Stateful rule engine API

Parameters:
ruleSet - - String reference to a file which contains a ruleSet.
dsl - - String reference to a file which contains a custom rule language definition
ruleReload - - if set to true, a ruleSet update should result in reloading the ruleSet.
dispose - - if set to true, working memory will be disposed after the rules are fired
message - - Message that is updated with the results.
objectList - - a list with additional objects (typically pulled from the message) to be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatefulRules

Message executeStatefulRules(StatefulRuleInfo info,
                             Message msg)
                             throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatefulRulesFromDecisionTable

Message executeStatefulRulesFromDecisionTable(java.lang.String decisionTable,
                                              boolean ruleReload,
                                              Message message,
                                              java.util.Map<java.lang.String,java.lang.Object> globals,
                                              java.util.List<java.lang.Object> objectList)
                                              throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use #executeStatefulRulesFromDecisionTable(RuleInfo, Message) instead.

Execute rules from a decision table using the Stateful rule engine API

Parameters:
decisionTable - - String reference to a file which contains a spreadsheet of rules
ruleReload - - if set to true, a ruleSet update should result in reloading the ruleSet.
dispose - - if set to true, working memory will be disposed after the rules are fired
message - - Message that is updated with the results.
objectList - - a list with additional objects (typically pulled from the message) to be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatefulRulesFromDecisionTable

Message executeStatefulRulesFromDecisionTable(StatefulRuleInfo info,
                                              Message msg)
                                              throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatefulRulesFromRuleAgent

Message executeStatefulRulesFromRuleAgent(java.lang.String ruleAgentProperties,
                                          Message message,
                                          java.util.Map<java.lang.String,java.lang.Object> globals,
                                          java.util.List<java.lang.Object> objectList)
                                          throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use #executeStatefulRulesFromRuleAgent(RuleInfo, Message) instead.

Execute rules using a rule package retrieved via the Rule Agent from a URL of local file system using the Stateful rule engine API

Parameters:
ruleAgentProperties - - String reference to a file which contains properties used by the RuleAgent to locate a rule package.
dispose - - if set to true, working memory will be disposed after the rules are fired
message - - Message that is updated with the results.
objectList - - a list with additional objects (typically pulled from the message)t o be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

executeStatefulRulesFromRuleAgent

Message executeStatefulRulesFromRuleAgent(StatefulRuleInfo info,
                                          Message msg)
                                          throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

continueStatefulRulesExecution

Message continueStatefulRulesExecution(java.lang.String rules,
                                       boolean dispose,
                                       Message message,
                                       java.util.Map<java.lang.String,java.lang.Object> globals,
                                       java.util.List<java.lang.Object> objectList)
                                       throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Deprecated. Please use continueStatefulRulesExecution(StatefulRuleInfo, Message) instead.

Continue executing rules where the working memory already exists.

Parameters:
rules - - String reference to a file, either the drl file, the decision table, or the ruleAgentProperties. This is used to find the ruleBase.
dispose - - if set to true, working memory will be disposed after the rules are fired
message - - Message that is updated with the results.
globals - - Map of globals variables that should be set in the working memory
objectList - - a list with additional objects (typically pulled from the message) to be inserted into working memory
Returns:
Message with updated objects.
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException

continueStatefulRulesExecution

Message continueStatefulRulesExecution(StatefulRuleInfo info,
                                       Message msg)
                                       throws org.jboss.internal.soa.esb.services.rules.RuleServiceException
Throws:
org.jboss.internal.soa.esb.services.rules.RuleServiceException