public abstract class PollingInputConnector extends InputConnector
It is used by IBM Integration Bus to obtain data from a system. It is created by the ConnectorFactory object which must also be implemented by a connector writer.
The PollingInputConnector is constructed when a node requiring it's function is constructed (for example: a ComIbmPollingInputNode). 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 PollingResult objects which are returned to Integration Bus from the ReadData method.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Constructor and Description |
---|
PollingInputConnector(ConnectorFactory connectorFactory,
java.lang.String name,
java.util.Properties properties)
Constructor that must be used to create PollingInputConnector objects.
|
Modifier and Type | Method and Description |
---|---|
void |
logNoData()
If it is not overridden then a standard activity log message is written stating it is waiting for data.
|
abstract PollingResult |
readData(long timeout)
Called by the Integration Bus to obtain data to be processed.
|
isStarted, start, stop
deccrementStatValue, decrementStatValue, getConnectorFactory, getName, getProperties, incrementStatValue, incrementStatValue, initialize, terminate, writeActivityLog, writeActivityLog
public static final java.lang.String copyright
public PollingInputConnector(ConnectorFactory connectorFactory, java.lang.String name, java.util.Properties properties) throws com.ibm.broker.plugin.MbException
name
- the name given to the connector based on the flow and node nameproperties
- the node properties used to construct this connectorconnectorFactory
- the connection factory constructing this connectorcom.ibm.broker.plugin.MbException
public void logNoData() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public abstract PollingResult readData(long timeout) throws com.ibm.broker.plugin.MbException
timeout
- The maximum time the method should wait for data before returning.com.ibm.broker.plugin.MbException