com.mirth.connect.server.userutil
Class RawMessage

java.lang.Object
  com.mirth.connect.server.userutil.RawMessage

public class RawMessage
extends java.lang.Object

This class represents a raw message as it is received by a channel, and is used to retrieve details such as the raw data or source map.

Constructor Summary

RawMessage(byte[] rawBytes)
Instantiates a RawMessage object to dispatch to a channel.

RawMessage(byte[] rawBytes, java.util.Collection<java.lang.Number> destinationMetaDataIds)
Instantiates a RawMessage object to dispatch to a channel.

RawMessage(byte[] rawBytes, java.util.Collection<java.lang.Number> destinationMetaDataIds, java.util.Map<java.lang.String,java.lang.Object> sourceMap)
Instantiates a RawMessage object to dispatch to a channel.

RawMessage(java.lang.String rawData)
Instantiates a RawMessage object to dispatch to a channel.

RawMessage(java.lang.String rawData, java.util.Collection<java.lang.Number> destinationMetaDataIds)
Instantiates a RawMessage object to dispatch to a channel.

RawMessage(java.lang.String rawData, java.util.Collection<java.lang.Number> destinationMetaDataIds, java.util.Map<java.lang.String,java.lang.Object> sourceMap)
Instantiates a RawMessage object to dispatch to a channel.

Method Summary

void	clearMessage() Removes references to any data (textual or binary) currently stored by the raw message.
java.util.Map<java.lang.String,java.lang.Object>	getChannelMap() Deprecated. This method is deprecated and will soon be removed. Please use getSourceMap() instead.
java.util.Collection<java.lang.Integer>	getDestinationMetaDataIds() Returns the collection of integers (metadata IDs) representing which destinations to dispatch the message to.
byte[]	getRawBytes() Returns the binary data (byte array) to be dispatched to a channel.
java.lang.String	getRawData() Returns the textual data to be dispatched to a channel.
java.util.Map<java.lang.String,java.lang.Object>	getSourceMap() Returns the source map to be used at the beginning of the channel dispatch.
java.lang.Boolean	isBinary() Returns a Boolean representing whether this object contains textual or binary data.
void	setChannelMap(java.util.Map<java.lang.String,java.lang.Object> channelMap) Deprecated. This method is deprecated and will soon be removed. Please use setSourceMap(sourceMap) instead.
void	setDestinationMetaDataIds(java.util.Collection<java.lang.Number> destinationMetaDataIds) Sets which destinations to dispatch the message to.
void	setSourceMap(java.util.Map<java.lang.String,java.lang.Object> sourceMap) Sets the source map to be used at the beginning of the channel dispatch.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawMessage

public RawMessage(java.lang.String rawData)

Instantiates a RawMessage object to dispatch to a channel.

Parameters:

rawData - The textual data to dispatch to the channel.

RawMessage

public RawMessage(java.lang.String rawData,
                  java.util.Collection<java.lang.Number> destinationMetaDataIds)

Instantiates a RawMessage object to dispatch to a channel.

Parameters:

rawData - The textual data to dispatch to the channel.

destinationMetaDataIds - A collection of integers (metadata IDs) representing which destinations to dispatch the message to. JavaScript arrays can be used.

RawMessage

public RawMessage(java.lang.String rawData,
                  java.util.Collection<java.lang.Number> destinationMetaDataIds,
                  java.util.Map<java.lang.String,java.lang.Object> sourceMap)

Instantiates a RawMessage object to dispatch to a channel.

Parameters:

rawData - The textual data to dispatch to the channel.

destinationMetaDataIds - A collection of integers (metadata IDs) representing which destinations to dispatch the message to. JavaScript arrays can be used.

sourceMap - Any values placed in this map will be populated in the source map at the beginning of the message's lifecycle.

RawMessage

public RawMessage(byte[] rawBytes)

Instantiates a RawMessage object to dispatch to a channel.

Parameters:

rawBytes - The binary data (byte array) to dispatch to the channel.

RawMessage

public RawMessage(byte[] rawBytes,
                  java.util.Collection<java.lang.Number> destinationMetaDataIds)

Instantiates a RawMessage object to dispatch to a channel.

Parameters:

rawBytes - The binary data (byte array) to dispatch to the channel.

destinationMetaDataIds - A collection of integers (metadata IDs) representing which destinations to dispatch the message to. JavaScript arrays can be used.

RawMessage

public RawMessage(byte[] rawBytes,
                  java.util.Collection<java.lang.Number> destinationMetaDataIds,
                  java.util.Map<java.lang.String,java.lang.Object> sourceMap)

Instantiates a RawMessage object to dispatch to a channel.

Parameters:

rawBytes - The binary data (byte array) to dispatch to the channel.

destinationMetaDataIds - A collection of integers (metadata IDs) representing which destinations to dispatch the message to. JavaScript arrays can be used.

sourceMap - Any values placed in this map will be populated in the source map at the beginning of the message's lifecycle.

Method Detail

getRawData

public java.lang.String getRawData()

Returns the textual data to be dispatched to a channel.

getRawBytes

public byte[] getRawBytes()

Returns the binary data (byte array) to be dispatched to a channel.

getDestinationMetaDataIds

public java.util.Collection<java.lang.Integer> getDestinationMetaDataIds()

Returns the collection of integers (metadata IDs) representing which destinations to dispatch the message to.

setDestinationMetaDataIds

public void setDestinationMetaDataIds(java.util.Collection<java.lang.Number> destinationMetaDataIds)

Sets which destinations to dispatch the message to.

Parameters:

destinationMetaDataIds - A list of integers (metadata IDs) representing which destinations to dispatch the message to.

getChannelMap

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

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

Returns the channel map to be used at the beginning of the channel dispatch.

setChannelMap

public void setChannelMap(java.util.Map<java.lang.String,java.lang.Object> channelMap)

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

Sets the channel map to be used at the beginning of the channel dispatch.

Parameters:

channelMap - Any values placed in this map will be populated in the channel map at the beginning of the message's lifecycle.

getSourceMap

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

Returns the source map to be used at the beginning of the channel dispatch.

setSourceMap

public void setSourceMap(java.util.Map<java.lang.String,java.lang.Object> sourceMap)

Sets the source map to be used at the beginning of the channel dispatch.

Parameters:

sourceMap - Any values placed in this map will be populated in the source map at the beginning of the message's lifecycle.

isBinary

public java.lang.Boolean isBinary()

Returns a Boolean representing whether this object contains textual or binary data.

clearMessage

public void clearMessage()

Removes references to any data (textual or binary) currently stored by the raw message.