Package com.mirth.connect.userutil

Class ImmutableMessage

java.lang.Object
com.mirth.connect.userutil.ImmutableMessage
public class ImmutableMessage extends 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 Details

    • 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 Details

    • getMessageId

      public Long getMessageId()
      Returns the sequential ID of this message, as a Long.
      Returns:
      The sequential ID of this message, as a Long.

    • getServerId

      public String getServerId()
      Returns the ID of the server associated with this message.
      Returns:
      The ID of the server associated with this message.

    • getChannelId

      public String getChannelId()
      Returns the ID of the channel associated with this message.
      Returns:
      The ID of the channel associated with this message.

    • getReceivedDate

      @Deprecated public 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.
      Returns:
      The original date/time that this message was created by the channel.

    • 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.
      Returns:
      A boolean indicating whether this message has finished processing through a channel.

    • getOriginalId

      public Long getOriginalId()
      Returns the ID of the original message this one was reprocessed from.
      Returns:
      The ID of the original message this one was reprocessed from.

    • getImportId

      public Long getImportId()
      Returns the ID of the original message this one was imported from.
      Returns:
      The ID of the original message this one was imported from.

    • getImportChannelId

      public String getImportChannelId()
      Returns the ID of the original channel this message was reprocessed from.
      Returns:
      The ID of the original channel this message was reprocessed from.

    • getAttachments

      public List<ImmutableAttachment> getAttachments()
      Returns a list of attachments associated with this message. This will only be populated in certain cases, such as when a message is being exported or archived.
      Returns:
      A list of attachments associated with this message.

    • getConnectorMessages

      public Map<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.
      Returns:
      A map of connector messages associated with this message.

    • 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.
      Returns:
      A "merged" connector message containing data from all connector messages combined.

    • getDestinationNameMap

      @Deprecated public Map<String,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).
      Returns:
      A Map of destination connector names linked to their corresponding "d#" response map keys.

    • getDestinationIdMap

      public Map<String,Integer> getDestinationIdMap()
      Returns a Map of destination connector names linked to their corresponding connector metadata ID.
      Returns:
      A Map of destination connector names linked to their corresponding connector metadata ID.

    • toString

      public String toString()
      Overrides:
      toString in class Object