com.ibm.broker.connector

Class OutputInteraction

  • java.lang.Object
    • com.ibm.broker.connector.OutputInteraction


  • public abstract class OutputInteraction
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      OutputConnector getConnector()
      Returns the OutputConnector that constructed this interaction.
      void initialize()
      This is called by the integration node when the OutputInteraction is constructed.
      void logSend()
      This is called by the integration node after send to allow the connector writer to do their own logging.
      abstract java.util.Properties send(java.util.Properties overrideProps, OutputRecord record)
      This is called by the integration node to send data to the system.
      java.lang.String sentDestination()
      This is called by the integration node after send to find out what destination was sent to.
      void terminate()
      This is called by the integration node when the OutputInteraction is no longer needed.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OutputInteraction

        public OutputInteraction(OutputConnector connector)
                          throws com.ibm.broker.plugin.MbException
        Throws:
        com.ibm.broker.plugin.MbException
    • Method Detail

      • send

        public abstract java.util.Properties send(java.util.Properties overrideProps,
                                                  OutputRecord record)
                                           throws com.ibm.broker.plugin.MbException
        This is called by the integration node to send data to the system. Throwing an exception will cause the message flow node to throw an exception for the messaging being currently processed.
        Parameters:
        overrideProps - The properties to override for this call.
        record - A record that represents the data to be sent.
        Returns:
        A Properties object containing entries to added to the WrittenDestination of the out going message.
        Throws:
        com.ibm.broker.plugin.MbException
      • initialize

        public void initialize()
                        throws com.ibm.broker.plugin.MbException
        This is called by the integration node when the OutputInteraction is constructed.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the message flow node to throw an exception for the messaging being currently processed.
      • terminate

        public void terminate()
                       throws com.ibm.broker.plugin.MbException
        This is called by the integration node when the OutputInteraction is no longer needed.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the exception to be written to the system log but no processing will be failed.
      • sentDestination

        public java.lang.String sentDestination()
                                         throws com.ibm.broker.plugin.MbException
        This is called by the integration node after send to find out what destination was sent to. The information is used in log entries to tell the end user where the data was sent. If it is not overridden then the connector key is used
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the message flow node to throw an exception for the messaging being currently processed.
      • logSend

        public void logSend()
                     throws com.ibm.broker.plugin.MbException
        This is called by the integration node after send to allow the connector writer to do their own logging. If it is not overridden then a standard activity log message is written using the details given in sentDestination.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an exception will cause the message flow node to throw an exception for the messaging being currently processed.
      • getConnector

        public final OutputConnector getConnector()
                                           throws com.ibm.broker.plugin.MbException
        Returns the OutputConnector that constructed this interaction.
        Throws:
        com.ibm.broker.plugin.MbException
IBM Integration BusTM
JavaTM Connector API