XAQueueSession


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>XAQueueSession</CODE> provides a regular <CODE>QueueSession</CODE>,
28    * which can be used to
29    * create <CODE>QueueReceiver</CODE>, <CODE>QueueSender</CODE>, and 
30    *<CODE>QueueBrowser</CODE> objects (optional).
31    *
32    * <P>The <CODE>XAQueueSession</CODE> interface is optional. JMS providers 
33    * are not required to support this interface. This interface is for 
34    * use by JMS providers to support transactional environments. 
35    * Client programs are strongly encouraged to use the transactional support
36    * available in their environment, rather than use these XA
37    * interfaces directly. 
38   *
39    * @version     1.1 - February 2, 2002
40    * @author      Mark Hapner
41    * @author      Rich Burridge
42    * @author      Kate Stout
43    *
44    * @see         javax.jms.XASession
45    */
46  
47  public interface XAQueueSession extends XASession   {
48  
49      /** Gets the queue session associated with this <CODE>XAQueueSession</CODE>.
50        *  
51        * @return the queue session object
52        *  
53        * @exception JMSException if an internal error occurs.
54        */ 
55   
56      QueueSession  
57      getQueueSession() throws JMSException  ;
58  }
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags