com.mirth.connect.server.userutil

Class AttachmentUtil

java.lang.Object

com.mirth.connect.server.userutil.AttachmentUtil

public class AttachmentUtil
extends Object

Provides utility methods for creating, retrieving, and re-attaching message attachments.

Method Summary

Modifier and Type	Method and Description
static Attachment	addAttachment(List<Attachment> attachments, Object content, String type) Creates an Attachment and adds it to the provided list.
static Attachment	createAttachment(ImmutableConnectorMessage connectorMessage, Object content, String type) Creates an attachment associated with a given connector message, and inserts it into the database.
static Attachment	getMessageAttachment(String channelId, Long messageId, String attachmentId) Retrieves an attachment from a specific channel/message ID.
static List<Attachment>	getMessageAttachments(ImmutableConnectorMessage connectorMessage) Retrieves all attachments associated with a connector message.
static List<Attachment>	getMessageAttachments(String channelId, Long messageId) Retrieves all attachments associated with a specific channel/message ID.
static List<Attachment>	getMessageAttachmentsFromSourceChannel(ImmutableConnectorMessage connectorMessage) Retrieves an attachment from an upstream channel that sent a message to the current channel.
static String	reAttachMessage(ImmutableConnectorMessage connectorMessage) Replaces any unique attachment tokens (e.g.
static String	reAttachMessage(String raw, ImmutableConnectorMessage connectorMessage) Replaces any unique attachment tokens (e.g.
static byte[]	reAttachMessage(String raw, ImmutableConnectorMessage connectorMessage, String charsetEncoding, boolean binary) Replaces any unique attachment tokens (e.g.
static byte[]	reAttachMessage(String raw, ImmutableConnectorMessage connectorMessage, String charsetEncoding, boolean binary, boolean reattach, boolean localOnly) Replaces any unique attachment tokens (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

reAttachMessage

public static byte[] reAttachMessage(String raw,
                                     ImmutableConnectorMessage connectorMessage,
                                     String charsetEncoding,
                                     boolean binary)

Replaces any unique attachment tokens (e.g. "${ATTACH:id}") with the corresponding attachment content, and returns the full post-replacement message as a byte array.

Parameters:

raw - The raw message string to replace tokens from.

connectorMessage - The ConnectorMessage associated with this message, used to identify the channel/message ID.

charsetEncoding - If binary mode is not used, the resulting byte array will be encoded using this charset.

binary - If enabled, the raw data is assumed to be Base64 encoded. The resulting byte array will be the raw Base64 decoded bytes.

Returns:

The resulting message as a byte array, with all applicable attachment content re-inserted.

reAttachMessage

public static byte[] reAttachMessage(String raw,
                                     ImmutableConnectorMessage connectorMessage,
                                     String charsetEncoding,
                                     boolean binary,
                                     boolean reattach,
                                     boolean localOnly)

Replaces any unique attachment tokens (e.g. "${ATTACH:id}") with the corresponding attachment content, and returns the full post-replacement message as a byte array.

Parameters:

raw - The raw message string to replace tokens from.

connectorMessage - The ConnectorMessage associated with this message, used to identify the channel/message ID.

charsetEncoding - If binary mode is not used, the resulting byte array will be encoded using this charset.

binary - If enabled, the raw data is assumed to be Base64 encoded. The resulting byte array will be the raw Base64 decoded bytes.

reattach - If true, attachment tokens will be replaced with the actual attachment content. Otherwise, local attachment tokens will be replaced only with the corresponding expanded tokens.

localOnly - If true, only local attachment tokens will be replaced, and expanded tokens will be ignored.

Returns:

The resulting message as a byte array, with all applicable attachment content re-inserted.

reAttachMessage

public static String reAttachMessage(ImmutableConnectorMessage connectorMessage)

Replaces any unique attachment tokens (e.g. "${ATTACH:id}") with the corresponding attachment content, and returns the full post-replacement message.

Parameters:

connectorMessage - The ConnectorMessage associated with this message, used to identify the channel/message ID. The message string will be either the encoded or raw content.

Returns:

The resulting message with all applicable attachment content re-inserted.

reAttachMessage

public static String reAttachMessage(String raw,
                                     ImmutableConnectorMessage connectorMessage)

Replaces any unique attachment tokens (e.g. "${ATTACH:id}") with the corresponding attachment content, and returns the full post-replacement message.

Parameters:

raw - The raw message string to replace tokens from.

connectorMessage - The ConnectorMessage associated with this message, used to identify the channel/message ID.

Returns:

The resulting message with all applicable attachment content re-inserted.

getMessageAttachments

public static List<Attachment> getMessageAttachments(ImmutableConnectorMessage connectorMessage)
                                              throws com.mirth.connect.donkey.model.message.MessageSerializerException

Retrieves all attachments associated with a connector message.

Parameters:

connectorMessage - The ConnectorMessage associated with this message, used to identify the channel/message ID.

Returns:

A list of attachments associated with the connector message.

Throws:

com.mirth.connect.donkey.model.message.MessageSerializerException

getMessageAttachments

public static List<Attachment> getMessageAttachments(String channelId,
                                                     Long messageId)
                                              throws com.mirth.connect.donkey.model.message.MessageSerializerException

Retrieves all attachments associated with a specific channel/message ID.

Parameters:

channelId - The ID of the channel to retrieve the attachments from.

messageId - The ID of the message to retrieve the attachments from.

Returns:

A list of attachments associated with the channel/message ID.

Throws:

com.mirth.connect.donkey.model.message.MessageSerializerException

getMessageAttachment

public static Attachment getMessageAttachment(String channelId,
                                              Long messageId,
                                              String attachmentId)
                                       throws com.mirth.connect.donkey.model.message.MessageSerializerException

Retrieves an attachment from a specific channel/message ID.

Parameters:

channelId - The ID of the channel to retrieve the attachment from.

messageId - The ID of the message to retrieve the attachment from.

attachmentId - The ID of the attachment to retrieve.

Returns:

The attachment associated with the given IDs, or null if none was found.

Throws:

com.mirth.connect.donkey.model.message.MessageSerializerException

getMessageAttachmentsFromSourceChannel

public static List<Attachment> getMessageAttachmentsFromSourceChannel(ImmutableConnectorMessage connectorMessage)
                                                               throws com.mirth.connect.donkey.model.message.MessageSerializerException

Retrieves an attachment from an upstream channel that sent a message to the current channel.

Parameters:

connectorMessage - The ConnectorMessage associated with this message. The channel ID and message ID will be retrieved from the source map.

Returns:

A list of attachments associated with the source channel/message IDs.

Throws:

com.mirth.connect.donkey.model.message.MessageSerializerException

addAttachment

public static Attachment addAttachment(List<Attachment> attachments,
                                       Object content,
                                       String type)
                                throws UnsupportedDataTypeException

Creates an Attachment and adds it to the provided list.

Parameters:

attachments - The list of attachments to add to.

content - The attachment content (must be a string or byte array).

type - The MIME type of the attachment.

Returns:

The attachment added to the list.

Throws:

UnsupportedDataTypeException

createAttachment

public static Attachment createAttachment(ImmutableConnectorMessage connectorMessage,
                                          Object content,
                                          String type)
                                   throws UnsupportedDataTypeException

Creates an attachment associated with a given connector message, and inserts it into the database.

Parameters:

connectorMessage - The connector message to be associated with the attachment.

content - The attachment content (must be a string or byte array).

type - The MIME type of the attachment.

Returns:

The attachment that was created and inserted.

Throws:

UnsupportedDataTypeException