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 2006 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: DefaultThreadPoolFactory.java,v 1.1 2006/02/23 11:07:05 tanderson Exp $
44   */
45  package org.exolab.jms.common.threads;
46  
47  import EDU.oswego.cs.dl.util.concurrent.PooledExecutor;
48  import EDU.oswego.cs.dl.util.concurrent.Channel;
49  
50  
51  /***
52   * Default {@link ThreadPoolFactory} implementation that enables a {@link
53   * ThreadListener} to be associated with each pool.
54   *
55   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
56   * @version $Revision: 1.1 $ $Date: 2006/02/23 11:07:05 $
57   */
58  public class DefaultThreadPoolFactory implements ThreadPoolFactory {
59  
60      /***
61       * The thread listener. May be <code>null</code>.
62       */
63      private final ThreadListener _listener;
64  
65  
66      /***
67       * Construct a new <code>DefaultThreadPoolFactory</code>.
68       *
69       * @param listener the thread listener. May be <code>null</code>
70       */
71      public DefaultThreadPoolFactory(ThreadListener listener) {
72          _listener = listener;
73      }
74  
75      /***
76       * Construct a new <code>PooledExecutor</code>.
77       *
78       * @param name        the name to assign the thread group and worker
79       *                    threads
80       * @param maxPoolSize the maximum no. of threads to use
81       */
82      public PooledExecutor create(String name, int maxPoolSize) {
83          return init(new ThreadPool(name, maxPoolSize));
84      }
85  
86      /***
87       * Construct a new <code>ThreadPool</code>.
88       *
89       * @param name        the name to assign the thread group and worker
90       *                    threads
91       * @param channel     the channel for queueing
92       * @param maxPoolSize the maximum no. of threads to use
93       */
94      public PooledExecutor create(String name, Channel channel, int maxPoolSize) {
95          return init(new ThreadPool(name, channel, maxPoolSize));
96      }
97  
98      /***
99       * Initialises a pool.
100      *
101      * @param pool the pool to initialise
102      * @return the pool
103      */
104     protected ThreadPool init(ThreadPool pool) {
105         pool.setThreadListener(_listener);
106         return pool;
107     }
108 
109 }