public abstract class PollingResult
extends java.lang.Object
IBM Integration Bus makes call backs to the PollingResult object during the processing of the PollingResult as follows:
logResult
is called when the PollingResult is about to be processed and needs to be logged to activity trace.buildInputRecord
is called when the record representing the PollingResult 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 PollingResult are required which are not part of the data. These details are written out to the LocalEnvironment tree.confirm
is called if the processing of the result was successful.
markAsFailed
is called if the processing of the result failed.
The connector writer constructs PollingResultwhich are returned to Integration Bus from the PollingInputConnector's readData method.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Constructor and Description |
---|
PollingResult(PollingInputConnector connector)
Initializes a new instance of the PollingResult class.
|
Modifier and Type | Method and Description |
---|---|
abstract InputRecord |
buildInputRecord()
This is called by the integration node when the record representing the result is required.
|
java.util.Properties |
buildProperties()
This is called by the integration node when the additional information in found in the record is required.
|
void |
confirm()
This is called by the integration node if the processing of the result completes without error.
|
PollingInputConnector |
getConnector()
Returns the owning NBPollingInputConnector.
|
void |
logResult()
This is called by the integration node after readData to allow the connector writer to do there own logging.
|
void |
markAsFailed()
This is called by the integration node if the processing of the result fails with an error.
|
java.lang.String |
resultSource()
This is called by the the integration node after a result is received.
|
public static final java.lang.String copyright
public PollingResult(PollingInputConnector connector) throws com.ibm.broker.plugin.MbException
connector
- The owning connector.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 resultSource() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void logResult() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public final PollingInputConnector getConnector() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException