01: /*
02: * @(#)XATopicConnectionFactory.java 1.14 02/04/09
03: *
04: * Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
05: *
06: * SUN PROPRIETARY/CONFIDENTIAL.
07: * This software is the proprietary information of Sun Microsystems, Inc.
08: * Use is subject to license terms.
09: *
10: */
11:
12: package javax.jms;
13:
14: /** An <CODE>XATopicConnectionFactory</CODE> provides the same create options as
15: * a <CODE>TopicConnectionFactory</CODE> (optional).
16: *
17: * <P>The <CODE>XATopicConnectionFactory</CODE> interface is optional. JMS providers
18: * are not required to support this interface. This interface is for
19: * use by JMS providers to support transactional environments.
20: * Client programs are strongly encouraged to use the transactional support
21: * available in their environment, rather than use these XA
22: * interfaces directly.
23: *
24: * @version 1.1 February 2, 2002
25: * @author Mark Hapner
26: * @author Rich Burridge
27: * @author Kate Stout
28: *
29: * @see javax.jms.TopicConnectionFactory
30: * @see javax.jms.XAConnectionFactory
31: */
32:
33: public interface XATopicConnectionFactory extends XAConnectionFactory,
34: TopicConnectionFactory {
35:
36: /** Creates an XA topic connection with the default user identity.
37: * The connection is created in stopped mode. No messages
38: * will be delivered until the <code>Connection.start</code> method
39: * is explicitly called.
40: *
41: * @return a newly created XA topic connection
42: *
43: * @exception JMSException if the JMS provider fails to create an XA topic
44: * connection due to some internal error.
45: * @exception JMSSecurityException if client authentication fails due to
46: * an invalid user name or password.
47: */
48:
49: XATopicConnection createXATopicConnection() throws JMSException;
50:
51: /** Creates an XA topic connection with the specified user identity.
52: * The connection is created in stopped mode. No messages
53: * will be delivered until the <code>Connection.start</code> method
54: * is explicitly called.
55: *
56: * @param userName the caller's user name
57: * @param password the caller's password
58: *
59: * @return a newly created XA topic connection
60: *
61: * @exception JMSException if the JMS provider fails to create an XA topic
62: * connection due to some internal error.
63: * @exception JMSSecurityException if client authentication fails due to
64: * an invalid user name or password.
65: */
66:
67: XATopicConnection createXATopicConnection(String userName,
68: String password) throws JMSException;
69: }
|