Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ReceivingApplication |
|
| 1.0;1 |
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 "ReceivingApplication.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, 2005. 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 | package ca.uhn.hl7v2.protocol; | |
27 | ||
28 | import java.util.Map; | |
29 | ||
30 | import ca.uhn.hl7v2.HL7Exception; | |
31 | import ca.uhn.hl7v2.model.Message; | |
32 | ||
33 | /** | |
34 | * <p>From an HL7 messaging perspective, a ReceivingApplication is a consumer of a messages. | |
35 | * Once a parser parses an incoming message, the message would normally be forwarded | |
36 | * to an application of some sort (e.g. a lab system) which would process the | |
37 | * message in some way meaningful for it, and then return a response.</p> | |
38 | * | |
39 | * <p>If you are wondering how to integrate HAPI into an existing server application, | |
40 | * this is probably the place. Create a class that implements ReceivingApplication, then look | |
41 | * at HL7Server and ApplicationRouter to see how to get HAPI to listen for messages on | |
42 | * a socket and pass them to your ReceivingApplication.</p> | |
43 | * | |
44 | * Note that this interface replaces ca.uhn.hl7v2.app.Application in HAPI 0.5. | |
45 | * | |
46 | * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a> | |
47 | */ | |
48 | public interface ReceivingApplication<T extends Message> { | |
49 | ||
50 | /** | |
51 | * Uses the contents of the message for whatever purpose the application | |
52 | * has for this message, and returns an appropriate response message. | |
53 | * | |
54 | * @param theMessage an inbound HL7 message | |
55 | * @param theMetadata message metadata (which may include information about where the message comes | |
56 | * from, etc). This is the same metadata as in {@link ca.uhn.hl7v2.protocol.Transportable#getMetadata()}. | |
57 | * | |
58 | * @return an appropriate application response (for example an application ACK or query response). | |
59 | * Appropriate responses to different types of incoming messages are defined by HL7. | |
60 | * | |
61 | * @throws ReceivingApplicationException if there is a problem internal to the application (for example | |
62 | * a database problem) | |
63 | * @throws HL7Exception if there is a problem with the message | |
64 | */ | |
65 | public Message processMessage(T theMessage, Map<String, Object> theMetadata) | |
66 | throws ReceivingApplicationException, HL7Exception; | |
67 | ||
68 | /** | |
69 | * @param theMessage an inbound HL7 message | |
70 | * @return true if this ReceivingApplication wishes to accept the message. By returning | |
71 | * true, this Application declares itself the recipient of the message, accepts | |
72 | * responsibility for it, and must be able to respond appropriately to the sending system. | |
73 | */ | |
74 | public boolean canProcess(T theMessage); | |
75 | ||
76 | } |