com.ibm.broker.connector

Class InputRecord

  • java.lang.Object
    • com.ibm.broker.connector.InputRecord
  • Direct Known Subclasses:
    ByteArrayInputRecord, ElementInputRecord


    public abstract class InputRecord
    extends java.lang.Object
    InputRecord is an abstract base class for records returned from Event.buildInputRecord or PollingResult.buildInputRecord A record represents a single message to be sent down a message flow.
    • Constructor Summary

      Constructors 
      Constructor and Description
      InputRecord() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getDestinationName()
      This is called by the broker to decide where the message will be sent.
      void setException(com.ibm.broker.plugin.MbException exception) 
      int validateData(com.ibm.broker.plugin.MbElement root)
      This is called by the integration node once the message tree has been constructed.
      • Methods inherited from class java.lang.Object

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

      • InputRecord

        public InputRecord()
                    throws com.ibm.broker.plugin.MbException
        Throws:
        com.ibm.broker.plugin.MbException
    • Method Detail

      • getDestinationName

        public java.lang.String getDestinationName()
        This is called by the broker to decide where the message will be sent. Return the name of the terminal or label that the message will be propagated to. The string that is returned is compared to the available the terminals on the node. If there is a match, that is where the message will be sent. If there is no match, then the string will be compared with the available labels and if there is a match then the message will be propagated to the corresponding Label node. If no match is made then an exception is thrown and the message will be sent to the failure terminal. In addition, throwing an Exception will also cause the message will be sent to the failure terminal. The default implementation will propagate the message to the 'Out' terminal. Returning an empty string means the message will not be propagated at all, and will be discarded.
      • validateData

        public int validateData(com.ibm.broker.plugin.MbElement root)
                         throws com.ibm.broker.plugin.MbException
        This is called by the integration node once the message tree has been constructed. Return OK if the data is constructed correctly. Return CONSUMED if the message must be discarded and not processed any further.
        Throws:
        com.ibm.broker.plugin.MbException - Throwing an MbException will cause the message will be sent to the failure terminal.
      • setException

        public void setException(com.ibm.broker.plugin.MbException exception)
IBM Integration BusTM
JavaTM Connector API