com.ibm.commerce.bi.events.transmit

Interface GenericTransmitter


  • public interface GenericTransmitter
    This generic transmitter interface should be implemented by all classes which need to a provide a transport mechanism for the Common Base Events used for Analytics. The analytics event processor will call, in order:
    1. setConfiguration with a map of all the configuration attributes defined in the instance XML( Instance XML is the configuration file used by WebSphere Commerce which can be found at <WC_installdir>/instances/<instance>/xml/<instance>.xml. The instance XML that is used by runtime is <WAS_deploydir>/xml/config/wc-server.xml)
    2. setEvents with a Document rooted by the <CommonBaseEvents> element containing child <CommonBaseEvent> elements
    3. and finally, sendEvents to initiate the transfer

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      org.w3c.dom.Document getEvents()
      Returns the list of events that should be sent or have been sent.
      boolean sendEvents()
      Initiates the transmission of events based on success or failure, respectively.
      void setConfiguration(TypedProperty config)
      Provides the transmitter its configuration properties as defined in the instance XML.
      void setEvents(org.w3c.dom.Document events)
      Sets the list of events that should be sent.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Method Detail

      • setConfiguration

        void setConfiguration(TypedProperty config)
        Provides the transmitter its configuration properties as defined in the instance XML.
        Parameters:
        config - A TypedProperty map of all the attributes names and values corresponding to the <configuration> node in the instance XML as defined in the Analytics Event Processor component. (Instance XML is the configuration file used by WebSphere Commerce which can be found at <WC_installdir>/instances/<instance>/xml/<instance>.xml. The instance XML that is used by runtime is <WAS_deploydir>/xml/config/wc-server.xml).

      • setEvents

        void setEvents(org.w3c.dom.Document events)
        Sets the list of events that should be sent.
        Parameters:
        events - An XML Document that contains all of the processed common base events in the current transaction. The document is rooted with a <CommonBaseEvents> node with child <CommonBaseEvent> nodes for each event.

      • getEvents

        org.w3c.dom.Document getEvents()
        Returns the list of events that should be sent or have been sent.
        Returns:
        The XML Document of events that contains all of the processed common base events in the current transaction.

      • sendEvents

        boolean sendEvents()
        Initiates the transmission of events based on success or failure, respectively.
        Returns:
        true if the transmission was successful. false otherwise.
Skip navigation links
  • Prev Class
  • Next Class