de.hybris.platform.ruleenginebackoffice.actions

Class AbstractRuleCompilePublishComposer

java.lang.Object

ViewAnnotationAwareComposer

de.hybris.platform.ruleenginebackoffice.actions.AbstractRuleCompilePublishComposer

Direct Known Subclasses:

AbstractRuleCompileForModuleComposer, AbstractRuleUndeployFromModuleComposer, RuleArchiveComposer, RulesModuleSyncComposer

public abstract class AbstractRuleCompilePublishComposer
extends ViewAnnotationAwareComposer

Abstract class for the rule compile/publish composers with the global event listener binding

Constructor Summary

Constructors

Constructor and Description
AbstractRuleCompilePublishComposer()

Method Summary

Modifier and Type	Method and Description
void	doAfterCompose(Component component)
protected <T extends AbstractRuleModel> java.util.List<T>	getAffectedRules(java.util.List<T> rules) Provides a list of all the related rules for the provided rule set.
protected NotificationService	getNotificationService()
void	handleRuleEngineModuleSwapCompletedEvent(CockpitEvent event)
void	handleRuleUpdatedEvent(CockpitEvent event)
protected void	onException(java.lang.Exception exception) the method invoked upon exception
protected void	onJobTriggered(CronJobModel cronJob) the method invoked upon job being triggered
protected void	onPublishingError(java.lang.String failureReason, java.util.Collection<ResultItem> results) the method invoked upon publishing errors
protected void	onRuleUpdate(java.lang.String ruleCode) the method invoked upon rule update
protected abstract void	onSuccess(java.lang.String moduleName, java.lang.String previousModuleVersion, java.lang.String moduleVersion) the method invoked upon publishing success

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRuleCompilePublishComposer

public AbstractRuleCompilePublishComposer()

Method Detail

doAfterCompose

public void doAfterCompose(Component component)
                    throws java.lang.Exception

Throws:

java.lang.Exception

handleRuleEngineModuleSwapCompletedEvent

public void handleRuleEngineModuleSwapCompletedEvent(CockpitEvent event)

handleRuleUpdatedEvent

public void handleRuleUpdatedEvent(CockpitEvent event)

onSuccess

protected abstract void onSuccess(java.lang.String moduleName,
                                  java.lang.String previousModuleVersion,
                                  java.lang.String moduleVersion)

the method invoked upon publishing success

Parameters:

moduleName - name of the published module

previousModuleVersion - previous version of the module

moduleVersion - current version of the module

onPublishingError

protected void onPublishingError(java.lang.String failureReason,
                                 java.util.Collection<ResultItem> results)

the method invoked upon publishing errors

Parameters:

failureReason - failure reason message

results - collection of publishing results

onRuleUpdate

protected void onRuleUpdate(java.lang.String ruleCode)

the method invoked upon rule update

Parameters:

ruleCode - code of the updated rule

onException

protected void onException(java.lang.Exception exception)

the method invoked upon exception

Parameters:

exception - the exception encountered

onJobTriggered

protected void onJobTriggered(CronJobModel cronJob)

the method invoked upon job being triggered

Parameters:

cronJob - the cron job to be used in notification

getAffectedRules

protected <T extends AbstractRuleModel> java.util.List<T> getAffectedRules(java.util.List<T> rules)

Provides a list of all the related rules for the provided rule set. This method is intended to be used to identify all rules whose state might have been impacted by an action (such as publish/undeploy) triggered for one of the rules

Parameters:

rules - collection of rules

Returns:

list of all of the rules that are in a relationship to the provided rule set

getNotificationService

protected NotificationService getNotificationService()