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 "Initiator.java ".  Description:
010 "Initiator interface"
011
012 The Initial Developer of the Original Code is University Health Network. Copyright (C)
013 2013.  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 */
026package ca.uhn.hl7v2.app;
027
028import java.io.IOException;
029import java.util.concurrent.TimeUnit;
030
031import ca.uhn.hl7v2.HL7Exception;
032import ca.uhn.hl7v2.llp.LLPException;
033import ca.uhn.hl7v2.model.Message;
034
035/**
036 * Interface for an Initiator
037 */
038public interface Initiator {
039
040    /**
041     * Sends a message to a server and waits for the response
042     *
043     * @param outgoing outgoing message
044     * @return resposne message
045     * @throws HL7Exception
046     * @throws LLPException
047     * @throws IOException
048     */
049    Message sendAndReceive(Message outgoing) throws HL7Exception,
050            LLPException, IOException;
051
052    /**
053     * Sets the time that the initiator will wait for a
054     * response for a given message before timing out and throwing an exception
055     * (default is 10 seconds).
056     *
057     * @param timeout  time duration
058     * @param timeUnit time unit
059     */
060    void setTimeout(long timeout, TimeUnit timeUnit);
061
062    /**
063     * Sets the time (in milliseconds) that the initiator will wait for a
064     * response for a given message before timing out and throwing an exception
065     * (default is 10 seconds).
066     *
067     * @param timeout time in milliseconds
068     * @deprecated use {@link #setTimeout(long, java.util.concurrent.TimeUnit)}}
069     */
070    void setTimeoutMillis(int timeout);
071}