XATopicConnectionFactory


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  
24  
25  package javax.jms;
26  
27  /** An <CODE>XATopicConnectionFactory</CODE> provides the same create options as 
28    * a <CODE>TopicConnectionFactory</CODE> (optional).
29    *
30    * <P>The <CODE>XATopicConnectionFactory</CODE> interface is optional.  JMS providers 
31    * are not required to support this interface. This interface is for 
32    * use by JMS providers to support transactional environments. 
33    * Client programs are strongly encouraged to use the transactional support
34    * available in their environment, rather than use these XA
35    * interfaces directly. 
36    *
37    * @version     1.1 February 2, 2002
38    * @author      Mark Hapner
39    * @author      Rich Burridge
40    * @author      Kate Stout
41    *
42    * @see         javax.jms.TopicConnectionFactory
43    * @see         javax.jms.XAConnectionFactory
44    */
45  
46  public interface XATopicConnectionFactory 
47      extends XAConnectionFactory  , TopicConnectionFactory   {
48  
49      /** Creates an XA topic connection with the default user identity.
50        * The connection is created in stopped mode. No messages 
51        * will be delivered until the <code>Connection.start</code> method
52        * is explicitly called.
53        *
54        * @return a newly created XA topic connection
55        *
56        * @exception JMSException if the JMS provider fails to create an XA topic 
57        *                         connection due to some internal error.
58        * @exception JMSSecurityException  if client authentication fails due to 
59        *                         an invalid user name or password.
60        */ 
61  
62      XATopicConnection  
63      createXATopicConnection() throws JMSException  ;
64  
65  
66      /** Creates an XA topic connection with the specified user identity.
67        * The connection is created in stopped mode. No messages 
68        * will be delivered until the <code>Connection.start</code> method
69        * is explicitly called.
70        *  
71        * @param userName the caller's user name
72        * @param password the caller's password
73        *  
74        * @return a newly created XA topic connection
75        *
76        * @exception JMSException if the JMS provider fails to create an XA topic 
77        *                         connection due to some internal error.
78        * @exception JMSSecurityException  if client authentication fails due to 
79        *                         an invalid user name or password.
80        */ 
81  
82      XATopicConnection  
83      createXATopicConnection(String   userName, String   password) 
84                           throws JMSException  ;
85  }
86
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags