|
Sun Adapter for TCP/IP HL7 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HL7AppMessage
This class is used as a place holder of HL7 specific functions.
Field Summary | |
---|---|
static java.lang.String |
version
|
Method Summary | |
---|---|
byte[] |
convertHL7MessagetoXML(java.lang.String payLoad)
Convert HL7 raw message to HL7 XML message, if the hl7 eway receives hl7 xml data |
byte[] |
convertXMLtoMessage(java.lang.String hl7XmlMessage)
Convert HL7 XML message to HL7 raw message, if the hl7 eway receives hl7 xml data |
java.lang.String |
getACKXMLPayLoad()
The payload holds HL7 ACK XML message. |
char |
getBlockType()
The getBlockType method is only used for HLLP (Hybrid Lower Layer Protocol). |
byte[] |
getPayload()
The payload holds HL7 data. |
java.lang.String |
getXMLPayLoad()
The payload holds HL7 XML message. |
boolean |
handleXMLMessage()
Condition to check the incoming and outgoing message is xml or not. |
boolean |
isDataBlockType()
The isDataBlockType is only used for HLLP (Hybrid Lower Layer Protocol). |
boolean |
isNAKBlockType()
The isNAKBlockType is only used for HLLP (Hybrid Lower Layer Protocol). |
int |
loadSequenceNumber()
Loads the sequence number from the persistence file. |
void |
receive()
Receives the enveloped data over the TCP/IP connection and de-envelopes/validates it (according to LLP settings). |
void |
send()
Envelopes (according to LLP settings) the HL7 data which is stored in payload, The enveloped HL7 data is then sent out over the TCP/IP connection. |
void |
setACKXMLPayLoad(java.lang.String hl7AckXmlMessage)
The payload holds HL7 ACK XML message. |
void |
setBlockType(char blockType)
The setBlockType method is only used for HLLP (Hybrid Lower Layer Protocol). |
void |
setDataBlockType()
The setDataBlockType is only used for HLLP (Hybrid Lower Layer Protocol). |
void |
setNAKBlockType()
The setNAKBlockType is only used for HLLP (Hybrid Lower Layer Protocol). |
void |
setPayload(byte[] payload)
The payload holds HL7 data. |
void |
setXMLPayLoad(java.lang.String hl7XmlMessage)
The payload holds HL7 XML message. |
void |
storeHL7Ack(java.lang.String messageId,
java.lang.String HL7ACK)
Stores the HL7 Ack message in the MLLPV2's persistence storage. |
void |
storeHL7Nak(java.lang.String messageId,
java.lang.String HL7NAK)
Stores the HL7 NAK message in the MLLPV2's persistence storage. |
void |
storeSequenceNumber(int sequenceNumber)
Stores the sequence number to the persistence file. |
Field Detail |
---|
static final java.lang.String version
Method Detail |
---|
void send() throws HL7ApplicationException, java.io.IOException
Before this method is called, the outgoing HL7 data should already be stored in payload by the setPayload() method. Note: If it fails to send the enveloped data over the TCP/IP connection, IOException will be thrown. If it fails to envelope data, HL7ApplicationException will be thrown.
HL7ApplicationException
- Thrown upon LLP enveloping related error.
IOException
- Thrown upon TCP/IP transport error.
HL7ApplicationException
java.io.IOException
void receive() throws HL7ApplicationException, java.io.IOException
Note: If it fails to receive the enveloped data over the TCP/IP connection, java.io.IOException is thrown. There are 3 cases:
If it fails to de-envelope/validate data, com.stc.connector.tcpip.hl7.exception.HL7ApplicationException is thrown.
HL7ApplicationException
- Thrown upon LLP de-enveloping/validation related error.
IOException
- Thrown upon TCP/IP i/o error.
HL7ApplicationException
java.io.IOException
byte[] getPayload() throws HL7ApplicationException
byte[]
- The payload in byte array.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void setPayload(byte[] payload) throws HL7ApplicationException
payload
- The payload to set.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
boolean isNAKBlockType() throws HL7ApplicationException
Boolean
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void setNAKBlockType() throws HL7ApplicationException
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
boolean isDataBlockType() throws HL7ApplicationException
Boolean
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void setDataBlockType() throws HL7ApplicationException
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
char getBlockType() throws HL7ApplicationException
char
- The block type.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void setBlockType(char blockType) throws HL7ApplicationException
blockType
- The type to set.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
int loadSequenceNumber() throws HL7ApplicationException, java.io.IOException
int
- The number stored in file.
HL7ApplicationException
- Thrown upon error.
IOException
- Thrown upon i/o error.
HL7ApplicationException
java.io.IOException
void storeSequenceNumber(int sequenceNumber) throws HL7ApplicationException, java.io.IOException
sequenceNumber
- The number to store.
HL7ApplicationException
- Thrown upon error.
IOException
- Thrown upon i/o error.
HL7ApplicationException
java.io.IOException
void storeHL7Ack(java.lang.String messageId, java.lang.String HL7ACK) throws HL7ApplicationException
messageId
- The MSH message control Id of the original HL7 request messageHL7ACK
- The complete HL7 ACK message to store
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void storeHL7Nak(java.lang.String messageId, java.lang.String HL7NAK) throws HL7ApplicationException
messageId
- The MSH message control Id of the original HL7 request messageHL7NAK
- The complete HL7 NAK message to store
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
byte[] convertXMLtoMessage(java.lang.String hl7XmlMessage) throws HL7ApplicationException
hl7XmlMessage
- The xml message to convert.
byte[]
- The payload is byte array.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
byte[] convertHL7MessagetoXML(java.lang.String payLoad) throws HL7ApplicationException
hl7XmlMessage
- The HL7 raw message to convert to xml message.
byte[]
- The xml message in byte array.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
boolean handleXMLMessage() throws HL7ApplicationException
boolean
-true/false.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void setXMLPayLoad(java.lang.String hl7XmlMessage) throws HL7ApplicationException
hl7XmlMessage
- The xml message to store.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
java.lang.String getXMLPayLoad() throws HL7ApplicationException
String
- The payload in XML payload.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
void setACKXMLPayLoad(java.lang.String hl7AckXmlMessage) throws HL7ApplicationException
hl7ACKXmlMessage
- The xml ACK message to store.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
java.lang.String getACKXMLPayLoad() throws HL7ApplicationException
String
- The payload is xml ack message.
HL7ApplicationException
- Thrown upon error.
HL7ApplicationException
|
Sun Adapter for TCP/IP HL7 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |