de.hybris.platform.ruleengine.init.impl

Class DefaultRuleEngineKieModuleSwapper

java.lang.Object

de.hybris.platform.ruleengine.init.impl.DefaultRuleEngineKieModuleSwapper

All Implemented Interfaces:

RuleEngineKieModuleSwapper

public class DefaultRuleEngineKieModuleSwapper
extends Object
implements RuleEngineKieModuleSwapper

Default (drools-based) implementation of the RuleEngineKieModuleSwapper interface

Field Summary

Fields

Modifier and Type	Field and Description
static String	WORKER_PRE_DESTROY_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DefaultRuleEngineKieModuleSwapper()

Method Summary

Modifier and Type	Method and Description
String	activateKieModule(DroolsKIEModuleModel module) Updates the instance of DroolsKIEModuleModel with information about affectively deployed ReleaseId version
void	addKieBase(KieModuleModel module, KieFileSystem kfs, DroolsKIEBaseModel base, KIEModuleCacheBuilder cache) Adds new KieBaseModel to a KieModuleModel with all rules
void	addKieSession(KieBaseModel base, DroolsKIESessionModel session) Adds instance of new KieSessionModel to KieBaseModel
protected ResultItem	addNewResultItemOf(RuleEngineActionResult result, MessageLevel messageLevel, String message)
void	addRules(KieFileSystem kfs, DroolsKIEBaseModel base, KIEModuleCacheBuilder cache) Adds rules from a given DroolsKIEBaseModel to KieFileSystem
void	beforeDestroy() This method to be called by containers (like spring container) as destroy method
<any>	createKieModule(DroolsKIEModuleModel module, RuleEngineActionResult result) Creates the new instance of KieModule, based on information contained in DroolsKIEModuleModel
protected ConcurrentMapFactory	getConcurrentMapFactory()
protected ConfigurationService	getConfigurationService()
protected Tenant	getCurrentTenant()
Optional<ReleaseId>	getDeployedReleaseId(DroolsKIEModuleModel module, String deployedMvnVersion) Returns (optional) ReleaseId for a deployed version of the KieModuleModel
protected KieServices	getKieServices()
protected ModelService	getModelService()
ReleaseId	getReleaseId(DroolsKIEModuleModel module) Creates the new instance of ReleaseId based on DroolsKIEModuleModel
protected RuleEngineCacheService	getRuleEngineCacheService()
protected RulesModuleDao	getRulesModuleDao()
protected ThreadFactory	getTenantAwareThreadFactory()
protected long	getWorkerPreDestroyTimeout()
protected void	initializeNewModule(DroolsKIEModuleModel droolsKIEModuleModel, RuleEngineActionResult result, KieContainerListener listener)
protected boolean	isInitialEngineStartup(ReleaseId releaseId, String newDeployedMvnVersion)
protected void	registerWorker(String moduleName, Thread worker)
boolean	removeKieModuleIfPresent(ReleaseId releaseId, RuleEngineActionResult result) Tries to remove the KieModule with given ReleaseId from org.kie.api.builder.KieRepository
void	setConcurrentMapFactory(ConcurrentMapFactory concurrentMapFactory)
void	setConfigurationService(ConfigurationService configurationService)
void	setCurrentTenant(Tenant currentTenant)
protected void	setKieServices(KieServices kieServices)
void	setModelService(ModelService modelService)
void	setRuleEngineCacheService(RuleEngineCacheService ruleEngineCacheService)
void	setRulesModuleDao(RulesModuleDao rulesModuleDao)
void	setTenantAwareThreadFactory(ThreadFactory tenantAwareThreadFactory)
void	setup()
void	setUpKieServices() Initializes the org.kie.api.KieServices instance
List<Object>	switchKieModule(DroolsKIEModuleModel module, RuleEngineActionResult result, KieContainerListener listener, LinkedList<Supplier<Object>> postTaskList) Swaps synchroneously to a new KieModule.
void	switchKieModuleAsync(String moduleName, RuleEngineActionResult result, KieContainerListener listener, List<Object> resultsAccumulator, LinkedList<Supplier<Object>> postTaskList) Swaps asynchroneously to a new KieModule.
protected Runnable	switchKieModuleRunnableTask(String moduleName, RuleEngineActionResult result, KieContainerListener listener, List<Object> resultsAccumulator, LinkedList<Supplier<Object>> postTaskList)
void	waitForSwappingToFinish() Block until the whole swapping task/tasks are finished
protected void	waitWhileWorkerIsRunning(Thread worker)
void	writeKModuleXML(KieModuleModel module, KieFileSystem kfs) Creates the XML representation of KieModuleModel and writes it to KieFileSystem
void	writePomXML(DroolsKIEModuleModel module, KieFileSystem kfs) Write the building POM XML to KieFileSystem

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.ruleengine.init.RuleEngineKieModuleSwapper

convertLevel, getEqualityBehaviorOption, getEventProcessingOption, getSessionType

Field Detail

WORKER_PRE_DESTROY_TIMEOUT

public static final String WORKER_PRE_DESTROY_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

DefaultRuleEngineKieModuleSwapper

public DefaultRuleEngineKieModuleSwapper()

Method Detail

switchKieModule

public List<Object> switchKieModule(DroolsKIEModuleModel module,
                                    RuleEngineActionResult result,
                                    KieContainerListener listener,
                                    LinkedList<Supplier<Object>> postTaskList)

Description copied from interface: RuleEngineKieModuleSwapper

Swaps synchroneously to a new KieModule. It's a blocking call

Specified by:

switchKieModule in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of the AbstractRulesModuleModel module

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

listener - instance of KieContainerListener that fires when the switch of Kie Container is complete

postTaskList - chain of post-task operations incapsulated as a linked list of Supplier instances

Returns:

the list that will contain the method execution results including the post-tasks

switchKieModuleAsync

public void switchKieModuleAsync(String moduleName,
                                 RuleEngineActionResult result,
                                 KieContainerListener listener,
                                 List<Object> resultsAccumulator,
                                 LinkedList<Supplier<Object>> postTaskList)

Description copied from interface: RuleEngineKieModuleSwapper

Swaps asynchroneously to a new KieModule. It's a non-blocking call

Specified by:

switchKieModuleAsync in interface RuleEngineKieModuleSwapper

Parameters:

moduleName - kie module name

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

listener - instance of KieContainerListener that fires when the switch of Kie Container is complete

resultsAccumulator - the list that will contain the method execution results including the post-tasks

postTaskList - chain of post-task operations incapsulated as a linked list of Supplier instances

waitForSwappingToFinish

public void waitForSwappingToFinish()

Description copied from interface: RuleEngineKieModuleSwapper

Block until the whole swapping task/tasks are finished

Specified by:

waitForSwappingToFinish in interface RuleEngineKieModuleSwapper

waitWhileWorkerIsRunning

protected void waitWhileWorkerIsRunning(Thread worker)

beforeDestroy

public void beforeDestroy()

This method to be called by containers (like spring container) as destroy method

writeKModuleXML

public void writeKModuleXML(KieModuleModel module,
                            KieFileSystem kfs)

Description copied from interface: RuleEngineKieModuleSwapper

Creates the XML representation of KieModuleModel and writes it to KieFileSystem

Specified by:

writeKModuleXML in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of KieModuleModel

kfs - instance of KieFileSystem

writePomXML

public void writePomXML(DroolsKIEModuleModel module,
                        KieFileSystem kfs)

Description copied from interface: RuleEngineKieModuleSwapper

Write the building POM XML to KieFileSystem

Specified by:

writePomXML in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of DroolsKIEModuleModel to be used for ReleaseId creation

kfs - instance of KieFileSystem

getReleaseId

public ReleaseId getReleaseId(DroolsKIEModuleModel module)

Description copied from interface: RuleEngineKieModuleSwapper

Creates the new instance of ReleaseId based on DroolsKIEModuleModel

Specified by:

getReleaseId in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of DroolsKIEModuleModel

Returns:

newly created ReleaseId

createKieModule

public <any> createKieModule(DroolsKIEModuleModel module,
                             RuleEngineActionResult result)
                      throws DroolsInitializationException

Description copied from interface: RuleEngineKieModuleSwapper

Creates the new instance of KieModule, based on information contained in DroolsKIEModuleModel

Specified by:

createKieModule in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of DroolsKIEModuleModel

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

Returns:

pair of the newly created instance of KieModule and the corresponding caching structure for the created module

Throws:

DroolsInitializationException

addKieBase

public void addKieBase(KieModuleModel module,
                       KieFileSystem kfs,
                       DroolsKIEBaseModel base,
                       KIEModuleCacheBuilder cache)

Description copied from interface: RuleEngineKieModuleSwapper

Adds new KieBaseModel to a KieModuleModel with all rules

Specified by:

addKieBase in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of KieModuleModel to add the KieBaseModel to

kfs - instance of KieFileSystem

base - instance of DroolsKIEBaseModel that keeps the information for a KieBaseModel to be created

cache - the caching structure for the module being initialized

addKieSession

public void addKieSession(KieBaseModel base,
                          DroolsKIESessionModel session)

Description copied from interface: RuleEngineKieModuleSwapper

Adds instance of new KieSessionModel to KieBaseModel

Specified by:

addKieSession in interface RuleEngineKieModuleSwapper

Parameters:

base - instance of KieBaseModel

session - instance of DroolsKIESessionModel containing the information for new KieSessionModel

activateKieModule

public String activateKieModule(DroolsKIEModuleModel module)

Description copied from interface: RuleEngineKieModuleSwapper

Updates the instance of DroolsKIEModuleModel with information about affectively deployed ReleaseId version

Specified by:

activateKieModule in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of DroolsKIEModuleModel

Returns:

version of deployed ReleaseId

removeKieModuleIfPresent

public boolean removeKieModuleIfPresent(ReleaseId releaseId,
                                        RuleEngineActionResult result)

Description copied from interface: RuleEngineKieModuleSwapper

Tries to remove the KieModule with given ReleaseId from org.kie.api.builder.KieRepository

Specified by:

removeKieModuleIfPresent in interface RuleEngineKieModuleSwapper

Parameters:

releaseId - the instance of ReleaseId corresponding to a KieModule to be removed

result - instance of RuleEngineActionResult to be used in cluster nodes notification removal

Returns:

true if the module was found and removed, false otherwise

addRules

public void addRules(KieFileSystem kfs,
                     DroolsKIEBaseModel base,
                     KIEModuleCacheBuilder cache)

Description copied from interface: RuleEngineKieModuleSwapper

Adds rules from a given DroolsKIEBaseModel to KieFileSystem

Specified by:

addRules in interface RuleEngineKieModuleSwapper

Parameters:

kfs - instance of KieFileSystem

base - instance of DroolsKIEBaseModel containing the reference to the rules to publish

cache - the caching structure for the module being initialized

getDeployedReleaseId

public Optional<ReleaseId> getDeployedReleaseId(DroolsKIEModuleModel module,
                                                String deployedMvnVersion)

Description copied from interface: RuleEngineKieModuleSwapper

Returns (optional) ReleaseId for a deployed version of the KieModuleModel

Specified by:

getDeployedReleaseId in interface RuleEngineKieModuleSwapper

Parameters:

module - instance of DroolsKIEModuleModel

deployedMvnVersion - currently deployed releaseId version of the Kie Module, if known

Returns:

instance of Optional.of(ReleaseId) if the ReleaseId could be created, Optional.empty() otherwise

setUpKieServices

public void setUpKieServices()

Description copied from interface: RuleEngineKieModuleSwapper

Initializes the org.kie.api.KieServices instance

Specified by:

setUpKieServices in interface RuleEngineKieModuleSwapper

setup

@PostConstruct
public void setup()

initializeNewModule

protected void initializeNewModule(DroolsKIEModuleModel droolsKIEModuleModel,
                                   RuleEngineActionResult result,
                                   KieContainerListener listener)

addNewResultItemOf

protected ResultItem addNewResultItemOf(RuleEngineActionResult result,
                                        MessageLevel messageLevel,
                                        String message)

registerWorker

protected void registerWorker(String moduleName,
                              Thread worker)

switchKieModuleRunnableTask

protected Runnable switchKieModuleRunnableTask(String moduleName,
                                               RuleEngineActionResult result,
                                               KieContainerListener listener,
                                               List<Object> resultsAccumulator,
                                               LinkedList<Supplier<Object>> postTaskList)

isInitialEngineStartup

protected boolean isInitialEngineStartup(ReleaseId releaseId,
                                         String newDeployedMvnVersion)

getKieServices

protected KieServices getKieServices()

setKieServices

protected void setKieServices(KieServices kieServices)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getCurrentTenant

protected Tenant getCurrentTenant()

setCurrentTenant

public void setCurrentTenant(Tenant currentTenant)

getTenantAwareThreadFactory

protected ThreadFactory getTenantAwareThreadFactory()

setTenantAwareThreadFactory

public void setTenantAwareThreadFactory(ThreadFactory tenantAwareThreadFactory)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getRuleEngineCacheService

protected RuleEngineCacheService getRuleEngineCacheService()

setRuleEngineCacheService

public void setRuleEngineCacheService(RuleEngineCacheService ruleEngineCacheService)

getRulesModuleDao

protected RulesModuleDao getRulesModuleDao()

setRulesModuleDao

public void setRulesModuleDao(RulesModuleDao rulesModuleDao)

getConcurrentMapFactory

protected ConcurrentMapFactory getConcurrentMapFactory()

setConcurrentMapFactory

public void setConcurrentMapFactory(ConcurrentMapFactory concurrentMapFactory)

getWorkerPreDestroyTimeout

protected long getWorkerPreDestroyTimeout()