XAConnection


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  /** The <CODE>XAConnection</CODE> interface extends the capability of 
28    * <CODE>Connection</CODE> by providing an <CODE>XASession</CODE> (optional).
29    *
30    *<P>The <CODE>XAConnection</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.XAQueueConnection
43    * @see         javax.jms.XATopicConnection
44    */
45  
46  public interface XAConnection extends Connection  {
47      
48      /** Creates an <CODE>XASession</CODE> object.
49        *  
50        * @return a newly created <CODE>XASession</CODE>
51        *  
52        * @exception JMSException if the <CODE>XAConnection</CODE> object 
53        *                         fails to create an <CODE>XASession</CODE> due to
54        *                         some internal error.
55        *
56        * @since 1.1
57        */ 
58  
59      XASession  
60      createXASession() throws JMSException  ;
61  
62      /** Creates an <CODE>Session</CODE> object.
63        *
64        * @param transacted       usage undefined
65        * @param acknowledgeMode  usage undefined
66        *  
67        * @return a <CODE>Session</CODE> object
68        *  
69        * @exception JMSException if the <CODE>XAConnection</CODE> object 
70        *                         fails to create an <CODE>Session</CODE> due to
71        *                         some internal error.
72        *
73        * @since 1.1
74        */ 
75      Session  
76      createSession(boolean transacted,
77                         int acknowledgeMode) throws JMSException  ;
78  }
79
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags