1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2000-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: JmsQueueReceiver.java,v 1.11 2004/01/20 14:14:21 tanderson Exp $
44 */
45 package org.exolab.jms.client;
46
47 import javax.jms.InvalidDestinationException;
48 import javax.jms.QueueReceiver;
49 import javax.jms.Queue;
50 import javax.jms.JMSException;
51
52
53 /***
54 * Client implementation of the <code>javax.jms.QueueReceiver</code> interface
55 *
56 * @version $Revision: 1.11 $ $Date: 2004/01/20 14:14:21 $
57 * @author <a href="mailto:jima@comware.com.au">Jim Alateras</a>
58 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
59 */
60 class JmsQueueReceiver
61 extends JmsMessageConsumer
62 implements QueueReceiver {
63
64 /***
65 * The queue to receive messages from
66 */
67 private JmsQueue _queue = null;
68
69
70 /***
71 * Construct a new <code>JmsQueueReceiver</code>
72 *
73 * @param session the session responsible for the consumer
74 * @param clientId the session allocated consumer identifier
75 * @param queue the queue to access
76 * @param selector the message selector. May be <code>null</code>
77 * @throws InvalidDestinationException if <code>queue</code> is null
78 */
79 public JmsQueueReceiver(JmsSession session, long clientId, JmsQueue queue,
80 String selector)
81 throws InvalidDestinationException {
82 super(session, clientId, selector);
83 if (queue == null) {
84 throw new InvalidDestinationException("Argument 'queue' is null");
85 }
86 _queue = queue;
87 }
88
89 /***
90 * Returns the queue associated with this receiver
91 *
92 * @return the queue associated with this receiver
93 */
94 public Queue getQueue() {
95 return _queue;
96 }
97
98 /***
99 * Close the receiver.
100 * This call blocks until a receive or message listener in progress has
101 * completed. A blocked consumer receive call returns <code>null</code>
102 * when this consumer is closed.
103 *
104 * @throws JMSException if this consumer can't be closed
105 */
106 public synchronized void close() throws JMSException {
107 if (!isClosed()) {
108 JmsQueueSession session = (JmsQueueSession) getSession();
109 session.removeReceiver(this);
110 super.close();
111 }
112 }
113
114 /***
115 * Release all resources used by this receiver
116 *
117 * @throws JMSException if this receiver can't be destroyed
118 */
119 public synchronized void destroy() throws JMSException {
120 _queue = null;
121 super.destroy();
122 }
123 }