1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2000-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License ("CDDL") (collectively, the "License"). You may
9 * not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or mq/legal/LICENSE.txt. See the License for the specific language
12 * governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at mq/legal/LICENSE.txt. Sun designates
16 * this particular file as subject to the "Classpath" exception as provided by
17 * Sun in the GPL Version 2 section of the License file that accompanied this
18 * code. If applicable, add the following below the License Header, with the
19 * fields enclosed by brackets [] replaced by your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
21 *
22 * Contributor(s):
23 *
24 * If you wish your version of this file to be governed by only the CDDL or
25 * only the GPL Version 2, indicate your decision by adding "[Contributor]
26 * elects to include this software in this distribution under the [CDDL or GPL
27 * Version 2] license." If you don't indicate a single choice of license, a
28 * recipient has the option to distribute your version of this file under
29 * either the CDDL, the GPL Version 2 or to extend the choice of license to
30 * its licensees as provided above. However, if you add GPL Version 2 code
31 * and therefore, elected the GPL Version 2 license, then the option applies
32 * only if the new code is made subject to such option by the copyright holder.
33 */
34
35 /*
36 * @(#)XAConnection.java 1.10 07/02/07
37 */
38
39 package javax.jms;
40
41 /** The <CODE>XAConnection</CODE> interface extends the capability of
42 * <CODE>Connection</CODE> by providing an <CODE>XASession</CODE> (optional).
43 *
44 *<P>The <CODE>XAConnection</CODE> interface is optional. JMS providers
45 * are not required to support this interface. This interface is for
46 * use by JMS providers to support transactional environments.
47 * Client programs are strongly encouraged to use the transactional support
48 * available in their environment, rather than use these XA
49 * interfaces directly.
50 *
51 * @see javax.jms.XAQueueConnection
52 * @see javax.jms.XATopicConnection
53 */
54
55 public interface XAConnection extends Connection{
56
57 /** Creates an <CODE>XASession</CODE> object.
58 *
59 * @return a newly created <CODE>XASession</CODE>
60 *
61 * @exception JMSException if the <CODE>XAConnection</CODE> object
62 * fails to create an <CODE>XASession</CODE> due to
63 * some internal error.
64 *
65 * @since 1.1
66 */
67
68 XASession
69 createXASession() throws JMSException;
70
71 /** Creates an <CODE>Session</CODE> object.
72 *
73 * @param transacted usage undefined
74 * @param acknowledgeMode usage undefined
75 *
76 * @return a <CODE>Session</CODE> object
77 *
78 * @exception JMSException if the <CODE>XAConnection</CODE> object
79 * fails to create an <CODE>Session</CODE> due to
80 * some internal error.
81 *
82 * @since 1.1
83 */
84 Session
85 createSession(boolean transacted,
86 int acknowledgeMode) throws JMSException;
87 }
Save This Page