001    /**
002    The contents of this file are subject to the Mozilla Public License Version 1.1 
003    (the "License"); you may not use this file except in compliance with the License. 
004    You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005    Software distributed under the License is distributed on an "AS IS" basis, 
006    WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007    specific language governing rights and limitations under the License. 
008    
009    The Original Code is "ReceivingApplication.java".  Description: 
010    "From an HL7 messaging perspective, a consumer of a messages" 
011    
012    The Initial Developer of the Original Code is University Health Network. Copyright (C) 
013    2002, 2005.  All Rights Reserved. 
014    
015    Contributor(s): ______________________________________. 
016    
017    Alternatively, the contents of this file may be used under the terms of the 
018    GNU General Public License (the  ?GPL?), in which case the provisions of the GPL are 
019    applicable instead of those above.  If you wish to allow use of your version of this 
020    file only under the terms of the GPL and not to allow others to use your version 
021    of this file under the MPL, indicate your decision by deleting  the provisions above 
022    and replace  them with the notice and other provisions required by the GPL License.  
023    If you do not delete the provisions above, a recipient may use your version of 
024    this file under either the MPL or the GPL. 
025    */
026    package ca.uhn.hl7v2.protocol;
027    
028    import java.util.Map;
029    
030    import ca.uhn.hl7v2.HL7Exception;
031    import ca.uhn.hl7v2.model.Message;
032    
033    /**
034     * <p>From an HL7 messaging perspective, a ReceivingApplication is a consumer of a messages. 
035     * Once a parser parses an incoming message, the message would normally be forwarded 
036     * to an application of some sort (e.g. a lab system) which would process the 
037     * message in some way meaningful for it, and then return a response.</p>
038     *   
039     * <p>If you are wondering how to integrate HAPI into an existing server application, 
040     * this is probably the place.  Create a class that implements ReceivingApplication, then look 
041     * at HL7Server and ApplicationRouter to see how to get HAPI to listen for messages on 
042     * a socket and pass them to your ReceivingApplication.</p>
043     * 
044     * Note that this interface replaces ca.uhn.hl7v2.app.Application in HAPI 0.5.   
045     *   
046     * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
047     * @version $Revision: 1.1 $ updated on $Date: 2007/02/19 02:24:38 $ by $Author: jamesagnew $
048     */
049    public interface ReceivingApplication {
050    
051        /**
052         * Uses the contents of the message for whatever purpose the application 
053         * has for this message, and returns an appropriate response message.
054         * 
055         * @param theMessage an inbound HL7 message 
056         * @param theMetadata message metadata (which may include information about where the message comes 
057         *      from, etc).  This is the same metadata as in Transportable.  
058         * 
059         * @return an appropriate application response (for example an application ACK or query response). 
060         *      Appropriate responses to different types of incoming messages are defined by HL7. 
061         * 
062         * @throws ReceivingApplicationException if there is a problem internal to the application (for example 
063         *      a database problem)
064         * @throws HL7Exception if there is a problem with the message 
065         */
066        public Message processMessage(Message theMessage, Map theMetadata) 
067                throws ReceivingApplicationException, HL7Exception;
068        
069        /** 
070         * @param theMessage an inbound HL7 message 
071         * @return true if this ReceivingApplication wishes to accept the message.  By returning
072         *      true, this Application declares itself the recipient of the message, accepts 
073         *      responsibility for it, and must be able to respond appropriately to the sending system.  
074         */
075        public boolean canProcess(Message theMessage);
076    
077    }