|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.mirth.connect.userutil.ImmutableConnectorMessage
public class ImmutableConnectorMessage
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 Summary | |
---|---|
ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage)
Instantiates a new ImmutableConnectorMessage object. |
|
ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage,
boolean modifiableMaps)
Instantiates a new ImmutableConnectorMessage object. |
|
ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage,
boolean modifiableMaps,
java.util.Map<java.lang.String,java.lang.String> destinationNameMap)
Instantiates a new ImmutableConnectorMessage object. |
Method Summary | |
---|---|
java.lang.String |
getChannelId()
Returns the ID of the channel associated with this connector message. |
java.util.Map<java.lang.String,java.lang.Object> |
getChannelMap()
Returns the channel map. |
java.util.Map<java.lang.String,java.lang.Object> |
getConnectorMap()
Returns the connector map. |
java.lang.String |
getConnectorName()
Returns the name of the connector associated with this connector message. |
ImmutableMessageContent |
getContent(ContentType contentType)
Retrieves content associated with this connector message. |
java.util.Map<java.lang.String,java.lang.String> |
getDestinationNameMap()
Returns a Map of destination connector names linked to their corresponding "d#" response map keys (where "#" is the destination connector metadata ID). |
ImmutableMessageContent |
getEncoded()
Retrieves encoded content associated with this connector message. |
java.lang.String |
getEncodedData()
Retrieves encoded content associated with this connector message. |
long |
getMessageId()
Returns the sequential ID of the overall Message associated with this connector message. |
int |
getMetaDataId()
Returns the metadata ID of this connector message. |
ImmutableMessageContent |
getProcessedRaw()
Retrieves processed raw content associated with this connector message. |
java.lang.String |
getProcessedRawData()
Retrieves processed raw content associated with this connector message. |
ImmutableMessageContent |
getProcessedResponse()
Retrieves processed response content associated with this connector message. |
Response |
getProcessedResponseData()
Retrieves processed response content associated with this connector message. |
java.lang.String |
getProcessingError()
Returns the processing error string associated with this connector message, if it exists. |
ImmutableMessageContent |
getRaw()
Retrieves raw content associated with this connector message. |
java.lang.String |
getRawData()
Retrieves raw content associated with this connector message. |
java.util.Calendar |
getReceivedDate()
Returns the date/time that this connector message was created by the channel. |
ImmutableMessageContent |
getResponse()
Retrieves response content associated with this connector message. |
Response |
getResponseData()
Retrieves response content associated with this connector message. |
java.util.Calendar |
getResponseDate()
Returns the date/time immediately after this connector message's response is received. |
java.lang.String |
getResponseError()
Returns the response error string associated with this connector message, if it exists. |
java.util.Map<java.lang.String,java.lang.Object> |
getResponseMap()
Returns the response map. |
ImmutableMessageContent |
getResponseTransformed()
Retrieves transformed response content associated with this connector message. |
java.lang.String |
getResponseTransformedData()
Retrieves transformed response content associated with this connector message. |
int |
getSendAttempts()
Returns the number of times this message has been attempted to be dispatched by the connector. |
java.util.Calendar |
getSendDate()
Returns the date/time immediately before this connector message's most recent send attempt. |
ImmutableMessageContent |
getSent()
Deprecated. This method is deprecated and will soon be removed. Please use map variables to retrieve post-replacement data instead. This method will always return null. |
java.lang.String |
getSentData()
Deprecated. This method is deprecated and will soon be removed. Please use map variables to retrieve post-replacement data instead. This method will always return null. |
java.lang.String |
getServerId()
Returns the ID of the server associated with this connector message. |
java.util.Map<java.lang.String,java.lang.Object> |
getSourceMap()
Returns the source map. |
Status |
getStatus()
Returns the status (e.g. |
ImmutableMessageContent |
getTransformed()
Retrieves transformed content associated with this connector message. |
java.lang.String |
getTransformedData()
Retrieves transformed content associated with this connector message. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage)
connectorMessage
- The connector message that this object will reference for retrieving data.public ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage, boolean modifiableMaps)
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.public ImmutableConnectorMessage(com.mirth.connect.donkey.model.message.ConnectorMessage connectorMessage, boolean modifiableMaps, java.util.Map<java.lang.String,java.lang.String> destinationNameMap)
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.destinationNameMap
- A map containing all applicable destination names in the channel and their
corresponding "d#" response map keys. This is used so that the response map has
the ability to get destination responses by name as well as by the proper "d#"
key.Method Detail |
---|
public int getMetaDataId()
public java.lang.String getChannelId()
public java.lang.String getConnectorName()
public java.lang.String getServerId()
public java.util.Calendar getReceivedDate()
public int getSendAttempts()
public java.util.Calendar getSendDate()
public java.util.Calendar getResponseDate()
public Status getStatus()
public ImmutableMessageContent getContent(ContentType contentType)
contentType
- The ContentType (e.g. RAW, ENCODED) of the content to retrieve.
public ImmutableMessageContent getRaw()
public java.lang.String getRawData()
public ImmutableMessageContent getProcessedRaw()
public java.lang.String getProcessedRawData()
public ImmutableMessageContent getTransformed()
public java.lang.String getTransformedData()
public ImmutableMessageContent getEncoded()
public java.lang.String getEncodedData()
public ImmutableMessageContent getSent()
public java.lang.String getSentData()
public ImmutableMessageContent getResponse()
public Response getResponseData()
public ImmutableMessageContent getResponseTransformed()
public java.lang.String getResponseTransformedData()
public ImmutableMessageContent getProcessedResponse()
public Response getProcessedResponseData()
public long getMessageId()
public java.util.Map<java.lang.String,java.lang.Object> getSourceMap()
public java.util.Map<java.lang.String,java.lang.Object> getConnectorMap()
public java.util.Map<java.lang.String,java.lang.Object> getChannelMap()
public java.util.Map<java.lang.String,java.lang.Object> getResponseMap()
public java.lang.String getProcessingError()
public java.lang.String getResponseError()
public java.util.Map<java.lang.String,java.lang.String> getDestinationNameMap()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |