de.hybris.platform.ruleenginebackoffice.actions

Class AbstractRuleCompilePublishComposer

java.lang.Object

ViewAnnotationAwareComposer

de.hybris.platform.ruleenginebackoffice.actions.AbstractRuleCompilePublishComposer

Direct Known Subclasses:

AbstractRuleCompileForModuleComposer, AbstractRuleUndeployFromModuleComposer, 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
protected abstract void	buildCompilerErrorMessages(RuleCompilerPublisherResult ruleResults) the method to build the compiler error messages (called from within onCompilingError(RuleCompilerPublisherResult) ).
protected abstract void	buildCompilerProblems(RuleCompilerPublisherResult ruleResults) the method to build the compiler problems (called from within onCompilingError(RuleCompilerPublisherResult)).
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.
void	handleRuleEngineModuleSwapCompletedEvent(CockpitEvent event)
protected void	onCompilingError(RuleCompilerPublisherResult ruleResults) the method invoked upon compilation errors
protected abstract void	onPublishingError(java.lang.String failureReason, java.util.Collection<ResultItem> results) the method invoked upon publishing errors
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)

onCompilingError

protected void onCompilingError(RuleCompilerPublisherResult ruleResults)

the method invoked upon compilation errors

Parameters:

ruleResults - the rule compiling/publishing results

buildCompilerErrorMessages

protected abstract void buildCompilerErrorMessages(RuleCompilerPublisherResult ruleResults)

the method to build the compiler error messages (called from within onCompilingError(RuleCompilerPublisherResult) ).

Parameters:

ruleResults - the compiling/publishing results

buildCompilerProblems

protected abstract void buildCompilerProblems(RuleCompilerPublisherResult ruleResults)

the method to build the compiler problems (called from within onCompilingError(RuleCompilerPublisherResult)).

Parameters:

ruleResults - the compiling/publishing results

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 abstract 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

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