public abstract class Event
extends java.lang.Object
The connector writer implements and constructs event objects, which are delivered to Message Broker for processing by calling the deliverEvents method on the EventInputConnector.
Message broker makes call backs to the Event object during the processing of the Event as follows:
logEvent
is called when the event is about to be processed and needs to be logged to activity trace.
buildInputRecord
is called when the record representing the Event is required. The record is used to construct the message that is processed in the message flow.buildProperties
is called when extra details about the event are required which are not part of the data. These details are written out to the local environment.confirm
is called if the processing of the event was successful.
markAsFailed
is called if the processing of the event failed.
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 |
---|
Event() |
Modifier and Type | Method and Description |
---|---|
abstract InputRecord |
buildInputRecord()
This is called by broker when the record representing the Event is required.
|
java.util.Properties |
buildProperties()
This is called by broker when the additional information on found in the record is required.
|
void |
confirm()
This is called by broker if the processing of the event completes with out error.
|
java.lang.String |
eventSource()
This is called by the broker after an event is received.
|
EventInputConnector |
getConnector() |
void |
logEvent()
This is called by the broker after send to allow the connector writer to do there own logging.
|
void |
markAsFailed()
This is called by broker if the processing of the event fails with an error.
|
public static final java.lang.String copyright
public Event() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public abstract InputRecord buildInputRecord() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public java.util.Properties buildProperties() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void confirm() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void markAsFailed() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public java.lang.String eventSource() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void logEvent() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public final EventInputConnector getConnector() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException