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.

Constructor Summary

Constructors

Constructor and Description
DefaultPlatformRuleEngineService()

Method Summary

Modifier and Type	Method and Description
protected void	addKieBaseModel(KieModuleModel module, KieFileSystem kfs, DroolsKIEBaseModel base) Creates a new kie base from the given module based on the given base.
protected void	addKieSessionModel(KieBaseModel base, DroolsKIESessionModel session) Creates a new kie session from the given base based on the given session.
protected void	addRules(KieBaseModel kieBaseModel, KieFileSystem kfs, DroolsKIEBaseModel base) Adds the given base's rules to the given kfs.
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) converts a drools message Level to a MessageLevel.
protected KieModule	createKieModule(DroolsKIEModuleModel module, RuleEngineActionResult result) Creates a KieModule based on the given DroolsKIEModuleModel object.
protected RuleEngineActionResult	createRuleEngineActionResult(String message, String moduleName, boolean success, MessageLevel level) creates a RuleEngineActionResult object with the given parameters.
protected RuleExecutionCountListener	createRuleExecutionCounterListener()
RuleEvaluationResult	evaluate(RuleEvaluationContext context) Executes rule evaluation for given RuleEvaluationContext.
protected ConfigurationService	getConfigurationService()
protected DroolsKIEBaseFinderStrategy	getDroolsKIEBaseFinderStrategy()
protected EngineRuleDao	getEngineRuleDao()
protected EqualityBehaviorOption	getEqualityBehaviorOption(DroolsEqualityBehavior behavior) converts between hybris and drools equality behavior
protected EventProcessingOption	getEventProcessingOption(DroolsEventProcessingMode eventProcessingMode) converts between hybris and drools event processing mode
protected EventService	getEventService()
protected KieServices	getKieServices()
protected ModelService	getModelService()
protected Lock	getReadLock()
protected ReadWriteLock	getReadWriteLock()
protected ReleaseId	getReleaseId(DroolsKIEModuleModel module) creates a ReleaseId based on the given module
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) converts between hybris and drools session type
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) 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	isRuleEngineActive()
protected boolean	isSessionStateless(DroolsRuleEngineContextModel ruleEngineContext) Determine if the current RuleEngineContext's KieSession is Stateless.
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	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() The method is used to set KIEServices.
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 void	writeKModuleXML(KieModuleModel module, KieFileSystem kfs) writes the given module to the given kfs file system.
protected void	writePomXML(DroolsKIEModuleModel module, KieFileSystem kfs) writes the given module's pom file to the given kfs file system.

Methods inherited from class java.lang.Object

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

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

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 -

Returns:

true if stateless, false otherwise

initialize

public RuleEngineActionResult initialize(AbstractRulesModuleModel abstractModule,
                                         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

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)

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

createKieModule

protected KieModule createKieModule(DroolsKIEModuleModel module,
                                    RuleEngineActionResult result)
                             throws de.hybris.platform.ruleengine.impl.DefaultPlatformRuleEngineService.DroolsInitializationException

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

de.hybris.platform.ruleengine.impl.DefaultPlatformRuleEngineService.DroolsInitializationException

writeKModuleXML

protected void writeKModuleXML(KieModuleModel module,
                               KieFileSystem kfs)

writes the given module to the given kfs file system.

Parameters:

module - the kie module

kfs - the file system

writePomXML

protected void writePomXML(DroolsKIEModuleModel module,
                           KieFileSystem kfs)

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

Parameters:

module - the kie module

kfs - the file system

addKieBaseModel

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

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

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

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

protected void addKieSessionModel(KieBaseModel base,
                                  DroolsKIESessionModel session)

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

protected MessageLevel convertLevel(Level level)

converts a drools message Level to a MessageLevel.

getSessionType

protected KieSessionType getSessionType(DroolsSessionType sessionType)

converts between hybris and drools session type

getEventProcessingOption

protected EventProcessingOption getEventProcessingOption(DroolsEventProcessingMode eventProcessingMode)

converts between hybris and drools event processing mode

getEqualityBehaviorOption

protected EqualityBehaviorOption getEqualityBehaviorOption(DroolsEqualityBehavior behavior)

converts between hybris and drools equality behavior

createRuleExecutionCounterListener

protected RuleExecutionCountListener createRuleExecutionCounterListener()

getReleaseId

protected ReleaseId getReleaseId(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

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)

getDroolsKIEBaseFinderStrategy

protected DroolsKIEBaseFinderStrategy getDroolsKIEBaseFinderStrategy()

setDroolsKIEBaseFinderStrategy

public void setDroolsKIEBaseFinderStrategy(DroolsKIEBaseFinderStrategy droolsKIEBaseFinderStrategy)

getReadWriteLock

protected ReadWriteLock getReadWriteLock()

getReadLock

protected Lock getReadLock()

getWriteLock

protected Lock getWriteLock()

getKieServices

protected KieServices getKieServices()

setKieServices

protected void setKieServices(KieServices kieServices)

setUpKieServices

public void setUpKieServices()

The method is used to set KIEServices.