Package 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	Description
DefaultCommerceRuleEngineService()

Method Summary

Modifier and Type	Method	Description
protected RuleEngineResultRAO	addRuleEngineResultRAO(RuleEvaluationContext context)	Adds a RuleEngineResultRAO to the facts of this context if it doesn't exist already.
RuleEngineActionResult	archiveRule(AbstractRuleEngineRuleModel ruleEngineRule)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811
RuleEngineActionResult	archiveRule(AbstractRuleEngineRuleModel ruleEngineRule, AbstractRulesModuleModel rulesModule)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811
<T extends DroolsRuleModel> java.util.Optional<InitializationFuture>	archiveRules(java.util.Collection<T> engineRules)	Archive a collection of rules
<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 EngineRuleDao	getEngineRuleDao()
protected java.util.Set<java.lang.Object>	getEventListners(DroolsRuleEngineContextModel ruleEngineContext)
protected FactContextFactory	getFactContextFactory()
protected RuleEngineService	getPlatformRuleEngineService()
protected ProcessEventListenerFactory	getProcessEventListenerFactory()
protected RAOProvider	getRuleConfigurationProvider()
AbstractRuleEngineRuleModel	getRuleForCodeAndModule(java.lang.String code, java.lang.String moduleName)	Finds AbstractRuleEngineRuleModel for given code and module.
AbstractRuleEngineRuleModel	getRuleForUuid(java.lang.String uuid)	Finds AbstractRuleEngineRuleModel for given uuid.
protected RAOProvider	getRuleGroupExecutionProvider()
protected RuleRuntimeEventListenerFactory	getRuleRuntimeEventListenerFactory()
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).
void	initialize(AbstractRulesModuleModel module, java.lang.String deployedMvnVersion, boolean propagateToOtherNodes, boolean enableIncrementalUpdate, RuleEngineActionResult result, ExecutionContext executionContext)	Since 18.08 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).
InitializationFuture	initialize(java.util.List<AbstractRulesModuleModel> modules, boolean propagateToOtherNodes, boolean enableIncrementalUpdate, ExecutionContext executionContext)	Since 6.7 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, 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

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

initialize

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

Description copied from interface: RuleEngineService

Since 18.08 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

executionContext - the instance of ExecutionContext to be set as executionContext of RuleEngineActionResult if not null

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

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

initialize

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

Description copied from interface: RuleEngineService

Since 6.7 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

executionContext - instance of ExecutionContext that serves as a storage for initialization related data

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)

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)

provideRAOs

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

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

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

@Deprecated(since="1811",
            forRemoval=true)
public RuleEngineActionResult archiveRule(AbstractRuleEngineRuleModel ruleEngineRule)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811

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

@Deprecated(since="1811",
            forRemoval=true)
public RuleEngineActionResult archiveRule(AbstractRuleEngineRuleModel ruleEngineRule,
                                          AbstractRulesModuleModel rulesModule)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811

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

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)

Description copied from interface: RuleEngineService

Finds AbstractRuleEngineRuleModel for given uuid.

Specified by:

getRuleForUuid in interface RuleEngineService

Parameters:

uuid - the rule uuid

Returns:

AbstractRuleEngineRuleModel for given uuid.

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)