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 2000-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsTopicConnection.java,v 1.12 2004/01/11 02:33:44 tanderson Exp $
44   */
45  package org.exolab.jms.client;
46  
47  import javax.jms.ConnectionConsumer;
48  import javax.jms.IllegalStateException;
49  import javax.jms.JMSException;
50  import javax.jms.ServerSessionPool;
51  import javax.jms.Session;
52  import javax.jms.Topic;
53  import javax.jms.TopicConnection;
54  import javax.jms.TopicSession;
55  
56  
57  /***
58   * Client implementation of the <code>javax.jms.TopicConnection</code> 
59   * interface
60   *
61   * @version     $Revision: 1.12 $ $Date: 2004/01/11 02:33:44 $
62   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
63   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
64   */
65  class JmsTopicConnection extends JmsConnection implements TopicConnection {
66  
67      /***
68       * Construct a new <code>JmsTopicConnection</code>
69       * <p>
70       * This attempts to establish a connection to the JMS server
71       *
72       * @param factory the connection factory responsible for creating this
73       * @param id the client identity
74       * @param username the client username
75       * @param password the client password
76       * @throws JMSException if a connection cannot be established
77       */
78      public JmsTopicConnection(JmsTopicConnectionFactory factory, String id, 
79                                String username, String password)
80          throws JMSException {
81          super(factory, id, username, password);
82      }
83  
84      /***
85       * Create a new topic session
86       *
87       * @param transacted if <code>true</code>, the session is transacted.
88       * @param ackMode indicates whether the consumer or the client will 
89       * acknowledge any messages it receives. This parameter will be ignored if 
90       * the session is transacted. Legal values are 
91       * <code>Session.AUTO_ACKNOWLEDGE</code>, 
92       * <code>Session.CLIENT_ACKNOWLEDGE</code> and 
93       * <code>Session.DUPS_OK_ACKNOWLEDGE</code>.
94       * @return the new topic session
95       * @throws JMSException if the session cannot be created
96       */
97      public TopicSession createTopicSession(boolean transacted, int ackMode)
98          throws JMSException {
99  
100         ensureOpen();
101         setModified();
102 
103         JmsTopicSession session = null;
104 
105         session = new JmsTopicSession(this, transacted, ackMode);
106         if (!isStopped()) {
107             session.start();
108         }
109 
110         // add it to the list of managed sessions for this connection
111         addSession(session);
112 
113         return session;
114     }
115 
116     /***
117      * Create a connection consumer for this connection
118      *
119      * @param topic the topic to access
120      * @param selector the message selector. May be <code>null</code>
121      * @param pool the server session pool to associate with the consumer
122      * @param maxMessages the maximum number of messages that can be assigned 
123      * to a server session at one time
124      * @return the new connection consumer
125      * @throws InvalidSelectorException if the message selector is invalid
126      * @throws JMSException if the connection consumer cannot be created
127      */
128     public ConnectionConsumer createConnectionConsumer(
129         Topic topic, String selector, ServerSessionPool pool, int maxMessages)
130         throws JMSException {
131 
132         ensureOpen();
133         setModified();
134 
135         return new JmsTopicConnectionConsumer(
136             this, topic, pool, selector, maxMessages);
137     }
138 
139     /***
140      * Create a durable connection consumer for this connection
141      *
142      * @param topic the topic to access
143      * @param subscriptionName the durable subscription name 
144      * @param selector the message selector. May be <code>null</code>
145      * @param pool the server session pool to associate with the consumer
146      * @param maxMessages the maximum number of messages that can be assigned 
147      * to a server session at one time
148      * @return the new connection consumer
149      * @throws InvalidSelectorException if the message selector is invalid
150      * @throws JMSException if the connection consumer cannot be created
151      */
152     public ConnectionConsumer createDurableConnectionConsumer(
153         Topic topic, String subscriptionName, String selector,
154         ServerSessionPool pool, int maxMessages) throws JMSException {
155 
156         ensureOpen();
157         setModified();
158 
159         return new JmsTopicConnectionConsumer(this, topic, subscriptionName, 
160                                               pool, selector, maxMessages);
161     }
162 
163 }