com.mirth.connect.server.userutil
Class MessageObject

java.lang.Object
  extended by com.mirth.connect.server.userutil.MessageObject

Deprecated. This class is deprecated and will soon be removed. Please refer to ImmutableConnectorMessage instead.

public class MessageObject
extends java.lang.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.

See Also:
ImmutableConnectorMessage

Constructor Summary
MessageObject(ImmutableConnectorMessage connectorMessage)
          Deprecated. This class is deprecated and will soon be removed.
 
Method Summary
 java.lang.Object clone()
          Deprecated. This class is deprecated and will soon be removed.
 boolean equals(java.lang.Object that)
          Deprecated. This class is deprecated and will soon be removed.
 java.lang.String getChannelId()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getChannelId() or the variable "channelId" instead.
 java.util.Map getChannelMap()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getChannelMap() or the variable "channelMap" instead.
 java.util.Map getConnectorMap()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getConnectorMap() or the variable "connectorMap" instead.
 java.lang.String getConnectorName()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getConnectorName() or the variable "connector" instead.
 java.util.Map<java.lang.String,java.lang.Object> getContext()
          Deprecated. This class is deprecated and will soon be removed.
 java.lang.String getCorrelationId()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getMessageId() instead.
 java.util.Calendar getDateCreated()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getReceivedDate() instead.
 java.lang.String getEncodedData()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getEncodedData() instead.
 java.lang.String getEncodedDataProtocol()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getEncoded().getDataType() instead.
 java.lang.String getErrors()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getProcessingError() instead.
 java.lang.String getId()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getMessageId() instead.
 java.lang.String getRawData()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getRawData() instead.
 java.lang.String getRawDataProtocol()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getRaw().getDataType() instead.
 java.util.Map getResponseMap()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getResponseMap() or the variable "responseMap" instead.
 java.lang.String getServerId()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getServerId() instead.
 java.lang.String getSource()
          Deprecated. This class is deprecated and will soon be removed. Please use the "mirth_source" variable in the connector map instead.
 Status getStatus()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getStatus() instead. Note that the UNKNOWN and ACCEPTED statuses are no longer valid.
 java.lang.String getTransformedData()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getTransformedData() instead.
 java.lang.String getTransformedDataProtocol()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getRaw().getDataType() instead.
 java.lang.String getType()
          Deprecated. This class is deprecated and will soon be removed. Please use the "mirth_type" variable in the connector map instead.
 java.lang.String getVersion()
          Deprecated. This class is deprecated and will soon be removed. Please use the "mirth_version" variable in the connector map instead.
 boolean isAttachment()
          Deprecated. This class is deprecated and will soon be removed.
 boolean isEncrypted()
          Deprecated. This class is deprecated and will soon be removed.
 void setAttachment(boolean attachment)
          Deprecated. This class is deprecated and will soon be removed.
 void setChannelId(java.lang.String channelId)
          Deprecated. This class is deprecated and will soon be removed.
 void setChannelMap(java.util.Map channelMap)
          Deprecated. This class is deprecated and will soon be removed.
 void setConnectorMap(java.util.Map variableMap)
          Deprecated. This class is deprecated and will soon be removed.
 void setConnectorName(java.lang.String connectorName)
          Deprecated. This class is deprecated and will soon be removed.
 void setContext(java.util.Map<java.lang.String,java.lang.Object> context)
          Deprecated. This class is deprecated and will soon be removed.
 void setCorrelationId(java.lang.String correlationId)
          Deprecated. This class is deprecated and will soon be removed.
 void setDateCreated(java.util.Calendar dateCreated)
          Deprecated. This class is deprecated and will soon be removed.
 void setEncodedData(java.lang.String encodedData)
          Deprecated. This class is deprecated and will soon be removed.
 void setEncodedDataProtocol(java.lang.String encodedDataProtocol)
          Deprecated. This class is deprecated and will soon be removed.
 void setEncrypted(boolean encrypted)
          Deprecated. This class is deprecated and will soon be removed.
 void setErrors(java.lang.String errors)
          Deprecated. This class is deprecated and will soon be removed.
 void setId(java.lang.String id)
          Deprecated. This class is deprecated and will soon be removed.
 void setRawData(java.lang.String rawData)
          Deprecated. This class is deprecated and will soon be removed.
 void setRawDataProtocol(java.lang.String rawDataProtocol)
          Deprecated. This class is deprecated and will soon be removed.
 void setResponseMap(java.util.Map responseMap)
          Deprecated. This class is deprecated and will soon be removed.
 void setServerId(java.lang.String serverId)
          Deprecated. This class is deprecated and will soon be removed.
 void setSource(java.lang.String source)
          Deprecated. This class is deprecated and will soon be removed. Please set the "mirth_source" variable in the connector map instead.
 void setStatus(Status status)
          Deprecated. This class is deprecated and will soon be removed.
 void setTransformedData(java.lang.String transformedData)
          Deprecated. This class is deprecated and will soon be removed.
 void setTransformedDataProtocol(java.lang.String transformedDataProtocol)
          Deprecated. This class is deprecated and will soon be removed.
 void setType(java.lang.String type)
          Deprecated. This class is deprecated and will soon be removed. Please set the "mirth_type" variable in the connector map instead.
 void setVersion(java.lang.String version)
          Deprecated. This class is deprecated and will soon be removed. Please set the "mirth_version" variable in the connector map instead.
 java.lang.String toAuditString()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.toString() instead.
 java.lang.String toString()
          Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.toString() instead.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MessageObject

public MessageObject(ImmutableConnectorMessage connectorMessage)
Deprecated. This class is deprecated and will soon be removed.

Instantiates a MessageObject.

Parameters:
connectorMessage - The connector message that this object will reference for retrieving data.
Method Detail

getSource

public java.lang.String getSource()
Deprecated. This class is deprecated and will soon be removed. Please use the "mirth_source" variable in the connector map instead.

Returns the source of the message (dependent on the inbound data type).


setSource

public void setSource(java.lang.String source)
Deprecated. This class is deprecated and will soon be removed. Please set the "mirth_source" variable in the connector map instead.

Sets the source of the message.


getType

public java.lang.String getType()
Deprecated. This class is deprecated and will soon be removed. Please use the "mirth_type" variable in the connector map instead.

Returns the type of the message (dependent on the inbound data type).


setType

public void setType(java.lang.String type)
Deprecated. This class is deprecated and will soon be removed. Please set the "mirth_type" variable in the connector map instead.

Sets the type of the message.


getId

public java.lang.String getId()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getMessageId() instead.

Returns the sequential ID of the overall Message associated with this connector message.


setId

public void setId(java.lang.String id)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getVersion

public java.lang.String getVersion()
Deprecated. This class is deprecated and will soon be removed. Please use the "mirth_version" variable in the connector map instead.

Returns the version of the message (dependent on the inbound data type).


setVersion

public void setVersion(java.lang.String version)
Deprecated. This class is deprecated and will soon be removed. Please set the "mirth_version" variable in the connector map instead.

Sets the version of the message.


getChannelId

public java.lang.String getChannelId()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getChannelId() or the variable "channelId" instead.

Returns the ID of the channel associated with this connector message.


setChannelId

public void setChannelId(java.lang.String channelId)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getStatus

public Status getStatus()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getStatus() instead. Note that the UNKNOWN and ACCEPTED statuses are no longer valid.

Returns the status (e.g. SENT) of this connector message.


setStatus

public void setStatus(Status status)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getDateCreated

public java.util.Calendar getDateCreated()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getReceivedDate() instead.

Returns the date/time that this connector message was created by the channel.


setDateCreated

public void setDateCreated(java.util.Calendar dateCreated)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getEncodedData

public java.lang.String getEncodedData()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getEncodedData() instead.

Retrieves encoded content associated with this connector message.

Returns:
The encoded content, as a string.

setEncodedData

public void setEncodedData(java.lang.String encodedData)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getEncodedDataProtocol

public java.lang.String getEncodedDataProtocol()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getEncoded().getDataType() instead.

Returns the data type (e.g. "HL7V2") of the encoded content associated with this connector message.


setEncodedDataProtocol

public void setEncodedDataProtocol(java.lang.String encodedDataProtocol)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getRawData

public java.lang.String getRawData()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getRawData() instead.

Retrieves raw content associated with this connector message.

Returns:
The raw content, as a string.

setRawData

public void setRawData(java.lang.String rawData)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getRawDataProtocol

public java.lang.String getRawDataProtocol()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getRaw().getDataType() instead.

Returns the data type (e.g. "HL7V2") of the raw content associated with this connector message.


setRawDataProtocol

public void setRawDataProtocol(java.lang.String rawDataProtocol)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getTransformedData

public java.lang.String getTransformedData()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getTransformedData() instead.

Retrieves transformed content associated with this connector message.

Returns:
The transformed content, as a string.

setTransformedData

public void setTransformedData(java.lang.String transformedData)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getTransformedDataProtocol

public java.lang.String getTransformedDataProtocol()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getRaw().getDataType() instead.

Returns the data type (e.g. "HL7V2") of the transformed content associated with this connector message.


setTransformedDataProtocol

public void setTransformedDataProtocol(java.lang.String transformedDataProtocol)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getConnectorMap

public java.util.Map getConnectorMap()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getConnectorMap() or the variable "connectorMap" instead.

Returns the connector map.


setConnectorMap

public void setConnectorMap(java.util.Map variableMap)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


isEncrypted

public boolean isEncrypted()
Deprecated. This class is deprecated and will soon be removed.

This method always returns false.


setEncrypted

public void setEncrypted(boolean encrypted)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getConnectorName

public java.lang.String getConnectorName()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getConnectorName() or the variable "connector" instead.

Returns the name of the connector associated with this connector message.


setConnectorName

public void setConnectorName(java.lang.String connectorName)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getErrors

public java.lang.String getErrors()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getProcessingError() instead.

Returns the processing error string associated with this connector message, if it exists.


setErrors

public void setErrors(java.lang.String errors)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getResponseMap

public java.util.Map getResponseMap()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getResponseMap() or the variable "responseMap" instead.

Returns the response map.


setResponseMap

public void setResponseMap(java.util.Map responseMap)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getChannelMap

public java.util.Map getChannelMap()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getChannelMap() or the variable "channelMap" instead.

Returns the channel map.


setChannelMap

public void setChannelMap(java.util.Map channelMap)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getServerId

public java.lang.String getServerId()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getServerId() instead.

Returns the ID of the server associated with this connector message.


setServerId

public void setServerId(java.lang.String serverId)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


isAttachment

public boolean isAttachment()
Deprecated. This class is deprecated and will soon be removed.

This method always returns false.


setAttachment

public void setAttachment(boolean attachment)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


clone

public java.lang.Object clone()
Deprecated. This class is deprecated and will soon be removed.

This method always returns null.

Overrides:
clone in class java.lang.Object

equals

public boolean equals(java.lang.Object that)
Deprecated. This class is deprecated and will soon be removed.

This method always returns false.

Overrides:
equals in class java.lang.Object

getCorrelationId

public java.lang.String getCorrelationId()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.getMessageId() instead.

Returns the sequential ID of the overall Message associated with this connector message.


setCorrelationId

public void setCorrelationId(java.lang.String correlationId)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()
Deprecated. This class is deprecated and will soon be removed.

This method always returns an empty map.


setContext

public void setContext(java.util.Map<java.lang.String,java.lang.Object> context)
Deprecated. This class is deprecated and will soon be removed.

This method no longer does anything.


toString

public java.lang.String toString()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.toString() instead.

Returns a string representation of the object.

Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

toAuditString

public java.lang.String toAuditString()
Deprecated. This class is deprecated and will soon be removed. Please use connectorMessage.toString() instead.

Returns a string representation of the object.

See Also:
Object.toString()