com.ibm.commerce.context.content.resources.postpublish

Class PostPublishECEventListenerImpl

  • java.lang.Object
    • com.ibm.commerce.event.EventComponentConfiguration
      • com.ibm.commerce.event.impl.AbstractECEventListener
        • com.ibm.commerce.context.content.resources.postpublish.PostPublishECEventListenerImpl
  • All Implemented Interfaces:
    com.ibm.commerce.event.WCSEventListener, ComponentConfiguration, java.util.EventListener

    public class PostPublishECEventListenerImpl
extends com.ibm.commerce.event.impl.AbstractECEventListener
    An implementation of WCSEventListener that listens for Common Base Event events and processes post-publish events.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASS
      the class attribute of the PostPublishDataProcessor node in the post-publish configuration file.
      static java.lang.String DATA
      the name of the data attribute in the ExtendedDataElement object.
      static java.lang.String DATA_TOPIC_ID
      the name of the data topic ID attribute in the ExtendedDataElement object.
      static java.lang.String EDE_POST_PUBLISH_DATA
      the name of the ExtendedDataElement object in the post-publish event.
      static java.lang.String ID
      the id attribute of the PostPublishDataTopic node in the post-publish configuration file.
      static java.lang.String POST_PUBLISH_CONFIG_FILE
      the post-publish listener configuration file.
      static java.lang.String POST_PUBLISH_DATA_PROCESSOR
      the PostPublishDataProcessor node in the post-publish listener configuration file.
      static java.lang.String POST_PUBLISH_DATA_TOPIC
      the PostPublishDataTopic node in the post-publish listener configuration file.
      static java.lang.String POST_PUBLISH_DATA_TOPICS
      the PostPublishDataTopics node in the post-publish listener configuration file.
      static java.lang.String POST_PUBLISH_EC_EVENT
      the extension name of the post-publish event.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Class getECEventContainer()
      returns the class PostPublishECEventContainer as the event container.
      java.util.Set getEvents()
      returns a set that contains the extension name of the post-publish event.
      void initialize(java.net.URL configURL)
      initializes the utility by reading the post-publish configuration.
      void processEvent(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent commonBaseEvent)
      processes a post-publish event.

      • Methods inherited from class com.ibm.commerce.event.impl.AbstractECEventListener

        destroy, enable, getEventContainers, isTransactionRequired, processActivityEvent, registerEventContainer

      • Methods inherited from class com.ibm.commerce.event.EventComponentConfiguration

        init

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • POST_PUBLISH_EC_EVENT

        public static final java.lang.String POST_PUBLISH_EC_EVENT
        the extension name of the post-publish event.
        See Also:
        Constant Field Values

      • EDE_POST_PUBLISH_DATA

        public static final java.lang.String EDE_POST_PUBLISH_DATA
        the name of the ExtendedDataElement object in the post-publish event.
        See Also:
        Constant Field Values

      • DATA

        public static final java.lang.String DATA
        the name of the data attribute in the ExtendedDataElement object.
        See Also:
        Constant Field Values

      • DATA_TOPIC_ID

        public static final java.lang.String DATA_TOPIC_ID
        the name of the data topic ID attribute in the ExtendedDataElement object.
        See Also:
        Constant Field Values

      • POST_PUBLISH_CONFIG_FILE

        public static final java.lang.String POST_PUBLISH_CONFIG_FILE
        the post-publish listener configuration file.
        See Also:
        Constant Field Values

      • POST_PUBLISH_DATA_TOPICS

        public static final java.lang.String POST_PUBLISH_DATA_TOPICS
        the PostPublishDataTopics node in the post-publish listener configuration file.
        See Also:
        Constant Field Values

      • POST_PUBLISH_DATA_TOPIC

        public static final java.lang.String POST_PUBLISH_DATA_TOPIC
        the PostPublishDataTopic node in the post-publish listener configuration file.
        See Also:
        Constant Field Values

      • ID

        public static final java.lang.String ID
        the id attribute of the PostPublishDataTopic node in the post-publish configuration file.
        See Also:
        Constant Field Values

      • POST_PUBLISH_DATA_PROCESSOR

        public static final java.lang.String POST_PUBLISH_DATA_PROCESSOR
        the PostPublishDataProcessor node in the post-publish listener configuration file.
        See Also:
        Constant Field Values

      • CLASS

        public static final java.lang.String CLASS
        the class attribute of the PostPublishDataProcessor node in the post-publish configuration file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PostPublishECEventListenerImpl

        public PostPublishECEventListenerImpl()
        The default constructor.

    • Method Detail

      • getECEventContainer

        public java.lang.Class getECEventContainer()
        returns the class PostPublishECEventContainer as the event container.
        Specified by:
        getECEventContainer in class com.ibm.commerce.event.impl.AbstractECEventListener
        Returns:
        The PostPublishECEventContainer class.
        See Also:
        AbstractECEventListener.getECEventContainer()

      • getEvents

        public java.util.Set getEvents()
        returns a set that contains the extension name of the post-publish event.
        Specified by:
        getEvents in class com.ibm.commerce.event.impl.AbstractECEventListener
        Returns:
        A set with only the post-publish event extension name.
        See Also:
        AbstractECEventListener.getEvents()

      • processEvent

        public void processEvent(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent commonBaseEvent)
        processes a post-publish event.
        Specified by:
        processEvent in class com.ibm.commerce.event.impl.AbstractECEventListener
        Parameters:
        commonBaseEvent - The common base event to process.
        See Also:
        AbstractECEventListener.processEvent(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent)

      • initialize

        public void initialize(java.net.URL configURL)
                throws ECException
        initializes the utility by reading the post-publish configuration.
        Parameters:
        configURL - the URL of the post-publish configuration.
        Throws:
        ECException - a problem occurs when initializing the object.
Skip navigation links