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 tma@netspace.net.au.
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 2001-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: AsynchronousReceiver.java,v 1.6 2004/01/31 13:44:24 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import java.util.List;
48
49 import javax.jms.JMSException;
50 import javax.jms.MessageConsumer;
51 import javax.jms.Session;
52
53 import org.apache.log4j.Category;
54
55
56 /***
57 * Asynchronously receives messages from a {@link javax.jms.MessageConsumer}
58 *
59 * @version $Revision: 1.6 $ $Date: 2004/01/31 13:44:24 $
60 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
61 * @see MessageReceiver
62 * @see SynchronousReceiver
63 */
64 class AsynchronousReceiver extends AbstractMessageReceiver {
65
66 /***
67 * The logger
68 */
69 private static final Category log =
70 Category.getInstance(AsynchronousReceiver.class.getName());
71
72 /***
73 * Construct an instance with the consumer to receive messages with
74 *
75 * @param session the session that created the consumer
76 * @param consumer the consumer used to receive messages
77 * @param name the name of the subscriber, for durable topic subscribers.
78 * May be null.
79 */
80 public AsynchronousReceiver(Session session, MessageConsumer consumer,
81 String name) {
82 super(session, consumer, name);
83 }
84
85 /***
86 * Return a list of {@link javax.jms.Message} instances from a
87 * MessageConsumer. Messages are received asynchronously using a
88 * message listener.
89 *
90 * @param count the number of messages expected.
91 * @param timeout the maximum time to wait for each message. As messages
92 * are received asynchronously, the time will be determined by
93 * count * timeout. If <code>0</code>, it waits indefinitely.
94 * @return a list of messages, or null, if no messages were received in
95 * the specified time
96 * @throws JMSException if the operation fails
97 */
98 public List receive(int count, long timeout) throws JMSException {
99 if (log.isDebugEnabled()) {
100 log.debug("Expecting to receive count=" + count + " messages "
101 + "[destination=" + getDestination()
102 + ", timeout=" + timeout + "]");
103 }
104
105 MessageConsumer consumer = getConsumer();
106 CachingListener listener = new CachingListener(count);
107 consumer.setMessageListener(listener);
108
109 // give the listener time to receive the messages
110 try {
111 long time = (count == 0) ? timeout : count * timeout;
112 if (time > 0) {
113 listener.waitForCompletion(time);
114 } else {
115 listener.waitForCompletion();
116 }
117 } catch (InterruptedException ignore) {
118 // no-op
119 }
120 consumer.setMessageListener(null);
121 return listener.getMessages();
122 }
123
124 /***
125 * Receive messages, delegating received messages to a
126 * <code>CountingListener</code>
127 *
128 * @param timeout the maximum time to wait for each message. As messages
129 * are received asynchronously, the time will be determined by
130 * count * timeout. If <code>0</code>, it waits indefinitely.
131 * @param listener the listener to delegate messages to
132 * @throws JMSException if the operation fails
133 */
134 public void receive(long timeout, CountingListener listener)
135 throws JMSException {
136
137 int count = listener.getExpected();
138 if (log.isDebugEnabled()) {
139 log.debug("Expecting to receive count=" + count + " messages "
140 + "[destination=" + getDestination()
141 + ", timeout=" + timeout + "]");
142 }
143
144 MessageConsumer consumer = getConsumer();
145 consumer.setMessageListener(listener);
146
147 try {
148 long time = (count == 0) ? timeout : count * timeout;
149 if (time > 0) {
150 listener.waitForCompletion(time);
151 } else {
152 listener.waitForCompletion(); // wait indefinitely
153 }
154 } catch (InterruptedException ignore) {
155 // no-op
156 }
157 consumer.setMessageListener(null);
158 }
159
160 }
This page was automatically generated by Maven