| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Initiator |
|
| 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 "Initiator.java ". Description: | |
| 10 | "Initiator interface" | |
| 11 | ||
| 12 | The Initial Developer of the Original Code is University Health Network. Copyright (C) | |
| 13 | 2013. 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.app; | |
| 27 | ||
| 28 | import java.io.IOException; | |
| 29 | import java.util.concurrent.TimeUnit; | |
| 30 | ||
| 31 | import ca.uhn.hl7v2.HL7Exception; | |
| 32 | import ca.uhn.hl7v2.llp.LLPException; | |
| 33 | import ca.uhn.hl7v2.model.Message; | |
| 34 | ||
| 35 | /** | |
| 36 | * Interface for an Initiator | |
| 37 | */ | |
| 38 | public interface Initiator { | |
| 39 | ||
| 40 | /** | |
| 41 | * Sends a message to a server and waits for the response | |
| 42 | * | |
| 43 | * @param outgoing outgoing message | |
| 44 | * @return resposne message | |
| 45 | * @throws HL7Exception | |
| 46 | * @throws LLPException | |
| 47 | * @throws IOException | |
| 48 | */ | |
| 49 | Message sendAndReceive(Message outgoing) throws HL7Exception, | |
| 50 | LLPException, IOException; | |
| 51 | ||
| 52 | /** | |
| 53 | * Sets the time that the initiator will wait for a | |
| 54 | * response for a given message before timing out and throwing an exception | |
| 55 | * (default is 10 seconds). | |
| 56 | * | |
| 57 | * @param timeout time duration | |
| 58 | * @param timeUnit time unit | |
| 59 | */ | |
| 60 | void setTimeout(long timeout, TimeUnit timeUnit); | |
| 61 | ||
| 62 | /** | |
| 63 | * Sets the time (in milliseconds) that the initiator will wait for a | |
| 64 | * response for a given message before timing out and throwing an exception | |
| 65 | * (default is 10 seconds). | |
| 66 | * | |
| 67 | * @param timeout time in milliseconds | |
| 68 | * @deprecated use {@link #setTimeout(long, java.util.concurrent.TimeUnit)}} | |
| 69 | */ | |
| 70 | void setTimeoutMillis(int timeout); | |
| 71 | } |