de.hybris.platform.droolsruleengineservices.impl

Class DefaultCommerceRuleEngineService

java.lang.Object

de.hybris.platform.droolsruleengineservices.impl.DefaultCommerceRuleEngineService

All Implemented Interfaces:

RuleEngineService

public class DefaultCommerceRuleEngineService
extends java.lang.Object
implements RuleEngineService

Default implementation of Commerce Rule Engine Service.

Constructor Summary

Constructors

Constructor and Description
DefaultCommerceRuleEngineService()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<java.lang.Object>	addRuleConfigurationFacts(java.util.Collection<DroolsRuleModel> rules) Deprecated. since 6.3 this method is not invoked anymore during evaluate(RuleEvaluationContext). Instead RuleConfigurationRRDs are created using the DefaultCommerceRuleEngineCacheService.
protected RuleEngineResultRAO	addRuleEngineResultRAO(RuleEvaluationContext context) Adds a RuleEngineResultRAO to the facts of this context if it doesn't exist already.
protected java.util.Collection<java.lang.Object>	addRuleGroupExecutionFacts(java.util.Collection<DroolsRuleModel> rules) Deprecated. since 6.3 this method is not invoked anymore during evaluate(RuleEvaluationContext). Instead RuleGroupExecutionRRDs are created using the DefaultCommerceRuleEngineCacheService.
RuleEngineActionResult	archiveRule(AbstractRuleEngineRuleModel ruleEngineRule) Archives the given rule if it already exists.
RuleEngineActionResult	archiveRule(AbstractRuleEngineRuleModel ruleEngineRule, AbstractRulesModuleModel rulesModule) Archives the given rule if it already exists.
<T extends DroolsRuleModel> java.util.Optional<InitializationFuture>	archiveRules(java.util.Collection<T> engineRules) Archive a collection of rules
protected void	checkIfBeanDefinedPreviously(java.util.Map<java.lang.Object,DroolsRuleModel> duplicateGlobalsCheckMap, DroolsRuleModel rule, java.util.Map.Entry<java.lang.String,java.lang.String> entry, java.lang.Object bean, java.lang.Object oldBean) Deprecated. since 6.3 (used during getGlobals(Collection), this method is no longer invoked.
<T extends AbstractRuleEngineRuleModel> void	deactivateRulesModuleEngineRules(java.lang.String moduleName, java.util.Collection<T> engineRules) make the specified collection of engine rules belonging to a specified module inactive, so that the engine wouln't take them in consideration during init
RuleEvaluationResult	evaluate(RuleEvaluationContext context) Since 6.0 Executes rule evaluation for given RuleEvaluationContext.
protected AgendaEventListenerFactory	getAgendaEventListenerFactory()
protected AgendaFilterFactory	getAgendaFilterFactory()
protected ConfigurationService	getConfigurationService()
protected java.util.Collection<DroolsRuleModel>	getDroolsRulesForContext(DroolsRuleEngineContextModel ruleEngineContext, java.util.List<AbstractRuleEngineRuleModel> activeRulesForModule) Deprecated. since 6.3 rules are no longer iterated through during rule evaluation. Instead the RuleEngineCacheService is used.
protected EngineRuleDao	getEngineRuleDao()
protected java.util.Set<java.lang.Object>	getEventListners(DroolsRuleEngineContextModel ruleEngineContext)
protected FactContextFactory	getFactContextFactory()
protected java.util.Map<java.lang.String,java.lang.Object>	getGlobals(java.util.Collection<DroolsRuleModel> rules) Deprecated. since 6.3 this method is no longer invoked during evaluate(RuleEvaluationContext). Instead the globals are cached in DefaultPlatformRuleEngineService during DefaultPlatformRuleEngineService.initialize(AbstractRulesModuleModel, String, boolean, boolean, RuleEngineActionResult) and injected in the DefaultPlatformRuleEngineService.evaluate(RuleEvaluationContext) call.
protected RuleEngineService	getPlatformRuleEngineService()
protected ProcessEventListenerFactory	getProcessEventListenerFactory()
protected RAOProvider	getRuleConfigurationProvider()
AbstractRuleEngineRuleModel	getRuleForCode(java.lang.String code) Deprecated. since 6.4
AbstractRuleEngineRuleModel	getRuleForCodeAndModule(java.lang.String code, java.lang.String moduleName) Finds AbstractRuleEngineRuleModel for given code and module.
AbstractRuleEngineRuleModel	getRuleForUuid(java.lang.String uuid)
protected RAOProvider	getRuleGroupExecutionProvider()
AbstractRulesModuleModel	getRuleModuleForRule(AbstractRuleEngineRuleModel rule) Deprecated. since 6.3
protected RuleRuntimeEventListenerFactory	getRuleRuntimeEventListenerFactory()
RuleEngineActionResult	initialize(AbstractRulesModuleModel abstractModule) Deprecated. since 6.4
RuleEngineActionResult	initialize(AbstractRulesModuleModel abstractModule, boolean propagateToOtherNodes) Deprecated. since 6.3. Please use initialize(AbstractRulesModuleModel, String, boolean, boolean, RuleEngineActionResult) initialize} method instead
RuleEngineActionResult	initialize(AbstractRulesModuleModel abstractModule, java.lang.String deployedReleaseIdVersion, boolean propagateToOtherNodes) Deprecated. since 6.4
void	initialize(AbstractRulesModuleModel module, java.lang.String deployedMvnVersion, boolean propagateToOtherNodes, boolean enableIncrementalUpdate, RuleEngineActionResult result) Since 6.4 Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).
InitializationFuture	initialize(java.util.List<AbstractRulesModuleModel> modules, boolean propagateToOtherNodes, boolean enableIncrementalUpdate) Since 6.4 Initializes the given rules module in blocking/async mode (depending on blocking param) (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).
java.util.List<RuleEngineActionResult>	initializeAllRulesModules() Initializes all AbstractRulesModuleModels that are marked as active (in case of cluster mode - on all the nodes).
java.util.List<RuleEngineActionResult>	initializeAllRulesModules(boolean propagateToOtherNodes) Initializes all AbstractRulesModuleModels that are marked as active.
void	initializeNonBlocking(AbstractRulesModuleModel module, java.lang.String deployedReleaseIdVersion, boolean propagateToOtherNodes, boolean enableIncrementalUpdate, RuleEngineActionResult result) Since 6.4 Asynchronously initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).
protected void	logContextFacts(RuleEvaluationContext context)
protected java.util.Set<java.lang.Object>	provideRAOs(FactContext factContext)
void	setAgendaEventListenerFactory(AgendaEventListenerFactory agendaEventListenerFactory)
void	setAgendaFilterFactory(AgendaFilterFactory agendaFilterFactory)
void	setConfigurationService(ConfigurationService configurationService)
void	setEngineRuleDao(EngineRuleDao engineRuleDao)
void	setFactContextFactory(FactContextFactory factContextFactory)
void	setPlatformRuleEngineService(RuleEngineService ruleEngineService)
void	setProcessEventListenerFactory(ProcessEventListenerFactory processEventListenerFactory)
void	setRuleConfigurationProvider(RAOProvider ruleConfigurationProvider)
void	setRuleGroupExecutionProvider(RAOProvider ruleGroupExecutionProvider)
void	setRuleRuntimeEventListenerFactory(RuleRuntimeEventListenerFactory ruleRuntimeEventListenerFactory)
RuleEngineActionResult	updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule) Deprecated. since 6.3
RuleEngineActionResult	updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule, AbstractRulesModuleModel rulesModule) Updates the given rule if it already exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommerceRuleEngineService

public DefaultCommerceRuleEngineService()

Method Detail

initialize

@Deprecated
public RuleEngineActionResult initialize(AbstractRulesModuleModel abstractModule,
                                                     boolean propagateToOtherNodes)

Deprecated. since 6.3. Please use initialize(AbstractRulesModuleModel, String, boolean, boolean, RuleEngineActionResult) initialize} method instead

Description copied from interface: RuleEngineService

Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Specified by:

initialize in interface RuleEngineService

Parameters:

abstractModule - the module to be initialized

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

Returns:

the result of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initialize

@Deprecated
public RuleEngineActionResult initialize(AbstractRulesModuleModel abstractModule,
                                                     java.lang.String deployedReleaseIdVersion,
                                                     boolean propagateToOtherNodes)

Deprecated. since 6.4

Description copied from interface: RuleEngineService

Since 6.0 Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Specified by:

initialize in interface RuleEngineService

Parameters:

abstractModule - the module to be initialized

deployedReleaseIdVersion - currently deployed mvn version of the rule engine module

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

Returns:

the result of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initialize

public void initialize(AbstractRulesModuleModel module,
                       java.lang.String deployedMvnVersion,
                       boolean propagateToOtherNodes,
                       boolean enableIncrementalUpdate,
                       RuleEngineActionResult result)

Description copied from interface: RuleEngineService

Since 6.4 Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Specified by:

initialize in interface RuleEngineService

Parameters:

module - the module to be initialized

deployedMvnVersion - currently deployed mvn version of the rule engine module

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

enableIncrementalUpdate - flag, if true, enables for incremental updates of the rule engine kie module

result - the instance of RuleEngineActionResult accumulating the results of initialization

initializeNonBlocking

public void initializeNonBlocking(AbstractRulesModuleModel module,
                                  java.lang.String deployedReleaseIdVersion,
                                  boolean propagateToOtherNodes,
                                  boolean enableIncrementalUpdate,
                                  RuleEngineActionResult result)

Description copied from interface: RuleEngineService

Since 6.4 Asynchronously initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Specified by:

initializeNonBlocking in interface RuleEngineService

Parameters:

module - the module to be initialized

deployedReleaseIdVersion - currently deployed version of the Kie Module

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

enableIncrementalUpdate - flag, if true, enables for incremental updates of the rule engine kie module

result - the instance of RuleEngineActionResult accumulating the results of initialization

initialize

@Deprecated
public RuleEngineActionResult initialize(AbstractRulesModuleModel abstractModule)

Deprecated. since 6.4

Description copied from interface: RuleEngineService

Since 6.0 Initializes the given rules module and propagates a RuleEngineInitializedEvent to other nodes.

Specified by:

initialize in interface RuleEngineService

Parameters:

abstractModule - the module to be initialized

Returns:

the result of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initialize

public InitializationFuture initialize(java.util.List<AbstractRulesModuleModel> modules,
                                       boolean propagateToOtherNodes,
                                       boolean enableIncrementalUpdate)

Description copied from interface: RuleEngineService

Since 6.4 Initializes the given rules module in blocking/async mode (depending on blocking param) (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Specified by:

initialize in interface RuleEngineService

Parameters:

modules - the modules to be initialized

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

enableIncrementalUpdate - flag, if true, enables for incremental updates of the rule engine kie module

Returns:

instance of InitializationFuture to be used for eventual blocking on multiple parallel swapping

evaluate

public RuleEvaluationResult evaluate(RuleEvaluationContext context)

Description copied from interface: RuleEngineService

Since 6.0 Executes rule evaluation for given RuleEvaluationContext. Executes all rules contained within the context

Specified by:

evaluate in interface RuleEngineService

Parameters:

context - the rule engine context containing data about rule engine execution

Returns:

results of rule engine execution

deactivateRulesModuleEngineRules

public <T extends AbstractRuleEngineRuleModel> void deactivateRulesModuleEngineRules(java.lang.String moduleName,
                                                                                     java.util.Collection<T> engineRules)

Description copied from interface: RuleEngineService

make the specified collection of engine rules belonging to a specified module inactive, so that the engine wouln't take them in consideration during init

Specified by:

deactivateRulesModuleEngineRules in interface RuleEngineService

Type Parameters:

T - a type of engine rules

Parameters:

moduleName - Name of the module the rules should refer to when applying changes

engineRules - A collection of AbstractRuleEngineRuleModel to be deactivated

logContextFacts

protected void logContextFacts(RuleEvaluationContext context)

getDroolsRulesForContext

@Deprecated
protected java.util.Collection<DroolsRuleModel> getDroolsRulesForContext(DroolsRuleEngineContextModel ruleEngineContext,
                                                                                     java.util.List<AbstractRuleEngineRuleModel> activeRulesForModule)

Deprecated. since 6.3 rules are no longer iterated through during rule evaluation. Instead the RuleEngineCacheService is used.

getEventListners

protected java.util.Set<java.lang.Object> getEventListners(DroolsRuleEngineContextModel ruleEngineContext)

addRuleEngineResultRAO

protected RuleEngineResultRAO addRuleEngineResultRAO(RuleEvaluationContext context)

Adds a RuleEngineResultRAO to the facts of this context if it doesn't exist already.

Parameters:

context - the rule engine context

Returns:

the result rao (already added to the context.facts)

addRuleGroupExecutionFacts

@Deprecated
protected java.util.Collection<java.lang.Object> addRuleGroupExecutionFacts(java.util.Collection<DroolsRuleModel> rules)

Deprecated. since 6.3 this method is not invoked anymore during evaluate(RuleEvaluationContext). Instead RuleGroupExecutionRRDs are created using the DefaultCommerceRuleEngineCacheService.

Parameters:

rules - the rules for which to add the rule group execution facts

addRuleConfigurationFacts

@Deprecated
protected java.util.Collection<java.lang.Object> addRuleConfigurationFacts(java.util.Collection<DroolsRuleModel> rules)

Deprecated. since 6.3 this method is not invoked anymore during evaluate(RuleEvaluationContext). Instead RuleConfigurationRRDs are created using the DefaultCommerceRuleEngineCacheService.

Parameters:

rules - the rules for which to add the configuration facts

provideRAOs

protected java.util.Set<java.lang.Object> provideRAOs(FactContext factContext)

getGlobals

@Deprecated
protected java.util.Map<java.lang.String,java.lang.Object> getGlobals(java.util.Collection<DroolsRuleModel> rules)

Deprecated. since 6.3 this method is no longer invoked during evaluate(RuleEvaluationContext). Instead the globals are cached in DefaultPlatformRuleEngineService during DefaultPlatformRuleEngineService.initialize(AbstractRulesModuleModel, String, boolean, boolean, RuleEngineActionResult) and injected in the DefaultPlatformRuleEngineService.evaluate(RuleEvaluationContext) call.

Parameters:

rules - the rules

Returns:

a map with key key global name and value spring bean to be set as the global

checkIfBeanDefinedPreviously

@Deprecated
protected void checkIfBeanDefinedPreviously(java.util.Map<java.lang.Object,DroolsRuleModel> duplicateGlobalsCheckMap,
                                                        DroolsRuleModel rule,
                                                        java.util.Map.Entry<java.lang.String,java.lang.String> entry,
                                                        java.lang.Object bean,
                                                        java.lang.Object oldBean)

Deprecated. since 6.3 (used during getGlobals(Collection), this method is no longer invoked.

initializeAllRulesModules

public java.util.List<RuleEngineActionResult> initializeAllRulesModules()

Description copied from interface: RuleEngineService

Initializes all AbstractRulesModuleModels that are marked as active (in case of cluster mode - on all the nodes).

Specified by:

initializeAllRulesModules in interface RuleEngineService

Returns:

the results of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initializeAllRulesModules

public java.util.List<RuleEngineActionResult> initializeAllRulesModules(boolean propagateToOtherNodes)

Description copied from interface: RuleEngineService

Initializes all AbstractRulesModuleModels that are marked as active.

Specified by:

initializeAllRulesModules in interface RuleEngineService

Parameters:

propagateToOtherNodes - if true on all the nodes of cluster

Returns:

the activation results

updateEngineRule

@Deprecated
public RuleEngineActionResult updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule)

Deprecated. since 6.3

Specified by:

updateEngineRule in interface RuleEngineService

Parameters:

ruleEngineRule - Rule to be updated

Returns:

the result of the update action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

updateEngineRule

public RuleEngineActionResult updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule,
                                               AbstractRulesModuleModel rulesModule)

Description copied from interface: RuleEngineService

Updates the given rule if it already exists.

Specified by:

updateEngineRule in interface RuleEngineService

Parameters:

ruleEngineRule - Rule to be updated

rulesModule - AbstractRulesModuleModel where the Rule be updated

Returns:

the result of the update action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

archiveRule

public RuleEngineActionResult archiveRule(AbstractRuleEngineRuleModel ruleEngineRule)

Description copied from interface: RuleEngineService

Archives the given rule if it already exists.

Specified by:

archiveRule in interface RuleEngineService

Parameters:

ruleEngineRule - Rule to be archived

Returns:

the result of the archive action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

archiveRule

public RuleEngineActionResult archiveRule(AbstractRuleEngineRuleModel ruleEngineRule,
                                          AbstractRulesModuleModel rulesModule)

Description copied from interface: RuleEngineService

Archives the given rule if it already exists.

Specified by:

archiveRule in interface RuleEngineService

Parameters:

ruleEngineRule - Rule to be archived

rulesModule - AbstractRulesModuleModel where the Rule is archived

Returns:

the result of the archive action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

archiveRules

public <T extends DroolsRuleModel> java.util.Optional<InitializationFuture> archiveRules(java.util.Collection<T> engineRules)

Description copied from interface: RuleEngineService

Archive a collection of rules

Specified by:

archiveRules in interface RuleEngineService

Type Parameters:

T - subtype of DroolsRuleModel

Parameters:

engineRules - collection of DroolsRuleModel instances

Returns:

optional of InitializationFuture keeping the status of initialization

getRuleForCode

@Deprecated
public AbstractRuleEngineRuleModel getRuleForCode(java.lang.String code)

Deprecated. since 6.4

Specified by:

getRuleForCode in interface RuleEngineService

Parameters:

code - the rule code

Returns:

AbstractRuleEngineRuleModel for given code.

getRuleForCodeAndModule

public AbstractRuleEngineRuleModel getRuleForCodeAndModule(java.lang.String code,
                                                           java.lang.String moduleName)

Description copied from interface: RuleEngineService

Finds AbstractRuleEngineRuleModel for given code and module.

Specified by:

getRuleForCodeAndModule in interface RuleEngineService

Parameters:

code - the rule code

moduleName - the rules module name

Returns:

AbstractRuleEngineRuleModel for given code.

getRuleForUuid

public AbstractRuleEngineRuleModel getRuleForUuid(java.lang.String uuid)

Specified by:

getRuleForUuid in interface RuleEngineService

Parameters:

uuid - the rule uuid

Returns:

AbstractRuleEngineRuleModel for given uuid. Finds AbstractRuleEngineRuleModel for given uuid.

getRuleModuleForRule

@Deprecated
public AbstractRulesModuleModel getRuleModuleForRule(AbstractRuleEngineRuleModel rule)

Deprecated. since 6.3

Specified by:

getRuleModuleForRule in interface RuleEngineService

Parameters:

rule - the AbstractRuleEngineRuleModel

Returns:

AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel

getAgendaFilterFactory

protected AgendaFilterFactory getAgendaFilterFactory()

setAgendaFilterFactory

public void setAgendaFilterFactory(AgendaFilterFactory agendaFilterFactory)

getAgendaEventListenerFactory

protected AgendaEventListenerFactory getAgendaEventListenerFactory()

setAgendaEventListenerFactory

public void setAgendaEventListenerFactory(AgendaEventListenerFactory agendaEventListenerFactory)

getProcessEventListenerFactory

protected ProcessEventListenerFactory getProcessEventListenerFactory()

setProcessEventListenerFactory

public void setProcessEventListenerFactory(ProcessEventListenerFactory processEventListenerFactory)

getRuleRuntimeEventListenerFactory

protected RuleRuntimeEventListenerFactory getRuleRuntimeEventListenerFactory()

setRuleRuntimeEventListenerFactory

public void setRuleRuntimeEventListenerFactory(RuleRuntimeEventListenerFactory ruleRuntimeEventListenerFactory)

getRuleConfigurationProvider

protected RAOProvider getRuleConfigurationProvider()

setRuleConfigurationProvider

public void setRuleConfigurationProvider(RAOProvider ruleConfigurationProvider)

getRuleGroupExecutionProvider

protected RAOProvider getRuleGroupExecutionProvider()

setRuleGroupExecutionProvider

public void setRuleGroupExecutionProvider(RAOProvider ruleGroupExecutionProvider)

getPlatformRuleEngineService

protected RuleEngineService getPlatformRuleEngineService()

getEngineRuleDao

protected EngineRuleDao getEngineRuleDao()

setEngineRuleDao

public void setEngineRuleDao(EngineRuleDao engineRuleDao)

setPlatformRuleEngineService

public void setPlatformRuleEngineService(RuleEngineService ruleEngineService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getFactContextFactory

protected FactContextFactory getFactContextFactory()

setFactContextFactory

public void setFactContextFactory(FactContextFactory factContextFactory)