public abstract class EventInputConnector
extends com.ibm.broker.connector.Connector
It is used by WebSphere Message Broker 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 Message Broker 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 Message Broker by calling the deliverEvents
method.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Constructor and Description |
---|
EventInputConnector(ConnectorFactory connectorFactory,
java.lang.String name,
java.util.Properties properties)
Constructor that must be used to create EventInputConnector objects.
|
Modifier and Type | Method and Description |
---|---|
void |
deliverEvents(Event[] events)
Used to deliver Events to be processed by message broker.
|
boolean |
isStarted()
isStarted reports the running state of the connector.
|
void |
logNoEvent()
This is called by the broker when no events have been received for a while.
|
void |
start()
Start is called when the node using the connector is ready to start receiving events.
|
void |
stop()
Stop is called when the node using the connector no longer wants to receive events.
|
public static final java.lang.String copyright
public EventInputConnector(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 start() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void logNoEvent() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void stop() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public final boolean isStarted() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public final void deliverEvents(Event[] events) throws com.ibm.broker.plugin.MbException
events
- an array of events which the node using the connector must processcom.ibm.broker.plugin.MbException