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 * @(#)XATopicConnectionFactory.java 1.16 07/02/07
37 */
38
39 package javax.jms;
40
41 /** An <CODE>XATopicConnectionFactory</CODE> provides the same create options as
42 * a <CODE>TopicConnectionFactory</CODE> (optional).
43 *
44 * <P>The <CODE>XATopicConnectionFactory</CODE> interface is optional. JMS providers
45 * are not required to support this interface. This interface is for
46 * use by JMS providers to support transactional environments.
47 * Client programs are strongly encouraged to use the transactional support
48 * available in their environment, rather than use these XA
49 * interfaces directly.
50 *
51 * @see javax.jms.TopicConnectionFactory
52 * @see javax.jms.XAConnectionFactory
53 */
54
55 public interface XATopicConnectionFactory
56 extends XAConnectionFactory, TopicConnectionFactory {
57
58 /** Creates an XA topic connection with the default user identity.
59 * The connection is created in stopped mode. No messages
60 * will be delivered until the <code>Connection.start</code> method
61 * is explicitly called.
62 *
63 * @return a newly created XA topic connection
64 *
65 * @exception JMSException if the JMS provider fails to create an XA topic
66 * connection due to some internal error.
67 * @exception JMSSecurityException if client authentication fails due to
68 * an invalid user name or password.
69 */
70
71 XATopicConnection
72 createXATopicConnection() throws JMSException;
73
74
75 /** Creates an XA topic connection with the specified user identity.
76 * The connection is created in stopped mode. No messages
77 * will be delivered until the <code>Connection.start</code> method
78 * is explicitly called.
79 *
80 * @param userName the caller's user name
81 * @param password the caller's password
82 *
83 * @return a newly created XA topic connection
84 *
85 * @exception JMSException if the JMS provider fails to create an XA topic
86 * connection due to some internal error.
87 * @exception JMSSecurityException if client authentication fails due to
88 * an invalid user name or password.
89 */
90
91 XATopicConnection
92 createXATopicConnection(String userName, String password)
93 throws JMSException;
94 }
Save This Page