public enum AuthStatus +extends Enum<AuthStatus>+
| Enum Constant and Description | +
|---|
CHALLENGED
+Indicates that the request should be rejected and an authentication challenge has been sent.
+ |
+
FAILURE
+Indicates that the request should be rejected without an authentication challenge.
+ |
+
SUCCESS
+Indicates that the request should be accepted.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AuthStatus |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AuthStatus[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AuthStatus CHALLENGED+
public static final AuthStatus SUCCESS+
public static final AuthStatus FAILURE+
public static AuthStatus[] values()+
+for (AuthStatus c : AuthStatus.values()) + System.out.println(c); +
public static AuthStatus valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic class AuthenticationResult +extends Object+
| Constructor and Description | +
|---|
AuthenticationResult(AuthStatus status)
+Instantiates a new AuthenticationResult object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addResponseHeader(String key,
+ String value)
+Adds a new response header to be sent along with the authentication response.
+ |
+
static AuthenticationResult |
+Challenged(String authenticateHeader)
+Convenience method to create a new AuthenticationResult with the CHALLENGED status.
+ |
+
static AuthenticationResult |
+Failure()
+Convenience method to create a new AuthenticationResult with the FAILURE status.
+ |
+
String |
+getRealm()
+Returns the realm that the request has been authenticated with.
+ |
+
Map<String,List<String>> |
+getResponseHeaders()
+Returns the map of HTTP headers to be sent along with the authentication response.
+ |
+
AuthStatus |
+getStatus()
+Returns the accept/reject status of the authentication attempt.
+ |
+
String |
+getUsername()
+Returns the username that the request has been authenticated with.
+ |
+
void |
+setRealm(String realm)
+Sets the realm that the request has been authenticated with.
+ |
+
void |
+setResponseHeaders(Map<String,List<String>> responseHeaders)
+Sets the map of HTTP headers to be sent along with the authentication response.
+ |
+
void |
+setStatus(AuthStatus status)
+Sets the accept/reject status of the authentication attempt.
+ |
+
void |
+setUsername(String username)
+Sets the username that the request has been authenticated with.
+ |
+
static AuthenticationResult |
+Success()
+Convenience method to create a new AuthenticationResult with the SUCCESS status.
+ |
+
static AuthenticationResult |
+Success(String username,
+ String realm)
+Convenience method to create a new AuthenticationResult with the SUCCESS status.
+ |
+
public AuthenticationResult(AuthStatus status)+
status - The accept/reject status to use.public AuthStatus getStatus()+
public void setStatus(AuthStatus status)+
status - The accept/reject status to use.public String getUsername()+
public void setUsername(String username)+
username - The username that the request has been authenticated with.public String getRealm()+
public void setRealm(String realm)+
realm - The realm that the request has been authenticated with.public Map<String,List<String>> getResponseHeaders()+
public void setResponseHeaders(Map<String,List<String>> responseHeaders)+
responseHeaders - The map of HTTP headers to be sent along with the authentication response.public void addResponseHeader(String key, + String value)+
key - The name of the header.value - The value of the header.public static AuthenticationResult Challenged(String authenticateHeader)+
authenticateHeader - The value to include in the WWW-Authenticate response header.public static AuthenticationResult Success()+
public static AuthenticationResult Success(String username, + String realm)+
username - The username that the request has been authenticated with.realm - The realm that the request has been authenticated with.public static AuthenticationResult Failure()+
See: Description
+| Class | +Description | +
|---|---|
| AuthenticationResult | +
+ This class represents the result of an HTTP authentication attempt, used to accept or reject
+ requests coming into HTTP-based source connectors.
+ |
+
| Enum | +Description | +
|---|---|
| AuthStatus | +
+ Denotes the result of an HTTP authentication attempt.
+ |
+
public class ACKGenerator +extends Object+
| Constructor and Description | +
|---|
ACKGenerator()
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+generateAckResponse(String message,
+ boolean isXML,
+ String acknowledgementCode,
+ String textMessage,
+ String dateFormat,
+ String errorMessage)
+Generates an HL7 v2.x acknowledgment.
+ |
+
static String |
+generateAckResponse(String message,
+ String acknowledgementCode,
+ String textMessage)
+Generates an HL7 v2.x acknowledgment.
+ |
+
static String |
+generateAckResponse(String message,
+ String dataType,
+ String acknowledgementCode,
+ String textMessage,
+ String dateFormat,
+ String errorMessage)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ generateAckResponse(message, isXML, acknowledgementCode, textMessage, dateFormat,
+ errorMessage) instead.
+ |
+
@Deprecated +public ACKGenerator()+
public static String generateAckResponse(String message, + String acknowledgementCode, + String textMessage) + throws Exception+
message - The inbound HL7 v2.x message to generate the ACK for.acknowledgementCode - The MSA.1 ACK code to use (e.g. AA, AR, AE).textMessage - The MSA.3 text message to use.Exception - If the acknowledgement could not be generated.@Deprecated +public static String generateAckResponse(String message, + String dataType, + String acknowledgementCode, + String textMessage, + String dateFormat, + String errorMessage) + throws Exception+
message - The inbound HL7 v2.x message to generate the ACK for.dataType - If "XML", assumes the inbound message is formatted in XML, and the acknowledgment
+ returned will also be XML.acknowledgementCode - The MSA.1 ACK code to use (e.g. AA, AR, AE).textMessage - The MSA.3 text message to use.dateFormat - The date/time format used to generate a timestamp for the MSH.7 message date/time
+ (e.g. "yyyyMMddHHmmss").errorMessage - The ERR.1 error message to use. If left blank, an ERR segment will not be
+ generated.Exception - If the acknowledgement could not be generated.public static String generateAckResponse(String message, + boolean isXML, + String acknowledgementCode, + String textMessage, + String dateFormat, + String errorMessage) + throws Exception+
message - The inbound HL7 v2.x message to generate the ACK for.isXML - If true, assumes the inbound message is formatted in XML, and the acknowledgment
+ returned will also be XML.acknowledgementCode - The MSA.1 ACK code to use (e.g. AA, AR, AE).textMessage - The MSA.3 text message to use.dateFormat - The date/time format used to generate a timestamp for the MSH.7 message date/time
+ (e.g. "yyyyMMddHHmmss").errorMessage - The ERR.1 error message to use. If left blank, an ERR segment will not be
+ generated.Exception - If the acknowledgement could not be generated.public class AlertSender +extends Object+
| Constructor and Description | +
|---|
AlertSender(ImmutableConnectorMessage connectorMessage)
+Instantiates a new AlertSender.
+ |
+
AlertSender(String channelId)
+Instantiates a new AlertSender.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+sendAlert(String errorMessage)
+Dispatches an error event that can be alerted on.
+ |
+
public AlertSender(String channelId)+
channelId - The ID of the channel to associate dispatched alert events with.public AlertSender(ImmutableConnectorMessage connectorMessage)+
connectorMessage - The connector message to associate dispatched alert events with.public class Attachment +extends Object+
| Constructor and Description | +
|---|
Attachment()
+Instantiates a new Attachment with no ID, content, or MIME type.
+ |
+
Attachment(String id,
+ byte[] content,
+ String type)
+Instantiates a new Attachment.
+ |
+
Attachment(String id,
+ String content,
+ String type)
+Instantiates a new Attachment with String data using UTF-8 charset encoding.
+ |
+
Attachment(String id,
+ String content,
+ String charset,
+ String type)
+Instantiates a new Attachment with String data and a given charset encoding.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getAttachmentId()
+Returns the unique replacement token for the attachment.
+ |
+
byte[] |
+getContent()
+Returns the content of the attachment as a byte array.
+ |
+
String |
+getContentString()
+Returns the content of the attachment as a string, using UTF-8 encoding.
+ |
+
String |
+getContentString(String charset)
+Returns the content of the attachment as a string, using the specified charset encoding.
+ |
+
String |
+getId()
+Returns the unique ID for the attachment.
+ |
+
String |
+getType()
+Returns the MIME type of the attachment.
+ |
+
void |
+setContent(byte[] content)
+Sets the content of the attachment.
+ |
+
void |
+setContentString(String content)
+Sets the content of the attachment, using UTF-8 encoding.
+ |
+
void |
+setContentString(String content,
+ String charset)
+Sets the content of the attachment, using the specified charset encoding.
+ |
+
void |
+setId(String id)
+Sets the unique ID for the attachment.
+ |
+
void |
+setType(String type)
+Sets the MIME type for the attachment.
+ |
+
public Attachment()+
public Attachment(String id, + byte[] content, + String type)+
id - The unique ID of the attachment.content - The content (byte array) to store for the attachment.type - The MIME type of the attachment.public Attachment(String id, + String content, + String type) + throws UnsupportedEncodingException+
id - The unique ID of the attachment.content - The string representation of the attachment content.type - The MIME type of the attachment.UnsupportedEncodingException - If the named charset is not supported.public Attachment(String id, + String content, + String charset, + String type) + throws UnsupportedEncodingException+
id - The unique ID of the attachment.content - The string representation of the attachment content.charset - The charset encoding to convert the string to bytes with.type - The MIME type of the attachment.UnsupportedEncodingException - If the named charset is not supported.public String getAttachmentId()+
public String getId()+
public void setId(String id)+
id - The unique ID to use for the attachment.public byte[] getContent()+
public String getContentString() + throws UnsupportedEncodingException+
UnsupportedEncodingException - If the named charset is not supported.public String getContentString(String charset) + throws UnsupportedEncodingException+
charset - The charset encoding to convert the content bytes to a string with.UnsupportedEncodingException - If the named charset is not supported.public void setContent(byte[] content)+
content - The content (byte array) to use for the attachment.public void setContentString(String content) + throws UnsupportedEncodingException+
content - The string representation of the attachment content.UnsupportedEncodingException - If the named charset is not supported.public void setContentString(String content, + String charset) + throws UnsupportedEncodingException+
content - The string representation of the attachment content.charset - The charset encoding to convert the string to bytes with.UnsupportedEncodingException - If the named charset is not supported.public String getType()+
public void setType(String type)+
type - The MIME type to set for the attachment.public class AttachmentUtil +extends Object+
| 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 |
+addAttachment(List<Attachment> attachments,
+ Object content,
+ String type,
+ boolean base64Encode)
+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 |
+createAttachment(ImmutableConnectorMessage connectorMessage,
+ Object content,
+ String type,
+ boolean base64Encode)
+Creates an attachment associated with a given connector message, and inserts it into the
+ database.
+ |
+
static Attachment |
+getMessageAttachment(ImmutableConnectorMessage connectorMessage,
+ String attachmentId)
+Retrieves an attachment from the current channel/message ID.
+ |
+
static Attachment |
+getMessageAttachment(ImmutableConnectorMessage connectorMessage,
+ String attachmentId,
+ boolean base64Decode)
+Retrieves an attachment from the current channel/message ID.
+ |
+
static Attachment |
+getMessageAttachment(String channelId,
+ Long messageId,
+ String attachmentId)
+Retrieves an attachment from a specific channel/message ID.
+ |
+
static Attachment |
+getMessageAttachment(String channelId,
+ Long messageId,
+ String attachmentId,
+ boolean base64Decode)
+Retrieves an attachment from a specific channel/message ID.
+ |
+
static List<String> |
+getMessageAttachmentIds(ImmutableConnectorMessage connectorMessage)
+Returns a List of attachment IDs associated with the current channel / message.
+ |
+
static List<String> |
+getMessageAttachmentIds(String channelId,
+ Long messageId)
+Returns a List of attachment IDs associated with the current channel / message.
+ |
+
static List<Attachment> |
+getMessageAttachments(ImmutableConnectorMessage connectorMessage)
+Retrieves all attachments associated with a connector message.
+ |
+
static List<Attachment> |
+getMessageAttachments(ImmutableConnectorMessage connectorMessage,
+ boolean base64Decode)
+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> |
+getMessageAttachments(String channelId,
+ Long messageId,
+ boolean base64Decode)
+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 List<Attachment> |
+getMessageAttachmentsFromSourceChannel(ImmutableConnectorMessage connectorMessage,
+ boolean base64Decode)
+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.
+ |
+
static Attachment |
+updateAttachment(ImmutableConnectorMessage connectorMessage,
+ Attachment attachment)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(ImmutableConnectorMessage connectorMessage,
+ Attachment attachment,
+ boolean base64Encode)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(ImmutableConnectorMessage connectorMessage,
+ String attachmentId,
+ Object content,
+ String type)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(ImmutableConnectorMessage connectorMessage,
+ String attachmentId,
+ Object content,
+ String type,
+ boolean base64Encode)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(String channelId,
+ Long messageId,
+ Attachment attachment)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(String channelId,
+ Long messageId,
+ Attachment attachment,
+ boolean base64Encode)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(String channelId,
+ Long messageId,
+ String attachmentId,
+ Object content,
+ String type)
+Updates an attachment associated with a given connector message.
+ |
+
static Attachment |
+updateAttachment(String channelId,
+ Long messageId,
+ String attachmentId,
+ Object content,
+ String type,
+ boolean base64Encode)
+Updates an attachment associated with a given connector message.
+ |
+
public static byte[] reAttachMessage(String raw, + ImmutableConnectorMessage connectorMessage, + String charsetEncoding, + boolean binary)+
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.public static byte[] reAttachMessage(String raw, + ImmutableConnectorMessage connectorMessage, + String charsetEncoding, + boolean binary, + boolean reattach, + boolean localOnly)+
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.public static String reAttachMessage(ImmutableConnectorMessage connectorMessage)+
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.public static String reAttachMessage(String raw, + ImmutableConnectorMessage connectorMessage)+
raw - The raw message string to replace tokens from.connectorMessage - The ConnectorMessage associated with this message, used to identify the
+ channel/message ID.public static List<String> getMessageAttachmentIds(ImmutableConnectorMessage connectorMessage) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message, used to identify the
+ channel/message ID.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachment IDs could be retrieved.public static List<String> getMessageAttachmentIds(String channelId, + Long messageId) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
channelId - The ID of the channel the attachments are associated with.messageId - The ID of the message the attachments are associated with.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachment IDs could be retrieved.public static List<Attachment> getMessageAttachments(ImmutableConnectorMessage connectorMessage) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message, used to identify the
+ channel/message ID.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachments could not be retrieved.public static List<Attachment> getMessageAttachments(ImmutableConnectorMessage connectorMessage, + boolean base64Decode) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message, used to identify the
+ channel/message ID.base64Decode - If true, the content of each attachment will first be Base64 decoded for
+ convenient use.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachments could not be retrieved.public static List<Attachment> getMessageAttachments(String channelId, + Long messageId) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
channelId - The ID of the channel to retrieve the attachments from.messageId - The ID of the message to retrieve the attachments from.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachments could not be retrieved.public static List<Attachment> getMessageAttachments(String channelId, + Long messageId, + boolean base64Decode) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
channelId - The ID of the channel to retrieve the attachments from.messageId - The ID of the message to retrieve the attachments from.base64Decode - If true, the content of each attachment will first be Base64 decoded for
+ convenient use.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachments could not be retrieved.public static Attachment getMessageAttachment(ImmutableConnectorMessage connectorMessage, + String attachmentId) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message, used to identify the
+ channel/message ID.attachmentId - The ID of the attachment to retrieve.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachment could not be retrieved.public static Attachment getMessageAttachment(ImmutableConnectorMessage connectorMessage, + String attachmentId, + boolean base64Decode) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message, used to identify the
+ channel/message ID.attachmentId - The ID of the attachment to retrieve.base64Decode - If true, the content of each attachment will first be Base64 decoded for
+ convenient use.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachment could not be retrieved.public static Attachment getMessageAttachment(String channelId, + Long messageId, + String attachmentId) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
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.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachment could not be retrieved.public static Attachment getMessageAttachment(String channelId, + Long messageId, + String attachmentId, + boolean base64Decode) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
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.base64Decode - If true, the content of each attachment will first be Base64 decoded for
+ convenient use.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachment could not be retrieved.public static List<Attachment> getMessageAttachmentsFromSourceChannel(ImmutableConnectorMessage connectorMessage) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message. The channel ID and message ID
+ will be retrieved from the source map.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachments could not be retrieved.public static List<Attachment> getMessageAttachmentsFromSourceChannel(ImmutableConnectorMessage connectorMessage, + boolean base64Decode) + throws com.mirth.connect.donkey.model.message.MessageSerializerException+
connectorMessage - The ConnectorMessage associated with this message. The channel ID and message ID
+ will be retrieved from the source map.base64Decode - If true, the content of each attachment will first be Base64 decoded for
+ convenient use.com.mirth.connect.donkey.model.message.MessageSerializerException - If the attachments could not be retrieved.public static Attachment addAttachment(List<Attachment> attachments, + Object content, + String type) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
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.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment addAttachment(List<Attachment> attachments, + Object content, + String type, + boolean base64Encode) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
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.base64Encode - If true, the content of each attachment will first be Base64 encoded for
+ convenience.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment createAttachment(ImmutableConnectorMessage connectorMessage, + Object content, + String type) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
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.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment createAttachment(ImmutableConnectorMessage connectorMessage, + Object content, + String type, + boolean base64Encode) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
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.base64Encode - If true, the content of each attachment will first be Base64 encoded for
+ convenience.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(ImmutableConnectorMessage connectorMessage, + String attachmentId, + Object content, + String type) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
connectorMessage - The connector message to be associated with the attachment.attachmentId - The unique ID of the attachment to update.content - The attachment content (must be a string or byte array).type - The MIME type of the attachment.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(ImmutableConnectorMessage connectorMessage, + String attachmentId, + Object content, + String type, + boolean base64Encode) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
connectorMessage - The connector message to be associated with the attachment.attachmentId - The unique ID of the attachment to update.content - The attachment content (must be a string or byte array).type - The MIME type of the attachment.base64Encode - If true, the content of each attachment will first be Base64 encoded for
+ convenience.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(ImmutableConnectorMessage connectorMessage, + Attachment attachment) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
connectorMessage - The connector message to be associated with the attachment.attachment - The Attachment object to update.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(ImmutableConnectorMessage connectorMessage, + Attachment attachment, + boolean base64Encode) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
connectorMessage - The connector message to be associated with the attachment.attachment - The Attachment object to update.base64Encode - If true, the content of each attachment will first be Base64 encoded for
+ convenience.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(String channelId, + Long messageId, + Attachment attachment) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
channelId - The ID of the channel the attachment is associated with.messageId - The ID of the message the attachment is associated with.attachment - The Attachment object to update.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(String channelId, + Long messageId, + Attachment attachment, + boolean base64Encode) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
channelId - The ID of the channel the attachment is associated with.messageId - The ID of the message the attachment is associated with.attachment - The Attachment object to update.base64Encode - If true, the content of each attachment will first be Base64 encoded for
+ convenience.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(String channelId, + Long messageId, + String attachmentId, + Object content, + String type) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
channelId - The ID of the channel the attachment is associated with.messageId - The ID of the message the attachment is associated with.attachmentId - The unique ID of the attachment to update.content - The attachment content (must be a string or byte array).type - The MIME type of the attachment.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.public static Attachment updateAttachment(String channelId, + Long messageId, + String attachmentId, + Object content, + String type, + boolean base64Encode) + throws com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException+
channelId - The ID of the channel the attachment is associated with.messageId - The ID of the message the attachment is associated with.attachmentId - The unique ID of the attachment to update.content - The attachment content (must be a string or byte array).type - The MIME type of the attachment.base64Encode - If true, the content of each attachment will first be Base64 encoded for
+ convenience.com.mirth.connect.donkey.server.controllers.UnsupportedDataTypeException - If the attachment content is not a String or byte array.| Constructor and Description | +
|---|
ChannelMap(Map<String,Object> delegate,
+ Map<String,Object> sourceMap)
+Instantiates a new ChannelMap object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clear() |
+
boolean |
+containsKey(Object key) |
+
boolean |
+containsValue(Object value) |
+
Set<Map.Entry<String,Object>> |
+entrySet() |
+
boolean |
+equals(Object o) |
+
Object |
+get(Object key)
+Returns the value to which the specified key is mapped, or null if this map contains no
+ mapping for the key.
+ |
+
int |
+hashCode() |
+
boolean |
+isEmpty() |
+
Set<String> |
+keySet() |
+
Object |
+put(String key,
+ Object value) |
+
void |
+putAll(Map<? extends String,? extends Object> m) |
+
Object |
+remove(Object key) |
+
int |
+size() |
+
Collection<Object> |
+values() |
+
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic ChannelMap(Map<String,Object> delegate, + Map<String,Object> sourceMap)+
delegate - The underlying Map to reference for retrieving/setting data.sourceMap - The source map associated with the current connector message. This is used to
+ check against in the get(key) method for legacy support.public boolean containsKey(Object key)+
containsKey in interface Map<String,Object>public boolean containsValue(Object value)+
containsValue in interface Map<String,Object>public boolean equals(Object o)+ +
public Object get(Object key)+
public int hashCode()+ +
public boolean isEmpty()+ +
public class ChannelUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Future<Void> |
+deployChannel(String channelIdOrName)
+Deploy a channel.
+ |
+
static List<String> |
+getChannelIds()
+Get all channel Ids.
+ |
+
static String |
+getChannelName(String channelId)
+Get the name for a channel.
+ |
+
static List<String> |
+getChannelNames()
+Get all channels names.
+ |
+
static DeployedState |
+getChannelState(String channelIdOrName)
+Get the current state of a channel.
+ |
+
static DeployedState |
+getConnectorState(String channelIdOrName,
+ Number metaDataId)
+Get the current state of a connector.
+ |
+
static String |
+getDeployedChannelId(String channelName)
+Get the id for a deployed channel.
+ |
+
static List<String> |
+getDeployedChannelIds()
+Get all deployed channel Ids.
+ |
+
static String |
+getDeployedChannelName(String channelId)
+Get the name for a deployed channel.
+ |
+
static List<String> |
+getDeployedChannelNames()
+Get all deployed channels names.
+ |
+
static Long |
+getErrorCount(String channelIdOrName)
+Get the error count statistic for a specific channel.
+ |
+
static Long |
+getErrorCount(String channelIdOrName,
+ Number metaDataId)
+Get the error count statistic for a specific connector.
+ |
+
static Long |
+getFilteredCount(String channelIdOrName)
+Get the filtered count statistic for a specific channel.
+ |
+
static Long |
+getFilteredCount(String channelIdOrName,
+ Number metaDataId)
+Get the filtered count statistic for a specific connector.
+ |
+
static Long |
+getQueuedCount(String channelIdOrName)
+Get the queued count statistic for a specific channel.
+ |
+
static Long |
+getQueuedCount(String channelIdOrName,
+ Number metaDataId)
+Get the queued count statistic for a specific connector.
+ |
+
static Long |
+getReceivedCount(String channelIdOrName)
+Get the received count statistic for a specific channel.
+ |
+
static Long |
+getReceivedCount(String channelIdOrName,
+ Number metaDataId)
+Get the received count statistic for a specific connector.
+ |
+
static Long |
+getSentCount(String channelIdOrName)
+Get the sent count statistic for a specific channel.
+ |
+
static Long |
+getSentCount(String channelIdOrName,
+ Number metaDataId)
+Get the sent count statistic for a specific connector.
+ |
+
static Future<Void> |
+haltChannel(String channelIdOrName)
+Halt a deployed channel.
+ |
+
static boolean |
+isChannelDeployed(String channelIdOrName)
+Check if a channel is currently deployed.
+ |
+
static Future<Void> |
+pauseChannel(String channelIdOrName)
+Pause a deployed channel.
+ |
+
static Future<Void> |
+resetStatistics(String channelIdOrName)
+Reset all statistics for a specific channel.
+ |
+
static Future<Void> |
+resetStatistics(String channelIdOrName,
+ Integer metaDataId)
+Reset all statistics for the specified connector on the given channel.
+ |
+
static Future<Void> |
+resetStatistics(String channelIdOrName,
+ Integer metaDataId,
+ Collection<Status> statuses)
+Reset the specified statistics for the specified connector on the given channel.
+ |
+
static Future<Void> |
+resumeChannel(String channelIdOrName)
+Resume a deployed channel.
+ |
+
static Future<Void> |
+startChannel(String channelIdOrName)
+Start a deployed channel.
+ |
+
static Future<Void> |
+startConnector(String channelIdOrName,
+ Integer metaDataId)
+Start a connector on a given channel.
+ |
+
static Future<Void> |
+stopChannel(String channelIdOrName)
+Stop a deployed channel.
+ |
+
static Future<Void> |
+stopConnector(String channelIdOrName,
+ Integer metaDataId)
+Stop a connector on a given channel.
+ |
+
static Future<Void> |
+undeployChannel(String channelIdOrName)
+Undeploy a channel.
+ |
+
public static List<String> getChannelNames()+
public static List<String> getChannelIds()+
public static List<String> getDeployedChannelNames()+
public static String getChannelName(String channelId)+
channelId - The channel id of the channel.public static List<String> getDeployedChannelIds()+
public static String getDeployedChannelName(String channelId)+
channelId - The channel id of the deployed channel.public static String getDeployedChannelId(String channelName)+
channelName - The channel name of the deployed channel.public static Future<Void> startChannel(String channelIdOrName) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> stopChannel(String channelIdOrName) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> pauseChannel(String channelIdOrName) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> resumeChannel(String channelIdOrName) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> haltChannel(String channelIdOrName) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static DeployedState getChannelState(String channelIdOrName)+
channelIdOrName - The channel id or current name of the channel.public static Future<Void> deployChannel(String channelIdOrName)+
channelIdOrName - The channel id or current name of the channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.public static Future<Void> undeployChannel(String channelIdOrName)+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.public static boolean isChannelDeployed(String channelIdOrName)+
channelIdOrName - The channel id or current name of the channel.public static Future<Void> startConnector(String channelIdOrName, + Integer metaDataId) + throws Exception+
channelIdOrName - The channel id or current name of the channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> stopConnector(String channelIdOrName, + Integer metaDataId) + throws Exception+
channelIdOrName - The channel id or current name of the channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static DeployedState getConnectorState(String channelIdOrName, + Number metaDataId)+
channelIdOrName - The channel id or current name of the channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.public static Long getReceivedCount(String channelIdOrName)+
channelIdOrName - The channel id or current name of the deployed channel.public static Long getReceivedCount(String channelIdOrName, + Number metaDataId)+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.public static Long getFilteredCount(String channelIdOrName)+
channelIdOrName - The channel id or current name of the deployed channel.public static Long getFilteredCount(String channelIdOrName, + Number metaDataId)+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.public static Long getQueuedCount(String channelIdOrName)+
channelIdOrName - The channel id or current name of the deployed channel.public static Long getQueuedCount(String channelIdOrName, + Number metaDataId)+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.public static Long getSentCount(String channelIdOrName)+
channelIdOrName - The channel id or current name of the deployed channel.public static Long getSentCount(String channelIdOrName, + Number metaDataId)+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.public static Long getErrorCount(String channelIdOrName)+
channelIdOrName - The channel id or current name of the deployed channel.public static Long getErrorCount(String channelIdOrName, + Number metaDataId)+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the connector. Note that the source connector has a metadata id
+ of 0.public static Future<Void> resetStatistics(String channelIdOrName) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> resetStatistics(String channelIdOrName, + Integer metaDataId) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the deployed connector. Note that the source connector has a
+ metadata id of 0 and the aggregate of null.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public static Future<Void> resetStatistics(String channelIdOrName, + Integer metaDataId, + Collection<Status> statuses) + throws Exception+
channelIdOrName - The channel id or current name of the deployed channel.metaDataId - The metadata id of the deployed connector. Note that the source connector has a
+ metadata id of 0 and the aggregate of null.statuses - A collection of statuses to reset.Future object representing the result of the asynchronous operation. You
+ can call get() or get(timeoutInMillis)
+ to wait for the operation to finish.Exception - If the task cannot be scheduled for execution.public class ContextFactory +extends Object+
| Constructor and Description | +
|---|
ContextFactory(com.mirth.connect.server.util.javascript.MirthContextFactory delegate)
+Instantiates a new ContextFactory object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ClassLoader |
+getClassLoader()
+Returns the application classloader that the current JavaScript context is using.
+ |
+
ClassLoader |
+getIsolatedClassLoader()
+Returns a classloader containing only the libraries contained in the custom resources, with
+ no parent classloader.
+ |
+
Set<String> |
+getResourceIds()
+Returns the set of custom resource IDs that the current JavaScript context is using.
+ |
+
public ContextFactory(com.mirth.connect.server.util.javascript.MirthContextFactory delegate)+
delegate - The underlying ContextFactory this class will delegate to.public Set<String> getResourceIds()+
public ClassLoader getClassLoader()+
public ClassLoader getIsolatedClassLoader()+
public class DICOMUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static org.dcm4che2.data.DicomObject |
+byteArrayToDicomObject(byte[] bytes,
+ boolean decodeBase64)
+Converts a byte array into a dcm4che DicomObject.
+ |
+
static String |
+convertDICOM(String imageType,
+ ImmutableConnectorMessage connectorMessage)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static String |
+convertDICOM(String imageType,
+ ImmutableConnectorMessage connectorMessage,
+ boolean autoThreshold)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static String |
+convertDICOM(String imageType,
+ ImmutableConnectorMessage connectorMessage,
+ int sliceIndex)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static String |
+convertDICOM(String imageType,
+ ImmutableConnectorMessage connectorMessage,
+ int sliceIndex,
+ boolean autoThreshold)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static byte[] |
+convertDICOMToByteArray(String imageType,
+ ImmutableConnectorMessage connectorMessage)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static byte[] |
+convertDICOMToByteArray(String imageType,
+ ImmutableConnectorMessage connectorMessage,
+ int sliceIndex)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static byte[] |
+convertDICOMToByteArray(String imageType,
+ ImmutableConnectorMessage connectorMessage,
+ int sliceIndex,
+ boolean autoThreshold)
+Converts merged DICOM data associated with a connector message into a specified image format.
+ |
+
static byte[] |
+dicomObjectToByteArray(org.dcm4che2.data.DicomObject dicomObject)
+Converts a dcm4che DicomObject into a byte array.
+ |
+
static byte[] |
+getDICOMMessage(ImmutableConnectorMessage connectorMessage)
+Re-attaches DICOM attachments with the header data in the connector message and returns the
+ resulting merged data as a byte array.
+ |
+
static byte[] |
+getDICOMRawBytes(ImmutableConnectorMessage connectorMessage)
+Re-attaches DICOM attachments with the header data in the connector message and returns the
+ resulting merged data as a byte array.
+ |
+
static String |
+getDICOMRawData(ImmutableConnectorMessage connectorMessage)
+Re-attaches DICOM attachments with the header data in the connector message and returns the
+ resulting merged data as a Base64-encoded string.
+ |
+
static int |
+getSliceCount(ImmutableConnectorMessage connectorMessage)
+Returns the number of slices in the fully-merged DICOM data associated with a given connector
+ message.
+ |
+
static String |
+mergeHeaderAttachments(ImmutableConnectorMessage connectorMessage,
+ List<Attachment> attachments)
+Re-attaches DICOM attachments with the header data in the connector message and returns the
+ resulting merged data as a Base-64 encoded String.
+ |
+
static String |
+mergeHeaderPixelData(byte[] header,
+ List<byte[]> images)
+Re-attaches DICOM attachments with the given header data and returns the resulting merged
+ data as a Base-64 encoded String.
+ |
+
public static String getDICOMRawData(ImmutableConnectorMessage connectorMessage)+
connectorMessage - The connector message to retrieve merged DICOM data for.public static byte[] getDICOMRawBytes(ImmutableConnectorMessage connectorMessage)+
connectorMessage - The connector message to retrieve merged DICOM data for.public static byte[] getDICOMMessage(ImmutableConnectorMessage connectorMessage)+
connectorMessage - The connector message to retrieve merged DICOM data for.public static String mergeHeaderAttachments(ImmutableConnectorMessage connectorMessage, + List<Attachment> attachments) + throws com.mirth.connect.donkey.model.message.MessageSerializerException, + IOException+
connectorMessage - The connector message containing header data to merge DICOM attachments with.attachments - The DICOM attachments to merge with the header data.com.mirth.connect.donkey.model.message.MessageSerializerException - If a database access error occurs, or the DICOM data could not be parsed.IOException - If Base64 encoding failed.public static String mergeHeaderPixelData(byte[] header, + List<byte[]> images) + throws IOException+
header - The header data to merge DICOM attachments with.images - The DICOM attachments as byte arrays to merge with the header data.IOException - If Base64 encoding failed.public static int getSliceCount(ImmutableConnectorMessage connectorMessage)+
connectorMessage - The connector message to retrieve DICOM data for.public static String convertDICOM(String imageType, + ImmutableConnectorMessage connectorMessage, + boolean autoThreshold)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.autoThreshold - If true, automatically sets the lower and upper threshold levels.public static String convertDICOM(String imageType, + ImmutableConnectorMessage connectorMessage)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.public static String convertDICOM(String imageType, + ImmutableConnectorMessage connectorMessage, + int sliceIndex)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.sliceIndex - If there are multiple slices in the DICOM data, this indicates which one to use
+ (the first slice has an index of 1).public static String convertDICOM(String imageType, + ImmutableConnectorMessage connectorMessage, + int sliceIndex, + boolean autoThreshold)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.sliceIndex - If there are multiple slices in the DICOM data, this indicates which one to use
+ (the first slice has an index of 1).autoThreshold - If true, automatically sets the lower and upper threshold levels.public static byte[] convertDICOMToByteArray(String imageType, + ImmutableConnectorMessage connectorMessage)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.public static byte[] convertDICOMToByteArray(String imageType, + ImmutableConnectorMessage connectorMessage, + int sliceIndex)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.sliceIndex - If there are multiple slices in the DICOM data, this indicates which one to use
+ (the first slice has an index of 1).public static byte[] convertDICOMToByteArray(String imageType, + ImmutableConnectorMessage connectorMessage, + int sliceIndex, + boolean autoThreshold)+
imageType - The image format to convert the DICOM data to (e.g. "jpg").connectorMessage - The connector message to retrieve merged DICOM data for.sliceIndex - If there are multiple slices in the DICOM data, this indicates which one to use
+ (the first slice has an index of 1).autoThreshold - If true, automatically sets the lower and upper threshold levels.public static org.dcm4che2.data.DicomObject byteArrayToDicomObject(byte[] bytes, + boolean decodeBase64) + throws IOException+
bytes - The binary data to convert.decodeBase64 - If true, the data is assumed to be Base64-encoded.IOException - If Base64 encoding failed.public static byte[] dicomObjectToByteArray(org.dcm4che2.data.DicomObject dicomObject) + throws IOException+
dicomObject - The DicomObject to convert.IOException - If Base64 encoding failed.public class DatabaseConnection +extends Object+
| Constructor and Description | +
|---|
DatabaseConnection(Driver driver,
+ String address)
+Instantiates a new database connection with the given driver instance and server address.
+ |
+
DatabaseConnection(Driver driver,
+ String address,
+ Properties info)
+Instantiates a new database connection with the given driver instance, server address, and
+ connection arguments.
+ |
+
DatabaseConnection(String address)
+Instantiates a new database connection with the given server address.
+ |
+
DatabaseConnection(String address,
+ Properties info)
+Instantiates a new database connection with the given server address and connection
+ arguments.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+close()
+Closes the database connection.
+ |
+
void |
+commit()
+Makes all changes made since the previous commit/rollback permanent and releases any database
+ locks currently held by this DatabaseConnection object.
+ |
+
CachedRowSet |
+executeCachedQuery(String expression)
+Executes a query on the database and returns a CachedRowSet.
+ |
+
CachedRowSet |
+executeCachedQuery(String expression,
+ List<Object> parameters)
+Executes a prepared query on the database and returns a CachedRowSet.
+ |
+
int |
+executeUpdate(String expression)
+Executes an INSERT/UPDATE on the database and returns the row count.
+ |
+
int |
+executeUpdate(String expression,
+ List<Object> parameters)
+Executes a prepared INSERT/UPDATE statement on the database and returns the row count.
+ |
+
CachedRowSet |
+executeUpdateAndGetGeneratedKeys(String expression)
+Executes an INSERT/UPDATE statement on the database and returns a CachedRowSet containing any
+ generated keys.
+ |
+
CachedRowSet |
+executeUpdateAndGetGeneratedKeys(String expression,
+ List<Object> parameters)
+Executes a prepared INSERT/UPDATE statement on the database and returns a CachedRowSet
+ containing any generated keys.
+ |
+
String |
+getAddress()
+Returns the server address.
+ |
+
Connection |
+getConnection()
+Returns the database connection (java.sql.Connection) this class is using.
+ |
+
void |
+rollback()
+Undoes all changes made in the current transaction and releases any database locks currently
+ held by this Connection object.
+ |
+
void |
+setAutoCommit(boolean autoCommit)
+Sets this connection's auto-commit mode to the given state.
+ |
+
public DatabaseConnection(String address) + throws SQLException+
address - The server address to connect to.SQLException - If a database access error occurs.public DatabaseConnection(String address, + Properties info) + throws SQLException+
address - The server address to connect to.info - A Properties object containing all applicable connection arguments.SQLException - If a database access error occurs.public DatabaseConnection(Driver driver, + String address) + throws SQLException+
driver - The explicit driver instance to connect with.address - The server address to connect to.SQLException - If a database access error occurs.public DatabaseConnection(Driver driver, + String address, + Properties info) + throws SQLException+
driver - The explicit driver instance to connect with.address - The server address to connect to.info - A Properties object containing all applicable connection arguments.SQLException - If a database access error occurs.public String getAddress()+
public CachedRowSet executeCachedQuery(String expression) + throws SQLException+
expression - The query expression to be executed.SQLException - If a database access error occurs.public int executeUpdate(String expression) + throws SQLException+
expression - The statement to be executed.SQLException - If a database access error occurs.public int executeUpdate(String expression, + List<Object> parameters) + throws SQLException+
expression - The prepared statement to be executed.parameters - The parameters for the prepared statement.SQLException - If a database access error occurs.public CachedRowSet executeCachedQuery(String expression, + List<Object> parameters) + throws SQLException+
expression - The prepared statement to be executed.parameters - The parameters for the prepared statement.SQLException - If a database access error occurs.public void close()+
public void setAutoCommit(boolean autoCommit) + throws SQLException+
autoCommit - The value (true or false) to set the connection's auto-commit mode to.SQLException - If a database access error occurs.public void rollback() + throws SQLException+
SQLException - If a database access error occurs.public void commit() + throws SQLException+
SQLException - If a database access error occurs.public CachedRowSet executeUpdateAndGetGeneratedKeys(String expression) + throws SQLException+
expression - The statement to be executed.SQLException - If a database access error occurs.public CachedRowSet executeUpdateAndGetGeneratedKeys(String expression, + List<Object> parameters) + throws SQLException+
expression - The prepared statement to be executed.parameters - The parameters for the prepared statement.SQLException - If a database access error occurs.public Connection getConnection()+
public class DatabaseConnectionFactory +extends Object+
| Constructor and Description | +
|---|
DatabaseConnectionFactory(com.mirth.connect.server.util.javascript.MirthContextFactory contextFactory) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Connection |
+createConnection(String driver,
+ String address,
+ String username,
+ String password)
+Instantiates and returns a new java.sql.Connection object with the given connection
+ parameters.
+ |
+
DatabaseConnection |
+createDatabaseConnection(String driver,
+ String address)
+Instantiates and returns a new DatabaseConnection object with the given connection
+ parameters.
+ |
+
DatabaseConnection |
+createDatabaseConnection(String driver,
+ String address,
+ String username,
+ String password)
+Instantiates and returns a new DatabaseConnection object with the given connection
+ parameters.
+ |
+
void |
+initializeDriver(String driver)
+Initializes the specified JDBC driver.
+ |
+
public DatabaseConnectionFactory(com.mirth.connect.server.util.javascript.MirthContextFactory contextFactory)+
public DatabaseConnection createDatabaseConnection(String driver, + String address, + String username, + String password) + throws SQLException+
driver - The JDBC driver class (as a string) to use to create the connection with.address - The server address to connect to.username - The username to connect with.password - The password to connect with.SQLException - If a database access error occurs.public DatabaseConnection createDatabaseConnection(String driver, + String address) + throws SQLException+
driver - The JDBC driver class (as a string) to use to create the connection with.address - The server address to connect to.SQLException - If a database access error occurs.public Connection createConnection(String driver, + String address, + String username, + String password) + throws SQLException+
driver - The JDBC driver class (as a string) to use to create the connection with.address - The server address to connect to.username - The username to connect with.password - The password to connect with.SQLException - If a database access error occurs.public void initializeDriver(String driver) + throws Exception+
driver - The JDBC driver class (as a string) to initialize.Exception - If the driver could not be initialized.public class DateUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+convertDate(String inPattern,
+ String outPattern,
+ String date)
+Parses a date string according to a specified input pattern, and formats the date back to a
+ string according to a specified output pattern.
+ |
+
static String |
+formatDate(String pattern,
+ Date date)
+Formats a java.util.Date object into a string according to a specified pattern.
+ |
+
static String |
+getCurrentDate(String pattern)
+Formats the current date into a string according to a specified pattern.
+ |
+
static Date |
+getDate(String pattern,
+ String date)
+Parses a date string according to the specified pattern and returns a java.util.Date object.
+ |
+
public static Date getDate(String pattern, + String date) + throws Exception+
pattern - The SimpleDateFormat pattern to use (e.g. "yyyyMMddHHmmss").date - The date string to parse.Exception - If the pattern could not be parsed.public static String formatDate(String pattern, + Date date)+
pattern - The SimpleDateFormat pattern to use (e.g. "yyyyMMddHHmmss").date - The java.util.Date object to format.public static String getCurrentDate(String pattern)+
pattern - The SimpleDateFormat pattern to use (e.g. "yyyyMMddHHmmss").public static String convertDate(String inPattern, + String outPattern, + String date) + throws Exception+
inPattern - The SimpleDateFormat pattern to use for parsing the inbound date string (e.g.
+ "yyyyMMddHHmmss").outPattern - The SimpleDateFormat pattern to use for formatting the outbound date string (e.g.
+ "yyyyMMddHHmmss").date - The date string to convert.Exception - If the pattern could not be parsed.public enum DeployedState +extends Enum<DeployedState>+
| Enum Constant and Description | +
|---|
DEPLOYING |
+
PAUSED |
+
PAUSING |
+
STARTED |
+
STARTING |
+
STOPPED |
+
STOPPING |
+
SYNCING |
+
UNDEPLOYED |
+
UNDEPLOYING |
+
UNKNOWN |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+toString() |
+
static DeployedState |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DeployedState[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final DeployedState UNDEPLOYED+
public static final DeployedState DEPLOYING+
public static final DeployedState UNDEPLOYING+
public static final DeployedState STARTING+
public static final DeployedState STARTED+
public static final DeployedState PAUSING+
public static final DeployedState PAUSED+
public static final DeployedState STOPPING+
public static final DeployedState STOPPED+
public static final DeployedState SYNCING+
public static final DeployedState UNKNOWN+
public static DeployedState[] values()+
+for (DeployedState c : DeployedState.values()) + System.out.println(c); +
public static DeployedState valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String toString()+
toString in class Enum<DeployedState>public class DestinationSet +extends Object+
| Constructor and Description | +
|---|
DestinationSet(ImmutableConnectorMessage connectorMessage)
+DestinationSet instances should NOT be constructed manually.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+remove(Collection<Object> metaDataIdOrConnectorNames)
+Stop a destination from being processed for this message.
+ |
+
boolean |
+remove(Object metaDataIdOrConnectorName)
+Stop a destination from being processed for this message.
+ |
+
boolean |
+removeAll()
+Stop all destinations from being processed for this message.
+ |
+
boolean |
+removeAllExcept(Collection<Object> metaDataIdOrConnectorNames)
+Stop all except one destination from being processed for this message.
+ |
+
boolean |
+removeAllExcept(Object metaDataIdOrConnectorName)
+Stop all except one destination from being processed for this message.
+ |
+
public DestinationSet(ImmutableConnectorMessage connectorMessage)+
connectorMessage - The delegate ImmutableConnectorMessage object.public boolean remove(Object metaDataIdOrConnectorName)+
metaDataIdOrConnectorName - An integer representing the metaDataId of a destination connector, or the actual
+ destination connector name.public boolean remove(Collection<Object> metaDataIdOrConnectorNames)+
metaDataIdOrConnectorNames - A collection of integers representing the metaDataId of a destination connectors,
+ or the actual destination connector names. JavaScript arrays can be used.public boolean removeAllExcept(Object metaDataIdOrConnectorName)+
metaDataIdOrConnectorName - An integer representing the metaDataId of a destination connector, or the actual
+ destination connector name.public boolean removeAllExcept(Collection<Object> metaDataIdOrConnectorNames)+
metaDataIdOrConnectorNames - A collection of integers representing the metaDataId of a destination connectors,
+ or the actual destination connector names. JavaScript arrays can be used.public boolean removeAll()+
public class EncryptedData +extends Object+
EncryptionUtil.encrypt(byte[]).| Constructor and Description | +
|---|
EncryptedData(String header,
+ byte[] encryptedData) |
+
| Modifier and Type | +Method and Description | +
|---|---|
byte[] |
+getEncryptedData()
+Returns the encrypted data as a byte array.
+ |
+
String |
+getHeader()
+Returns the meta-information about the encrypted data.
+ |
+
public EncryptedData(String header, + byte[] encryptedData)+
public String getHeader()+
public byte[] getEncryptedData()+
public class EncryptionUtil +extends Object+
| Constructor and Description | +
|---|
EncryptionUtil() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+decrypt(String data)
+Convenience method for decrypting data.
+ |
+
static byte[] |
+decrypt(String header,
+ byte[] data)
+Convenience method for decrypting data.
+ |
+
static EncryptedData |
+encrypt(byte[] data)
+Convenience method for encrypting data.
+ |
+
static String |
+encrypt(String data)
+Convenience method for encrypting data.
+ |
+
public static String encrypt(String data) + throws com.mirth.commons.encryption.EncryptionException+
data - The data to encrypt, as a String.com.mirth.commons.encryption.EncryptionException - If the data cannot be encrypted for any reason.public static EncryptedData encrypt(byte[] data) + throws com.mirth.commons.encryption.EncryptionException+
data - The data to encrypt, as a raw byte array.EncryptedData object containing the header information and encrypted data.com.mirth.commons.encryption.EncryptionException - If the data cannot be encrypted for any reason.public static String decrypt(String data) + throws com.mirth.commons.encryption.EncryptionException+
data - The data to decrypt, as a String.com.mirth.commons.encryption.EncryptionException - If the data cannot be decrypted for any reason.public static byte[] decrypt(String header, + byte[] data) + throws com.mirth.commons.encryption.EncryptionException+
header - The meta-information about the encrypted data. This is a specially-formatted
+ string returned from the encrypt(byte[]) method.data - The data to decrypt, as a raw byte array.com.mirth.commons.encryption.EncryptionException - If the data cannot be decrypted for any reason.public class FileUtil +extends Object+
FileUtils| Modifier and Type | +Method and Description | +
|---|---|
static byte[] |
+decode(String data)
+Decodes a Base64 string into octets.
+ |
+
static boolean |
+deleteFile(File file)
+Deletes a specified File.
+ |
+
static String |
+encode(byte[] data)
+Encoded binary data into a Base64 string.
+ |
+
static String |
+read(String fileName)
+Returns the contents of the file as a string, using the system default charset encoding.
+ |
+
static byte[] |
+readBytes(String fileName)
+Returns the contents of the file as a byte array.
+ |
+
static String |
+rtfToPlainText(String message,
+ String replaceLinebreaksWith)
+Converts an RTF into plain text using the Swing RTFEditorKit.
+ |
+
static void |
+write(String fileName,
+ boolean append,
+ byte[] bytes)
+Writes a byte array to a file, creating the file if it does not exist.
+ |
+
static void |
+write(String fileName,
+ boolean append,
+ String data)
+Writes a string to a specified file, creating the file if it does not exist.
+ |
+
public static void write(String fileName, + boolean append, + String data) + throws IOException+
fileName - The pathname string of the file to write to.append - If true, the data will be added to the end of the file rather than overwriting the
+ file.data - The content to write to the file.IOException - If an I/O error occurred.FileUtils.writeStringToFile(File, String)public static byte[] decode(String data)+
data - The Base64 string to decode.public static String encode(byte[] data)+
data - The binary data to encode (byte array).public static void write(String fileName, + boolean append, + byte[] bytes) + throws IOException+
fileName - The pathname string of the file to write to.append - If true, the data will be added to the end of the file rather than overwriting the
+ file.bytes - The binary content to write to the file.IOException - If an I/O error occurred.FileUtils.writeByteArrayToFile(File, byte[])public static byte[] readBytes(String fileName) + throws IOException+
fileName - The pathname string of the file to read from.IOException - If an I/O error occurred.FileUtils.readFileToByteArray(File)public static String read(String fileName) + throws IOException+
fileName - The pathname string of the file to read from.IOException - If an I/O error occurred.FileUtils.readFileToString(File)public static boolean deleteFile(File file) + throws SecurityException+
file - The File to delete.SecurityException - If the security manager denies access to delete the file.public static String rtfToPlainText(String message, + String replaceLinebreaksWith) + throws IOException, + BadLocationException+
message - The RTF message to convert.replaceLinebreaksWith - If not null, any line breaks in the converted message will be replaced with this
+ string.IOException - If an I/O error occurred.BadLocationException - If an invalid location within the document is used.public class Future<V> +extends Object +implements Future<V>+
Future represents the result of an asynchronous computation. Methods are provided to
+ check if the computation is complete, to wait for its completion, and to retrieve the result of
+ the computation. The result can only be retrieved using method get when the computation
+ has completed, blocking if necessary until it is ready. Cancellation is performed by the
+ cancel method. Additional methods are provided to determine if the task completed
+ normally or was cancelled. Once a computation has completed, the computation cannot be cancelled.
+ If you would like to use a Future for the sake of cancellability but not provide a usable
+ result, you can declare types of the form Future<?> and return null as a result
+ of the underlying task.| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+cancel(boolean mayInterruptIfRunning)
+Attempts to cancel execution of this task.
+ |
+
V |
+get()
+Waits if necessary for the computation to complete, and then retrieves its result.
+ |
+
V |
+get(long timeoutInMillis)
+Waits if necessary for at most the given time for the computation to complete, and then
+ retrieves its result, if available.
+ |
+
V |
+get(long timeout,
+ TimeUnit unit)
+Waits if necessary for at most the given time for the computation to complete, and then
+ retrieves its result, if available.
+ |
+
boolean |
+isCancelled()
+Returns
+true if this task was cancelled before it completed normally. |
+
boolean |
+isDone()
+Returns
+true if this task completed. |
+
public boolean cancel(boolean mayInterruptIfRunning)+
cancel is called, this task should
+ never run. If the task has already started, then the mayInterruptIfRunning parameter
+ determines whether the thread executing this task should be interrupted in an attempt to stop
+ the task.
+
+ After this method returns, subsequent calls to isDone() will always return
+ true. Subsequent calls to isCancelled() will always return true if
+ this method returned true.cancel in interface Future<V>mayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise,
+ in-progress tasks are allowed to completefalse if the task could not be cancelled, typically because it has already
+ completed normally; true otherwisepublic boolean isCancelled()+
true if this task was cancelled before it completed normally.isCancelled in interface Future<V>true if this task was cancelled before it completedpublic boolean isDone()+
true if this task completed.
+
+ Completion may be due to normal termination, an exception, or cancellation -- in all of these
+ cases, this method will return true.public V get() + throws InterruptedException, + ExecutionException+
get in interface Future<V>CancellationException - if the computation was cancelledExecutionException - if the computation threw an exceptionInterruptedException - if the current thread was interrupted while waitingpublic V get(long timeoutInMillis) + throws InterruptedException, + ExecutionException, + TimeoutException+
timeoutInMillis - the maximum time to wait, in millisecondsCancellationException - if the computation was cancelledExecutionException - if the computation threw an exceptionInterruptedException - if the current thread was interrupted while waitingTimeoutException - if the wait timed outget(long, TimeUnit)public V get(long timeout, + TimeUnit unit) + throws InterruptedException, + ExecutionException, + TimeoutException+
get in interface Future<V>timeout - the maximum time to waitunit - the time unit of the timeout argumentCancellationException - if the computation was cancelledExecutionException - if the computation threw an exceptionInterruptedException - if the current thread was interrupted while waitingTimeoutException - if the wait timed outpublic class HTTPUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+httpBodyToXml(InputStream httpBody,
+ String contentType)
+Serializes an HTTP request body into XML.
+ |
+
static String |
+httpBodyToXml(String httpBody,
+ String contentType)
+Serializes an HTTP request body into XML.
+ |
+
static Map<String,String> |
+parseHeaders(String str)
+Converts a block of HTTP header fields into a Map containing each header key and value.
+ |
+
public static Map<String,String> parseHeaders(String str) + throws Exception+
str - The block of HTTP header fields to convert.Exception - If the header string could not be parsed.public static String httpBodyToXml(InputStream httpBody, + String contentType) + throws javax.mail.MessagingException, + IOException, + com.mirth.connect.donkey.util.DonkeyElement.DonkeyElementException, + ParserConfigurationException+
httpBody - The request body/payload input stream to parse.contentType - The MIME content type of the request.javax.mail.MessagingException - If the body could not be converted into a multipart object.IOException - If the body could not be read into a string.com.mirth.connect.donkey.util.DonkeyElement.DonkeyElementException - If an XML parsing error occurs.ParserConfigurationException - If an XML or multipart parsing error occurs.public static String httpBodyToXml(String httpBody, + String contentType) + throws javax.mail.MessagingException, + IOException, + com.mirth.connect.donkey.util.DonkeyElement.DonkeyElementException, + ParserConfigurationException+
httpBody - The request body/payload string to parse.contentType - The MIME content type of the request.javax.mail.MessagingException - If the body could not be converted into a multipart object.IOException - If the body could not be read into a string.com.mirth.connect.donkey.util.DonkeyElement.DonkeyElementException - If an XML parsing error occurs.ParserConfigurationException - If an XML or multipart parsing error occurs.public class HashUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+generate(byte[] bytes,
+ String algorithm)
+Takes in a byte[], an encoding, and a hashing algorithm and generates a hex hash.
+ |
+
static String |
+generate(Object data)
+Takes in any object and generates a SHA-256 hex hash.
+ |
+
static String |
+generate(String str,
+ String encoding,
+ String algorithm)
+Takes in a string, an encoding, and a hashing algorithm and generates a hex hash.
+ |
+
public static String generate(Object data) + throws Exception+
data - The data to hash.Exception - If generating a SHA-256 hex hash fails.public static String generate(String str, + String encoding, + String algorithm) + throws Exception+
str - The string to hash.encoding - The character encoding to use.algorithm - The hashing algorithm to use.Exception - If generating a hex hash of the string fails.public static String generate(byte[] bytes, + String algorithm) + throws Exception+
bytes - The byte[] to hash.algorithm - The hashing algorithm to use.Exception - If generating a hex hash of the byte[] fails.public class ImmutableResponse +extends Object+
| Constructor and Description | +
|---|
ImmutableResponse(Response response)
+Instantiates a new ImmutableResponse object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getError()
+Returns the error string associated with this response, if it exists.
+ |
+
String |
+getMessage()
+Returns the actual response data, as a string.
+ |
+
Status |
+getNewMessageStatus()
+Returns the Status (e.g.
+ |
+
String |
+getStatusMessage()
+Returns a brief message explaining the reason for the current status.
+ |
+
public ImmutableResponse(Response response)+
response - The Response object that this object will reference for retrieving data.public String getMessage()+
public Status getNewMessageStatus()+
public String getError()+
public String getStatusMessage()+
public class MirthCachedRowSet +extends Object +implements CachedRowSet+
COMMIT_ON_ACCEPT_CHANGESCLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE| Constructor and Description | +
|---|
MirthCachedRowSet() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+absolute(int row) |
+
void |
+acceptChanges() |
+
void |
+acceptChanges(Connection con) |
+
void |
+addRowSetListener(RowSetListener listener) |
+
void |
+afterLast() |
+
void |
+beforeFirst() |
+
void |
+cancelRowUpdates() |
+
void |
+clearParameters() |
+
void |
+clearWarnings() |
+
void |
+close() |
+
boolean |
+columnUpdated(int idx) |
+
boolean |
+columnUpdated(String columnName) |
+
void |
+commit() |
+
CachedRowSet |
+createCopy() |
+
CachedRowSet |
+createCopyNoConstraints() |
+
CachedRowSet |
+createCopySchema() |
+
RowSet |
+createShared() |
+
void |
+deleteRow() |
+
void |
+execute() |
+
void |
+execute(Connection conn) |
+
int |
+findColumn(String columnName) |
+
boolean |
+first() |
+
Array |
+getArray(int columnIndex) |
+
Array |
+getArray(String colName) |
+
InputStream |
+getAsciiStream(int columnIndex) |
+
InputStream |
+getAsciiStream(String columnName) |
+
BigDecimal |
+getBigDecimal(int columnIndex) |
+
BigDecimal |
+getBigDecimal(int columnIndex,
+ int scale) |
+
BigDecimal |
+getBigDecimal(String columnName) |
+
BigDecimal |
+getBigDecimal(String columnName,
+ int scale) |
+
InputStream |
+getBinaryStream(int columnIndex) |
+
InputStream |
+getBinaryStream(String columnName) |
+
Blob |
+getBlob(int columnIndex) |
+
Blob |
+getBlob(String colName) |
+
boolean |
+getBoolean(int columnIndex) |
+
boolean |
+getBoolean(String columnName) |
+
byte |
+getByte(int columnIndex) |
+
byte |
+getByte(String columnName) |
+
byte[] |
+getBytes(int columnIndex) |
+
byte[] |
+getBytes(String columnName) |
+
Reader |
+getCharacterStream(int columnIndex) |
+
Reader |
+getCharacterStream(String columnName) |
+
Clob |
+getClob(int columnIndex) |
+
Clob |
+getClob(String colName) |
+
String |
+getCommand() |
+
int |
+getConcurrency() |
+
String |
+getCursorName() |
+
String |
+getDataSourceName() |
+
Date |
+getDate(int columnIndex) |
+
Date |
+getDate(int columnIndex,
+ Calendar cal) |
+
Date |
+getDate(String columnName) |
+
Date |
+getDate(String columnName,
+ Calendar cal) |
+
double |
+getDouble(int columnIndex) |
+
double |
+getDouble(String columnName) |
+
boolean |
+getEscapeProcessing() |
+
int |
+getFetchDirection() |
+
int |
+getFetchSize() |
+
float |
+getFloat(int columnIndex) |
+
float |
+getFloat(String columnName) |
+
int |
+getHoldability() |
+
int |
+getInt(int columnIndex) |
+
int |
+getInt(String columnName) |
+
int[] |
+getKeyColumns() |
+
long |
+getLong(int columnIndex) |
+
long |
+getLong(String columnName) |
+
int[] |
+getMatchColumnIndexes() |
+
String[] |
+getMatchColumnNames() |
+
int |
+getMaxFieldSize() |
+
int |
+getMaxRows() |
+
ResultSetMetaData |
+getMetaData() |
+
Reader |
+getNCharacterStream(int columnIndex) |
+
Reader |
+getNCharacterStream(String columnLabel) |
+
NClob |
+getNClob(int columnIndex) |
+
NClob |
+getNClob(String columnLabel) |
+
String |
+getNString(int columnIndex) |
+
String |
+getNString(String columnLabel) |
+
Object |
+getObject(int columnIndex) |
+
<T> T |
+getObject(int columnIndex,
+ Class<T> type) |
+
Object |
+getObject(int columnIndex,
+ Map<String,Class<?>> map) |
+
Object |
+getObject(String columnName) |
+
<T> T |
+getObject(String columnLabel,
+ Class<T> type) |
+
Object |
+getObject(String columnName,
+ Map<String,Class<?>> map) |
+
ResultSet |
+getOriginal() |
+
ResultSet |
+getOriginalRow() |
+
int |
+getPageSize() |
+
String |
+getPassword() |
+
int |
+getQueryTimeout() |
+
Ref |
+getRef(int columnIndex) |
+
Ref |
+getRef(String colName) |
+
int |
+getRow() |
+
RowId |
+getRowId(int columnIndex) |
+
RowId |
+getRowId(String columnLabel) |
+
RowSetWarning |
+getRowSetWarnings() |
+
short |
+getShort(int columnIndex) |
+
short |
+getShort(String columnName) |
+
boolean |
+getShowDeleted() |
+
SQLXML |
+getSQLXML(int columnIndex) |
+
SQLXML |
+getSQLXML(String columnLabel) |
+
Statement |
+getStatement() |
+
String |
+getString(int columnIndex) |
+
String |
+getString(String columnName) |
+
SyncProvider |
+getSyncProvider() |
+
String |
+getTableName() |
+
Time |
+getTime(int columnIndex) |
+
Time |
+getTime(int columnIndex,
+ Calendar cal) |
+
Time |
+getTime(String columnName) |
+
Time |
+getTime(String columnName,
+ Calendar cal) |
+
Timestamp |
+getTimestamp(int columnIndex) |
+
Timestamp |
+getTimestamp(int columnIndex,
+ Calendar cal) |
+
Timestamp |
+getTimestamp(String columnName) |
+
Timestamp |
+getTimestamp(String columnName,
+ Calendar cal) |
+
int |
+getTransactionIsolation() |
+
int |
+getType() |
+
Map<String,Class<?>> |
+getTypeMap() |
+
InputStream |
+getUnicodeStream(int columnIndex) |
+
InputStream |
+getUnicodeStream(String columnName) |
+
String |
+getUrl() |
+
URL |
+getURL(int columnIndex) |
+
URL |
+getURL(String columnName) |
+
String |
+getUsername() |
+
SQLWarning |
+getWarnings() |
+
void |
+insertRow() |
+
boolean |
+isAfterLast() |
+
boolean |
+isBeforeFirst() |
+
boolean |
+isClosed() |
+
boolean |
+isFirst() |
+
boolean |
+isLast() |
+
boolean |
+isReadOnly() |
+
boolean |
+isWrapperFor(Class<?> iface) |
+
boolean |
+last() |
+
void |
+moveToCurrentRow() |
+
void |
+moveToInsertRow() |
+
boolean |
+next() |
+
boolean |
+nextPage() |
+
void |
+populate(ResultSet data) |
+
void |
+populate(ResultSet rs,
+ int startRow) |
+
boolean |
+previous() |
+
boolean |
+previousPage() |
+
void |
+refreshRow() |
+
boolean |
+relative(int rows) |
+
void |
+release() |
+
void |
+removeRowSetListener(RowSetListener listener) |
+
void |
+restoreOriginal() |
+
void |
+rollback() |
+
void |
+rollback(Savepoint s) |
+
boolean |
+rowDeleted() |
+
boolean |
+rowInserted() |
+
void |
+rowSetPopulated(RowSetEvent event,
+ int numRows) |
+
boolean |
+rowUpdated() |
+
void |
+setArray(int i,
+ Array x) |
+
void |
+setAsciiStream(int parameterIndex,
+ InputStream x) |
+
void |
+setAsciiStream(int parameterIndex,
+ InputStream x,
+ int length) |
+
void |
+setAsciiStream(String parameterName,
+ InputStream x) |
+
void |
+setAsciiStream(String parameterName,
+ InputStream x,
+ int length) |
+
void |
+setBigDecimal(int parameterIndex,
+ BigDecimal x) |
+
void |
+setBigDecimal(String parameterName,
+ BigDecimal x) |
+
void |
+setBinaryStream(int parameterIndex,
+ InputStream x) |
+
void |
+setBinaryStream(int parameterIndex,
+ InputStream x,
+ int length) |
+
void |
+setBinaryStream(String parameterName,
+ InputStream x) |
+
void |
+setBinaryStream(String parameterName,
+ InputStream x,
+ int length) |
+
void |
+setBlob(int i,
+ Blob x) |
+
void |
+setBlob(int parameterIndex,
+ InputStream inputStream) |
+
void |
+setBlob(int parameterIndex,
+ InputStream inputStream,
+ long length) |
+
void |
+setBlob(String parameterName,
+ Blob x) |
+
void |
+setBlob(String parameterName,
+ InputStream inputStream) |
+
void |
+setBlob(String parameterName,
+ InputStream inputStream,
+ long length) |
+
void |
+setBoolean(int parameterIndex,
+ boolean x) |
+
void |
+setBoolean(String parameterName,
+ boolean x) |
+
void |
+setByte(int parameterIndex,
+ byte x) |
+
void |
+setByte(String parameterName,
+ byte x) |
+
void |
+setBytes(int parameterIndex,
+ byte[] x) |
+
void |
+setBytes(String parameterName,
+ byte[] x) |
+
void |
+setCharacterStream(int parameterIndex,
+ Reader reader) |
+
void |
+setCharacterStream(int parameterIndex,
+ Reader reader,
+ int length) |
+
void |
+setCharacterStream(String parameterName,
+ Reader reader) |
+
void |
+setCharacterStream(String parameterName,
+ Reader reader,
+ int length) |
+
void |
+setClob(int i,
+ Clob x) |
+
void |
+setClob(int parameterIndex,
+ Reader reader) |
+
void |
+setClob(int parameterIndex,
+ Reader reader,
+ long length) |
+
void |
+setClob(String parameterName,
+ Clob x) |
+
void |
+setClob(String parameterName,
+ Reader reader) |
+
void |
+setClob(String parameterName,
+ Reader reader,
+ long length) |
+
void |
+setCommand(String cmd) |
+
void |
+setConcurrency(int concurrency) |
+
void |
+setDataSourceName(String name) |
+
void |
+setDate(int parameterIndex,
+ Date x) |
+
void |
+setDate(int parameterIndex,
+ Date x,
+ Calendar cal) |
+
void |
+setDate(String parameterName,
+ Date x) |
+
void |
+setDate(String parameterName,
+ Date x,
+ Calendar cal) |
+
void |
+setDouble(int parameterIndex,
+ double x) |
+
void |
+setDouble(String parameterName,
+ double x) |
+
void |
+setEscapeProcessing(boolean enable) |
+
void |
+setFetchDirection(int direction) |
+
void |
+setFetchSize(int rows) |
+
void |
+setFloat(int parameterIndex,
+ float x) |
+
void |
+setFloat(String parameterName,
+ float x) |
+
void |
+setInt(int parameterIndex,
+ int x) |
+
void |
+setInt(String parameterName,
+ int x) |
+
void |
+setKeyColumns(int[] keys) |
+
void |
+setLong(int parameterIndex,
+ long x) |
+
void |
+setLong(String parameterName,
+ long x) |
+
void |
+setMatchColumn(int columnIdx) |
+
void |
+setMatchColumn(int[] columnIdxes) |
+
void |
+setMatchColumn(String columnName) |
+
void |
+setMatchColumn(String[] columnNames) |
+
void |
+setMaxFieldSize(int max) |
+
void |
+setMaxRows(int max) |
+
void |
+setMetaData(RowSetMetaData md) |
+
void |
+setNCharacterStream(int parameterIndex,
+ Reader value) |
+
void |
+setNCharacterStream(int parameterIndex,
+ Reader value,
+ long length) |
+
void |
+setNCharacterStream(String parameterName,
+ Reader value) |
+
void |
+setNCharacterStream(String parameterName,
+ Reader value,
+ long length) |
+
void |
+setNClob(int parameterIndex,
+ NClob value) |
+
void |
+setNClob(int parameterIndex,
+ Reader reader) |
+
void |
+setNClob(int parameterIndex,
+ Reader reader,
+ long length) |
+
void |
+setNClob(String parameterName,
+ NClob value) |
+
void |
+setNClob(String parameterName,
+ Reader reader) |
+
void |
+setNClob(String parameterName,
+ Reader reader,
+ long length) |
+
void |
+setNString(int parameterIndex,
+ String value) |
+
void |
+setNString(String parameterName,
+ String value) |
+
void |
+setNull(int parameterIndex,
+ int sqlType) |
+
void |
+setNull(int paramIndex,
+ int sqlType,
+ String typeName) |
+
void |
+setNull(String parameterName,
+ int sqlType) |
+
void |
+setNull(String parameterName,
+ int sqlType,
+ String typeName) |
+
void |
+setObject(int parameterIndex,
+ Object x) |
+
void |
+setObject(int parameterIndex,
+ Object x,
+ int targetSqlType) |
+
void |
+setObject(int parameterIndex,
+ Object x,
+ int targetSqlType,
+ int scaleOrLength) |
+
void |
+setObject(String parameterName,
+ Object x) |
+
void |
+setObject(String parameterName,
+ Object x,
+ int targetSqlType) |
+
void |
+setObject(String parameterName,
+ Object x,
+ int targetSqlType,
+ int scale) |
+
void |
+setOriginalRow() |
+
void |
+setPageSize(int size) |
+
void |
+setPassword(String password) |
+
void |
+setQueryTimeout(int seconds) |
+
void |
+setReadOnly(boolean value) |
+
void |
+setRef(int i,
+ Ref x) |
+
void |
+setRowId(int parameterIndex,
+ RowId x) |
+
void |
+setRowId(String parameterName,
+ RowId x) |
+
void |
+setShort(int parameterIndex,
+ short x) |
+
void |
+setShort(String parameterName,
+ short x) |
+
void |
+setShowDeleted(boolean b) |
+
void |
+setSQLXML(int parameterIndex,
+ SQLXML xmlObject) |
+
void |
+setSQLXML(String parameterName,
+ SQLXML xmlObject) |
+
void |
+setString(int parameterIndex,
+ String x) |
+
void |
+setString(String parameterName,
+ String x) |
+
void |
+setSyncProvider(String provider) |
+
void |
+setTableName(String tabName) |
+
void |
+setTime(int parameterIndex,
+ Time x) |
+
void |
+setTime(int parameterIndex,
+ Time x,
+ Calendar cal) |
+
void |
+setTime(String parameterName,
+ Time x) |
+
void |
+setTime(String parameterName,
+ Time x,
+ Calendar cal) |
+
void |
+setTimestamp(int parameterIndex,
+ Timestamp x) |
+
void |
+setTimestamp(int parameterIndex,
+ Timestamp x,
+ Calendar cal) |
+
void |
+setTimestamp(String parameterName,
+ Timestamp x) |
+
void |
+setTimestamp(String parameterName,
+ Timestamp x,
+ Calendar cal) |
+
void |
+setTransactionIsolation(int level) |
+
void |
+setType(int type) |
+
void |
+setTypeMap(Map<String,Class<?>> map) |
+
void |
+setURL(int parameterIndex,
+ URL x) |
+
void |
+setUrl(String url) |
+
void |
+setUsername(String name) |
+
int |
+size() |
+
Collection<?> |
+toCollection() |
+
Collection<?> |
+toCollection(int column) |
+
Collection<?> |
+toCollection(String column) |
+
void |
+undoDelete() |
+
void |
+undoInsert() |
+
void |
+undoUpdate() |
+
void |
+unsetMatchColumn(int columnIdx) |
+
void |
+unsetMatchColumn(int[] columnIdxes) |
+
void |
+unsetMatchColumn(String columnName) |
+
void |
+unsetMatchColumn(String[] columnName) |
+
<T> T |
+unwrap(Class<T> iface) |
+
void |
+updateArray(int columnIndex,
+ Array x) |
+
void |
+updateArray(String columnName,
+ Array a) |
+
void |
+updateAsciiStream(int columnIndex,
+ InputStream x) |
+
void |
+updateAsciiStream(int columnIndex,
+ InputStream x,
+ int length) |
+
void |
+updateAsciiStream(int columnIndex,
+ InputStream x,
+ long length) |
+
void |
+updateAsciiStream(String columnLabel,
+ InputStream x) |
+
void |
+updateAsciiStream(String columnName,
+ InputStream x,
+ int length) |
+
void |
+updateAsciiStream(String columnLabel,
+ InputStream x,
+ long length) |
+
void |
+updateBigDecimal(int columnIndex,
+ BigDecimal x) |
+
void |
+updateBigDecimal(String columnName,
+ BigDecimal x) |
+
void |
+updateBinaryStream(int columnIndex,
+ InputStream x) |
+
void |
+updateBinaryStream(int columnIndex,
+ InputStream x,
+ int length) |
+
void |
+updateBinaryStream(int columnIndex,
+ InputStream x,
+ long length) |
+
void |
+updateBinaryStream(String columnLabel,
+ InputStream x) |
+
void |
+updateBinaryStream(String columnName,
+ InputStream x,
+ int length) |
+
void |
+updateBinaryStream(String columnLabel,
+ InputStream x,
+ long length) |
+
void |
+updateBlob(int columnIndex,
+ Blob x) |
+
void |
+updateBlob(int columnIndex,
+ InputStream inputStream) |
+
void |
+updateBlob(int columnIndex,
+ InputStream inputStream,
+ long length) |
+
void |
+updateBlob(String columnName,
+ Blob b) |
+
void |
+updateBlob(String columnLabel,
+ InputStream inputStream) |
+
void |
+updateBlob(String columnLabel,
+ InputStream inputStream,
+ long length) |
+
void |
+updateBoolean(int columnIndex,
+ boolean x) |
+
void |
+updateBoolean(String columnName,
+ boolean x) |
+
void |
+updateByte(int columnIndex,
+ byte x) |
+
void |
+updateByte(String columnName,
+ byte x) |
+
void |
+updateBytes(int columnIndex,
+ byte[] x) |
+
void |
+updateBytes(String columnName,
+ byte[] x) |
+
void |
+updateCharacterStream(int columnIndex,
+ Reader x) |
+
void |
+updateCharacterStream(int columnIndex,
+ Reader x,
+ int length) |
+
void |
+updateCharacterStream(int columnIndex,
+ Reader x,
+ long length) |
+
void |
+updateCharacterStream(String columnLabel,
+ Reader reader) |
+
void |
+updateCharacterStream(String columnName,
+ Reader reader,
+ int length) |
+
void |
+updateCharacterStream(String columnLabel,
+ Reader reader,
+ long length) |
+
void |
+updateClob(int columnIndex,
+ Clob x) |
+
void |
+updateClob(int columnIndex,
+ Reader reader) |
+
void |
+updateClob(int columnIndex,
+ Reader reader,
+ long length) |
+
void |
+updateClob(String columnName,
+ Clob c) |
+
void |
+updateClob(String columnLabel,
+ Reader reader) |
+
void |
+updateClob(String columnLabel,
+ Reader reader,
+ long length) |
+
void |
+updateDate(int columnIndex,
+ Date x) |
+
void |
+updateDate(String columnName,
+ Date x) |
+
void |
+updateDouble(int columnIndex,
+ double x) |
+
void |
+updateDouble(String columnName,
+ double x) |
+
void |
+updateFloat(int columnIndex,
+ float x) |
+
void |
+updateFloat(String columnName,
+ float x) |
+
void |
+updateInt(int columnIndex,
+ int x) |
+
void |
+updateInt(String columnName,
+ int x) |
+
void |
+updateLong(int columnIndex,
+ long x) |
+
void |
+updateLong(String columnName,
+ long x) |
+
void |
+updateNCharacterStream(int columnIndex,
+ Reader x) |
+
void |
+updateNCharacterStream(int columnIndex,
+ Reader x,
+ long length) |
+
void |
+updateNCharacterStream(String columnLabel,
+ Reader reader) |
+
void |
+updateNCharacterStream(String columnLabel,
+ Reader reader,
+ long length) |
+
void |
+updateNClob(int columnIndex,
+ NClob nClob) |
+
void |
+updateNClob(int columnIndex,
+ Reader reader) |
+
void |
+updateNClob(int columnIndex,
+ Reader reader,
+ long length) |
+
void |
+updateNClob(String columnLabel,
+ NClob nClob) |
+
void |
+updateNClob(String columnLabel,
+ Reader reader) |
+
void |
+updateNClob(String columnLabel,
+ Reader reader,
+ long length) |
+
void |
+updateNString(int columnIndex,
+ String nString) |
+
void |
+updateNString(String columnLabel,
+ String nString) |
+
void |
+updateNull(int columnIndex) |
+
void |
+updateNull(String columnName) |
+
void |
+updateObject(int columnIndex,
+ Object x) |
+
void |
+updateObject(int columnIndex,
+ Object x,
+ int scaleOrLength) |
+
void |
+updateObject(String columnName,
+ Object x) |
+
void |
+updateObject(String columnName,
+ Object x,
+ int scale) |
+
void |
+updateRef(int columnIndex,
+ Ref x) |
+
void |
+updateRef(String columnName,
+ Ref ref) |
+
void |
+updateRow() |
+
void |
+updateRowId(int columnIndex,
+ RowId x) |
+
void |
+updateRowId(String columnLabel,
+ RowId x) |
+
void |
+updateShort(int columnIndex,
+ short x) |
+
void |
+updateShort(String columnName,
+ short x) |
+
void |
+updateSQLXML(int columnIndex,
+ SQLXML xmlObject) |
+
void |
+updateSQLXML(String columnLabel,
+ SQLXML xmlObject) |
+
void |
+updateString(int columnIndex,
+ String x) |
+
void |
+updateString(String columnName,
+ String x) |
+
void |
+updateTime(int columnIndex,
+ Time x) |
+
void |
+updateTime(String columnName,
+ Time x) |
+
void |
+updateTimestamp(int columnIndex,
+ Timestamp x) |
+
void |
+updateTimestamp(String columnName,
+ Timestamp x) |
+
boolean |
+wasNull() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitupdateObject, updateObject, updateObject, updateObjectpublic MirthCachedRowSet() + throws SQLException+
SQLExceptionpublic Collection<?> toCollection(String column) + throws SQLException+
toCollection in interface CachedRowSetSQLExceptionpublic String getString(String columnName) + throws SQLException+
getString in interface ResultSetSQLExceptionpublic boolean getBoolean(String columnName) + throws SQLException+
getBoolean in interface ResultSetSQLExceptionpublic byte getByte(String columnName) + throws SQLException+
getByte in interface ResultSetSQLExceptionpublic short getShort(String columnName) + throws SQLException+
getShort in interface ResultSetSQLExceptionpublic int getInt(String columnName) + throws SQLException+
getInt in interface ResultSetSQLExceptionpublic long getLong(String columnName) + throws SQLException+
getLong in interface ResultSetSQLExceptionpublic float getFloat(String columnName) + throws SQLException+
getFloat in interface ResultSetSQLExceptionpublic double getDouble(String columnName) + throws SQLException+
getDouble in interface ResultSetSQLExceptionpublic BigDecimal getBigDecimal(String columnName, + int scale) + throws SQLException+
getBigDecimal in interface ResultSetSQLExceptionpublic byte[] getBytes(String columnName) + throws SQLException+
getBytes in interface ResultSetSQLExceptionpublic Date getDate(String columnName) + throws SQLException+
getDate in interface ResultSetSQLExceptionpublic Time getTime(String columnName) + throws SQLException+
getTime in interface ResultSetSQLExceptionpublic Timestamp getTimestamp(String columnName) + throws SQLException+
getTimestamp in interface ResultSetSQLExceptionpublic InputStream getAsciiStream(String columnName) + throws SQLException+
getAsciiStream in interface ResultSetSQLExceptionpublic InputStream getUnicodeStream(String columnName) + throws SQLException+
getUnicodeStream in interface ResultSetSQLExceptionpublic InputStream getBinaryStream(String columnName) + throws SQLException+
getBinaryStream in interface ResultSetSQLExceptionpublic Object getObject(String columnName) + throws SQLException+
getObject in interface ResultSetSQLExceptionpublic int findColumn(String columnName) + throws SQLException+
findColumn in interface ResultSetSQLExceptionpublic Reader getCharacterStream(String columnName) + throws SQLException+
getCharacterStream in interface ResultSetSQLExceptionpublic BigDecimal getBigDecimal(String columnName) + throws SQLException+
getBigDecimal in interface ResultSetSQLExceptionpublic boolean columnUpdated(String columnName) + throws SQLException+
columnUpdated in interface CachedRowSetSQLExceptionpublic void updateNull(String columnName) + throws SQLException+
updateNull in interface ResultSetSQLExceptionpublic void updateBoolean(String columnName, + boolean x) + throws SQLException+
updateBoolean in interface ResultSetSQLExceptionpublic void updateByte(String columnName, + byte x) + throws SQLException+
updateByte in interface ResultSetSQLExceptionpublic void updateShort(String columnName, + short x) + throws SQLException+
updateShort in interface ResultSetSQLExceptionpublic void updateInt(String columnName, + int x) + throws SQLException+
updateInt in interface ResultSetSQLExceptionpublic void updateLong(String columnName, + long x) + throws SQLException+
updateLong in interface ResultSetSQLExceptionpublic void updateFloat(String columnName, + float x) + throws SQLException+
updateFloat in interface ResultSetSQLExceptionpublic void updateDouble(String columnName, + double x) + throws SQLException+
updateDouble in interface ResultSetSQLExceptionpublic void updateBigDecimal(String columnName, + BigDecimal x) + throws SQLException+
updateBigDecimal in interface ResultSetSQLExceptionpublic void updateString(String columnName, + String x) + throws SQLException+
updateString in interface ResultSetSQLExceptionpublic void updateBytes(String columnName, + byte[] x) + throws SQLException+
updateBytes in interface ResultSetSQLExceptionpublic void updateDate(String columnName, + Date x) + throws SQLException+
updateDate in interface ResultSetSQLExceptionpublic void updateTime(String columnName, + Time x) + throws SQLException+
updateTime in interface ResultSetSQLExceptionpublic void updateTimestamp(String columnName, + Timestamp x) + throws SQLException+
updateTimestamp in interface ResultSetSQLExceptionpublic void updateAsciiStream(String columnName, + InputStream x, + int length) + throws SQLException+
updateAsciiStream in interface ResultSetSQLExceptionpublic void updateBinaryStream(String columnName, + InputStream x, + int length) + throws SQLException+
updateBinaryStream in interface ResultSetSQLExceptionpublic void updateCharacterStream(String columnName, + Reader reader, + int length) + throws SQLException+
updateCharacterStream in interface ResultSetSQLExceptionpublic void updateObject(String columnName, + Object x, + int scale) + throws SQLException+
updateObject in interface ResultSetSQLExceptionpublic void updateObject(String columnName, + Object x) + throws SQLException+
updateObject in interface ResultSetSQLExceptionpublic Object getObject(String columnName, + Map<String,Class<?>> map) + throws SQLException+
getObject in interface ResultSetSQLExceptionpublic Ref getRef(String colName) + throws SQLException+
getRef in interface ResultSetSQLExceptionpublic Blob getBlob(String colName) + throws SQLException+
getBlob in interface ResultSetSQLExceptionpublic Clob getClob(String colName) + throws SQLException+
getClob in interface ResultSetSQLExceptionpublic Array getArray(String colName) + throws SQLException+
getArray in interface ResultSetSQLExceptionpublic Date getDate(String columnName, + Calendar cal) + throws SQLException+
getDate in interface ResultSetSQLExceptionpublic Time getTime(String columnName, + Calendar cal) + throws SQLException+
getTime in interface ResultSetSQLExceptionpublic Timestamp getTimestamp(String columnName, + Calendar cal) + throws SQLException+
getTimestamp in interface ResultSetSQLExceptionpublic void updateRef(String columnName, + Ref ref) + throws SQLException+
updateRef in interface ResultSetSQLExceptionpublic void updateClob(String columnName, + Clob c) + throws SQLException+
updateClob in interface ResultSetSQLExceptionpublic void updateBlob(String columnName, + Blob b) + throws SQLException+
updateBlob in interface ResultSetSQLExceptionpublic void updateArray(String columnName, + Array a) + throws SQLException+
updateArray in interface ResultSetSQLExceptionpublic URL getURL(String columnName) + throws SQLException+
getURL in interface ResultSetSQLExceptionpublic String getUrl() + throws SQLException+
getUrl in interface RowSetSQLExceptionpublic void setUrl(String url) + throws SQLException+
setUrl in interface RowSetSQLExceptionpublic String getDataSourceName()+
getDataSourceName in interface RowSetpublic void setDataSourceName(String name) + throws SQLException+
setDataSourceName in interface RowSetSQLExceptionpublic String getUsername()+
getUsername in interface RowSetpublic void setUsername(String name) + throws SQLException+
setUsername in interface RowSetSQLExceptionpublic String getPassword()+
getPassword in interface RowSetpublic void setPassword(String password) + throws SQLException+
setPassword in interface RowSetSQLExceptionpublic int getTransactionIsolation()+
getTransactionIsolation in interface RowSetpublic void setTransactionIsolation(int level) + throws SQLException+
setTransactionIsolation in interface RowSetSQLExceptionpublic Map<String,Class<?>> getTypeMap() + throws SQLException+
getTypeMap in interface RowSetSQLExceptionpublic void setTypeMap(Map<String,Class<?>> map) + throws SQLException+
setTypeMap in interface RowSetSQLExceptionpublic String getCommand()+
getCommand in interface RowSetpublic void setCommand(String cmd) + throws SQLException+
setCommand in interface RowSetSQLExceptionpublic boolean isReadOnly()+
isReadOnly in interface RowSetpublic void setReadOnly(boolean value) + throws SQLException+
setReadOnly in interface RowSetSQLExceptionpublic int getMaxFieldSize() + throws SQLException+
getMaxFieldSize in interface RowSetSQLExceptionpublic void setMaxFieldSize(int max) + throws SQLException+
setMaxFieldSize in interface RowSetSQLExceptionpublic int getMaxRows() + throws SQLException+
getMaxRows in interface RowSetSQLExceptionpublic void setMaxRows(int max) + throws SQLException+
setMaxRows in interface RowSetSQLExceptionpublic boolean getEscapeProcessing() + throws SQLException+
getEscapeProcessing in interface RowSetSQLExceptionpublic void setEscapeProcessing(boolean enable) + throws SQLException+
setEscapeProcessing in interface RowSetSQLExceptionpublic int getQueryTimeout() + throws SQLException+
getQueryTimeout in interface RowSetSQLExceptionpublic void setQueryTimeout(int seconds) + throws SQLException+
setQueryTimeout in interface RowSetSQLExceptionpublic void setType(int type) + throws SQLException+
setType in interface RowSetSQLExceptionpublic void setConcurrency(int concurrency) + throws SQLException+
setConcurrency in interface RowSetSQLExceptionpublic void setNull(int parameterIndex, + int sqlType) + throws SQLException+
setNull in interface RowSetSQLExceptionpublic void setNull(String parameterName, + int sqlType) + throws SQLException+
setNull in interface RowSetSQLExceptionpublic void setNull(int paramIndex, + int sqlType, + String typeName) + throws SQLException+
setNull in interface RowSetSQLExceptionpublic void setNull(String parameterName, + int sqlType, + String typeName) + throws SQLException+
setNull in interface RowSetSQLExceptionpublic void setBoolean(int parameterIndex, + boolean x) + throws SQLException+
setBoolean in interface RowSetSQLExceptionpublic void setBoolean(String parameterName, + boolean x) + throws SQLException+
setBoolean in interface RowSetSQLExceptionpublic void setByte(int parameterIndex, + byte x) + throws SQLException+
setByte in interface RowSetSQLExceptionpublic void setByte(String parameterName, + byte x) + throws SQLException+
setByte in interface RowSetSQLExceptionpublic void setShort(int parameterIndex, + short x) + throws SQLException+
setShort in interface RowSetSQLExceptionpublic void setShort(String parameterName, + short x) + throws SQLException+
setShort in interface RowSetSQLExceptionpublic void setInt(int parameterIndex, + int x) + throws SQLException+
setInt in interface RowSetSQLExceptionpublic void setInt(String parameterName, + int x) + throws SQLException+
setInt in interface RowSetSQLExceptionpublic void setLong(int parameterIndex, + long x) + throws SQLException+
setLong in interface RowSetSQLExceptionpublic void setLong(String parameterName, + long x) + throws SQLException+
setLong in interface RowSetSQLExceptionpublic void setFloat(int parameterIndex, + float x) + throws SQLException+
setFloat in interface RowSetSQLExceptionpublic void setFloat(String parameterName, + float x) + throws SQLException+
setFloat in interface RowSetSQLExceptionpublic void setDouble(int parameterIndex, + double x) + throws SQLException+
setDouble in interface RowSetSQLExceptionpublic void setDouble(String parameterName, + double x) + throws SQLException+
setDouble in interface RowSetSQLExceptionpublic void setBigDecimal(int parameterIndex, + BigDecimal x) + throws SQLException+
setBigDecimal in interface RowSetSQLExceptionpublic void setBigDecimal(String parameterName, + BigDecimal x) + throws SQLException+
setBigDecimal in interface RowSetSQLExceptionpublic void setString(int parameterIndex, + String x) + throws SQLException+
setString in interface RowSetSQLExceptionpublic void setString(String parameterName, + String x) + throws SQLException+
setString in interface RowSetSQLExceptionpublic void setBytes(int parameterIndex, + byte[] x) + throws SQLException+
setBytes in interface RowSetSQLExceptionpublic void setBytes(String parameterName, + byte[] x) + throws SQLException+
setBytes in interface RowSetSQLExceptionpublic void setDate(int parameterIndex, + Date x) + throws SQLException+
setDate in interface RowSetSQLExceptionpublic void setTime(int parameterIndex, + Time x) + throws SQLException+
setTime in interface RowSetSQLExceptionpublic void setTimestamp(int parameterIndex, + Timestamp x) + throws SQLException+
setTimestamp in interface RowSetSQLExceptionpublic void setTimestamp(String parameterName, + Timestamp x) + throws SQLException+
setTimestamp in interface RowSetSQLExceptionpublic void setAsciiStream(int parameterIndex, + InputStream x, + int length) + throws SQLException+
setAsciiStream in interface RowSetSQLExceptionpublic void setAsciiStream(String parameterName, + InputStream x, + int length) + throws SQLException+
setAsciiStream in interface RowSetSQLExceptionpublic void setBinaryStream(int parameterIndex, + InputStream x, + int length) + throws SQLException+
setBinaryStream in interface RowSetSQLExceptionpublic void setBinaryStream(String parameterName, + InputStream x, + int length) + throws SQLException+
setBinaryStream in interface RowSetSQLExceptionpublic void setCharacterStream(int parameterIndex, + Reader reader, + int length) + throws SQLException+
setCharacterStream in interface RowSetSQLExceptionpublic void setCharacterStream(String parameterName, + Reader reader, + int length) + throws SQLException+
setCharacterStream in interface RowSetSQLExceptionpublic void setAsciiStream(int parameterIndex, + InputStream x) + throws SQLException+
setAsciiStream in interface RowSetSQLExceptionpublic void setAsciiStream(String parameterName, + InputStream x) + throws SQLException+
setAsciiStream in interface RowSetSQLExceptionpublic void setBinaryStream(int parameterIndex, + InputStream x) + throws SQLException+
setBinaryStream in interface RowSetSQLExceptionpublic void setBinaryStream(String parameterName, + InputStream x) + throws SQLException+
setBinaryStream in interface RowSetSQLExceptionpublic void setCharacterStream(int parameterIndex, + Reader reader) + throws SQLException+
setCharacterStream in interface RowSetSQLExceptionpublic void setCharacterStream(String parameterName, + Reader reader) + throws SQLException+
setCharacterStream in interface RowSetSQLExceptionpublic void setNCharacterStream(int parameterIndex, + Reader value) + throws SQLException+
setNCharacterStream in interface RowSetSQLExceptionpublic void setObject(int parameterIndex, + Object x, + int targetSqlType, + int scaleOrLength) + throws SQLException+
setObject in interface RowSetSQLExceptionpublic void setObject(String parameterName, + Object x, + int targetSqlType, + int scale) + throws SQLException+
setObject in interface RowSetSQLExceptionpublic void setObject(int parameterIndex, + Object x, + int targetSqlType) + throws SQLException+
setObject in interface RowSetSQLExceptionpublic void setObject(String parameterName, + Object x, + int targetSqlType) + throws SQLException+
setObject in interface RowSetSQLExceptionpublic void setObject(String parameterName, + Object x) + throws SQLException+
setObject in interface RowSetSQLExceptionpublic void setObject(int parameterIndex, + Object x) + throws SQLException+
setObject in interface RowSetSQLExceptionpublic void setRef(int i, + Ref x) + throws SQLException+
setRef in interface RowSetSQLExceptionpublic void setBlob(int i, + Blob x) + throws SQLException+
setBlob in interface RowSetSQLExceptionpublic void setBlob(int parameterIndex, + InputStream inputStream, + long length) + throws SQLException+
setBlob in interface RowSetSQLExceptionpublic void setBlob(int parameterIndex, + InputStream inputStream) + throws SQLException+
setBlob in interface RowSetSQLExceptionpublic void setBlob(String parameterName, + InputStream inputStream, + long length) + throws SQLException+
setBlob in interface RowSetSQLExceptionpublic void setBlob(String parameterName, + Blob x) + throws SQLException+
setBlob in interface RowSetSQLExceptionpublic void setBlob(String parameterName, + InputStream inputStream) + throws SQLException+
setBlob in interface RowSetSQLExceptionpublic void setClob(int i, + Clob x) + throws SQLException+
setClob in interface RowSetSQLExceptionpublic void setClob(int parameterIndex, + Reader reader, + long length) + throws SQLException+
setClob in interface RowSetSQLExceptionpublic void setClob(int parameterIndex, + Reader reader) + throws SQLException+
setClob in interface RowSetSQLExceptionpublic void setClob(String parameterName, + Reader reader, + long length) + throws SQLException+
setClob in interface RowSetSQLExceptionpublic void setClob(String parameterName, + Clob x) + throws SQLException+
setClob in interface RowSetSQLExceptionpublic void setClob(String parameterName, + Reader reader) + throws SQLException+
setClob in interface RowSetSQLExceptionpublic void setArray(int i, + Array x) + throws SQLException+
setArray in interface RowSetSQLExceptionpublic void setDate(int parameterIndex, + Date x, + Calendar cal) + throws SQLException+
setDate in interface RowSetSQLExceptionpublic void setDate(String parameterName, + Date x) + throws SQLException+
setDate in interface RowSetSQLExceptionpublic void setDate(String parameterName, + Date x, + Calendar cal) + throws SQLException+
setDate in interface RowSetSQLExceptionpublic void setTime(int parameterIndex, + Time x, + Calendar cal) + throws SQLException+
setTime in interface RowSetSQLExceptionpublic void setTime(String parameterName, + Time x) + throws SQLException+
setTime in interface RowSetSQLExceptionpublic void setTime(String parameterName, + Time x, + Calendar cal) + throws SQLException+
setTime in interface RowSetSQLExceptionpublic void setTimestamp(int parameterIndex, + Timestamp x, + Calendar cal) + throws SQLException+
setTimestamp in interface RowSetSQLExceptionpublic void setTimestamp(String parameterName, + Timestamp x, + Calendar cal) + throws SQLException+
setTimestamp in interface RowSetSQLExceptionpublic void clearParameters() + throws SQLException+
clearParameters in interface RowSetSQLExceptionpublic void execute() + throws SQLException+
execute in interface RowSetSQLExceptionpublic void addRowSetListener(RowSetListener listener)+
addRowSetListener in interface RowSetpublic void removeRowSetListener(RowSetListener listener)+
removeRowSetListener in interface RowSetpublic void setSQLXML(int parameterIndex, + SQLXML xmlObject) + throws SQLException+
setSQLXML in interface RowSetSQLExceptionpublic void setSQLXML(String parameterName, + SQLXML xmlObject) + throws SQLException+
setSQLXML in interface RowSetSQLExceptionpublic void setRowId(int parameterIndex, + RowId x) + throws SQLException+
setRowId in interface RowSetSQLExceptionpublic void setRowId(String parameterName, + RowId x) + throws SQLException+
setRowId in interface RowSetSQLExceptionpublic void setNString(int parameterIndex, + String value) + throws SQLException+
setNString in interface RowSetSQLExceptionpublic void setNString(String parameterName, + String value) + throws SQLException+
setNString in interface RowSetSQLExceptionpublic void setNCharacterStream(int parameterIndex, + Reader value, + long length) + throws SQLException+
setNCharacterStream in interface RowSetSQLExceptionpublic void setNCharacterStream(String parameterName, + Reader value, + long length) + throws SQLException+
setNCharacterStream in interface RowSetSQLExceptionpublic void setNCharacterStream(String parameterName, + Reader value) + throws SQLException+
setNCharacterStream in interface RowSetSQLExceptionpublic void setNClob(String parameterName, + NClob value) + throws SQLException+
setNClob in interface RowSetSQLExceptionpublic void setNClob(String parameterName, + Reader reader, + long length) + throws SQLException+
setNClob in interface RowSetSQLExceptionpublic void setNClob(String parameterName, + Reader reader) + throws SQLException+
setNClob in interface RowSetSQLExceptionpublic void setNClob(int parameterIndex, + Reader reader, + long length) + throws SQLException+
setNClob in interface RowSetSQLExceptionpublic void setNClob(int parameterIndex, + NClob value) + throws SQLException+
setNClob in interface RowSetSQLExceptionpublic void setNClob(int parameterIndex, + Reader reader) + throws SQLException+
setNClob in interface RowSetSQLExceptionpublic void setURL(int parameterIndex, + URL x) + throws SQLException+
setURL in interface RowSetSQLExceptionpublic boolean next() + throws SQLException+
next in interface ResultSetSQLExceptionpublic void close() + throws SQLException+
close in interface AutoCloseableclose in interface ResultSetSQLExceptionpublic boolean wasNull() + throws SQLException+
wasNull in interface ResultSetSQLExceptionpublic String getString(int columnIndex) + throws SQLException+
getString in interface ResultSetSQLExceptionpublic boolean getBoolean(int columnIndex) + throws SQLException+
getBoolean in interface ResultSetSQLExceptionpublic byte getByte(int columnIndex) + throws SQLException+
getByte in interface ResultSetSQLExceptionpublic short getShort(int columnIndex) + throws SQLException+
getShort in interface ResultSetSQLExceptionpublic int getInt(int columnIndex) + throws SQLException+
getInt in interface ResultSetSQLExceptionpublic long getLong(int columnIndex) + throws SQLException+
getLong in interface ResultSetSQLExceptionpublic float getFloat(int columnIndex) + throws SQLException+
getFloat in interface ResultSetSQLExceptionpublic double getDouble(int columnIndex) + throws SQLException+
getDouble in interface ResultSetSQLExceptionpublic BigDecimal getBigDecimal(int columnIndex, + int scale) + throws SQLException+
getBigDecimal in interface ResultSetSQLExceptionpublic byte[] getBytes(int columnIndex) + throws SQLException+
getBytes in interface ResultSetSQLExceptionpublic Date getDate(int columnIndex) + throws SQLException+
getDate in interface ResultSetSQLExceptionpublic Time getTime(int columnIndex) + throws SQLException+
getTime in interface ResultSetSQLExceptionpublic Timestamp getTimestamp(int columnIndex) + throws SQLException+
getTimestamp in interface ResultSetSQLExceptionpublic InputStream getAsciiStream(int columnIndex) + throws SQLException+
getAsciiStream in interface ResultSetSQLExceptionpublic InputStream getUnicodeStream(int columnIndex) + throws SQLException+
getUnicodeStream in interface ResultSetSQLExceptionpublic InputStream getBinaryStream(int columnIndex) + throws SQLException+
getBinaryStream in interface ResultSetSQLExceptionpublic SQLWarning getWarnings() + throws SQLException+
getWarnings in interface ResultSetSQLExceptionpublic void clearWarnings() + throws SQLException+
clearWarnings in interface ResultSetSQLExceptionpublic String getCursorName() + throws SQLException+
getCursorName in interface ResultSetSQLExceptionpublic ResultSetMetaData getMetaData() + throws SQLException+
getMetaData in interface ResultSetSQLExceptionpublic Object getObject(int columnIndex) + throws SQLException+
getObject in interface ResultSetSQLExceptionpublic Reader getCharacterStream(int columnIndex) + throws SQLException+
getCharacterStream in interface ResultSetSQLExceptionpublic BigDecimal getBigDecimal(int columnIndex) + throws SQLException+
getBigDecimal in interface ResultSetSQLExceptionpublic boolean isBeforeFirst() + throws SQLException+
isBeforeFirst in interface ResultSetSQLExceptionpublic boolean isAfterLast() + throws SQLException+
isAfterLast in interface ResultSetSQLExceptionpublic boolean isFirst() + throws SQLException+
isFirst in interface ResultSetSQLExceptionpublic boolean isLast() + throws SQLException+
isLast in interface ResultSetSQLExceptionpublic void beforeFirst() + throws SQLException+
beforeFirst in interface ResultSetSQLExceptionpublic void afterLast() + throws SQLException+
afterLast in interface ResultSetSQLExceptionpublic boolean first() + throws SQLException+
first in interface ResultSetSQLExceptionpublic boolean last() + throws SQLException+
last in interface ResultSetSQLExceptionpublic int getRow() + throws SQLException+
getRow in interface ResultSetSQLExceptionpublic boolean absolute(int row) + throws SQLException+
absolute in interface ResultSetSQLExceptionpublic boolean relative(int rows) + throws SQLException+
relative in interface ResultSetSQLExceptionpublic boolean previous() + throws SQLException+
previous in interface ResultSetSQLExceptionpublic void setFetchDirection(int direction) + throws SQLException+
setFetchDirection in interface ResultSetSQLExceptionpublic int getFetchDirection() + throws SQLException+
getFetchDirection in interface ResultSetSQLExceptionpublic void setFetchSize(int rows) + throws SQLException+
setFetchSize in interface ResultSetSQLExceptionpublic int getFetchSize() + throws SQLException+
getFetchSize in interface ResultSetSQLExceptionpublic int getType() + throws SQLException+
getType in interface ResultSetSQLExceptionpublic int getConcurrency() + throws SQLException+
getConcurrency in interface ResultSetSQLExceptionpublic boolean rowUpdated() + throws SQLException+
rowUpdated in interface ResultSetSQLExceptionpublic boolean rowInserted() + throws SQLException+
rowInserted in interface ResultSetSQLExceptionpublic boolean rowDeleted() + throws SQLException+
rowDeleted in interface ResultSetSQLExceptionpublic void updateNull(int columnIndex) + throws SQLException+
updateNull in interface ResultSetSQLExceptionpublic void updateBoolean(int columnIndex, + boolean x) + throws SQLException+
updateBoolean in interface ResultSetSQLExceptionpublic void updateByte(int columnIndex, + byte x) + throws SQLException+
updateByte in interface ResultSetSQLExceptionpublic void updateShort(int columnIndex, + short x) + throws SQLException+
updateShort in interface ResultSetSQLExceptionpublic void updateInt(int columnIndex, + int x) + throws SQLException+
updateInt in interface ResultSetSQLExceptionpublic void updateLong(int columnIndex, + long x) + throws SQLException+
updateLong in interface ResultSetSQLExceptionpublic void updateFloat(int columnIndex, + float x) + throws SQLException+
updateFloat in interface ResultSetSQLExceptionpublic void updateDouble(int columnIndex, + double x) + throws SQLException+
updateDouble in interface ResultSetSQLExceptionpublic void updateBigDecimal(int columnIndex, + BigDecimal x) + throws SQLException+
updateBigDecimal in interface ResultSetSQLExceptionpublic void updateString(int columnIndex, + String x) + throws SQLException+
updateString in interface ResultSetSQLExceptionpublic void updateBytes(int columnIndex, + byte[] x) + throws SQLException+
updateBytes in interface ResultSetSQLExceptionpublic void updateDate(int columnIndex, + Date x) + throws SQLException+
updateDate in interface ResultSetSQLExceptionpublic void updateTime(int columnIndex, + Time x) + throws SQLException+
updateTime in interface ResultSetSQLExceptionpublic void updateTimestamp(int columnIndex, + Timestamp x) + throws SQLException+
updateTimestamp in interface ResultSetSQLExceptionpublic void updateAsciiStream(int columnIndex, + InputStream x, + int length) + throws SQLException+
updateAsciiStream in interface ResultSetSQLExceptionpublic void updateBinaryStream(int columnIndex, + InputStream x, + int length) + throws SQLException+
updateBinaryStream in interface ResultSetSQLExceptionpublic void updateCharacterStream(int columnIndex, + Reader x, + int length) + throws SQLException+
updateCharacterStream in interface ResultSetSQLExceptionpublic void updateObject(int columnIndex, + Object x, + int scaleOrLength) + throws SQLException+
updateObject in interface ResultSetSQLExceptionpublic void updateObject(int columnIndex, + Object x) + throws SQLException+
updateObject in interface ResultSetSQLExceptionpublic void insertRow() + throws SQLException+
insertRow in interface ResultSetSQLExceptionpublic void updateRow() + throws SQLException+
updateRow in interface ResultSetSQLExceptionpublic void deleteRow() + throws SQLException+
deleteRow in interface ResultSetSQLExceptionpublic void refreshRow() + throws SQLException+
refreshRow in interface ResultSetSQLExceptionpublic void cancelRowUpdates() + throws SQLException+
cancelRowUpdates in interface ResultSetSQLExceptionpublic void moveToInsertRow() + throws SQLException+
moveToInsertRow in interface ResultSetSQLExceptionpublic void moveToCurrentRow() + throws SQLException+
moveToCurrentRow in interface ResultSetSQLExceptionpublic Statement getStatement() + throws SQLException+
getStatement in interface ResultSetSQLExceptionpublic Object getObject(int columnIndex, + Map<String,Class<?>> map) + throws SQLException+
getObject in interface ResultSetSQLExceptionpublic Ref getRef(int columnIndex) + throws SQLException+
getRef in interface ResultSetSQLExceptionpublic Blob getBlob(int columnIndex) + throws SQLException+
getBlob in interface ResultSetSQLExceptionpublic Clob getClob(int columnIndex) + throws SQLException+
getClob in interface ResultSetSQLExceptionpublic Array getArray(int columnIndex) + throws SQLException+
getArray in interface ResultSetSQLExceptionpublic Date getDate(int columnIndex, + Calendar cal) + throws SQLException+
getDate in interface ResultSetSQLExceptionpublic Time getTime(int columnIndex, + Calendar cal) + throws SQLException+
getTime in interface ResultSetSQLExceptionpublic Timestamp getTimestamp(int columnIndex, + Calendar cal) + throws SQLException+
getTimestamp in interface ResultSetSQLExceptionpublic URL getURL(int columnIndex) + throws SQLException+
getURL in interface ResultSetSQLExceptionpublic void updateRef(int columnIndex, + Ref x) + throws SQLException+
updateRef in interface ResultSetSQLExceptionpublic void updateBlob(int columnIndex, + Blob x) + throws SQLException+
updateBlob in interface ResultSetSQLExceptionpublic void updateClob(int columnIndex, + Clob x) + throws SQLException+
updateClob in interface ResultSetSQLExceptionpublic void updateArray(int columnIndex, + Array x) + throws SQLException+
updateArray in interface ResultSetSQLExceptionpublic RowId getRowId(int columnIndex) + throws SQLException+
getRowId in interface ResultSetSQLExceptionpublic RowId getRowId(String columnLabel) + throws SQLException+
getRowId in interface ResultSetSQLExceptionpublic void updateRowId(int columnIndex, + RowId x) + throws SQLException+
updateRowId in interface ResultSetSQLExceptionpublic void updateRowId(String columnLabel, + RowId x) + throws SQLException+
updateRowId in interface ResultSetSQLExceptionpublic int getHoldability() + throws SQLException+
getHoldability in interface ResultSetSQLExceptionpublic boolean isClosed() + throws SQLException+
isClosed in interface ResultSetSQLExceptionpublic void updateNString(int columnIndex, + String nString) + throws SQLException+
updateNString in interface ResultSetSQLExceptionpublic void updateNString(String columnLabel, + String nString) + throws SQLException+
updateNString in interface ResultSetSQLExceptionpublic void updateNClob(int columnIndex, + NClob nClob) + throws SQLException+
updateNClob in interface ResultSetSQLExceptionpublic void updateNClob(String columnLabel, + NClob nClob) + throws SQLException+
updateNClob in interface ResultSetSQLExceptionpublic NClob getNClob(int columnIndex) + throws SQLException+
getNClob in interface ResultSetSQLExceptionpublic NClob getNClob(String columnLabel) + throws SQLException+
getNClob in interface ResultSetSQLExceptionpublic SQLXML getSQLXML(int columnIndex) + throws SQLException+
getSQLXML in interface ResultSetSQLExceptionpublic SQLXML getSQLXML(String columnLabel) + throws SQLException+
getSQLXML in interface ResultSetSQLExceptionpublic void updateSQLXML(int columnIndex, + SQLXML xmlObject) + throws SQLException+
updateSQLXML in interface ResultSetSQLExceptionpublic void updateSQLXML(String columnLabel, + SQLXML xmlObject) + throws SQLException+
updateSQLXML in interface ResultSetSQLExceptionpublic String getNString(int columnIndex) + throws SQLException+
getNString in interface ResultSetSQLExceptionpublic String getNString(String columnLabel) + throws SQLException+
getNString in interface ResultSetSQLExceptionpublic Reader getNCharacterStream(int columnIndex) + throws SQLException+
getNCharacterStream in interface ResultSetSQLExceptionpublic Reader getNCharacterStream(String columnLabel) + throws SQLException+
getNCharacterStream in interface ResultSetSQLExceptionpublic void updateNCharacterStream(int columnIndex, + Reader x, + long length) + throws SQLException+
updateNCharacterStream in interface ResultSetSQLExceptionpublic void updateNCharacterStream(String columnLabel, + Reader reader, + long length) + throws SQLException+
updateNCharacterStream in interface ResultSetSQLExceptionpublic void updateAsciiStream(int columnIndex, + InputStream x, + long length) + throws SQLException+
updateAsciiStream in interface ResultSetSQLExceptionpublic void updateBinaryStream(int columnIndex, + InputStream x, + long length) + throws SQLException+
updateBinaryStream in interface ResultSetSQLExceptionpublic void updateCharacterStream(int columnIndex, + Reader x, + long length) + throws SQLException+
updateCharacterStream in interface ResultSetSQLExceptionpublic void updateAsciiStream(String columnLabel, + InputStream x, + long length) + throws SQLException+
updateAsciiStream in interface ResultSetSQLExceptionpublic void updateBinaryStream(String columnLabel, + InputStream x, + long length) + throws SQLException+
updateBinaryStream in interface ResultSetSQLExceptionpublic void updateCharacterStream(String columnLabel, + Reader reader, + long length) + throws SQLException+
updateCharacterStream in interface ResultSetSQLExceptionpublic void updateBlob(int columnIndex, + InputStream inputStream, + long length) + throws SQLException+
updateBlob in interface ResultSetSQLExceptionpublic void updateBlob(String columnLabel, + InputStream inputStream, + long length) + throws SQLException+
updateBlob in interface ResultSetSQLExceptionpublic void updateClob(int columnIndex, + Reader reader, + long length) + throws SQLException+
updateClob in interface ResultSetSQLExceptionpublic void updateClob(String columnLabel, + Reader reader, + long length) + throws SQLException+
updateClob in interface ResultSetSQLExceptionpublic void updateNClob(int columnIndex, + Reader reader, + long length) + throws SQLException+
updateNClob in interface ResultSetSQLExceptionpublic void updateNClob(String columnLabel, + Reader reader, + long length) + throws SQLException+
updateNClob in interface ResultSetSQLExceptionpublic void updateNCharacterStream(int columnIndex, + Reader x) + throws SQLException+
updateNCharacterStream in interface ResultSetSQLExceptionpublic void updateNCharacterStream(String columnLabel, + Reader reader) + throws SQLException+
updateNCharacterStream in interface ResultSetSQLExceptionpublic void updateAsciiStream(int columnIndex, + InputStream x) + throws SQLException+
updateAsciiStream in interface ResultSetSQLExceptionpublic void updateBinaryStream(int columnIndex, + InputStream x) + throws SQLException+
updateBinaryStream in interface ResultSetSQLExceptionpublic void updateCharacterStream(int columnIndex, + Reader x) + throws SQLException+
updateCharacterStream in interface ResultSetSQLExceptionpublic void updateAsciiStream(String columnLabel, + InputStream x) + throws SQLException+
updateAsciiStream in interface ResultSetSQLExceptionpublic void updateBinaryStream(String columnLabel, + InputStream x) + throws SQLException+
updateBinaryStream in interface ResultSetSQLExceptionpublic void updateCharacterStream(String columnLabel, + Reader reader) + throws SQLException+
updateCharacterStream in interface ResultSetSQLExceptionpublic void updateBlob(int columnIndex, + InputStream inputStream) + throws SQLException+
updateBlob in interface ResultSetSQLExceptionpublic void updateBlob(String columnLabel, + InputStream inputStream) + throws SQLException+
updateBlob in interface ResultSetSQLExceptionpublic void updateClob(int columnIndex, + Reader reader) + throws SQLException+
updateClob in interface ResultSetSQLExceptionpublic void updateClob(String columnLabel, + Reader reader) + throws SQLException+
updateClob in interface ResultSetSQLExceptionpublic void updateNClob(int columnIndex, + Reader reader) + throws SQLException+
updateNClob in interface ResultSetSQLExceptionpublic void updateNClob(String columnLabel, + Reader reader) + throws SQLException+
updateNClob in interface ResultSetSQLExceptionpublic <T> T getObject(int columnIndex, + Class<T> type) + throws SQLException+
getObject in interface ResultSetSQLExceptionpublic <T> T getObject(String columnLabel, + Class<T> type) + throws SQLException+
getObject in interface ResultSetSQLExceptionpublic <T> T unwrap(Class<T> iface) + throws SQLException+
unwrap in interface WrapperSQLExceptionpublic boolean isWrapperFor(Class<?> iface) + throws SQLException+
isWrapperFor in interface WrapperSQLExceptionpublic void setMatchColumn(int columnIdx) + throws SQLException+
setMatchColumn in interface JoinableSQLExceptionpublic void setMatchColumn(int[] columnIdxes) + throws SQLException+
setMatchColumn in interface JoinableSQLExceptionpublic void setMatchColumn(String columnName) + throws SQLException+
setMatchColumn in interface JoinableSQLExceptionpublic void setMatchColumn(String[] columnNames) + throws SQLException+
setMatchColumn in interface JoinableSQLExceptionpublic int[] getMatchColumnIndexes() + throws SQLException+
getMatchColumnIndexes in interface JoinableSQLExceptionpublic String[] getMatchColumnNames() + throws SQLException+
getMatchColumnNames in interface JoinableSQLExceptionpublic void unsetMatchColumn(int columnIdx) + throws SQLException+
unsetMatchColumn in interface JoinableSQLExceptionpublic void unsetMatchColumn(int[] columnIdxes) + throws SQLException+
unsetMatchColumn in interface JoinableSQLExceptionpublic void unsetMatchColumn(String columnName) + throws SQLException+
unsetMatchColumn in interface JoinableSQLExceptionpublic void unsetMatchColumn(String[] columnName) + throws SQLException+
unsetMatchColumn in interface JoinableSQLExceptionpublic void populate(ResultSet data) + throws SQLException+
populate in interface CachedRowSetSQLExceptionpublic void execute(Connection conn) + throws SQLException+
execute in interface CachedRowSetSQLExceptionpublic void acceptChanges() + throws SyncProviderException+
acceptChanges in interface CachedRowSetSyncProviderExceptionpublic void acceptChanges(Connection con) + throws SyncProviderException+
acceptChanges in interface CachedRowSetSyncProviderExceptionpublic void restoreOriginal() + throws SQLException+
restoreOriginal in interface CachedRowSetSQLExceptionpublic void release() + throws SQLException+
release in interface CachedRowSetSQLExceptionpublic void undoDelete() + throws SQLException+
undoDelete in interface CachedRowSetSQLExceptionpublic void undoInsert() + throws SQLException+
undoInsert in interface CachedRowSetSQLExceptionpublic void undoUpdate() + throws SQLException+
undoUpdate in interface CachedRowSetSQLExceptionpublic boolean columnUpdated(int idx) + throws SQLException+
columnUpdated in interface CachedRowSetSQLExceptionpublic Collection<?> toCollection() + throws SQLException+
toCollection in interface CachedRowSetSQLExceptionpublic Collection<?> toCollection(int column) + throws SQLException+
toCollection in interface CachedRowSetSQLExceptionpublic SyncProvider getSyncProvider() + throws SQLException+
getSyncProvider in interface CachedRowSetSQLExceptionpublic void setSyncProvider(String provider) + throws SQLException+
setSyncProvider in interface CachedRowSetSQLExceptionpublic int size()+
size in interface CachedRowSetpublic void setMetaData(RowSetMetaData md) + throws SQLException+
setMetaData in interface CachedRowSetSQLExceptionpublic ResultSet getOriginal() + throws SQLException+
getOriginal in interface CachedRowSetSQLExceptionpublic ResultSet getOriginalRow() + throws SQLException+
getOriginalRow in interface CachedRowSetSQLExceptionpublic void setOriginalRow() + throws SQLException+
setOriginalRow in interface CachedRowSetSQLExceptionpublic String getTableName() + throws SQLException+
getTableName in interface CachedRowSetSQLExceptionpublic void setTableName(String tabName) + throws SQLException+
setTableName in interface CachedRowSetSQLExceptionpublic int[] getKeyColumns() + throws SQLException+
getKeyColumns in interface CachedRowSetSQLExceptionpublic void setKeyColumns(int[] keys) + throws SQLException+
setKeyColumns in interface CachedRowSetSQLExceptionpublic RowSet createShared() + throws SQLException+
createShared in interface CachedRowSetSQLExceptionpublic CachedRowSet createCopy() + throws SQLException+
createCopy in interface CachedRowSetSQLExceptionpublic CachedRowSet createCopySchema() + throws SQLException+
createCopySchema in interface CachedRowSetSQLExceptionpublic CachedRowSet createCopyNoConstraints() + throws SQLException+
createCopyNoConstraints in interface CachedRowSetSQLExceptionpublic RowSetWarning getRowSetWarnings() + throws SQLException+
getRowSetWarnings in interface CachedRowSetSQLExceptionpublic boolean getShowDeleted() + throws SQLException+
getShowDeleted in interface CachedRowSetSQLExceptionpublic void setShowDeleted(boolean b) + throws SQLException+
setShowDeleted in interface CachedRowSetSQLExceptionpublic void commit() + throws SQLException+
commit in interface CachedRowSetSQLExceptionpublic void rollback() + throws SQLException+
rollback in interface CachedRowSetSQLExceptionpublic void rollback(Savepoint s) + throws SQLException+
rollback in interface CachedRowSetSQLExceptionpublic void rowSetPopulated(RowSetEvent event, + int numRows) + throws SQLException+
rowSetPopulated in interface CachedRowSetSQLExceptionpublic void populate(ResultSet rs, + int startRow) + throws SQLException+
populate in interface CachedRowSetSQLExceptionpublic void setPageSize(int size) + throws SQLException+
setPageSize in interface CachedRowSetSQLExceptionpublic int getPageSize()+
getPageSize in interface CachedRowSetpublic boolean nextPage() + throws SQLException+
nextPage in interface CachedRowSetSQLExceptionpublic boolean previousPage() + throws SQLException+
previousPage in interface CachedRowSetSQLExceptionpublic class NCPDPUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+formatNCPDPNumber(String origNumber,
+ int decimalPoints)
+Converts a signed overpunch code into a string representing the appropriate decimal value.
+ |
+
public static String formatNCPDPNumber(String origNumber, + int decimalPoints)+
origNumber - The signed overpunch code to convert.decimalPoints - The index at which to place a decimal point in the converted string. If this value
+ is less than or equal to zero, or greater than or equal to the length of the
+ overpunch code, a decimal point will not be inserted.public class RawMessage +extends Object+
| Constructor and Description | +
|---|
RawMessage(byte[] rawBytes)
+Instantiates a RawMessage object to dispatch to a channel.
+ |
+
RawMessage(byte[] rawBytes,
+ Collection<Number> destinationMetaDataIds)
+Instantiates a RawMessage object to dispatch to a channel.
+ |
+
RawMessage(byte[] rawBytes,
+ Collection<Number> destinationMetaDataIds,
+ Map<String,Object> sourceMap)
+Instantiates a RawMessage object to dispatch to a channel.
+ |
+
RawMessage(String rawData)
+Instantiates a RawMessage object to dispatch to a channel.
+ |
+
RawMessage(String rawData,
+ Collection<Number> destinationMetaDataIds)
+Instantiates a RawMessage object to dispatch to a channel.
+ |
+
RawMessage(String rawData,
+ Collection<Number> destinationMetaDataIds,
+ Map<String,Object> sourceMap)
+Instantiates a RawMessage object to dispatch to a channel.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clearMessage()
+Removes references to any data (textual or binary) currently stored by the raw message.
+ |
+
Map<String,Object> |
+getChannelMap()
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+
+getSourceMap() instead. |
+
Collection<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.
+ |
+
String |
+getRawData()
+Returns the textual data to be dispatched to a channel.
+ |
+
Map<String,Object> |
+getSourceMap()
+Returns the source map to be used at the beginning of the channel dispatch.
+ |
+
Boolean |
+isBinary()
+Returns a Boolean representing whether this object contains textual or binary data.
+ |
+
void |
+setChannelMap(Map<String,Object> channelMap)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+
+setSourceMap(sourceMap) instead. |
+
void |
+setDestinationMetaDataIds(Collection<Number> destinationMetaDataIds)
+Sets which destinations to dispatch the message to.
+ |
+
void |
+setSourceMap(Map<String,Object> sourceMap)
+Sets the source map to be used at the beginning of the channel dispatch.
+ |
+
public RawMessage(String rawData)+
rawData - The textual data to dispatch to the channel.public RawMessage(String rawData, + Collection<Number> destinationMetaDataIds)+
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.public RawMessage(String rawData, + Collection<Number> destinationMetaDataIds, + Map<String,Object> sourceMap)+
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.public RawMessage(byte[] rawBytes)+
rawBytes - The binary data (byte array) to dispatch to the channel.public RawMessage(byte[] rawBytes, + Collection<Number> destinationMetaDataIds)+
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.public RawMessage(byte[] rawBytes, + Collection<Number> destinationMetaDataIds, + Map<String,Object> sourceMap)+
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.public String getRawData()+
public byte[] getRawBytes()+
public Collection<Integer> getDestinationMetaDataIds()+
public void setDestinationMetaDataIds(Collection<Number> destinationMetaDataIds)+
destinationMetaDataIds - A list of integers (metadata IDs) representing which destinations to dispatch the
+ message to.@Deprecated +public Map<String,Object> getChannelMap()+
getSourceMap() instead.@Deprecated +public void setChannelMap(Map<String,Object> channelMap)+
setSourceMap(sourceMap) instead.channelMap - Any values placed in this map will be populated in the channel map at the
+ beginning of the message's lifecycle.public Map<String,Object> getSourceMap()+
public void setSourceMap(Map<String,Object> sourceMap)+
sourceMap - Any values placed in this map will be populated in the source map at the beginning
+ of the message's lifecycle.public Boolean isBinary()+
public void clearMessage()+
public class ResponseFactory +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Response |
+getErrorResponse(String message)
+Returns a Response representing a erred message.
+ |
+
static Response |
+getFilteredResponse(String message)
+Returns a Response representing a filtered message.
+ |
+
static Response |
+getQueuedResponse(String message)
+Returns a Response representing a queued message.
+ |
+
static Response |
+getSentResponse(String message)
+Returns a Response representing a successfully sent message.
+ |
+
public static Response getSentResponse(String message)+
message - The response data to store.public static Response getErrorResponse(String message)+
message - The response data to store.public static Response getFilteredResponse(String message)+
message - The response data to store.public class SMTPConnection +extends Object+
| Constructor and Description | +
|---|
SMTPConnection(String host,
+ String port,
+ boolean useAuthentication,
+ String secure,
+ String username,
+ String password,
+ String from)
+Instantiates an SMTP connection used to send e-mail messages with.
+ |
+
SMTPConnection(String host,
+ String port,
+ int socketTimeout,
+ boolean useAuthentication,
+ String secure,
+ String username,
+ String password,
+ String from)
+Instantiates an SMTP connection used to send e-mail messages with.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getFrom()
+Returns the FROM field being used for dispatched e-mail messages.
+ |
+
String |
+getHost()
+Returns the SMTP server address.
+ |
+
String |
+getPassword()
+Returns the password being used to authenticate to the SMTP server.
+ |
+
String |
+getPort()
+Returns the SMTP server port.
+ |
+
String |
+getSecure()
+Returns the encryption security layer being used for the SMTP connection (e.g "TLS" or
+ "SSL").
+ |
+
int |
+getSocketTimeout()
+Returns the socket connection timeout value in milliseconds.
+ |
+
String |
+getUsername()
+Returns the username being used to authenticate to the SMTP server.
+ |
+
boolean |
+isUseAuthentication()
+Returns true if authentication is needed for the SMTP server, otherwise returns false.
+ |
+
void |
+send(String toList,
+ String ccList,
+ String subject,
+ String body)
+Sends an e-mail message.
+ |
+
void |
+send(String toList,
+ String ccList,
+ String from,
+ String subject,
+ String body)
+Sends an e-mail message.
+ |
+
void |
+send(String toList,
+ String ccList,
+ String from,
+ String subject,
+ String body,
+ String charset)
+Sends an e-mail message.
+ |
+
void |
+setFrom(String from)
+Sets the FROM field to use for dispatched e-mail messages.
+ |
+
void |
+setHost(String host)
+Sets the SMTP server address.
+ |
+
void |
+setPassword(String password)
+Sets the password to use to authenticate to the SMTP server.
+ |
+
void |
+setPort(String port)
+Sets the SMTP server port.
+ |
+
void |
+setSecure(String secure)
+Sets the encryption security layer to use for the SMTP connection.
+ |
+
void |
+setSocketTimeout(int socketTimeout)
+Sets the socket connection timeout value.
+ |
+
void |
+setUseAuthentication(boolean useAuthentication)
+Sets whether authentication is needed for the SMTP server.
+ |
+
void |
+setUsername(String username)
+Sets the username to use to authenticate to the SMTP server.
+ |
+
public SMTPConnection(String host, + String port, + int socketTimeout, + boolean useAuthentication, + String secure, + String username, + String password, + String from)+
host - The SMTP server address.port - The SMTP server port (e.g. 25, 587, 465).socketTimeout - The socket connection timeout value in milliseconds.useAuthentication - Determines whether authentication is needed for the SMTP server.secure - The encryption security layer to use for the SMTP connection ("TLS" or "SSL"). If
+ left blank, no encryption layer will be used.username - If authentication is required, the username to authenticate with.password - If authentication is required, the password to authenticate with.from - The FROM field to use for dispatched e-mail messages.public SMTPConnection(String host, + String port, + boolean useAuthentication, + String secure, + String username, + String password, + String from)+
host - The SMTP server address.port - The SMTP server port (e.g. 25, 587, 465).useAuthentication - Determines whether authentication is needed for the SMTP server.secure - The encryption security layer to use for the SMTP connection ("TLS" or "SSL"). If
+ left blank, no encryption layer will be used.username - If authentication is required, the username to authenticate with.password - If authentication is required, the password to authenticate with.from - The FROM field to use for the e-mail.public String getHost()+
public void setHost(String host)+
host - The SMTP server address to use.public String getPort()+
public void setPort(String port)+
port - The SMTP server port to use (e.g. 25, 587, 465).public boolean isUseAuthentication()+
public void setUseAuthentication(boolean useAuthentication)+
useAuthentication - Determines whether authentication is needed for the SMTP server.public String getSecure()+
public void setSecure(String secure)+
secure - The encryption security layer to use for the SMTP connection ("TLS" or "SSL"). If
+ left blank, no encryption layer will be used.public String getUsername()+
public void setUsername(String username)+
username - The username to authenticate with.public String getPassword()+
public void setPassword(String password)+
password - The password to authenticate with.public String getFrom()+
public void setFrom(String from)+
from - The FROM field to use for dispatched e-mail messages.public int getSocketTimeout()+
public void setSocketTimeout(int socketTimeout)+
socketTimeout - The socket connection timeout value in milliseconds.public void send(String toList, + String ccList, + String from, + String subject, + String body, + String charset) + throws org.apache.commons.mail.EmailException+
toList - A string representing a list of e-mail addresses to send the message to (separated
+ by ",").ccList - A string representing a list of e-mail addresses to copy the message to (separated
+ by ",").from - The FROM field to use for the e-mail message.subject - The subject of the e-mail message.body - The content of the e-mail message.charset - The charset encoding to use when sending the e-mail message.org.apache.commons.mail.EmailException - If an error occurred while sending the e-mail message.public void send(String toList, + String ccList, + String from, + String subject, + String body) + throws org.apache.commons.mail.EmailException+
toList - A string representing a list of e-mail addresses to send the message to (separated
+ by ",").ccList - A string representing a list of e-mail addresses to copy the message to (separated
+ by ",").from - The FROM field to use for the e-mail message.subject - The subject of the e-mail message.body - The content of the e-mail message.org.apache.commons.mail.EmailException - If an error occurred while sending the e-mail message.public void send(String toList, + String ccList, + String subject, + String body) + throws org.apache.commons.mail.EmailException+
toList - A string representing a list of e-mail addresses to send the message to (separated
+ by ",").ccList - A string representing a list of e-mail addresses to copy the message to (separated
+ by ",").subject - The subject of the e-mail message.body - The content of the e-mail message.org.apache.commons.mail.EmailException - If an error occurred while sending the e-mail message.public class SMTPConnectionFactory +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static SMTPConnection |
+createSMTPConnection()
+Creates an create SMTPConnection object using the server's default SMTP settings.
+ |
+
public static SMTPConnection createSMTPConnection() + throws com.mirth.connect.client.core.ControllerException+
com.mirth.connect.client.core.ControllerException - If the SMTP connection could not be created.public class SerializerFactory +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Map<String,Object> |
+getDefaultDeserializationProperties(String dataType)
+Returns a map of default properties used to customize how deserialization from XML to the
+ data type is performed.
+ |
+
static Map<String,Object> |
+getDefaultSerializationProperties(String dataType)
+Returns a map of default properties used to customize how serialization from the data type to
+ XML is performed.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getEDISerializer(String segmentDelim,
+ String elementDelim,
+ String subelementDelim)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getHL7Serializer()
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getHL7Serializer(boolean useStrictParser,
+ boolean useStrictValidation)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getHL7Serializer(boolean useStrictParser,
+ boolean useStrictValidation,
+ boolean handleRepetitions)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getHL7Serializer(boolean useStrictParser,
+ boolean useStrictValidation,
+ boolean handleRepetitions,
+ boolean convertLFtoCR)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getHL7Serializer(boolean useStrictParser,
+ boolean useStrictValidation,
+ boolean handleRepetitions,
+ boolean convertLFtoCR,
+ boolean handleSubcomponents)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getNCPDPSerializer(String segmentDelim,
+ String groupDelim,
+ String fieldDelim)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getNCPDPSerializer(String segmentDelim,
+ String groupDelim,
+ String fieldDelim,
+ boolean useStrictValidation)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getSerializer(String dataType)
+Returns a serializer (with toXML and fromXML methods) for a given data type.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getSerializer(String dataType,
+ Map<String,Object> serializationPropertiesMap,
+ Map<String,Object> deserializationPropertiesMap)
+Returns a serializer (with toXML and fromXML methods) for a given data type and properties.
+ |
+
static com.mirth.connect.model.converters.IMessageSerializer |
+getX12Serializer(boolean inferDelimiters)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
public static com.mirth.connect.model.converters.IMessageSerializer getSerializer(String dataType)+
dataType - The plugin point (e.g. "HL7V2") of the data type to create the serializer for.public static com.mirth.connect.model.converters.IMessageSerializer getSerializer(String dataType, + Map<String,Object> serializationPropertiesMap, + Map<String,Object> deserializationPropertiesMap)+
dataType - The plugin point (e.g. "HL7V2") of the data type to create the serializer for.serializationPropertiesMap - A Map of properties used to customize how serialization from the data type to XML
+ is performed.deserializationPropertiesMap - A Map of properties used to customize how deserialization from XML to the data
+ type is performed.public static Map<String,Object> getDefaultSerializationProperties(String dataType)+
dataType - The plugin point (e.g. "HL7V2") of the data type to get default properties for.public static Map<String,Object> getDefaultDeserializationProperties(String dataType)+
dataType - The plugin point (e.g. "HL7V2") of the data type to get default properties for.@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getHL7Serializer(boolean useStrictParser, + boolean useStrictValidation, + boolean handleRepetitions, + boolean convertLFtoCR, + boolean handleSubcomponents)+
useStrictParser - If true, messages will be parsed based upon strict HL7 specifications.useStrictValidation - If true, messages will be validated using HL7 specifications (applies to Strict
+ Parser only).handleRepetitions - If true, field repetitions will be parsed (applies to Non-Strict Parser only).convertLFtoCR - If true, line feeds (\n) will be converted to carriage returns (\r) automatically
+ (applies to Non-Strict Parser only).handleSubcomponents - If true, subcomponents will be parsed (applies to Non-Strict Parser only).@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getHL7Serializer(boolean useStrictParser, + boolean useStrictValidation, + boolean handleRepetitions, + boolean convertLFtoCR)+
useStrictParser - If true, messages will be parsed based upon strict HL7 specifications.useStrictValidation - If true, messages will be validated using HL7 specifications (applies to Strict
+ Parser only).handleRepetitions - If true, field repetitions will be parsed (applies to Non-Strict Parser only).convertLFtoCR - If true, line feeds (\n) will be converted to carriage returns (\r) automatically
+ (applies to Non-Strict Parser only).@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getHL7Serializer(boolean useStrictParser, + boolean useStrictValidation, + boolean handleRepetitions)+
useStrictParser - If true, messages will be parsed based upon strict HL7 specifications.useStrictValidation - If true, messages will be validated using HL7 specifications (applies to Strict
+ Parser only).handleRepetitions - If true, field repetitions will be parsed (applies to Non-Strict Parser only).@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getHL7Serializer(boolean useStrictParser, + boolean useStrictValidation)+
useStrictParser - If true, messages will be parsed based upon strict HL7 specifications.useStrictValidation - If true, messages will be validated using HL7 specifications (applies to Strict
+ Parser only).@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getHL7Serializer()+
@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getX12Serializer(boolean inferDelimiters)+
inferDelimiters - This property only applies to X12 messages. If checked, the delimiters are
+ inferred from the incoming message and the delimiter properties will not be used.@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getEDISerializer(String segmentDelim, + String elementDelim, + String subelementDelim)+
segmentDelim - Characters that delimit the segments in the message.elementDelim - Characters that delimit the elements in the message.subelementDelim - Characters that delimit the subelements in the message.@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getNCPDPSerializer(String segmentDelim, + String groupDelim, + String fieldDelim, + boolean useStrictValidation)+
segmentDelim - Characters that delimit the segments in the message.groupDelim - Characters that delimit the groups in the message.fieldDelim - Characters that delimit the fields in the message.useStrictValidation - Validates the NCPDP message against a schema.@Deprecated +public static com.mirth.connect.model.converters.IMessageSerializer getNCPDPSerializer(String segmentDelim, + String groupDelim, + String fieldDelim)+
segmentDelim - Characters that delimit the segments in the message.groupDelim - Characters that delimit the groups in the message.fieldDelim - Characters that delimit the fields in the message.| Constructor and Description | +
|---|
SourceMap(Map<String,Object> delegate)
+Instantiates a new SourceMap object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clear() |
+
boolean |
+containsKey(Object key) |
+
boolean |
+containsValue(Object value) |
+
Set<Map.Entry<String,Object>> |
+entrySet() |
+
boolean |
+equals(Object o) |
+
Object |
+get(Object key) |
+
int |
+hashCode() |
+
boolean |
+isEmpty() |
+
Set<String> |
+keySet() |
+
Object |
+put(String key,
+ Object value) |
+
void |
+putAll(Map<? extends String,? extends Object> m) |
+
Object |
+remove(Object key) |
+
int |
+size() |
+
Collection<Object> |
+values() |
+
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic boolean containsKey(Object key)+
containsKey in interface Map<String,Object>public boolean containsValue(Object value)+
containsValue in interface Map<String,Object>public boolean equals(Object o)+ +
public int hashCode()+ +
public boolean isEmpty()+ +
public class UUIDGenerator +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+getUUID()
+Returns a type 4 (pseudo randomly generated) UUID.
+ |
+
public class VMRouter +extends Object+
| Constructor and Description | +
|---|
VMRouter()
+Instantiates a VMRouter object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+routeMessage(String channelName,
+ RawMessage rawMessage)
+Dispatches a message to a channel, specified by the deployed channel name.
+ |
+
Response |
+routeMessage(String channelName,
+ String message)
+Dispatches a message to a channel, specified by the deployed channel name.
+ |
+
Response |
+routeMessageByChannelId(String channelId,
+ RawMessage rawMessage)
+Dispatches a message to a channel, specified by the deployed channel ID.
+ |
+
Response |
+routeMessageByChannelId(String channelId,
+ String message)
+Dispatches a message to a channel, specified by the deployed channel ID.
+ |
+
public VMRouter()+
public Response routeMessage(String channelName, + String message)+
channelName - The name of the deployed channel to dispatch the message to.message - The message to dispatch to the channel.public Response routeMessage(String channelName, + RawMessage rawMessage)+
channelName - The name of the deployed channel to dispatch the message to.rawMessage - A RawMessage object to dispatch to the channel.public Response routeMessageByChannelId(String channelId, + String message)+
channelId - The ID of the deployed channel to dispatch the message to.message - The message to dispatch to the channel.public Response routeMessageByChannelId(String channelId, + RawMessage rawMessage)+
channelId - The ID of the deployed channel to dispatch the message to.rawMessage - A RawMessage object to dispatch to the channel.See: Description
+| Class | +Description | +
|---|---|
| ACKGenerator | +
+ Allows users to generate HL7 v2.x acknowledgments based on an inbound message, with a specified
+ ACK code and custom text message.
+ |
+
| AlertSender | +
+ Allows users to dispatch error events which can be alerted on.
+ |
+
| Attachment | +
+ Used to store and retrieve details about message attachments such as the ID, MIME type, and
+ content.
+ |
+
| AttachmentUtil | +
+ Provides utility methods for creating, retrieving, and re-attaching message attachments.
+ |
+
| ChannelMap | +
+ A wrapper class for the channel map that checks against the source map in the
+get(key) method for legacy support. |
+
| ChannelUtil | +
+ This utility class allows the user to query information from channels or to perform actions on
+ channels.
+ |
+
| ContextFactory | +
+ Allows the user to retrieve information about the current JavaScript context.
+ |
+
| DatabaseConnection | +
+ Provides the ability to run SQL queries again the database connection object instantiated using
+ DatabaseConnectionFactory.
+ |
+
| DatabaseConnectionFactory | +
+ Used to create database connection objects.
+ |
+
| DateUtil | +
+ Provides date/time utility methods.
+ |
+
| DestinationSet | +
+ Utility class used in the preprocessor or source filter/transformer to prevent the message from
+ being sent to specific destinations.
+ |
+
| DICOMUtil | +
+ Provides DICOM utility methods.
+ |
+
| EncryptedData | +
+ This object is returned from
+EncryptionUtil.encrypt(byte[]). |
+
| EncryptionUtil | +
+ This utility class provides some convenience methods for encrypting or decrypting data.
+ |
+
| FileUtil | +
+ Provides file utility methods.
+ |
+
| Future<V> | +
+ A
+Future represents the result of an asynchronous computation. |
+
| HashUtil | +
+ Provides hash utility methods.
+ |
+
| HTTPUtil | +
+ Provides HTTP utility methods.
+ |
+
| ImmutableResponse | +
+ This class represents a destination response and is used to retrieve details such as the response
+ data, message status, and errors.
+ |
+
| MirthCachedRowSet | +
+ An implementation of CachedRowSet that retrieves values based on the column label value.
+ |
+
| NCPDPUtil | +
+ Provides NCPDP utility methods.
+ |
+
| RawMessage | +
+ 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.
+ |
+
| ResponseFactory | +
+ Provides methods to create Response objects.
+ |
+
| SerializerFactory | +
+ Used to create a serializer for a specific data type for conversion to and from XML.
+ |
+
| SMTPConnection | +
+ Used to send e-mail messages.
+ |
+
| SMTPConnectionFactory | +
+ Utility class used to create SMTPConnection object using the server's default SMTP settings.
+ |
+
| SourceMap | ++ |
| UUIDGenerator | +
+ Utility class to create unique identifiers.
+ |
+
| VMRouter | +
+ Utility class used to dispatch messages to channels.
+ |
+
| Enum | +Description | +
|---|---|
| DeployedState | +
+ States of UNDEPLOYED, DEPLOYING, UNDEPLOYING, STARTING, STARTED, PAUSING, PAUSED, STOPPING,
+ STOPPED
+ |
+
public class AttachmentEntry +extends Object +implements Serializable+
| Constructor and Description | +
|---|
AttachmentEntry()
+Instantiates a new AttachmentEntry with no name, content, or MIME type.
+ |
+
AttachmentEntry(AttachmentEntry attachment)
+Instantiates a new AttachmentEntry that copies the name, content, and MIME type
+ from a given AttachmentEntry object.
+ |
+
AttachmentEntry(String name,
+ String content,
+ String mimeType)
+Instantiates a new AttachmentEntry with a name, content, and a MIME type.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
String |
+getContent()
+Returns the content of the attachment entry.
+ |
+
String |
+getMimeType()
+Returns the MIME type of the attachment entry.
+ |
+
String |
+getName()
+Returns the name of the attachment entry.
+ |
+
void |
+setContent(String content)
+Sets the content of the attachment entry.
+ |
+
void |
+setMimeType(String mimeType)
+Sets the MIME type of the attachment entry.
+ |
+
void |
+setName(String name)
+Sets the name of the attachment entry.
+ |
+
public AttachmentEntry()+
public AttachmentEntry(AttachmentEntry attachment)+
attachment - The AttachmentEntry object to copy.public AttachmentEntry(String name, + String content, + String mimeType)+
name - The name of the attachment entry.content - The content to store for the attachment entry.mimeType - The MIME type of the attachment entry.public String getName()+
public void setName(String name)+
name - The name of the attachment entry.public String getContent()+
public void setContent(String content)+
content - The content of the attachment entry.public String getMimeType()+
public void setMimeType(String mimeType)+
mimeType - The MIME type of the attachment entry.public enum ContentType +extends Enum<ContentType>+
| Enum Constant and Description | +
|---|
CHANNEL_MAP |
+
CONNECTOR_MAP |
+
ENCODED |
+
POSTPROCESSOR_ERROR |
+
PROCESSED_RAW |
+
PROCESSED_RESPONSE |
+
PROCESSING_ERROR |
+
RAW |
+
RESPONSE |
+
RESPONSE_ERROR |
+
RESPONSE_MAP |
+
RESPONSE_TRANSFORMED |
+
SENT |
+
SOURCE_MAP |
+
TRANSFORMED |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+toString() |
+
static ContentType |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ContentType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ContentType RAW+
public static final ContentType PROCESSED_RAW+
public static final ContentType TRANSFORMED+
public static final ContentType ENCODED+
public static final ContentType SENT+
public static final ContentType RESPONSE+
public static final ContentType RESPONSE_TRANSFORMED+
public static final ContentType PROCESSED_RESPONSE+
public static final ContentType CONNECTOR_MAP+
public static final ContentType CHANNEL_MAP+
public static final ContentType RESPONSE_MAP+
public static final ContentType PROCESSING_ERROR+
public static final ContentType POSTPROCESSOR_ERROR+
public static final ContentType RESPONSE_ERROR+
public static final ContentType SOURCE_MAP+
public static ContentType[] values()+
+for (ContentType c : ContentType.values()) + System.out.println(c); +
public static ContentType valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String toString()+
toString in class Enum<ContentType>public class ImmutableAttachment +extends Object+
| Constructor and Description | +
|---|
ImmutableAttachment(com.mirth.connect.donkey.model.message.attachment.Attachment attachment)
+Instantiates a new ImmutableAttachment object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getAttachmentId()
+Returns the unique replacement token for the attachment.
+ |
+
byte[] |
+getContent()
+Returns the content of the attachment as a byte array.
+ |
+
String |
+getId()
+Returns the unique ID for the attachment.
+ |
+
String |
+getType()
+Returns the MIME type of the attachment.
+ |
+
boolean |
+isEncrypted()
+Returns a boolean indicating whether the attachment content is encrypted.
+ |
+
public ImmutableAttachment(com.mirth.connect.donkey.model.message.attachment.Attachment attachment)+
attachment - The Attachment object that this object will reference for retrieving data.public String getAttachmentId()+
public String getId()+
public byte[] getContent()+
public String getType()+
public boolean isEncrypted()+
public class ImmutableConnectorMessage +extends Object+
| Constructor and Description | +
|---|
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,
+ Map<String,Integer> destinationIdMap)
+Instantiates a new ImmutableConnectorMessage object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getChannelId()
+Returns the ID of the channel associated with this connector message.
+ |
+
Map<String,Object> |
+getChannelMap()
+Returns the channel map.
+ |
+
String |
+getChannelName()
+Returns the Name of the channel associated with this connector message.
+ |
+
Map<String,Object> |
+getConnectorMap()
+Returns the connector map.
+ |
+
String |
+getConnectorName()
+Returns the name of the connector associated with this connector message.
+ |
+
ImmutableMessageContent |
+getContent(ContentType contentType)
+Deprecated.
+
+The getContent(contentType) method has been deprecated and will soon be removed.
+ Please use getMessageContent(contentType) instead.
+ |
+
Map<String,Integer> |
+getDestinationIdMap()
+Returns a Map of destination connector names linked to their corresponding connector metadata
+ ID.
+ |
+
Map<String,String> |
+getDestinationNameMap()
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+
+getDestinationIdMap() instead. |
+
ImmutableMessageContent |
+getEncoded()
+Retrieves encoded content associated with this connector message.
+ |
+
String |
+getEncodedData()
+Retrieves encoded content associated with this connector message.
+ |
+
ImmutableMessageContent |
+getMessageContent(ContentType contentType)
+Retrieves 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.
+ |
+
String |
+getPostProcessorError()
+Returns the postprocessing error string associated with this connector message, if it exists.
+ |
+
ImmutableMessageContent |
+getProcessedRaw()
+Retrieves processed raw content associated with this connector message.
+ |
+
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.
+ |
+
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.
+ |
+
String |
+getRawData()
+Retrieves raw content associated with this connector message.
+ |
+
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.
+ |
+
Calendar |
+getResponseDate()
+Returns the date/time immediately after this connector message's response is received.
+ |
+
String |
+getResponseError()
+Returns the response error string associated with this connector message, if it exists.
+ |
+
Map<String,Object> |
+getResponseMap()
+Returns the response map.
+ |
+
ImmutableMessageContent |
+getResponseTransformed()
+Retrieves transformed response content associated with this connector message.
+ |
+
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.
+ |
+
Calendar |
+getSendDate()
+Returns the date/time immediately before this connector message's most recent send attempt.
+ |
+
String |
+getServerId()
+Returns the ID of the server associated with this connector message.
+ |
+
Map<String,Object> |
+getSourceMap()
+Returns the source map.
+ |
+
Status |
+getStatus()
+Returns the status (e.g.
+ |
+
ImmutableMessageContent |
+getTransformed()
+Retrieves transformed content associated with this connector message.
+ |
+
String |
+getTransformedData()
+Retrieves transformed content associated with this connector message.
+ |
+
String |
+toString() |
+
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, + Map<String,Integer> destinationIdMap)+
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.public int getMetaDataId()+
public String getChannelId()+
public String getChannelName()+
public String getConnectorName()+
public String getServerId()+
public Calendar getReceivedDate()+
public int getSendAttempts()+
public Calendar getSendDate()+
public Calendar getResponseDate()+
public Status getStatus()+
public ImmutableMessageContent getMessageContent(ContentType contentType)+
contentType - The ContentType (e.g. RAW, ENCODED) of the content to retrieve.@Deprecated +public ImmutableMessageContent getContent(ContentType contentType)+
contentType - The ContentType (e.g. RAW, ENCODED) of the content to retrieve.public ImmutableMessageContent getRaw()+
public String getRawData()+
public ImmutableMessageContent getProcessedRaw()+
public String getProcessedRawData()+
public ImmutableMessageContent getTransformed()+
public String getTransformedData()+
public ImmutableMessageContent getEncoded()+
public String getEncodedData()+
public ImmutableMessageContent getResponse()+
public Response getResponseData()+
public ImmutableMessageContent getResponseTransformed()+
public String getResponseTransformedData()+
public ImmutableMessageContent getProcessedResponse()+
public Response getProcessedResponseData()+
public long getMessageId()+
public Map<String,Object> getSourceMap()+
public Map<String,Object> getConnectorMap()+
public Map<String,Object> getChannelMap()+
public Map<String,Object> getResponseMap()+
public String getPostProcessorError()+
public String getProcessingError()+
public String getResponseError()+
@Deprecated +public Map<String,String> getDestinationNameMap()+
getDestinationIdMap() instead.public Map<String,Integer> getDestinationIdMap()+
public class ImmutableMessage +extends Object+
| Constructor and Description | +
|---|
ImmutableMessage(com.mirth.connect.donkey.model.message.Message message)
+Instantiates a new ImmutableMessage object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ImmutableAttachment> |
+getAttachments()
+Returns a list of attachments associated with this message.
+ |
+
String |
+getChannelId()
+Returns the ID of the channel associated with this message.
+ |
+
Map<Integer,ImmutableConnectorMessage> |
+getConnectorMessages()
+Returns a map of connector messages associated with this message.
+ |
+
Map<String,Integer> |
+getDestinationIdMap()
+Returns a Map of destination connector names linked to their corresponding connector metadata
+ ID.
+ |
+
Map<String,String> |
+getDestinationNameMap()
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use
+
+getDestinationIdMap() instead. |
+
String |
+getImportChannelId()
+Returns the ID of the original channel this message was reprocessed from.
+ |
+
Long |
+getImportId()
+Returns the ID of the original message this one was imported from.
+ |
+
ImmutableConnectorMessage |
+getMergedConnectorMessage()
+Returns a "merged" connector message containing data from all connector messages combined.
+ |
+
Long |
+getMessageId()
+Returns the sequential ID of this message, as a Long.
+ |
+
Long |
+getOriginalId()
+Returns the ID of the original message this one was reprocessed from.
+ |
+
Calendar |
+getReceivedDate()
+Deprecated.
+
+This method is deprecated and will soon be removed. This method currently returns
+ the received date of the source connector message.
+ |
+
String |
+getServerId()
+Returns the ID of the server associated with this message.
+ |
+
boolean |
+isProcessed()
+Returns whether this message has finished processing through a channel.
+ |
+
String |
+toString() |
+
public ImmutableMessage(com.mirth.connect.donkey.model.message.Message message)+
message - The Message object that this object will reference for retrieving data.public Long getMessageId()+
public String getServerId()+
public String getChannelId()+
@Deprecated +public Calendar getReceivedDate()+
public boolean isProcessed()+
public Long getOriginalId()+
public Long getImportId()+
public String getImportChannelId()+
public List<ImmutableAttachment> getAttachments()+
public Map<Integer,ImmutableConnectorMessage> getConnectorMessages()+
public ImmutableConnectorMessage getMergedConnectorMessage()+
@Deprecated +public Map<String,String> getDestinationNameMap()+
getDestinationIdMap() instead.public Map<String,Integer> getDestinationIdMap()+
public class ImmutableMessageContent +extends Object+
| Constructor and Description | +
|---|
ImmutableMessageContent(com.mirth.connect.donkey.model.message.MessageContent messageContent)
+Instantiates a new ImmutableMessageContent object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getContent()
+Returns the actual content, as a string.
+ |
+
ContentType |
+getContentType()
+Returns the ContentType of this message content (e.g.
+ |
+
String |
+getDataType()
+Returns the data type (e.g.
+ |
+
long |
+getMessageId()
+Returns the sequential ID of the overall Message associated with this message content.
+ |
+
int |
+getMetaDataId()
+Returns the metadata ID of the connector associated with this message content.
+ |
+
public ImmutableMessageContent(com.mirth.connect.donkey.model.message.MessageContent messageContent)+
messageContent - The MessageContent object that this object will reference for retrieving data.public ContentType getContentType()+
public String getContent()+
public long getMessageId()+
public int getMetaDataId()+
public String getDataType()+
public class JsonUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+escape(String input)
+Escapes any special JSON characters in the input.
+ |
+
static String |
+prettyPrint(String input)
+Formats an JSON string with indented markup.
+ |
+
static String |
+toXml(String jsonString)
+Converts a JSON string to XML.
+ |
+
static String |
+toXml(String jsonString,
+ boolean multiplePI,
+ boolean prettyPrint)
+Converts a JSON string to XML.
+ |
+
public static String prettyPrint(String input)+
input - The JSON string to format.public static String escape(String input)+
input - The string to escape.public static String toXml(String jsonString) + throws Exception+
jsonString - The JSON string to convert.Exception - If the conversion failed.public static String toXml(String jsonString, + boolean multiplePI, + boolean prettyPrint) + throws Exception+
jsonString - The JSON string to convert.multiplePI - If true, the <? xml-multiple ... ?> processing instruction will
+ be included for arrays.prettyPrint - Whether or not to fully indent the XML output.Exception - If the conversion failed.public class ListBuilder +extends Object +implements List+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(int index,
+ Object element) |
+
boolean |
+add(Object e) |
+
boolean |
+addAll(Collection c) |
+
boolean |
+addAll(int index,
+ Collection c) |
+
ListBuilder |
+append(Object e)
+Adds an element to the list using the
+add(java.lang.Object) method, and returns this builder. |
+
void |
+clear() |
+
boolean |
+contains(Object o) |
+
boolean |
+containsAll(Collection c) |
+
boolean |
+equals(Object obj) |
+
Object |
+get(int index) |
+
int |
+hashCode() |
+
int |
+indexOf(Object o) |
+
boolean |
+isEmpty() |
+
Iterator |
+iterator() |
+
int |
+lastIndexOf(Object o) |
+
ListIterator |
+listIterator() |
+
ListIterator |
+listIterator(int index) |
+
Object |
+remove(int index) |
+
boolean |
+remove(Object o) |
+
boolean |
+removeAll(Collection c) |
+
boolean |
+retainAll(Collection c) |
+
Object |
+set(int index,
+ Object element) |
+
int |
+size() |
+
List |
+subList(int fromIndex,
+ int toIndex) |
+
Object[] |
+toArray() |
+
Object[] |
+toArray(Object[] a) |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitreplaceAll, sort, spliteratorparallelStream, removeIf, streampublic ListBuilder append(Object e)+
add(java.lang.Object) method, and returns this builder.e - element to be appended to this listpublic int size()+
size in interface Collectionsize in interface Listpublic boolean isEmpty()+
isEmpty in interface CollectionisEmpty in interface Listpublic boolean contains(Object o)+
contains in interface Collectioncontains in interface Listpublic Iterator iterator()+ +
public Object[] toArray()+
toArray in interface CollectiontoArray in interface Listpublic Object[] toArray(Object[] a)+
toArray in interface CollectiontoArray in interface Listpublic boolean add(Object e)+
add in interface Collectionadd in interface Listpublic boolean remove(Object o)+
remove in interface Collectionremove in interface Listpublic boolean containsAll(Collection c)+
containsAll in interface CollectioncontainsAll in interface Listpublic boolean addAll(Collection c)+
addAll in interface CollectionaddAll in interface Listpublic boolean addAll(int index, + Collection c)+ +
public boolean removeAll(Collection c)+
removeAll in interface CollectionremoveAll in interface Listpublic boolean retainAll(Collection c)+
retainAll in interface CollectionretainAll in interface Listpublic void clear()+
clear in interface Collectionclear in interface Listpublic int lastIndexOf(Object o)+
lastIndexOf in interface Listpublic ListIterator listIterator()+
listIterator in interface Listpublic ListIterator listIterator(int index)+
listIterator in interface Listpublic List subList(int fromIndex, + int toIndex)+ +
public boolean equals(Object obj)+ +
public int hashCode()+ +
public class Lists +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static ListBuilder |
+list()
+Instantiates a new
+ListBuilder using an ArrayList. |
+
static ListBuilder |
+list(List list)
+Instantiates a new
+ListBuilder using the given list. |
+
static ListBuilder |
+list(Object e)
+Instantiates a new
+ListBuilder using an ArrayList and the given element. |
+
public static ListBuilder list()+
ListBuilder using an ArrayList.ListBuilder instance.public static ListBuilder list(Object e)+
ListBuilder using an ArrayList and the given element.e - element to be appended to this listListBuilder instance.public static ListBuilder list(List list)+
ListBuilder using the given list.list - The delegate List to use.ListBuilder instance.| Modifier and Type | +Method and Description | +
|---|---|
MapBuilder |
+add(Object key,
+ Object value)
+Adds an entry to the map using the
+put(java.lang.Object, java.lang.Object) method, and returns this builder. |
+
void |
+clear() |
+
boolean |
+containsKey(Object key) |
+
boolean |
+containsValue(Object value) |
+
Set<?> |
+entrySet() |
+
boolean |
+equals(Object obj) |
+
Object |
+get(Object key) |
+
int |
+hashCode() |
+
boolean |
+isEmpty() |
+
Set<?> |
+keySet() |
+
Object |
+put(Object key,
+ Object value) |
+
void |
+putAll(Map m) |
+
Object |
+remove(Object key) |
+
int |
+size() |
+
String |
+toString() |
+
Collection<?> |
+values() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic MapBuilder add(Object key, + Object value)+
put(java.lang.Object, java.lang.Object) method, and returns this builder.key - key with which the specified value is to be associatedvalue - value to be associated with the specified keypublic boolean containsKey(Object key)+
containsKey in interface Mappublic boolean containsValue(Object value)+
containsValue in interface Mappublic Collection<?> values()+ +
public boolean equals(Object obj)+ +
public int hashCode()+ +
public class Maps +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static MapBuilder |
+map()
+Instantiates a new
+MapBuilder using a HashMap. |
+
static MapBuilder |
+map(Map map)
+Instantiates a new
+MapBuilder using the given map. |
+
static MapBuilder |
+map(Object key,
+ Object value)
+Instantiates a new
+MapBuilder using a HashMap and the given key/value entry. |
+
public static MapBuilder map()+
MapBuilder using a HashMap.MapBuilder instance.public static MapBuilder map(Object key, + Object value)+
MapBuilder using a HashMap and the given key/value entry.key - key with which the specified value is to be associatedvalue - value to be associated with the specified keyMapBuilder instance.public static MapBuilder map(Map map)+
MapBuilder using the given map.map - The delegate map to use.MapBuilder instance.public class MessageHeaders +extends Object+
| Constructor and Description | +
|---|
MessageHeaders(Map<String,List<String>> delegate) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+contains(String key)
+Check if headers exists for a given key.
+ |
+
String |
+get(String key)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use getHeader(key) or
+ getHeaderList(key) instead.
+ |
+
String |
+getHeader(String key)
+Get the first header value for the given key.
+ |
+
List<String> |
+getHeaderList(String key)
+Get all header values for the given key.
+ |
+
Set<String> |
+getKeys()
+Get all header keys.
+ |
+
String |
+toString() |
+
@Deprecated +public String get(String key)+
key - The name of the header key.public String getHeader(String key)+
key - The name of the header key.public List<String> getHeaderList(String key)+
key - The name of header key.public Set<String> getKeys()+
public boolean contains(String key)+
key - The name of the header key.public class MessageParameters +extends Object+
| Constructor and Description | +
|---|
MessageParameters(Map<String,List<String>> delegate) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+contains(String key)
+Check if parameters exist for a given key.
+ |
+
String |
+get(String key)
+Deprecated.
+
+This method is deprecated and will soon be removed. Please use getParameter(key)
+ or getParameterList(key) instead.
+ |
+
Set<String> |
+getKeys()
+Get all parameter keys.
+ |
+
String |
+getParameter(String key)
+Get the first parameter value for the given key.
+ |
+
List<String> |
+getParameterList(String key)
+Get all parameter values for the given key.
+ |
+
String |
+toString() |
+
@Deprecated +public String get(String key)+
key - The name of the parameter key.public String getParameter(String key)+
key - The name of the parameter key.public List<String> getParameterList(String key)+
key - The name of parameter key.public Set<String> getKeys()+
public boolean contains(String key)+
key - The name of the parameter key.public class Response +extends Object+
| Constructor and Description | +
|---|
Response()
+Instantiates a new Response object.
+ |
+
Response(com.mirth.connect.donkey.model.message.Response response)
+Instantiates a new Response object.
+ |
+
Response(Status status,
+ String message)
+Instantiates a new Response object.
+ |
+
Response(Status status,
+ String message,
+ String statusMessage)
+Instantiates a new Response object.
+ |
+
Response(Status status,
+ String message,
+ String statusMessage,
+ String error)
+Instantiates a new Response object.
+ |
+
Response(String message)
+Instantiates a new Response object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object other) |
+
String |
+getError()
+Returns the error string associated with this response, if it exists.
+ |
+
String |
+getMessage()
+Returns the actual response data, as a string.
+ |
+
Status |
+getStatus()
+Returns the Status (e.g.
+ |
+
String |
+getStatusMessage()
+Returns a brief message explaining the reason for the current status.
+ |
+
void |
+setError(String error)
+Sets the error string to be associated with this response.
+ |
+
void |
+setMessage(String message)
+Sets the response data.
+ |
+
void |
+setStatus(Status status)
+Sets the status of this response.
+ |
+
void |
+setStatusMessage(String statusMessage)
+Sets the status message to use for this response.
+ |
+
String |
+toString() |
+
public Response()+
public Response(String message)+
message - The actual response data.public Response(Status status, + String message)+
status - The status (e.g. SENT, ERROR) of the response.message - The actual response data.public Response(Status status, + String message, + String statusMessage)+
status - The status (e.g. SENT, ERROR) of the response.message - The actual response data.statusMessage - A brief message explaining the reason for the current status.public Response(Status status, + String message, + String statusMessage, + String error)+
status - The status (e.g. SENT, ERROR) of the response.message - The actual response data.statusMessage - A brief message explaining the reason for the current status.error - The error string associated with this response, if applicable.public Response(com.mirth.connect.donkey.model.message.Response response)+
response - The underlying Donkey Response object to reference.public String getMessage()+
public void setMessage(String message)+
message - The response data (String) to use.public Status getStatus()+
public void setStatus(Status status)+
status - The status (e.g. SENT, QUEUED) to use for this response.public String getError()+
public void setError(String error)+
error - The error string to use.public String getStatusMessage()+
public void setStatusMessage(String statusMessage)+
statusMessage - A brief message explaining the reason for the current status.| Constructor and Description | +
|---|
ResponseMap(Map<String,Object> delegate,
+ Map<String,Integer> destinationIdMap)
+Instantiates a new ResponseMap object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clear() |
+
boolean |
+containsKey(Object key) |
+
boolean |
+containsValue(Object value) |
+
Set<Map.Entry<String,Object>> |
+entrySet() |
+
boolean |
+equals(Object o) |
+
Object |
+get(Object key)
+Returns the value to which the specified key is mapped, or null if this map contains no
+ mapping for the key.
+ |
+
int |
+hashCode() |
+
boolean |
+isEmpty() |
+
Set<String> |
+keySet() |
+
Object |
+put(String key,
+ Object value) |
+
void |
+putAll(Map<? extends String,? extends Object> m) |
+
Object |
+remove(Object key) |
+
int |
+size() |
+
Collection<Object> |
+values() |
+
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic ResponseMap(Map<String,Object> delegate, + Map<String,Integer> destinationIdMap)+
delegate - The underlying Map to reference for retrieving/setting data.destinationIdMap - A Map of destination names and their corresponding "d#" response map keys (where
+ "#" is the destination connector metadata ID).public boolean containsKey(Object key)+
containsKey in interface Map<String,Object>public boolean containsValue(Object value)+
containsValue in interface Map<String,Object>public boolean equals(Object o)+ +
public Object get(Object key)+
public int hashCode()+ +
public boolean isEmpty()+ +
public enum Status +extends Enum<Status>+
| Enum Constant and Description | +
|---|
ERROR |
+
FILTERED |
+
PENDING |
+
QUEUED |
+
RECEIVED |
+
SENT |
+
TRANSFORMED |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Status |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Status[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Status RECEIVED+
public static final Status FILTERED+
public static final Status TRANSFORMED+
public static final Status SENT+
public static final Status QUEUED+
public static final Status ERROR+
public static final Status PENDING+
public static Status[] values()+
+for (Status c : Status.values()) + System.out.println(c); +
public static Status valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic class XmlUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+decode(String entity)
+Converts an XML/HTML entity reference into a string with the literal character.
+ |
+
static String |
+encode(char s)
+Encodes a character into the corresponding XML/HTML entity.
+ |
+
static String |
+encode(char[] text,
+ int start,
+ int length)
+Converts a character array, encoding characters into the corresponding XML/HTML entities as
+ needed.
+ |
+
static String |
+encode(String s)
+Converts a string, encoding characters into the corresponding XML/HTML entities as needed.
+ |
+
static String |
+prettyPrint(String input)
+Formats an XML string with indented markup.
+ |
+
static String |
+toJson(String xmlString)
+Converts an XML string to JSON, while stripping bound namespace prefixes.
+ |
+
static String |
+toJson(String xmlString,
+ boolean normalizeNamespaces)
+Converts an XML string to JSON.
+ |
+
static String |
+toJson(String xmlString,
+ boolean autoArray,
+ boolean autoPrimitive,
+ boolean prettyPrint,
+ boolean normalizeNamespaces)
+Converts an XML string to JSON.
+ |
+
static String |
+toJson(String xmlString,
+ boolean autoArray,
+ boolean autoPrimitive,
+ boolean prettyPrint,
+ boolean normalizeNamespaces,
+ boolean alwaysArray,
+ boolean alwaysExpandObjects)
+Converts an XML string to JSON.
+ |
+
public static String prettyPrint(String input)+
input - The XML string to format.public static String decode(String entity)+
entity - The XML/HTML entity to decode.public static String encode(char s)+
s - The character to encode.public static String encode(String s)+
s - The string to encode.public static String encode(char[] text, + int start, + int length)+
text - The character array to encode.start - The index to start at in the character array.length - The maximum amount of characters to read from the array.public static String toJson(String xmlString) + throws Exception+
xmlString - The XML string to convert.Exception - If conversion failed.public static String toJson(String xmlString, + boolean normalizeNamespaces) + throws Exception+
xmlString - The XML string to convert.normalizeNamespaces - Whether or not to normalize namespaces by stripping prefixes.Exception - If conversion failed.public static String toJson(String xmlString, + boolean autoArray, + boolean autoPrimitive, + boolean prettyPrint, + boolean normalizeNamespaces) + throws Exception+
xmlString - The XML string to convert.autoArray - If true, sibling nodes with the same tag name will be consolidated into a JSON
+ array. If false, multiple properties with the same name will be present.autoPrimitive - If true, element text will be converted to JSON primitive values where applicable.
+ If false, element text will always be converted to string values.prettyPrint - Whether or not to fully indent the JSON output.normalizeNamespaces - Whether or not to normalize namespaces by stripping prefixes.Exception - If conversion failed.public static String toJson(String xmlString, + boolean autoArray, + boolean autoPrimitive, + boolean prettyPrint, + boolean normalizeNamespaces, + boolean alwaysArray, + boolean alwaysExpandObjects) + throws Exception+
xmlString - The XML string to convert.autoArray - If true, sibling nodes with the same tag name will be consolidated into a JSON
+ array. If false, multiple properties with the same name will be present.autoPrimitive - If true, element text will be converted to JSON primitive values where applicable.
+ If false, element text will always be converted to string values.prettyPrint - Whether or not to fully indent the JSON output.normalizeNamespaces - Whether or not to normalize namespaces by stripping prefixes.alwaysArray - If true, all nodes except for the top-level object will be written into JSON
+ arrays. Overrides the autoArray option.alwaysExpandObjects - If true, all values will be written in the expanded "$" syntax.Exception - If conversion failed.See: Description
+| Class | +Description | +
|---|---|
| AttachmentEntry | +
+ Used to store and retrieve details about message attachments such as the name, contents, and
+ MIME type.
+ |
+
| ImmutableAttachment | +
+ This class represents an message attachment and is used to retrieve details such as the
+ replacement token or content type.
+ |
+
| 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.
+ |
+
| ImmutableMessage | +
+ This class represents an overall message and is used to retrieve details such as the message ID,
+ specific connector messages, or the merged connector message.
+ |
+
| ImmutableMessageContent | +
+ This class represents content associated with a connector message.
+ |
+
| JsonUtil | +
+ Provides JSON utility methods.
+ |
+
| ListBuilder | +
+ Convenience class to allow fluent building of lists.
+ |
+
| Lists | +
+ Convenience class to allow fluent building of lists.
+ |
+
| MapBuilder | +
+ Convenience class to allow fluent building of maps.
+ |
+
| Maps | +
+ Convenience class to allow fluent building of maps.
+ |
+
| MessageHeaders | ++ |
| MessageParameters | ++ |
| Response | +
+ This class represents a channel or destination response and is used to retrieve details such as
+ the response data, message status, and errors.
+ |
+
| ResponseMap | +
+ A wrapper class for the response map which allows users to retrieve values using the proper "d#"
+ key (where "#" is the destination connector's metadata ID), or by using the actual destination
+ name.
+ |
+
| XmlUtil | +
+ Provides XML utility methods.
+ |
+
| Enum | +Description | +
|---|---|
| ContentType | +
+ Denotes various types of content created by a channel.
+ |
+
| Status | +
+ Denotes the status of a connector message or response.
+ |
+
| Method and Description | +
|---|
| com.mirth.connect.server.userutil.ACKGenerator.generateAckResponse(String, String, String, String, String, String)
+ This method is deprecated and will soon be removed. Please use
+ generateAckResponse(message, isXML, acknowledgementCode, textMessage, dateFormat,
+ errorMessage) instead.
+ |
+
| com.mirth.connect.userutil.MessageHeaders.get(String)
+ This method is deprecated and will soon be removed. Please use getHeader(key) or
+ getHeaderList(key) instead.
+ |
+
| com.mirth.connect.userutil.MessageParameters.get(String)
+ This method is deprecated and will soon be removed. Please use getParameter(key)
+ or getParameterList(key) instead.
+ |
+
| com.mirth.connect.server.userutil.RawMessage.getChannelMap()
+ This method is deprecated and will soon be removed. Please use
+
+RawMessage.getSourceMap() instead. |
+
| com.mirth.connect.userutil.ImmutableConnectorMessage.getContent(ContentType)
+ The getContent(contentType) method has been deprecated and will soon be removed.
+ Please use getMessageContent(contentType) instead.
+ |
+
| com.mirth.connect.userutil.ImmutableConnectorMessage.getDestinationNameMap()
+ This method is deprecated and will soon be removed. Please use
+
+getDestinationIdMap() instead. |
+
| com.mirth.connect.userutil.ImmutableMessage.getDestinationNameMap()
+ This method is deprecated and will soon be removed. Please use
+
+getDestinationIdMap() instead. |
+
| com.mirth.connect.server.userutil.SerializerFactory.getEDISerializer(String, String, String)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getHL7Serializer()
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getHL7Serializer(boolean, boolean)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getHL7Serializer(boolean, boolean, boolean)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getHL7Serializer(boolean, boolean, boolean, boolean)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getHL7Serializer(boolean, boolean, boolean, boolean, boolean)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead. The new method will now strip namespaces by default unless the
+ 'stripNamespaces' property is set to false.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getNCPDPSerializer(String, String, String)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getNCPDPSerializer(String, String, String, boolean)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
| com.mirth.connect.userutil.ImmutableMessage.getReceivedDate()
+ This method is deprecated and will soon be removed. This method currently returns
+ the received date of the source connector message.
+ |
+
| com.mirth.connect.server.userutil.SerializerFactory.getX12Serializer(boolean)
+ This method is deprecated and will soon be removed. Please use
+ getSerializer(dataType, serializationPropertiesMap, deserializationPropertiesMap)
+ instead.
+ |
+
| com.mirth.connect.server.userutil.RawMessage.setChannelMap(Map<String, Object>)
+ This method is deprecated and will soon be removed. Please use
+
+setSourceMap(sourceMap) instead. |
+
| Constructor and Description | +
|---|
| com.mirth.connect.server.userutil.ACKGenerator() | +
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+MapBuilder.put(java.lang.Object, java.lang.Object) method, and returns this builder.ListBuilder.add(java.lang.Object) method, and returns this builder.get(key) method for legacy support.EncryptionUtil.encrypt(byte[]).Future represents the result of an asynchronous computation.RawMessage.getSourceMap() instead.getDestinationIdMap() instead.getDestinationIdMap() instead.true if this task was cancelled before it completed normally.true if this task completed.ListBuilder using an ArrayList.ListBuilder using an ArrayList and the given element.ListBuilder using the given list.MapBuilder using a HashMap.MapBuilder using a HashMap and the given key/value entry.MapBuilder using the given map.setSourceMap(sourceMap) instead.+ + diff --git a/server/src/main/resources/docs/javadocs/user-api/overview-summary.html b/server/src/main/resources/docs/javadocs/user-api/overview-summary.html new file mode 100644 index 0000000000..5c8a574f0e --- /dev/null +++ b/server/src/main/resources/docs/javadocs/user-api/overview-summary.html @@ -0,0 +1,153 @@ + + + + + +
| Package | +Description | +
|---|---|
| com.mirth.connect.plugins.httpauth.userutil | +
+ This package is included in the JavaScript scope on the server. Classes in this package are
+ part of the supported User API for use in channels/scripts. Reference to any class in Mirth
+ Connect outside of the userutil packages is unsupported.
+ |
+
| com.mirth.connect.server.userutil | +
+ This package is included in the JavaScript scope on the server. Classes in this package are
+ part of the supported User API for use in channels/scripts. Reference to any class in Mirth
+ Connect outside of the userutil packages is unsupported.
+ |
+
| com.mirth.connect.userutil | +
+ This package is included in the JavaScript scope on both the client and the server. Classes
+ in this package are part of the supported User API for use in channels/scripts. Reference to
+ any class in Mirth Connect outside of the userutil packages is unsupported.
+ |
+