com.ibm.broker.connector

Class EventInputConnector



  • public abstract class EventInputConnector
    extends InputConnector
    EventInputConnector is the base class which must be extended to implement a connector which can receive events from the system.

    It is used by IBM Integration Bus to listen and wait for events from a system. It is created by the ConnectorFactory object which must also be implemented by a connector writer.

    The EventInputConnector is constructed when a node requiring it's function is constructed (for example: a ComIbmEventInputNode). The following methods are called by IBM Integration Bus to interact with the connector:

    • initialize is called when a node using the connector is constructed.
    • start is called when a node using the connector is ready to receive data.
    • stop is called when a node using the connector is no longer ready to receive data.
    • Terminate is called when the node is stopped or destroyed.

    The connector writer constructs Event objects which are delivered to IBM Integration Bus by calling the deliverEvents method.

    • Constructor Detail

      • EventInputConnector

        public EventInputConnector(ConnectorFactory connectorFactory,
                                   java.lang.String name,
                                   java.util.Properties properties)
                            throws com.ibm.broker.plugin.MbException
        Constructor that must be used to create EventInputConnector objects.
        Parameters:
        name - the name given to the connector based on the flow and node name
        properties - the node properties used to construct this connector
        connectorFactory - the connection factory constructing this connector
        Throws:
        com.ibm.broker.plugin.MbException
    • Method Detail

      • logNoEvent

        public void logNoEvent()
                        throws com.ibm.broker.plugin.MbException
        This is called by the integration node when no events have been received for a while. If it is not overridden then a standard activity log message is written stating it is waiting for data. Throwing an exception will cause no activity log message to be written out.
        Throws:
        com.ibm.broker.plugin.MbException
      • deliverEvents

        public final void deliverEvents(Event[] events)
                                 throws com.ibm.broker.plugin.MbException
        Used to deliver Events to be processed by IBM Integration Bus. The method returns as soon as the events have been successfully delivered to the node, but before the events are processed within the message flow.
        Parameters:
        events - an array of events which the node using the connector must process
        Throws:
        com.ibm.broker.plugin.MbException
IBM Integration BusTM
JavaTM Connector API