01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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,
39: TopicConnectionFactory {
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()
54: throws JMSException;
55:
56: /** Creates an XA topic connection with the specified user identity.
57: * The connection is created in stopped mode. No messages
58: * will be delivered until the <code>Connection.start</code> method
59: * is explicitly called.
60: *
61: * @param userName the caller's user name
62: * @param password the caller's password
63: *
64: * @return a newly created XA topic connection
65: *
66: * @exception JMSException if the JMS provider fails to create an XA topic
67: * connection due to some internal error.
68: * @exception JMSSecurityException if client authentication fails due to
69: * an invalid user name or password.
70: */
71: public XATopicConnection createXATopicConnection(String userName,
72: String password) throws JMSException;
73: }
|