View Javadoc

1   /**
2   The contents of this file are subject to the Mozilla Public License Version 1.1 
3   (the "License"); you may not use this file except in compliance with the License. 
4   You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
5   Software distributed under the License is distributed on an "AS IS" basis, 
6   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
7   specific language governing rights and limitations under the License. 
8   
9   The Original Code is "Application.java".  Description: 
10  "From an HL7 messaging perspective, a consumer of a messages" 
11  
12  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
13  2002.  All Rights Reserved. 
14  
15  Contributor(s): ______________________________________. 
16  
17  Alternatively, the contents of this file may be used under the terms of the 
18  GNU General Public License (the  �GPL�), in which case the provisions of the GPL are 
19  applicable instead of those above.  If you wish to allow use of your version of this 
20  file only under the terms of the GPL and not to allow others to use your version 
21  of this file under the MPL, indicate your decision by deleting  the provisions above 
22  and replace  them with the notice and other provisions required by the GPL License.  
23  If you do not delete the provisions above, a recipient may use your version of 
24  this file under either the MPL or the GPL. 
25  */
26  
27  package ca.uhn.hl7v2.app;
28  
29  import ca.uhn.hl7v2.model.Message;
30  import ca.uhn.hl7v2.HL7Exception;
31  
32  /**
33   * <p>From an HL7 messaging perspective, an Application is a consumer of a messages. 
34   * Once a parser parses an incoming message, the message would normally be forwarded 
35   * to an Application of some sort (e.g. a lab system) which would process the 
36   * message in some way meaningful for it, and then return a response.</p>  
37   * <p>If you are wondering how to integrate HAPI into an existing server application, 
38   * this is probably the place.  Create a class that implements Application, then look 
39   * at Responder and SimpleServer to see how to get HAPI to listen for messages on 
40   * a socket and pass them to your Application.</p>
41   * @author  Bryan Tripp
42   * 
43   * @see ApplicationExceptionHandler
44   * @see DefaultApplication
45   * 
46   */
47  public interface Application {
48  
49      /**
50       * Uses the contents of the message for whatever purpose the Application 
51       * has for this message, and returns an appropriate response message.   
52       */
53      public Message processMessage(Message in) throws ApplicationException, HL7Exception;
54      
55      /** 
56       * Returns true if this Application wishes to accept the message.  By returning
57       * true, this Application declares itself the recipient of the message, accepts 
58       * responsibility for it, and must be able to respond appropriately to the sending system.  
59       */
60      public boolean canProcess(Message in);
61  }
62