View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2001-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsXATopicSession.java,v 1.2 2005/03/18 03:36:37 tanderson Exp $
44   */
45  package org.exolab.jms.client;
46  
47  import javax.jms.JMSException;
48  import javax.jms.Session;
49  import javax.jms.TopicSession;
50  import javax.jms.TransactionInProgressException;
51  import javax.jms.XATopicSession;
52  import javax.transaction.xa.XAResource;
53  
54  
55  /***
56   * Client implementation of the <code>javax.jms.XATopicSession</code> interface
57   *
58   * @author <a href="mailto:jima@comware.com.au">Jim Alateras</a>
59   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
60   * @version $Revision: 1.2 $ $Date: 2005/03/18 03:36:37 $
61   */
62  public class JmsXATopicSession
63          extends JmsTopicSession
64          implements XATopicSession {
65  
66      /***
67       * The XA resource.
68       */
69      private JmsXAResource _xares;
70  
71  
72      /***
73       * Construct a new <code>JmsXATopicSession</code>.
74       *
75       * @param connection the owner of the session
76       * @throws JMSException if the session cannot be created
77       */
78      JmsXATopicSession(JmsXATopicConnection connection)
79              throws JMSException {
80          super(connection, true, Session.CLIENT_ACKNOWLEDGE);
81          _xares = new JmsXAResource(getServerSession());
82      }
83  
84      /***
85       * Gets the queue session associated with this <code>XATopicSession</code>.
86       *
87       * @return the queue session object
88       */
89      public TopicSession getTopicSession() {
90          return this;
91      }
92  
93      /***
94       * Gets the session associated with this <code>XASession</code>.
95       *
96       * @return the session object
97       */
98      public Session getSession() {
99          return this;
100     }
101 
102     /***
103      * Returns an XA resource to the caller.
104      *
105      * @return an XA resource to the caller
106      */
107     public XAResource getXAResource() {
108         return _xares;
109     }
110 
111     /***
112      * Indicates whether the session is in transacted mode.
113      *
114      * @return true
115      */
116     public boolean getTransacted() {
117         return true;
118     }
119 
120     /***
121      * Throws a <code>TransactionInProgressException</code>, since it should not
122      * be called for an <code>XASession</code> object.
123      *
124      * @throws TransactionInProgressException if invoked
125      */
126     public void commit() throws JMSException {
127         throw new TransactionInProgressException(
128                 "Cannot call commit on XATopicession");
129     }
130 
131     /***
132      * Throws a <code>TransactionInProgressException</code>, since it should not
133      * be called for an <code>XASession</code> object.
134      *
135      * @throws TransactionInProgressException if invoked
136      */
137     public void rollback() throws JMSException {
138         throw new TransactionInProgressException(
139                 "Cannot call rollback on XATopicSession");
140     }
141 }