KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > jms > TemporaryQueue


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package javax.jms;
25
26 /** A <CODE>TemporaryQueue</CODE> object is a unique <CODE>Queue</CODE> object
27   * created for the duration of a <CODE>Connection</CODE>. It is a
28   * system-defined queue that can be consumed only by the
29   * <CODE>Connection</CODE> that created it.
30   *
31   *<P>A <CODE>TemporaryQueue</CODE> object can be created at either the
32   * <CODE>Session</CODE> or <CODE>QueueSession</CODE> level. Creating it at the
33   * <CODE>Session</CODE> level allows to the <CODE>TemporaryQueue</CODE> to
34   * participate in transactions with objects from the Pub/Sub domain.
35   * If it is created at the <CODE>QueueSession</CODE>, it will only
36   * be able participate in transactions with objects from the PTP domain.
37   *
38   * @version 1.1 - February 2, 2002
39   * @author Mark Hapner
40   * @author Rich Burridge
41   * @author Kate Stout
42   *
43   * @see Session#createTemporaryQueue()
44   * @see QueueSession#createTemporaryQueue()
45   */
46
47 public interface TemporaryQueue extends Queue JavaDoc {
48
49     /** Deletes this temporary queue. If there are existing receivers
50       * still using it, a <CODE>JMSException</CODE> will be thrown.
51       *
52       * @exception JMSException if the JMS provider fails to delete the
53       * temporary queue due to some internal error.
54       */
55
56     void
57     delete() throws JMSException JavaDoc;
58 }
59
Popular Tags