SenderInterface

Each sender must implement this interface. It has the following methods:

Method

init

Method description

Initializes the sender, based on the contents of the deliveryConfig object, which contains gateway configuration information

Syntax

public void init (Context context, Config deliveryConfig)
       throws BCGSenderException

Parameters

context
Flow information associated with this sender
deliveryConfig
Gateway configuration details as specified in the Community Console

Method

send

Method description

Called by the SenderFramework. It sends the document to the destination using the information specified in the deliveryConfig object. It creates and updates the SenderResult object with delivery status, WebSphere Partner Gateway transport headers, and, in the case of a synchronous flow, the response document. If delivery fails, the sender may try transport retries.

Syntax

public SenderResult send(BusinessDocumentInterface document)

Parameters

document
The business document being sent

Method

cancel

Method description

Called by the SenderFramework. Stops message delivery and any transport retries.

Syntax

public SenderResult cancel()

Parameters

None

Copyright IBM Corp. 2003, 2005