| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| JMSDestination |
|
| 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 "JMSDestination.java". Description: | |
| 10 | "A facade for a JMS Queue or Topic." | |
| 11 | ||
| 12 | The Initial Developer of the Original Code is University Health Network. Copyright (C) | |
| 13 | 2004. 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 javax.jms.Connection; | |
| 29 | import javax.jms.JMSException; | |
| 30 | import javax.jms.Message; | |
| 31 | import javax.jms.TextMessage; | |
| 32 | ||
| 33 | /** | |
| 34 | * A facade for a JMS Queue or Topic. | |
| 35 | * | |
| 36 | * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a> | |
| 37 | * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:38 $ by $Author: jamesagnew $ | |
| 38 | */ | |
| 39 | public interface JMSDestination { | |
| 40 | ||
| 41 | /** | |
| 42 | * @return the name of the Queue or Topic | |
| 43 | * @throws JMSException | |
| 44 | */ | |
| 45 | public String getName() throws JMSException; | |
| 46 | ||
| 47 | /** | |
| 48 | * @return a new JMS Message object. | |
| 49 | * @throws JMSException | |
| 50 | */ | |
| 51 | public TextMessage createMessage() throws JMSException; | |
| 52 | ||
| 53 | /** | |
| 54 | * Creates a new session, sender/publisher, and receiver/subscriber. | |
| 55 | * @throws JMSException | |
| 56 | */ | |
| 57 | public void connect() throws JMSException; | |
| 58 | ||
| 59 | /** | |
| 60 | * Closes the JMS session. | |
| 61 | * @throws JMSException | |
| 62 | */ | |
| 63 | public void disconnect() throws JMSException; | |
| 64 | ||
| 65 | /** | |
| 66 | * @return true if connected. | |
| 67 | */ | |
| 68 | public boolean isConnected(); | |
| 69 | ||
| 70 | /** | |
| 71 | * @return the JMS Connection underlying this destination | |
| 72 | */ | |
| 73 | public Connection getConnection(); | |
| 74 | ||
| 75 | /** | |
| 76 | * Sends the given message to the JMS destination. | |
| 77 | * @param theMessage message to send | |
| 78 | * @throws JMSException | |
| 79 | */ | |
| 80 | public void send(Message theMessage) throws JMSException; | |
| 81 | ||
| 82 | /** | |
| 83 | * @return a message received from the JMS destination. | |
| 84 | * @throws JMSException | |
| 85 | */ | |
| 86 | public Message receive() throws JMSException; | |
| 87 | ||
| 88 | } |