ca.uhn.hl7v2.app

Class DefaultApplication

java.lang.Object

ca.uhn.hl7v2.app.DefaultApplication

All Implemented Interfaces:

ReceivingApplication<Message>

Direct Known Subclasses:

AcceptApplication

public class DefaultApplication
extends Object
implements ReceivingApplication<Message>

An Application that does nothing with the message and returns an Application Reject message in response. To be used when there are no other Applications that can process a given message.

Author:

Bryan Tripp, Christian Ohr

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_INTERNAL_ERROR
static String	MSG_NO_APPROPRIATE_DEST

Constructor Summary

Constructors

Constructor and Description
DefaultApplication() New instance which always returns an acknowledgment code of AcknowledgmentCode.AR and a message indicating that no appropriate handler could be found.
DefaultApplication(AcknowledgmentCode theAcknowledgmentCode) New instance which always uses the given acknowledgment code, and generates an appropriate message for the given code, according to the following rules:
DefaultApplication(AcknowledgmentCode theAcknowledgmentCode, String theMessage) New instance which always uses the given acknowledgment code and message

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(Message in) Returns true.
static Message	makeACK(Message message) Deprecated. use Message.generateACK()
static Message	makeACK(Segment inboundHeader) Deprecated. use Message.generateACK()
Message	processMessage(Message theMessage, Map<String,Object> theMetadata) Uses the contents of the message for whatever purpose the application has for this message, and returns an appropriate response message.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_INTERNAL_ERROR

public static final String MSG_INTERNAL_ERROR

See Also:

Constant Field Values

MSG_NO_APPROPRIATE_DEST

public static final String MSG_NO_APPROPRIATE_DEST

See Also:

Constant Field Values

Constructor Detail

DefaultApplication

public DefaultApplication()

New instance which always returns an acknowledgment code of AcknowledgmentCode.AR and a message indicating that no appropriate handler could be found.

See Also:

MSG_NO_APPROPRIATE_DEST

DefaultApplication

public DefaultApplication(AcknowledgmentCode theAcknowledgmentCode)

New instance which always uses the given acknowledgment code, and generates an appropriate message for the given code, according to the following rules:

Code	Message
AcknowledgmentCode.AA AcknowledgmentCode.AA	null (no message)
AcknowledgmentCode.AR AcknowledgmentCode.AR	MSG_NO_APPROPRIATE_DEST
AcknowledgmentCode.AE AcknowledgmentCode.AE	MSG_INTERNAL_ERROR

Parameters:

theAcknowledgmentCode - The code to always use (must not be null)

DefaultApplication

public DefaultApplication(AcknowledgmentCode theAcknowledgmentCode,
                          String theMessage)

New instance which always uses the given acknowledgment code and message

Parameters:

theAcknowledgmentCode - The code to always use (must not be null)

theMessage - The message (may be null, in which case no message will be given)

Method Detail

canProcess

public boolean canProcess(Message in)

Returns true.

Specified by:

canProcess in interface ReceivingApplication<Message>

Parameters:

in - an inbound HL7 message

Returns:

true if this ReceivingApplication wishes to accept the message. By returning true, this Application declares itself the recipient of the message, accepts responsibility for it, and must be able to respond appropriately to the sending system.

makeACK

public static Message makeACK(Message message)
                       throws HL7Exception,
                              IOException

Deprecated. use Message.generateACK()

Creates an ACK message with the minimum required information from an inbound message. Optional fields can be filled in afterwards, before the message is returned. Please note that MSH-10, the outbound message control ID, is also set using the class ca.uhn.hl7v2.util.MessageIDGenerator. Also note that the ACK messages returned is the same version as the version stated in the inbound MSH if there is a generic ACK for that version, otherwise a version 2.4 ACK is returned. MSA-1 is set to AA by default.

Parameters:

message - message the MSH segment if the inbound message

Throws:

HL7Exception

IOException

makeACK

public static Message makeACK(Segment inboundHeader)
                       throws HL7Exception,
                              IOException

Deprecated. use Message.generateACK()

Throws:

HL7Exception

IOException

processMessage

public Message processMessage(Message theMessage,
                              Map<String,Object> theMetadata)
                       throws ReceivingApplicationException

Description copied from interface: ReceivingApplication

Uses the contents of the message for whatever purpose the application has for this message, and returns an appropriate response message.

Specified by:

processMessage in interface ReceivingApplication<Message>

Parameters:

theMessage - an inbound HL7 message

theMetadata - message metadata (which may include information about where the message comes from, etc). This is the same metadata as in Transportable.getMetadata().

Returns:

an appropriate application response (for example an application ACK or query response). Appropriate responses to different types of incoming messages are defined by HL7.

Throws:

ReceivingApplicationException - if there is a problem internal to the application (for example a database problem)