de.hybris.platform.ruleengine.impl

Class DefaultPlatformRuleEngineService

java.lang.Object

de.hybris.platform.ruleengine.impl.DefaultPlatformRuleEngineService

All Implemented Interfaces:

RuleEngineService

public class DefaultPlatformRuleEngineService
extends Object
implements RuleEngineService

The DefaultDroolsRuleEngineService allows initialization and evaluation of rules modules.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SWAPPING_IS_BLOCKING

Constructor Summary

Constructors

Constructor and Description
DefaultPlatformRuleEngineService()

Method Summary

Modifier and Type	Method and Description
protected void	addKieBaseModel(KieModuleModel module, KieFileSystem kfs, DroolsKIEBaseModel base) Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call
protected void	addKieSessionModel(KieBaseModel base, DroolsKIESessionModel session) Deprecated. to be substituted with RuleEngineKieModuleSwapper interface call
protected void	addRules(KieBaseModel kieBaseModel, KieFileSystem kfs, DroolsKIEBaseModel base) Deprecated. to be substituted with RuleEngineKieModuleSwapper interface method call
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.
protected MessageLevel	convertLevel(Level level) Deprecated.
protected KieModule	createKieModule(DroolsKIEModuleModel module, RuleEngineActionResult result) Deprecated. substituted by RuleEngineKieModuleSwapper interface methods
protected RuleEngineActionResult	createRuleEngineActionResult(String message, String moduleName, boolean success, MessageLevel level) creates a RuleEngineActionResult object with the given parameters.
protected RuleExecutionCountListener	createRuleExecutionCounterListener()
protected void	doSwapKieContainers(KieContainer kieContainer, KIEModuleCacheBuilder cache, RuleEngineActionResult ruleEngineActionResult, DroolsKIEModuleModel module, String deployedReleaseIdVersion, boolean propagateToOtherNodes)
RuleEvaluationResult	evaluate(RuleEvaluationContext context) Executes rule evaluation for given RuleEvaluationContext.
protected ConcurrentMapFactory	getConcurrentMapFactory()
protected ConfigurationService	getConfigurationService()
protected DroolsKIEBaseFinderStrategy	getDroolsKIEBaseFinderStrategy()
protected EngineRuleDao	getEngineRuleDao()
protected EqualityBehaviorOption	getEqualityBehaviorOption(DroolsEqualityBehavior behavior) Deprecated.
protected EventProcessingOption	getEventProcessingOption(DroolsEventProcessingMode eventProcessingMode) Deprecated.
protected EventService	getEventService()
protected MultiFlag	getInitializationMultiFlag()
protected KieServices	getKieServices()
protected ModelService	getModelService()
protected Lock	getReadLock()
protected ReadWriteLock	getReadWriteLock()
protected ReleaseId	getReleaseId(DroolsKIEModuleModel module) Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call
protected RuleEngineCacheService	getRuleEngineCacheService()
protected RuleEngineKieModuleSwapper	getRuleEngineKieModuleSwapper()
Class<? extends RuleExecutionCountListener>	getRuleExecutionCounterClass()
AbstractRuleEngineRuleModel	getRuleForCode(String code) Finds AbstractRuleEngineRuleModel for given code.
AbstractRuleEngineRuleModel	getRuleForUuid(String uuid) Finds AbstractRuleEngineRuleModel for given uuid.
protected RuleModuleFinderStrategy	getRuleModuleFinderStrategy()
AbstractRulesModuleModel	getRuleModuleForRule(AbstractRuleEngineRuleModel rule) Finds AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel.
protected RulesModuleDao	getRulesModuleDao()
protected KieSessionType	getSessionType(DroolsSessionType sessionType) Deprecated.
protected Lock	getWriteLock()
RuleEngineActionResult	initialize(AbstractRulesModuleModel module) Initializes the given rules module and propagates a RuleEngineInitializedEvent to other nodes.
RuleEngineActionResult	initialize(AbstractRulesModuleModel abstractModule, boolean propagateToOtherNodes) Deprecated. since 6.3. Please use initialize method instead
RuleEngineActionResult	initialize(AbstractRulesModuleModel abstractModule, String deployedMvnVersion, boolean propagateToOtherNodes) Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).
List<RuleEngineActionResult>	initializeAllRulesModules() Initializes all AbstractRulesModuleModels that are marked as active (in case of cluster mode - on all the nodes).
List<RuleEngineActionResult>	initializeAllRulesModules(boolean propagateToOtherNodes) Initializes all AbstractRulesModuleModels that are marked as active.
protected boolean	isBlocking()
protected boolean	isRuleEngineActive()
protected boolean	isSessionStateless(DroolsRuleEngineContextModel ruleEngineContext) Determine if the current RuleEngineContext's KieSession is Stateless.
protected Optional<ReleaseId>	lookupForDeployedReleaseId(DroolsKIEModuleModel kieModule)
protected void	notifyOtherNodes(RuleEngineActionResult result)
protected void	notifyOtherNodesAboutKieModuleSwapping(String moduleName, String deployedReleaseIdVersion)
protected void	populateRuleEngineActionResult(RuleEngineActionResult result, String message, String moduleName, boolean success, MessageLevel level) populates a RuleEngineActionResult object with the given parameters.
protected boolean	removeOldKieModuleIfSwapSuccessful(RuleEngineActionResult result, ReleaseId oldReleaseId)
void	setConcurrentMapFactory(ConcurrentMapFactory concurrentMapFactory)
void	setConfigurationService(ConfigurationService configurationService)
void	setDroolsKIEBaseFinderStrategy(DroolsKIEBaseFinderStrategy droolsKIEBaseFinderStrategy)
void	setEngineRuleDao(EngineRuleDao engineRuleDao)
void	setEventService(EventService eventService)
protected void	setKieServices(KieServices kieServices)
void	setModelService(ModelService modelService)
void	setRuleEngineCacheService(RuleEngineCacheService ruleEngineCacheService)
void	setRuleEngineKieModuleSwapper(RuleEngineKieModuleSwapper ruleEngineKieModuleSwapper)
void	setRuleExecutionCounterClass(Class<? extends RuleExecutionCountListener> ruleExecutionCounterClass)
void	setRuleModuleFinderStrategy(RuleModuleFinderStrategy ruleModuleFinderStrategy)
void	setRulesModuleDao(RulesModuleDao rulesModuleDao)
void	setup() The method is used to set the date format and KIEServices before the class is put into service(dependency injection).
void	setUpKieServices() Deprecated. substituted by analogous method in RuleEngineKieModuleSwapper The method is used to set KIEServices.
protected void	switchKieModule(DroolsKIEModuleModel module, RuleEngineActionResult result, KieContainerListener listener, boolean propagateToOtherNodes, Supplier<Object>... chainOfPostTasks) Switches the Kie modules in the rule execution context
protected ExecutionResultImpl	tryExecution(StatelessKieSession session, Command command, int currentAttempt) Deprecated. do not use, this method is subject to change without further notice.
RuleEngineActionResult	updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule) Updates the given rule if it already exists and returns true if update was successful.
RuleEngineActionResult	updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule, AbstractRulesModuleModel rulesModule) Updates the given rule if it already exists.
protected DroolsRuleEngineContextModel	validateRuleEvaluationContext(RuleEvaluationContext context)
protected void	writeKModuleXML(KieModuleModel module, KieFileSystem kfs) Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call
protected void	writePomXML(DroolsKIEModuleModel module, KieFileSystem kfs) Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call

Methods inherited from class java.lang.Object

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

Field Detail

SWAPPING_IS_BLOCKING

public static final String SWAPPING_IS_BLOCKING

See Also:

Constant Field Values

Constructor Detail

DefaultPlatformRuleEngineService

public DefaultPlatformRuleEngineService()

Method Detail

evaluate

public RuleEvaluationResult evaluate(RuleEvaluationContext context)

Description copied from interface: RuleEngineService

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

lookupForDeployedReleaseId

protected Optional<ReleaseId> lookupForDeployedReleaseId(DroolsKIEModuleModel kieModule)

validateRuleEvaluationContext

protected DroolsRuleEngineContextModel validateRuleEvaluationContext(RuleEvaluationContext context)

tryExecution

@Deprecated
protected ExecutionResultImpl tryExecution(StatelessKieSession session,
                                                       Command command,
                                                       int currentAttempt)

Deprecated. do not use, this method is subject to change without further notice.

isSessionStateless

protected boolean isSessionStateless(DroolsRuleEngineContextModel ruleEngineContext)

Determine if the current RuleEngineContext's KieSession is Stateless.

Parameters:

ruleEngineContext - the rule engine context

Returns:

true if stateless, false otherwise

initialize

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

Deprecated. since 6.3. Please use 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

public RuleEngineActionResult initialize(AbstractRulesModuleModel abstractModule,
                                         String deployedMvnVersion,
                                         boolean propagateToOtherNodes)

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

deployedMvnVersion - 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)

removeOldKieModuleIfSwapSuccessful

protected boolean removeOldKieModuleIfSwapSuccessful(RuleEngineActionResult result,
                                                     ReleaseId oldReleaseId)

isBlocking

protected boolean isBlocking()

switchKieModule

protected void switchKieModule(DroolsKIEModuleModel module,
                               RuleEngineActionResult result,
                               KieContainerListener listener,
                               boolean propagateToOtherNodes,
                               Supplier<Object>... chainOfPostTasks)

Switches the Kie modules in the rule execution context

Parameters:

module - instance of the DroolsKIEModuleModel module

result - instance of RuleEngineActionResult to be used for cluster nodes notification

listener - instance of KieContainerListener that implements the switching logic

chainOfPostTasks - chain of suppliers to be used as a sequence of post-swapping tasks

doSwapKieContainers

protected void doSwapKieContainers(KieContainer kieContainer,
                                   KIEModuleCacheBuilder cache,
                                   RuleEngineActionResult ruleEngineActionResult,
                                   DroolsKIEModuleModel module,
                                   String deployedReleaseIdVersion,
                                   boolean propagateToOtherNodes)

createKieModule

@Deprecated
protected KieModule createKieModule(DroolsKIEModuleModel module,
                                                RuleEngineActionResult result)
                                         throws DroolsInitializationException

Deprecated. substituted by RuleEngineKieModuleSwapper interface methods

Creates a KieModule based on the given DroolsKIEModuleModel object. This makes use of the following methods:

• addKieBaseModel(KieModuleModel, KieFileSystem, DroolsKIEBaseModel)
• addKieSessionModel(KieBaseModel, DroolsKIESessionModel)
• addRules(KieBaseModel, KieFileSystem, DroolsKIEBaseModel)
• writeKModuleXML(KieModuleModel, KieFileSystem)
• writePomXML(DroolsKIEModuleModel, KieFileSystem)

Parameters:

module - the module to create the KieModule from

Returns:

the created KieModule

Throws:

DroolsInitializationException - if any errors are encountered during the creation

notifyOtherNodes

protected void notifyOtherNodes(RuleEngineActionResult result)

notifyOtherNodesAboutKieModuleSwapping

protected void notifyOtherNodesAboutKieModuleSwapping(String moduleName,
                                                      String deployedReleaseIdVersion)

isRuleEngineActive

protected boolean isRuleEngineActive()

initialize

public RuleEngineActionResult initialize(AbstractRulesModuleModel module)

Description copied from interface: RuleEngineService

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

Specified by:

initialize in interface RuleEngineService

Parameters:

module - the module to be initialized

Returns:

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

initializeAllRulesModules

public 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

initializeAllRulesModules

public 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)

updateEngineRule

public RuleEngineActionResult updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule)

Description copied from interface: RuleEngineService

Updates the given rule if it already exists and returns true if update was successful.

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)

getRuleForCode

public AbstractRuleEngineRuleModel getRuleForCode(String code)

Description copied from interface: RuleEngineService

Finds AbstractRuleEngineRuleModel for given code.

Specified by:

getRuleForCode in interface RuleEngineService

Parameters:

code - the rule code

Returns:

AbstractRuleEngineRuleModel for given code.

getRuleForUuid

public AbstractRuleEngineRuleModel getRuleForUuid(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.

getRuleModuleForRule

public AbstractRulesModuleModel getRuleModuleForRule(AbstractRuleEngineRuleModel rule)

Description copied from interface: RuleEngineService

Finds AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel.

Specified by:

getRuleModuleForRule in interface RuleEngineService

Parameters:

rule - the AbstractRuleEngineRuleModel

Returns:

AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel

writeKModuleXML

@Deprecated
protected void writeKModuleXML(KieModuleModel module,
                                           KieFileSystem kfs)

Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call

writes the given module to the given kfs file system.

Parameters:

module - the kie module

kfs - the file system

writePomXML

@Deprecated
protected void writePomXML(DroolsKIEModuleModel module,
                                       KieFileSystem kfs)

Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call

writes the given module's pom file to the given kfs file system.

Parameters:

module - the kie module

kfs - the file system

addKieBaseModel

@Deprecated
protected void addKieBaseModel(KieModuleModel module,
                                           KieFileSystem kfs,
                                           DroolsKIEBaseModel base)

Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call

Creates a new kie base from the given module based on the given base. This method internally calls addRules(KieBaseModel, KieFileSystem, DroolsKIEBaseModel) and addKieSessionModel(KieBaseModel, DroolsKIESessionModel)

Parameters:

module - the kie module

kfs - the file system

base - the hybris KIE base object

addRules

@Deprecated
protected void addRules(KieBaseModel kieBaseModel,
                                    KieFileSystem kfs,
                                    DroolsKIEBaseModel base)

Deprecated. to be substituted with RuleEngineKieModuleSwapper interface method call

Adds the given base's rules to the given kfs.

Parameters:

kieBaseModel - the kieBaseModel

kfs - the file system

base - the hybris KIE base object

addKieSessionModel

@Deprecated
protected void addKieSessionModel(KieBaseModel base,
                                              DroolsKIESessionModel session)

Deprecated. to be substituted with RuleEngineKieModuleSwapper interface call

Creates a new kie session from the given base based on the given session.

Parameters:

base - the kie base

session - the hybris KIE session object

convertLevel

@Deprecated
protected MessageLevel convertLevel(Level level)

Deprecated.

converts a drools message Level to a MessageLevel.

getSessionType

@Deprecated
protected KieSessionType getSessionType(DroolsSessionType sessionType)

Deprecated.

converts between hybris and drools session type

getEventProcessingOption

@Deprecated
protected EventProcessingOption getEventProcessingOption(DroolsEventProcessingMode eventProcessingMode)

Deprecated.

converts between hybris and drools event processing mode

getEqualityBehaviorOption

@Deprecated
protected EqualityBehaviorOption getEqualityBehaviorOption(DroolsEqualityBehavior behavior)

Deprecated.

converts between hybris and drools equality behavior

createRuleExecutionCounterListener

protected RuleExecutionCountListener createRuleExecutionCounterListener()

getReleaseId

@Deprecated
protected ReleaseId getReleaseId(DroolsKIEModuleModel module)

Deprecated. Will be substituted by RuleEngineKieModuleSwapper interface call

public ReleaseId getReleaseId(final DroolsKIEModuleModel module) creates a ReleaseId based on the given module

Parameters:

module - the module to create the ReleaseId for

Returns:

the newly created ReleaseId

getRuleExecutionCounterClass

public Class<? extends RuleExecutionCountListener> getRuleExecutionCounterClass()

setRuleExecutionCounterClass

public void setRuleExecutionCounterClass(Class<? extends RuleExecutionCountListener> ruleExecutionCounterClass)

getEventService

protected EventService getEventService()

setEventService

public void setEventService(EventService eventService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

createRuleEngineActionResult

protected RuleEngineActionResult createRuleEngineActionResult(String message,
                                                              String moduleName,
                                                              boolean success,
                                                              MessageLevel level)

creates a RuleEngineActionResult object with the given parameters. The result contains one ResultItem object with the given message and level.

Parameters:

message - the message

moduleName - the module's name

success - whether the operation of this result was successful or not (sets RuleEngineActionResult.setActionFailed(boolean) with the negated value of success

level - the message level of the ResultItem

Returns:

a new RuleEngineActionResult object

populateRuleEngineActionResult

protected void populateRuleEngineActionResult(RuleEngineActionResult result,
                                              String message,
                                              String moduleName,
                                              boolean success,
                                              MessageLevel level)

populates a RuleEngineActionResult object with the given parameters. Changes the state of RuleEngineActionResult and should be used with care

Parameters:

result - the RuleEngineActionResult instance to be populated with given fields

message - the message

moduleName - the module's name

success - whether the operation of this result was successful or not (sets RuleEngineActionResult.setActionFailed(boolean) with the negated value of success

level - the message level of the ResultItem

setup

@PostConstruct
public void setup()

The method is used to set the date format and KIEServices before the class is put into service(dependency injection).

getEngineRuleDao

protected EngineRuleDao getEngineRuleDao()

setEngineRuleDao

public void setEngineRuleDao(EngineRuleDao engineRuleDao)

getRulesModuleDao

protected RulesModuleDao getRulesModuleDao()

setRulesModuleDao

public void setRulesModuleDao(RulesModuleDao rulesModuleDao)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getRuleModuleFinderStrategy

protected RuleModuleFinderStrategy getRuleModuleFinderStrategy()

setRuleModuleFinderStrategy

public void setRuleModuleFinderStrategy(RuleModuleFinderStrategy ruleModuleFinderStrategy)

getRuleEngineKieModuleSwapper

protected RuleEngineKieModuleSwapper getRuleEngineKieModuleSwapper()

setRuleEngineKieModuleSwapper

public void setRuleEngineKieModuleSwapper(RuleEngineKieModuleSwapper ruleEngineKieModuleSwapper)

getDroolsKIEBaseFinderStrategy

protected DroolsKIEBaseFinderStrategy getDroolsKIEBaseFinderStrategy()

setDroolsKIEBaseFinderStrategy

public void setDroolsKIEBaseFinderStrategy(DroolsKIEBaseFinderStrategy droolsKIEBaseFinderStrategy)

getRuleEngineCacheService

protected RuleEngineCacheService getRuleEngineCacheService()

setRuleEngineCacheService

public void setRuleEngineCacheService(RuleEngineCacheService ruleEngineCacheService)

getConcurrentMapFactory

protected ConcurrentMapFactory getConcurrentMapFactory()

setConcurrentMapFactory

public void setConcurrentMapFactory(ConcurrentMapFactory concurrentMapFactory)

getReadWriteLock

protected ReadWriteLock getReadWriteLock()

getReadLock

protected Lock getReadLock()

getWriteLock

protected Lock getWriteLock()

getKieServices

protected KieServices getKieServices()

setKieServices

protected void setKieServices(KieServices kieServices)

getInitializationMultiFlag

protected MultiFlag getInitializationMultiFlag()

setUpKieServices

@Deprecated
public void setUpKieServices()

Deprecated. substituted by analogous method in RuleEngineKieModuleSwapper The method is used to set KIEServices.