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: JmsTopicConnectionConsumer.java,v 1.5 2004/01/11 02:33:45 tanderson Exp $
44   */
45  package org.exolab.jms.client;
46  
47  import javax.jms.ConnectionConsumer;
48  import javax.jms.JMSException;
49  import javax.jms.MessageListener;
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  import javax.jms.TopicSubscriber;
56  
57  
58  /***
59   * Client implementation of the <code>javax.jms.ConnectionConsumer</code>
60   * interface, for topics.
61   *
62   * @version     $Revision: 1.5 $ $Date: 2004/01/11 02:33:45 $
63   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
64   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
65   */
66  class JmsTopicConnectionConsumer extends JmsConnectionConsumer {
67  
68      /***
69       * The session to receive messages via.
70       */
71      private TopicSession _session;
72  
73      /***
74       * The subscriber of messages
75       */
76      private TopicSubscriber _subscriber;
77  
78  
79      /***
80       * Construct a new, non-durable <code>JmsTopicConnectionConsumer</code>
81       *
82       * @param connection the connection which created this
83       * @param topic the topic to access
84       * @param pool the server session pool
85       * @param selector the message selector. May be <code>null</code>
86       * @param maxMessages the maximum number of messages that can be assigned 
87       * to a server session at one time
88       * @throws JMSException if the consumer cannot be constructed
89       */
90      public JmsTopicConnectionConsumer(TopicConnection connection, Topic topic,
91                                        ServerSessionPool pool, String selector, 
92                                        int maxMessages)
93          throws JMSException {
94          this(connection, topic, null, pool, selector, maxMessages);
95      }
96  
97      /***
98       * Construct a new <code>JmsTopicConnectionConsumer</code>
99       *
100      * @param connection the connection which created this
101      * @param topic the topic to access
102      * @param subscriptionName the durable subscription name. 
103      * May be <code>null</code>
104      * @param pool the server session pool
105      * @param selector the message selector. May be <code>null</code>
106      * @param maxMessages the maximum number of messages that can be assigned 
107      * to a server session at one time
108      * @throws JMSException if the consumer cannot be constructed
109      */
110     public JmsTopicConnectionConsumer(
111         TopicConnection connection, Topic topic, String subscriptionName, 
112         ServerSessionPool pool, String selector, int maxMessages)
113         throws JMSException {
114         super(pool, maxMessages);
115 
116         _session = connection.createTopicSession(
117             false, Session.CLIENT_ACKNOWLEDGE);
118         if (subscriptionName == null) {
119             // transient subscriber
120             _subscriber = _session.createSubscriber(topic, selector, false);
121         } else {
122             // durable subscriber.
123             _subscriber = _session.createDurableSubscriber(
124                 topic, subscriptionName, selector, false);
125         }
126 
127         _subscriber.setMessageListener(this);
128     }
129 
130     /***
131      * Close the connection consumer, freeing any allocated resources
132      *
133      * @throws JMSException if the consumer cannot be closed
134      */
135     public void close() throws JMSException {
136         super.close();
137         try {
138             _subscriber.close();
139             _session.close();
140         } finally {
141             _subscriber = null;
142             _session = null;
143         }
144     }
145 }