com.mirth.connect.userutil
Class ImmutableMessage

java.lang.Object
  com.mirth.connect.userutil.ImmutableMessage

public class ImmutableMessage
extends java.lang.Object

This class represents an overall message and is used to retrieve details such as the message ID, specific connector messages, or the merged connector message.

Constructor Summary

ImmutableMessage(com.mirth.connect.donkey.model.message.Message message)
Instantiates a new ImmutableMessage object.

Method Summary

java.lang.String	getChannelId() Returns the ID of the channel associated with this message.
java.util.Map<java.lang.Integer,ImmutableConnectorMessage>	getConnectorMessages() Returns a map of connector messages associated with this message.
java.util.Map<java.lang.String,java.lang.Integer>	getDestinationIdMap() Returns a Map of destination connector names linked to their corresponding connector metadata ID.
java.util.Map<java.lang.String,java.lang.String>	getDestinationNameMap() Deprecated. This method is deprecated and will soon be removed. Please use getDestinationIdMap() instead.
ImmutableConnectorMessage	getMergedConnectorMessage() Returns a "merged" connector message containing data from all connector messages combined.
java.lang.Long	getMessageId() Returns the sequential ID of this message, as a Long.
java.util.Calendar	getReceivedDate() Deprecated. This method is deprecated and will soon be removed. This method currently returns the received date of the source connector message.
java.lang.String	getServerId() Returns the ID of the server associated with this message.
boolean	isProcessed() Returns whether this message has finished processing through a channel.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableMessage

public ImmutableMessage(com.mirth.connect.donkey.model.message.Message message)

Instantiates a new ImmutableMessage object.

Parameters:

message - The Message object that this object will reference for retrieving data.

Method Detail

getMessageId

public java.lang.Long getMessageId()

Returns the sequential ID of this message, as a Long.

getServerId

public java.lang.String getServerId()

Returns the ID of the server associated with this message.

getChannelId

public java.lang.String getChannelId()

Returns the ID of the channel associated with this message.

getReceivedDate

public java.util.Calendar getReceivedDate()

Deprecated. This method is deprecated and will soon be removed. This method currently returns the received date of the source connector message.

Returns the original date/time that this message was created by the channel. If the message is reprocessed at a later point, this date will remain the same and instead the connector message received dates will be updated.

isProcessed

public boolean isProcessed()

Returns whether this message has finished processing through a channel. A message is considered "processed" if it correctly flows through each applicable connector and the postprocessor script finishes. Even if a non-fatal error occurs on a particular connector message and the status ends up as ERROR, or if a message is queued by a destination and has not yet been sent to the outbound system, it can still be considered processed.

getConnectorMessages

public java.util.Map<java.lang.Integer,ImmutableConnectorMessage> getConnectorMessages()

Returns a map of connector messages associated with this message. The keys are the metadata IDs (as Integer objects), and the values are the connector messages themselves.

getMergedConnectorMessage

public ImmutableConnectorMessage getMergedConnectorMessage()

Returns a "merged" connector message containing data from all connector messages combined. The raw and processed raw content is copied from the source connector, while values in the channel and response maps are copied from all connectors.

getDestinationNameMap

public java.util.Map<java.lang.String,java.lang.String> getDestinationNameMap()

Deprecated. This method is deprecated and will soon be removed. Please use getDestinationIdMap() instead.

Returns a Map of destination connector names linked to their corresponding "d#" response map keys (where "#" is the destination connector metadata ID).

getDestinationIdMap

public java.util.Map<java.lang.String,java.lang.Integer> getDestinationIdMap()

Returns a Map of destination connector names linked to their corresponding connector metadata ID.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object