com.ibm.broker.connector

Class InputConnector

  • Direct Known Subclasses:
    EventInputConnector, PollingInputConnector


    public abstract class InputConnector
    extends Connector
    InputConnector is an abstract base class for all Input connectors. It should not be extended by the user, but is extended by the system. It is used by IBM Integration Bus to listen and wait for data from a system.
    • Constructor Detail

      • InputConnector

        public InputConnector(ConnectorFactory connectorFactory,
                              java.lang.String name,
                              java.util.Properties properties)
                       throws com.ibm.broker.plugin.MbException
        Constructor that must be used to create InputConnector 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
        securityIdentity - the securityIdentity used by this connector to retrieve authentication credentials
        Throws:
        com.ibm.broker.plugin.MbException
    • Method Detail

      • start

        public void start()
                   throws com.ibm.broker.plugin.MbException
        Start is called when the node using the connector is ready to start receiving data. Any initializition of connections to the end system should be done at this step. If an exception is thrown then the error is reported to the system log and start is called again after a short wait.
        Throws:
        com.ibm.broker.plugin.MbException
      • stop

        public void stop()
                  throws com.ibm.broker.plugin.MbException
        stop is called when the integration node using the connector no longer wants to receive data. If an exception is thrown then the error is reported to the system log and the connector goes into stopped state. Stop is not called again untill after another start has been called.
        Throws:
        com.ibm.broker.plugin.MbException
      • isStarted

        public final boolean isStarted()
                                throws com.ibm.broker.plugin.MbException
        isStarted reports the running state of the connector. It is always set to true before start() is called and set to false before stop is called. Throwing an exception from either stop or start does not affect the running state of the connector.
        Returns:
        Running state of the connector. true means connector is running and should collect data. false means connector is stopped and should stop collecting data.
        Throws:
        com.ibm.broker.plugin.MbException
IBM Integration BusTM
JavaTM Connector API