KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > jms > XAQueueConnection


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 package javax.jms;
25
26 /** An <CODE>XAQueueConnection</CODE> provides the same create options as
27   * <CODE>QueueConnection</CODE> (optional).
28   * The only difference is that an <CODE>XAConnection</CODE> is by definition
29   * transacted.
30   *
31   *<P>The <CODE>XAQueueConnection</CODE> interface is optional. JMS providers
32   * are not required to support this interface. This interface is for
33   * use by JMS providers to support transactional environments.
34   * Client programs are strongly encouraged to use the transactional support
35   * available in their environment, rather than use these XA
36   * interfaces directly.
37   *
38   * @version 1.1 February 2 - 2002
39   * @author Mark Hapner
40   * @author Rich Burridge
41   * @author Kate Stout
42   *
43   * @see javax.jms.XAConnection
44   */

45
46 public interface XAQueueConnection
47     extends XAConnection JavaDoc, QueueConnection JavaDoc {
48
49     /** Creates an <CODE>XAQueueSession</CODE> object.
50       *
51       * @return a newly created <CODE>XAQueueSession</CODE>
52       *
53       * @exception JMSException if the <CODE>XAQueueConnection</CODE> object
54       * fails to create an XA queue session due to some
55       * internal error.
56       */

57
58     XAQueueSession JavaDoc
59     createXAQueueSession() throws JMSException JavaDoc;
60
61     /** Creates an <CODE>XAQueueSession</CODE> object.
62       *
63       * @param transacted usage undefined
64       * @param acknowledgeMode usage undefined
65       *
66       * @return a newly created <CODE>XAQueueSession</CODE>
67       *
68       * @exception JMSException if the <CODE>XAQueueConnection</CODE> object
69       * fails to create an XA queue session due to some
70       * internal error.
71       */

72     QueueSession JavaDoc
73     createQueueSession(boolean transacted,
74                        int acknowledgeMode) throws JMSException JavaDoc;
75 }
76
Popular Tags