Package com.mirth.connect.userutil

Class ImmutableConnectorMessage

java.lang.Object
com.mirth.connect.userutil.ImmutableConnectorMessage
public class ImmutableConnectorMessage extends Object
This class represents a connector message and is used to retrieve details such as the message ID, metadata ID, status, and various content types.

  • Constructor Details

    • ImmutableConnectorMessage

      public ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage)
      Instantiates a new ImmutableConnectorMessage object.
      Parameters:
      connectorMessage - The connector message that this object will reference for retrieving data.

    • ImmutableConnectorMessage

      public ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage, boolean modifiableMaps)
      Instantiates a new ImmutableConnectorMessage object.
      Parameters:
      connectorMessage - The connector message that this object will reference for retrieving data.
      modifiableMaps - If true, variable maps (e.g. connector/channel/response) will be modifiable, and values may be set in them as well as retrieved. Otherwise, data will only be able to be retrieved from the maps, and no updates will be allowed.

    • ImmutableConnectorMessage

      public ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage, boolean modifiableMaps, Map<String,Integer> destinationIdMap)
      Instantiates a new ImmutableConnectorMessage object.
      Parameters:
      connectorMessage - The connector message that this object will reference for retrieving data.
      modifiableMaps - If true, variable maps (e.g. connector/channel/response) will be modifiable, and values may be set in them as well as retrieved. Otherwise, data will only be able to be retrieved from the maps, and no updates will be allowed.
      destinationIdMap - A map containing all applicable destination names in the channel and their corresponding connector metadata ids.

  • Method Details

    • getMetaDataId

      public int getMetaDataId()
      Returns the metadata ID of this connector message. Note that the source connector has a metadata ID of 0.
      Returns:
      The metadata ID of this connector message.

    • getChannelId

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

    • getChannelName

      public String getChannelName()
      Returns the Name of the channel associated with this connector message.
      Returns:
      The Name of the channel associated with this connector message.

    • getConnectorName

      public String getConnectorName()
      Returns the name of the connector associated with this connector message.
      Returns:
      The name of the connector associated with this connector message.

    • getServerId

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

    • getReceivedDate

      public Calendar getReceivedDate()
      Returns the date/time that this connector message was created by the channel.
      Returns:
      The date/time that this connector message was created by the channel.

    • getSendAttempts

      public int getSendAttempts()
      Returns the number of times this message has been attempted to be dispatched by the connector.
      Returns:
      The number of times this message has been attempted to be dispatched by the connector.

    • getSendDate

      public Calendar getSendDate()
      Returns the date/time immediately before this connector message's most recent send attempt. Only valid for destination connectors in the response transformer or postprocessor. Returns null otherwise.
      Returns:
      The date/time immediately before this connector message's most recent send attempt.

    • getResponseDate

      public Calendar getResponseDate()
      Returns the date/time immediately after this connector message's response is received. Only valid for destination connectors in the response transformer or postprocessor. Returns null otherwise.
      Returns:
      The date/time immediately after this connector message's response is received.

    • getStatus

      public Status getStatus()
      Returns the status (e.g. SENT) of this connector message.
      Returns:
      The status (e.g. SENT) of this connector message.

    • getMessageContent

      public ImmutableMessageContent getMessageContent(ContentType contentType)
      Retrieves content associated with this connector message.
      Parameters:
      contentType - The ContentType (e.g. RAW, ENCODED) of the content to retrieve.
      Returns:
      The content, as an ImmutableMessageContent object.

    • getContent

      @Deprecated public ImmutableMessageContent getContent(ContentType contentType)
      Deprecated.
      The getContent(contentType) method has been deprecated and will soon be removed. Please use getMessageContent(contentType) instead.
      Retrieves content associated with this connector message.
      Parameters:
      contentType - The ContentType (e.g. RAW, ENCODED) of the content to retrieve.
      Returns:
      The content, as an ImmutableMessageContent object.

    • getRaw

      public ImmutableMessageContent getRaw()
      Retrieves raw content associated with this connector message.
      Returns:
      The raw content, as an ImmutableMessageContent object.

    • getRawData

      public String getRawData()
      Retrieves raw content associated with this connector message.
      Returns:
      The raw content, as a string.

    • getProcessedRaw

      public ImmutableMessageContent getProcessedRaw()
      Retrieves processed raw content associated with this connector message.
      Returns:
      The processed raw content, as an ImmutableMessageContent object.

    • getProcessedRawData

      public String getProcessedRawData()
      Retrieves processed raw content associated with this connector message.
      Returns:
      The processed raw content, as a string.

    • getTransformed

      public ImmutableMessageContent getTransformed()
      Retrieves transformed content associated with this connector message.
      Returns:
      The transformed content, as an ImmutableMessageContent object.

    • getTransformedData

      public String getTransformedData()
      Retrieves transformed content associated with this connector message.
      Returns:
      The transformed content, as a string.

    • getEncoded

      public ImmutableMessageContent getEncoded()
      Retrieves encoded content associated with this connector message.
      Returns:
      The encoded content, as an ImmutableMessageContent object.

    • getEncodedData

      public String getEncodedData()
      Retrieves encoded content associated with this connector message.
      Returns:
      The encoded content, as a string.

    • getResponse

      public ImmutableMessageContent getResponse()
      Retrieves response content associated with this connector message.
      Returns:
      The response content, as an ImmutableMessageContent object.

    • getResponseData

      public Response getResponseData()
      Retrieves response content associated with this connector message.
      Returns:
      The response content, as a string.

    • getResponseTransformed

      public ImmutableMessageContent getResponseTransformed()
      Retrieves transformed response content associated with this connector message.
      Returns:
      The transformed response content, as an ImmutableMessageContent object.

    • getResponseTransformedData

      public String getResponseTransformedData()
      Retrieves transformed response content associated with this connector message.
      Returns:
      The transformed response content, as a string.

    • getProcessedResponse

      public ImmutableMessageContent getProcessedResponse()
      Retrieves processed response content associated with this connector message.
      Returns:
      The processed response content, as an ImmutableMessageContent object.

    • getProcessedResponseData

      public Response getProcessedResponseData()
      Retrieves processed response content associated with this connector message.
      Returns:
      The processed response content, as a string.

    • getMessageId

      public long getMessageId()
      Returns the sequential ID of the overall Message associated with this connector message.
      Returns:
      The sequential ID of the overall Message associated with this connector message.

    • getSourceMap

      public Map<String,Object> getSourceMap()
      Returns the source map. This map is unmodifiable and only data retrieval will be allowed.
      Returns:
      The source map.

    • getConnectorMap

      public Map<String,Object> getConnectorMap()
      Returns the connector map. If this connector message was instantiated with a 'true' value for modifiableMaps, then this map will allow both data retrieval and updates. Otherwise, the map will be unmodifiable and only data retrieval will be allowed.
      Returns:
      The connector map.

    • getChannelMap

      public Map<String,Object> getChannelMap()
      Returns the channel map. If this connector message was instantiated with a 'true' value for modifiableMaps, then this map will allow both data retrieval and updates. Otherwise, the map will be unmodifiable and only data retrieval will be allowed.
      Returns:
      The channel map.

    • getResponseMap

      public Map<String,Object> getResponseMap()
      Returns the response map. If this connector message was instantiated with a 'true' value for modifiableMaps, then this map will allow both data retrieval and updates. Otherwise, the map will be unmodifiable and only data retrieval will be allowed. In addition, if this connector message was instantiated with the destinationNameMap parameter, the map will check destination names as well as the proper "d#" keys when retrieving data.
      Returns:
      The response map.

    • getPostProcessorError

      public String getPostProcessorError()
      Returns the postprocessing error string associated with this connector message, if it exists.
      Returns:
      The postprocessing error string associated with this connector message, if it exists.

    • getProcessingError

      public String getProcessingError()
      Returns the processing error string associated with this connector message, if it exists.
      Returns:
      The processing error string associated with this connector message, if it exists.

    • getResponseError

      public String getResponseError()
      Returns the response error string associated with this connector message, if it exists.
      Returns:
      The response error string associated with this connector message, if it exists.

    • 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