1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package javax.jms;
23
24 /** An <CODE>XATopicConnectionFactory</CODE> provides the same create options as
25 * a <CODE>TopicConnectionFactory</CODE> (optional).
26 *
27 * <P>The <CODE>XATopicConnectionFactory</CODE> interface is optional. JMS providers
28 * are not required to support this interface. This interface is for
29 * use by JMS providers to support transactional environments.
30 * Client programs are strongly encouraged to use the transactional support
31 * available in their environment, rather than use these XA
32 * interfaces directly.
33 *
34 * @see javax.jms.TopicConnectionFactory
35 * @see javax.jms.XAConnectionFactory
36 */
37
38 public interface XATopicConnectionFactory extends XAConnectionFactory, TopicConnectionFactory
39 {
40
41 /** Creates an XA topic connection with the default user identity.
42 * The connection is created in stopped mode. No messages
43 * will be delivered until the <code>Connection.start</code> method
44 * is explicitly called.
45 *
46 * @return a newly created XA topic connection
47 *
48 * @exception JMSException if the JMS provider fails to create an XA topic
49 * connection due to some internal error.
50 * @exception JMSSecurityException if client authentication fails due to
51 * an invalid user name or password.
52 */
53 public XATopicConnection createXATopicConnection() throws JMSException;
54
55 /** Creates an XA topic connection with the specified user identity.
56 * The connection is created in stopped mode. No messages
57 * will be delivered until the <code>Connection.start</code> method
58 * is explicitly called.
59 *
60 * @param userName the caller's user name
61 * @param password the caller's password
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 public XATopicConnection createXATopicConnection(String userName, String password) throws JMSException;
71 }
Save This Page