Package de.hybris.platform.ruleenginebackoffice.actions

Class AbstractRuleCompilePublishComposer

  • All Implemented Interfaces:
    java.io.Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>
    Direct Known Subclasses:
    AbstractRuleCompileForModuleComposer, AbstractRuleUndeployFromModuleComposer, RuleArchiveComposer, RulesModuleSyncComposer
    public abstract class AbstractRuleCompilePublishComposer
extends com.hybris.cockpitng.util.ViewAnnotationAwareComposer
    Abstract class for the rule compile/publish composers with the global event listener binding
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

        _separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

      • Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

        _applied

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void doAfterCompose​(org.zkoss.zk.ui.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 com.hybris.cockpitng.util.notifications.NotificationService getNotificationService()  
      void handleRuleEngineModuleSwapCompletedEvent​(com.hybris.cockpitng.core.events.CockpitEvent event)  
      void handleRuleUpdatedEvent​(com.hybris.cockpitng.core.events.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 com.hybris.cockpitng.util.ViewAnnotationAwareComposer

        invokeListenerMethod, scanEventListeners

      • Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

        alert, didActivate, getPage, willClone, willPassivate

      • Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

        doBeforeCompose, doBeforeComposeChildren, doCatch, doFinally

      • Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

        bindComponent, getController, onEvent, unbindComponent

      • 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​(org.zkoss.zk.ui.Component component)
                    throws java.lang.Exception
        Specified by:
        doAfterCompose in interface org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>
        Overrides:
        doAfterCompose in class com.hybris.cockpitng.util.ViewAnnotationAwareComposer
        Throws:
        java.lang.Exception

      • handleRuleEngineModuleSwapCompletedEvent

        public void handleRuleEngineModuleSwapCompletedEvent​(com.hybris.cockpitng.core.events.CockpitEvent event)

      • handleRuleUpdatedEvent

        public void handleRuleUpdatedEvent​(com.hybris.cockpitng.core.events.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 com.hybris.cockpitng.util.notifications.NotificationService getNotificationService()