com.interfaceware.iguana.plugin
Class SourceMessageRequestCompletedEventInputs

java.lang.Object
  com.interfaceware.iguana.plugin.SourceMessageRequestCompletedEventInputs

public class SourceMessageRequestCompletedEventInputs
extends java.lang.Object

This class is used to pass data from Iguana to messageRequestCompleted event handlers.

Constructor Summary

SourceMessageRequestCompletedEventInputs()

SourceMessageRequestCompletedEventInputs(long Handle)

Method Summary

protected void	finalize()
java.lang.String	getMessageLogId() Id assigned by Iguana uniquely identifying the generated message within Iguana's logs.
boolean	getMessageProcessed() Flag indicating whether or not message was processed by Iguana.
java.lang.String	getPluginMessageId() Id assigned by the plugin's messageRequested event handler via the PluginMessageId property.
void	release()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceMessageRequestCompletedEventInputs

public SourceMessageRequestCompletedEventInputs()
                                         throws PluginException

Throws:

PluginException

SourceMessageRequestCompletedEventInputs

public SourceMessageRequestCompletedEventInputs(long Handle)
                                         throws PluginException

Throws:

PluginException

Method Detail

release

public void release()
             throws PluginException

Throws:

PluginException

finalize

protected void finalize()
                 throws PluginException

Overrides:

finalize in class java.lang.Object

Throws:

PluginException

getPluginMessageId

public java.lang.String getPluginMessageId()
                                    throws PluginException

Id assigned by the plugin's messageRequested event handler via the PluginMessageId property. This allows the plugin to associate each message request completed notification with the message sent to Iguana.

The format of the PluginMessageId is to be determined by the plugin author. Iguana does not interpret this value, other than by adding it to logs, and sending it back to the plugin.

Throws:

PluginException

getMessageLogId

public java.lang.String getMessageLogId()
                                 throws PluginException

Id assigned by Iguana uniquely identifying the generated message within Iguana's logs.

The Message Log Id may be used to query Iguana for additional message-related information.

See

http://www.interfaceware.com/manual/iguana4_using_message_id.html

Throws:

PluginException

getMessageProcessed

public boolean getMessageProcessed()
                            throws PluginException

Flag indicating whether or not message was processed by Iguana.

If true, the message has been processed by Iguana and does not need to be resent. The plugin should respond to the next messageRequested event with the next available message.

If false, the message has not been processed by Iguana and needs to be resent. The plugin should respond to the next messageRequested event with the same message.

Throws:

PluginException