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: MessageReceiver.java,v 1.7 2004/02/03 21:52:06 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import java.util.List;
48
49 import javax.jms.Destination;
50 import javax.jms.JMSException;
51
52
53 /***
54 * Interface for receiving messages from a {@link javax.jms.MessageConsumer} or
55 * {@link javax.jms.QueueBrowser}.
56 *
57 * @version $Revision: 1.7 $ $Date: 2004/02/03 21:52:06 $
58 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
59 */
60 public interface MessageReceiver {
61
62 /***
63 * Return a list of {@link javax.jms.Message} instances from a
64 * MessageConsumer or QueueBrowser
65 *
66 * @param count the number of messages expected. This is indicative only;
67 * implementations may return less (if messages aren't available) or more
68 * (if an asynchronous implementation is used) messages than the specified
69 * value.
70 * @param timeout the maximum time to wait for each message. If set to 0,
71 * then it waits until a message becomes available.
72 * @return a list of messages, or null, if no messages were received in
73 * the specified time
74 * @throws JMSException if the operation fails
75 */
76 List receive(int count, long timeout) throws JMSException;
77
78 /***
79 * Receive messages, delegating received messages to a
80 * <code>CountingListener</code>
81 *
82 * @param timeout the maximum time to wait for each message. If set to 0,
83 * then it waits until a message becomes available.
84 * @param listener the listener to delegate messages to
85 * @throws JMSException if the operation fails
86 */
87 void receive(long timeout, CountingListener listener) throws JMSException;
88
89 /***
90 * Return the destination associated with the MessageConsumer
91 *
92 * @return the destination to receive messages from
93 * @throws JMSException if the operation fails
94 */
95 Destination getDestination() throws JMSException;
96
97 /***
98 * Returns the message selector associated with the MessageConsumer
99 *
100 * @return the message selector
101 * @throws JMSException if the operation fails
102 */
103 String getSelector() throws JMSException;
104
105 /***
106 * Returns the name of the subscriber, if the consumer is a durable topic
107 * subscriber
108 *
109 * @return the name of the subscriber, or <code>null</code> if the
110 * consumer is not a durable topic subscriber
111 */
112 String getName();
113
114 /***
115 * Returns the no-local value, if the consumer is a topic subscriber
116 *
117 * @return the no-local value, if the consumer is a topic subscriber;
118 * otherwise <code>false</code>
119 * @throws JMSException if the operation fails
120 */
121 boolean getNoLocal() throws JMSException;
122
123 /***
124 * Close the underlying MessageConsumer or QueueBrowser
125 *
126 * @throws JMSException if the operation fails
127 */
128 void close() throws JMSException;
129
130 /***
131 * Close the underlying MessageConsumer or QueueBrowser. For durable topic
132 * subscribers, unsubscribe it from the session.
133 *
134 * @throws JMSException if the operation fails
135 */
136 void remove() throws JMSException;
137
138 }
This page was automatically generated by Maven