01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package javax.jms;
38:
39: /** A client uses a <CODE>QueueReceiver</CODE> object to receive messages that
40: * have been delivered to a queue.
41: *
42: * <P>Although it is possible to have multiple <CODE>QueueReceiver</CODE>s
43: * for the same queue, the JMS API does not define how messages are
44: * distributed between the <CODE>QueueReceiver</CODE>s.
45: *
46: * <P>If a <CODE>QueueReceiver</CODE> specifies a message selector, the
47: * messages that are not selected remain on the queue. By definition, a message
48: * selector allows a <CODE>QueueReceiver</CODE> to skip messages. This
49: * means that when the skipped messages are eventually read, the total ordering
50: * of the reads does not retain the partial order defined by each message
51: * producer. Only <CODE>QueueReceiver</CODE>s without a message selector
52: * will read messages in message producer order.
53: *
54: * <P>Creating a <CODE>MessageConsumer</CODE> provides the same features as
55: * creating a <CODE>QueueReceiver</CODE>. A <CODE>MessageConsumer</CODE> object is
56: * recommended for creating new code. The <CODE>QueueReceiver</CODE> is
57: * provided to support existing code.
58: *
59: * @version 1.1 February 2, 2002
60: * @author Mark Hapner
61: * @author Rich Burridge
62: * @author Kate Stout
63: *
64: * @see javax.jms.Session#createConsumer(Destination, String)
65: * @see javax.jms.Session#createConsumer(Destination)
66: * @see javax.jms.QueueSession#createReceiver(Queue, String)
67: * @see javax.jms.QueueSession#createReceiver(Queue)
68: * @see javax.jms.MessageConsumer
69: */
70:
71: public interface QueueReceiver extends MessageConsumer {
72:
73: /** Gets the <CODE>Queue</CODE> associated with this queue receiver.
74: *
75: * @return this receiver's <CODE>Queue</CODE>
76: *
77: * @exception JMSException if the JMS provider fails to get the queue for
78: * this queue receiver
79: * due to some internal error.
80: */
81:
82: Queue getQueue() throws JMSException;
83: }
|