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 2003-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   */
43  package org.exolab.jms.persistence;
44  
45  import java.sql.Connection;
46  import java.sql.SQLException;
47  import javax.sql.DataSource;
48  
49  import org.apache.commons.dbcp.BasicDataSource;
50  
51  
52  /***
53   * Wrapper around the DBCP connection manager.
54   *
55   * @version     $Revision: 1.2 $ $Date: 2005/12/01 13:50:17 $
56   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
57   */
58  public class DBCPConnectionManager extends AbstractConnectionManager {
59  
60      /***
61       * The data source.
62       */
63      private DataSource _dataSource;
64  
65      /***
66       * Default constructor.
67       */
68      public DBCPConnectionManager() {
69      }
70  
71      /***
72       * Initialise the connection manager. This must be called before a call to
73       * {@link #getConnection} is made and after all the properties have been
74       * set.
75       */
76      public void init() throws PersistenceException {
77          long evictionIntervalMS = getEvictionInterval() * 1000;
78          long minIdleTimeMS = getMinIdleTime() * 1000;
79          
80          String testQuery = getTestQuery();
81          boolean testWhileIdle = false;
82  
83          if (testQuery != null) {
84              testWhileIdle = true;
85          }
86          
87          BasicDataSource dataSource = new BasicDataSource();
88          dataSource.setUsername(getUser());
89          dataSource.setPassword(getPassword());
90          dataSource.setDriverClassName(getDriver());
91          dataSource.setUrl(getURL());
92          dataSource.setDefaultAutoCommit(false);
93          dataSource.setPoolPreparedStatements(true);
94  
95          // configure pooling
96          dataSource.setMaxActive(getMaxActive());
97          dataSource.setMaxIdle(getMaxIdle());
98  
99          dataSource.setMaxWait(60 * 1000);
100         // force the pool to timeout to avoid deadlocks
101 
102         dataSource.setValidationQuery(testQuery);
103         dataSource.setTestOnBorrow(getTestBeforeUse());
104         dataSource.setTimeBetweenEvictionRunsMillis(evictionIntervalMS);
105         dataSource.setMinEvictableIdleTimeMillis(minIdleTimeMS);
106         dataSource.setTestWhileIdle(testWhileIdle);
107 
108         _dataSource = dataSource;
109     }
110 
111     /***
112      * Retrieve a connection to the underlying database from the pool of
113      * connections.
114      *
115      * @return a connection to the database
116      * @throws PersistenceException if a connection cannot be retrieved
117      */
118     public Connection getConnection() throws PersistenceException {
119         Connection connection;
120         try {
121             connection = _dataSource.getConnection();
122         } catch (SQLException exception) {
123             throw new PersistenceException("Failed to get pooled connection",
124                 exception);
125         }
126 
127         return connection;
128     }
129 
130 }