de.hybris.platform.ruleengineservices.maintenance.impl

Class DefaultRuleMaintenanceService

java.lang.Object

de.hybris.platform.ruleengineservices.maintenance.impl.DefaultRuleMaintenanceService

All Implemented Interfaces:

RuleMaintenanceService

public class DefaultRuleMaintenanceService
extends java.lang.Object
implements RuleMaintenanceService

Default implementation of RuleMaintenanceService

Constructor Summary

Constructors

Constructor and Description
DefaultRuleMaintenanceService()

Method Summary

Modifier and Type	Method and Description
protected RuleCompilerPublisherResult	archiveDeployedRule(java.util.List<AbstractRuleEngineRuleModel> deployedEngineRules) Deprecated. since 1811
protected RuleCompilerPublisherResult	archiveNonDeployedRule(AbstractRuleModel rule) Deprecated. since 1811
RuleCompilerPublisherResult	archiveRule(AbstractRuleModel rule) Deprecated. since 1811
<T extends SourceRuleModel> RuleCompilerPublisherResult	compileAndPublishRules(java.util.List<T> rules, java.lang.String moduleName, boolean enableIncrementalUpdate) Compiles and publishes rules
protected <T extends SourceRuleModel> RuleCompilerPublisherResult	compileAndPublishRules(java.util.List<T> rules, java.lang.String moduleName, boolean enableIncrementalUpdate, boolean blocking)
protected <T extends SourceRuleModel> RuleCompilerPublisherResult	compileAndPublishRules(java.util.List<T> rules, java.lang.String moduleName, boolean enableIncrementalUpdate, CronJobProgressTracker cronJobProgressTracker, boolean blocking)
<T extends SourceRuleModel> RuleCompilerPublisherResult	compileAndPublishRulesWithBlocking(java.util.List<T> rules, java.lang.String moduleName, boolean enableIncrementalUpdate) Compiles and publishes rules with blocking on initialization
<T extends SourceRuleModel> RuleCompilerPublisherResult	compileAndPublishRulesWithBlocking(java.util.List<T> rules, java.lang.String moduleName, boolean enableIncrementalUpdate, CronJobProgressTracker cronJobProgressTracker) Compiles and publishes rules with blocking on initialization
protected <T extends SourceRuleModel> RuleCompilerTaskResult	compileRules(java.util.List<T> rules, java.lang.String moduleName)
protected ExecutionContext	createExecutionContext(RuleCompilerTaskResult ruleCompilerTaskResult)
protected <S extends SourceRuleModel> java.util.Map<S,DroolsRuleModel>	getDeployedRules(DroolsKIEModuleModel module) Given the rule engine module get the map of source rules to deployed drools rules
protected EngineRuleDao	getEngineRuleDao()
protected EngineRulesRepository	getEngineRulesRepository()
protected EventService	getEventService()
protected ModelService	getModelService()
protected RuleCompilationContextProvider	getRuleCompilationContextProvider()
protected RuleEngineService	getRuleEngineService()
protected GuardedSuspension<java.lang.String>	getRulesCompilationGuardedSuspension()
protected RuleService	getRuleService()
protected DroolsKIEModuleModel	getRulesModuleByName(java.lang.String moduleName)
protected RulesModuleDao	getRulesModuleDao()
protected RulesModuleResolver	getRulesModuleResolver()
protected <S extends SourceRuleModel> java.util.Map<java.lang.String,S>	getSourceRulesByName(java.util.Collection<S> sourceRules) Maps provided collection of source rules to their names
RuleCompilerPublisherResult	initializeAllModules(boolean enableIncrementalUpdate) Publish/re-publish drools rules for a all available modules
RuleCompilerPublisherResult	initializeModule(java.lang.String moduleName, boolean enableIncrementalUpdate) Publish/re-publish drools rules for a specific module
protected <S extends SourceRuleModel> boolean	isSourceRuleDeployed(java.util.Map<java.lang.String,S> deployedRulesMap, SourceRuleModel sourceRule) Given the map of deployed source rules, verify whether the provided rule instance makes part of it
protected void	logCompilerErrors(RuleCompilerTaskResult ruleCompilerTaskResult)
protected void	onCompileErrorCleanup(RuleCompilerTaskResult result, java.lang.String moduleName)
void	setEngineRuleDao(EngineRuleDao engineRuleDao)
void	setEngineRulesRepository(EngineRulesRepository engineRulesRepository)
void	setEventService(EventService eventService)
void	setModelService(ModelService modelService)
void	setRuleCompilationContextProvider(RuleCompilationContextProvider ruleCompilationContextProvider)
void	setRuleEngineService(RuleEngineService ruleEngineService)
void	setRulesCompilationGuardedSuspension(GuardedSuspension<java.lang.String> rulesCompilationGuardedSuspension)
void	setRuleService(RuleService ruleService)
void	setRulesModuleDao(RulesModuleDao rulesModuleDao)
void	setRulesModuleResolver(RulesModuleResolver rulesModuleResolver)
java.util.Optional<RuleCompilerPublisherResult>	synchronizeModules(java.lang.String sourceModuleName, java.lang.String targetModuleName) Synchronize the deployed rules between two modules.
<T extends SourceRuleModel> java.util.Optional<RuleCompilerPublisherResult>	undeployRules(java.util.List<T> rules, java.lang.String moduleName) "Undeploy" (deactivate) the rules in the rule engine
protected void	updateCronJobTracker(CronJobProgressTracker tracker, int itemsTotal, int itemsProcessed)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRuleMaintenanceService

public DefaultRuleMaintenanceService()

Method Detail

archiveRule

@Deprecated
public RuleCompilerPublisherResult archiveRule(AbstractRuleModel rule)

Deprecated. since 1811

Description copied from interface: RuleMaintenanceService

Archives given rule

Specified by:

archiveRule in interface RuleMaintenanceService

Parameters:

rule - - rule to archive

Returns:

instance of RuleCompilerPublisherResult containing the status of rule archiving

archiveNonDeployedRule

@Deprecated
protected RuleCompilerPublisherResult archiveNonDeployedRule(AbstractRuleModel rule)

Deprecated. since 1811

archiveDeployedRule

@Deprecated
protected RuleCompilerPublisherResult archiveDeployedRule(java.util.List<AbstractRuleEngineRuleModel> deployedEngineRules)

Deprecated. since 1811

compileAndPublishRulesWithBlocking

public <T extends SourceRuleModel> RuleCompilerPublisherResult compileAndPublishRulesWithBlocking(java.util.List<T> rules,
                                                                                                  java.lang.String moduleName,
                                                                                                  boolean enableIncrementalUpdate)

Description copied from interface: RuleMaintenanceService

Compiles and publishes rules with blocking on initialization

Specified by:

compileAndPublishRulesWithBlocking in interface RuleMaintenanceService

Parameters:

rules - - list of rules to compile and publish

moduleName - Rules module name

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

Returns:

instance of RuleCompilerPublisherResult containing the status of rules compilation and publication

compileAndPublishRulesWithBlocking

public <T extends SourceRuleModel> RuleCompilerPublisherResult compileAndPublishRulesWithBlocking(java.util.List<T> rules,
                                                                                                  java.lang.String moduleName,
                                                                                                  boolean enableIncrementalUpdate,
                                                                                                  CronJobProgressTracker cronJobProgressTracker)

Description copied from interface: RuleMaintenanceService

Compiles and publishes rules with blocking on initialization

Specified by:

compileAndPublishRulesWithBlocking in interface RuleMaintenanceService

Parameters:

rules - - list of rules to compile and publish

moduleName - Rules module name

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

cronJobProgressTracker - instance of CronJobProgressTracker used by cron job framework to track the job execution

Returns:

instance of RuleCompilerPublisherResult containing the status of rules compilation and publication

compileAndPublishRules

public <T extends SourceRuleModel> RuleCompilerPublisherResult compileAndPublishRules(java.util.List<T> rules,
                                                                                      java.lang.String moduleName,
                                                                                      boolean enableIncrementalUpdate)

Description copied from interface: RuleMaintenanceService

Compiles and publishes rules

Specified by:

compileAndPublishRules in interface RuleMaintenanceService

Parameters:

rules - - list of rules to compile and publish

moduleName - Rules module name

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

Returns:

instance of RuleCompilerPublisherResult containing the status of rules compilation and publication

initializeModule

public RuleCompilerPublisherResult initializeModule(java.lang.String moduleName,
                                                    boolean enableIncrementalUpdate)

Description copied from interface: RuleMaintenanceService

Publish/re-publish drools rules for a specific module

Specified by:

initializeModule in interface RuleMaintenanceService

Parameters:

moduleName - Rules module name to publish the rules for

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

Returns:

instance of RuleCompilerPublisherResult containing the status of rules compilation and publication

initializeAllModules

public RuleCompilerPublisherResult initializeAllModules(boolean enableIncrementalUpdate)

Description copied from interface: RuleMaintenanceService

Publish/re-publish drools rules for a all available modules

Specified by:

initializeAllModules in interface RuleMaintenanceService

Parameters:

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

Returns:

instance of RuleCompilerPublisherResult containing the status of rules compilation and publication

undeployRules

public <T extends SourceRuleModel> java.util.Optional<RuleCompilerPublisherResult> undeployRules(java.util.List<T> rules,
                                                                                                 java.lang.String moduleName)

Description copied from interface: RuleMaintenanceService

"Undeploy" (deactivate) the rules in the rule engine

Specified by:

undeployRules in interface RuleMaintenanceService

Type Parameters:

T - type of the SourceRuleModel

Parameters:

rules - instances of SourceRuleModel to undeploy from module if they were deployed

moduleName - the name of the rules module to undeploy the rules from

Returns:

Optional of RuleCompilerPublisherResult containing the status of rules compilation and publication

synchronizeModules

public java.util.Optional<RuleCompilerPublisherResult> synchronizeModules(java.lang.String sourceModuleName,
                                                                          java.lang.String targetModuleName)

Description copied from interface: RuleMaintenanceService

Synchronize the deployed rules between two modules. The result after synchronisation should be a complete alignment of source rules (including their versions) deployed for target module with those deployed for source module

Specified by:

synchronizeModules in interface RuleMaintenanceService

Parameters:

sourceModuleName - The name of the module to be used as a source for synchronisation

targetModuleName - The name of the module to be used as a target for synchronisation

Returns:

Optional of RuleCompilerPublisherResult containing the status of rules compilation and publication for target module

isSourceRuleDeployed

protected <S extends SourceRuleModel> boolean isSourceRuleDeployed(java.util.Map<java.lang.String,S> deployedRulesMap,
                                                                   SourceRuleModel sourceRule)

Given the map of deployed source rules, verify whether the provided rule instance makes part of it

Type Parameters:

S - type of the source rule

Parameters:

deployedRulesMap - map of deployed source rules (by name)

sourceRule - source rule instance to check

Returns:

true if the provided source rule instance makes part of deployed rules. False otherwise

getSourceRulesByName

protected <S extends SourceRuleModel> java.util.Map<java.lang.String,S> getSourceRulesByName(java.util.Collection<S> sourceRules)

Maps provided collection of source rules to their names

Type Parameters:

S - generic type of source rules

Parameters:

sourceRules - collection of source rules to map

Returns:

map of source rules by code

getDeployedRules

protected <S extends SourceRuleModel> java.util.Map<S,DroolsRuleModel> getDeployedRules(DroolsKIEModuleModel module)

Given the rule engine module get the map of source rules to deployed drools rules

Type Parameters:

S - generic type of source rules

Parameters:

module - instance of DroolsKIEModuleModel to find a map for

Returns:

map of deployed drools rule by corresponding source rule

compileAndPublishRules

protected <T extends SourceRuleModel> RuleCompilerPublisherResult compileAndPublishRules(java.util.List<T> rules,
                                                                                         java.lang.String moduleName,
                                                                                         boolean enableIncrementalUpdate,
                                                                                         boolean blocking)

compileAndPublishRules

protected <T extends SourceRuleModel> RuleCompilerPublisherResult compileAndPublishRules(java.util.List<T> rules,
                                                                                         java.lang.String moduleName,
                                                                                         boolean enableIncrementalUpdate,
                                                                                         CronJobProgressTracker cronJobProgressTracker,
                                                                                         boolean blocking)

onCompileErrorCleanup

protected void onCompileErrorCleanup(RuleCompilerTaskResult result,
                                     java.lang.String moduleName)

createExecutionContext

protected ExecutionContext createExecutionContext(RuleCompilerTaskResult ruleCompilerTaskResult)

updateCronJobTracker

protected void updateCronJobTracker(CronJobProgressTracker tracker,
                                    int itemsTotal,
                                    int itemsProcessed)

compileRules

protected <T extends SourceRuleModel> RuleCompilerTaskResult compileRules(java.util.List<T> rules,
                                                                          java.lang.String moduleName)

getRulesModuleByName

protected DroolsKIEModuleModel getRulesModuleByName(java.lang.String moduleName)

logCompilerErrors

protected void logCompilerErrors(RuleCompilerTaskResult ruleCompilerTaskResult)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getRuleEngineService

protected RuleEngineService getRuleEngineService()

setRuleEngineService

public void setRuleEngineService(RuleEngineService ruleEngineService)

getRulesModuleDao

protected RulesModuleDao getRulesModuleDao()

setRulesModuleDao

public void setRulesModuleDao(RulesModuleDao rulesModuleDao)

getRuleService

protected RuleService getRuleService()

setRuleService

public void setRuleService(RuleService ruleService)

getRuleCompilationContextProvider

protected RuleCompilationContextProvider getRuleCompilationContextProvider()

setRuleCompilationContextProvider

public void setRuleCompilationContextProvider(RuleCompilationContextProvider ruleCompilationContextProvider)

getRulesModuleResolver

protected RulesModuleResolver getRulesModuleResolver()

setRulesModuleResolver

public void setRulesModuleResolver(RulesModuleResolver rulesModuleResolver)

getRulesCompilationGuardedSuspension

protected GuardedSuspension<java.lang.String> getRulesCompilationGuardedSuspension()

setRulesCompilationGuardedSuspension

public void setRulesCompilationGuardedSuspension(GuardedSuspension<java.lang.String> rulesCompilationGuardedSuspension)

getEngineRulesRepository

protected EngineRulesRepository getEngineRulesRepository()

setEngineRulesRepository

public void setEngineRulesRepository(EngineRulesRepository engineRulesRepository)

getEventService

protected EventService getEventService()

setEventService

public void setEventService(EventService eventService)

getEngineRuleDao

protected EngineRuleDao getEngineRuleDao()

setEngineRuleDao

public void setEngineRuleDao(EngineRuleDao engineRuleDao)