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 * @(#)TopicConnectionFactory.java 1.17 07/02/07
37 */
38
39 package javax.jms;
40
41 /** A client uses a <CODE>TopicConnectionFactory</CODE> object to create
42 * <CODE>TopicConnection</CODE> objects with a publish/subscribe JMS provider.
43 *
44 * <P>A<CODE> TopicConnectionFactory</CODE> can be used to create a
45 * <CODE>TopicConnection</CODE>, from which specialized topic-related objects
46 * can be created. A more general, and recommended approach
47 * is to use the <CODE>ConnectionFactory</CODE> object.
48 *
49 * <P> The <CODE>TopicConnectionFactory</CODE> object
50 * should be used to support existing code.
51 *
52 * @see javax.jms.ConnectionFactory
53 */
54
55 public interface TopicConnectionFactory extends ConnectionFactory {
56
57 /** Creates a topic connection with the default user identity.
58 * The connection is created in stopped mode. No messages
59 * will be delivered until the <code>Connection.start</code> method
60 * is explicitly called.
61 *
62 * @return a newly created topic connection
63 *
64 * @exception JMSException if the JMS provider fails to create a topic
65 * connection due to some internal error.
66 * @exception JMSSecurityException if client authentication fails due to
67 * an invalid user name or password.
68 */
69
70 TopicConnection
71 createTopicConnection() throws JMSException;
72
73
74 /** Creates a topic connection with the specified user identity.
75 * The connection is created in stopped mode. No messages
76 * will be delivered until the <code>Connection.start</code> method
77 * is explicitly called.
78 *
79 * @param userName the caller's user name
80 * @param password the caller's password
81 *
82 * @return a newly created topic connection
83 *
84 * @exception JMSException if the JMS provider fails to create a topic
85 * connection due to some internal error.
86 * @exception JMSSecurityException if client authentication fails due to
87 * an invalid user name or password.
88 */
89
90 TopicConnection
91 createTopicConnection(String userName, String password)
92 throws JMSException;
93 }
Save This Page