1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2000-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License ("CDDL") (collectively, the "License"). You may
9 * 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 mq/legal/LICENSE.txt. See the License for the specific language
12 * 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 mq/legal/LICENSE.txt. Sun designates
16 * this particular file as subject to the "Classpath" exception as provided by
17 * Sun in the GPL Version 2 section of the License file that accompanied this
18 * code. If applicable, add the following below the License Header, with the
19 * fields enclosed by brackets [] replaced by your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
21 *
22 * Contributor(s):
23 *
24 * If you wish your version of this file to be governed by only the CDDL or
25 * only the GPL Version 2, indicate your decision by adding "[Contributor]
26 * elects to include this software in this distribution under the [CDDL or GPL
27 * Version 2] license." If you don't indicate a single choice of license, a
28 * recipient has the option to distribute your version of this file under
29 * either the CDDL, the GPL Version 2 or to extend the choice of license to
30 * its licensees as provided above. However, if you add GPL Version 2 code
31 * and therefore, elected the GPL Version 2 license, then the option applies
32 * only if the new code is made subject to such option by the copyright holder.
33 */
34
35 /*
36 * @(#)TemporaryTopic.java 1.13 07/02/07
37 */
38
39 package javax.jms;
40
41 /** A <CODE>TemporaryTopic</CODE> object is a unique <CODE>Topic</CODE> object
42 * created for the duration of a <CODE>Connection</CODE>. It is a
43 * system-defined topic that can be consumed only by the
44 * <CODE>Connection</CODE> that created it.
45 *
46 *<P>A <CODE>TemporaryTopic</CODE> object can be created either at the
47 * <CODE>Session</CODE> or <CODE>TopicSession</CODE> level. Creating it at the
48 * <CODE>Session</CODE> level allows the <CODE>TemporaryTopic</CODE> to participate
49 * in the same transaction with objects from the PTP domain.
50 * If a <CODE>TemporaryTopic</CODE> is created at the
51 * <CODE>TopicSession</CODE>, it will only
52 * be able participate in transactions with objects from the Pub/Sub domain.
53 *
54 * @see Session#createTemporaryTopic()
55 * @see TopicSession#createTemporaryTopic()
56 */
57
58 public interface TemporaryTopic extends Topic {
59
60 /** Deletes this temporary topic. If there are existing subscribers
61 * still using it, a <CODE>JMSException</CODE> will be thrown.
62 *
63 * @exception JMSException if the JMS provider fails to delete the
64 * temporary topic due to some internal error.
65 */
66
67 void
68 delete() throws JMSException;
69 }