com.interfaceware.iguana.plugin
Interface DestinationListener

public interface DestinationListener

The listener interface for receiving Destination events. A class that is interested in processing a Destination event must implement this interface (and all the methods it contains). The listener object created from that class is then registered with a Destination object using the Destination's addListener method. When the Destination's state changes, the relevant method in the listener object is invoked. If you wish the Destination object to stop receiving notifications, use the Destination's removeListener method.

See Also:

Destination

Method Summary

void	disconnected() Event raised upon disconnection of the plugin from Iguana.
void	messageReceived(DestinationMessageReceivedEventInputs Inputs, DestinationMessageReceivedEventOutputs Outputs) Event raised upon receipt of a message from Iguana.
void	resubmissionPreviewMessageReceived(DestinationMessageReceivedEventInputs Inputs, DestinationMessageReceivedEventOutputs Outputs) Event raised upon receipt of a resubmission preview message from Iguana.

Method Detail

messageReceived

void messageReceived(DestinationMessageReceivedEventInputs Inputs,
                     DestinationMessageReceivedEventOutputs Outputs)

Event raised upon receipt of a message from Iguana.

Exceptions should never be allowed to propagate out of the event handler. Event handlers should catch and handle all exceptions internally.

Parameters:

Inputs - Input data from Iguana.

Outputs - Output data to send back to Iguana.

resubmissionPreviewMessageReceived

void resubmissionPreviewMessageReceived(DestinationMessageReceivedEventInputs Inputs,
                                        DestinationMessageReceivedEventOutputs Outputs)

Event raised upon receipt of a resubmission preview message from Iguana.

Plugins should simulate the processing that would be performed by the messageReceived event handler without causing external side effects. For example, database changes should not be made for resubmission preview messages.

Exceptions should never be allowed to propagate out of the event handler. Event handlers should catch and handle all exceptions internally.

Parameters:

Inputs - Input data from Iguana.

Outputs - Output data to send back to Iguana.

disconnected

void disconnected()

Event raised upon disconnection of the plugin from Iguana.

Will not be raised for failed connection attempts. Specifically, will not be raised if connect throws an exception as a result of a connection failure.

Exceptions should never be allowed to propagate out of the event handler. Event handlers should catch and handle all exceptions internally.