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: JmsConnectionConsumer.java,v 1.4 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.JMSException;
49  import javax.jms.Message;
50  import javax.jms.MessageListener;
51  import javax.jms.ServerSession;
52  import javax.jms.ServerSessionPool;
53  import javax.jms.Session;
54  import javax.jms.Topic;
55  import javax.jms.TopicConnection;
56  import javax.jms.TopicSession;
57  
58  import org.apache.commons.logging.Log;
59  import org.apache.commons.logging.LogFactory;
60  
61  
62  /***
63   * Implementation of the <code>javax.jms.ConnectionConsumer</code> interface
64   *
65   * @version     $Revision: 1.4 $ $Date: 2004/01/11 02:33:44 $
66   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
67   */
68  abstract class JmsConnectionConsumer
69      implements ConnectionConsumer, MessageListener {
70  
71      /***
72       * The server session pool
73       */
74      private ServerSessionPool _pool;
75  
76      /***
77       * The maximum number of messages that can be assigned to a server session 
78       * at one time
79       */
80      private final int _maxMessages;
81  
82      /***
83       * The logger
84       */
85      private static final Log _log =
86          LogFactory.getLog(JmsConnectionConsumer.class);
87  
88  
89      /***
90       * Construct a new <code>JmsConnectionConsumer</code>
91       *
92       * @param pool the server session pool
93       * @param maxMessages maximum number of messages that can be assigned to a 
94       * server session at one time
95       */
96      public JmsConnectionConsumer(ServerSessionPool pool, int maxMessages) {
97          if (pool == null) {
98              throw new IllegalArgumentException("Argument 'pool' is null");
99          }
100         if (maxMessages <= 0) {
101             throw new IllegalArgumentException(
102                 "Argument 'maxMessages' must be > 0");
103         }
104         _pool = pool;
105         _maxMessages = maxMessages;
106     }
107 
108     /***
109      * Get the server session pool associated with this connection consumer
110      *
111      * @return the server session pool used by this connection consumer
112      */
113     public ServerSessionPool getServerSessionPool() {
114         return _pool;
115     }
116 
117     /***
118      * Close the connection consumer, freeing any allocated resources
119      *
120      * @throws JMSException if the consumer cannot be closed
121      */
122     public void close() throws JMSException {
123         _pool = null;
124     }
125 
126     /***
127      * Impmentation of MessageListener.onMessage, which will receive
128      * messages from the server. 
129      * In this most simple case, it loads each message into a server session 
130      * and calls the start method.
131      *
132      * @param message the message
133      */
134     public void onMessage(Message message) {
135         try {
136             // not very sophisticated at this point. Simply get a session
137             // from the pool, put the message in it, and start it.
138             ServerSession serverSession = _pool.getServerSession();
139             JmsSession session = (JmsSession) serverSession.getSession();
140             message.acknowledge();
141             session.addMessage(message);
142             serverSession.start();
143         } catch (Exception exception) {
144             _log.error(exception, exception);
145         }
146     }
147 
148 }