View Javadoc

1   package org.apache.torque.dsfactory;
2   
3   /* ====================================================================
4    * The Apache Software License, Version 1.1
5    *
6    * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
7    * reserved.
8    *
9    * Redistribution and use in source and binary forms, with or without
10   * modification, are permitted provided that the following conditions
11   * are met:
12   *
13   * 1. Redistributions of source code must retain the above copyright
14   *    notice, this list of conditions and the following disclaimer.
15   *
16   * 2. Redistributions in binary form must reproduce the above copyright
17   *    notice, this list of conditions and the following disclaimer in
18   *    the documentation and/or other materials provided with the
19   *    distribution.
20   *
21   * 3. The end-user documentation included with the redistribution,
22   *    if any, must include the following acknowledgment:
23   *       "This product includes software developed by the
24   *        Apache Software Foundation (http://www.apache.org/)."
25   *    Alternately, this acknowledgment may appear in the software itself,
26   *    if and wherever such third-party acknowledgments normally appear.
27   *
28   * 4. The names "Apache" and "Apache Software Foundation" and
29   *    "Apache Turbine" must not be used to endorse or promote products
30   *    derived from this software without prior written permission. For
31   *    written permission, please contact apache@apache.org.
32   *
33   * 5. Products derived from this software may not be called "Apache",
34   *    "Apache Turbine", nor may "Apache" appear in their name, without
35   *    prior written permission of the Apache Software Foundation.
36   *
37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48   * SUCH DAMAGE.
49   * ====================================================================
50   *
51   * This software consists of voluntary contributions made by many
52   * individuals on behalf of the Apache Software Foundation.  For more
53   * information on the Apache Software Foundation, please see
54   * <http://www.apache.org/>.
55   */
56  
57  import javax.sql.ConnectionPoolDataSource;
58  import javax.sql.DataSource;
59  
60  import org.apache.commons.configuration.Configuration;
61  
62  import org.apache.commons.dbcp.datasources.PerUserPoolDataSource;
63  
64  import org.apache.commons.logging.Log;
65  import org.apache.commons.logging.LogFactory;
66  
67  import org.apache.torque.Torque;
68  import org.apache.torque.TorqueException;
69  
70  /***
71   * A factory that looks up the DataSource using the JDBC2 pool methods.
72   *
73   * @author <a href="mailto:jmcnally@apache.org">John McNally</a>
74   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
75   * @version $Id: PerUserPoolDataSourceFactory.java,v 1.1 2003/08/19 19:09:12 mpoeschl Exp $
76   */
77  public class PerUserPoolDataSourceFactory
78      extends AbstractDataSourceFactory
79      implements DataSourceFactory
80  {
81  
82      /*** The log. */
83      private static Log log 
84              = LogFactory.getLog(PerUserPoolDataSourceFactory.class);
85  
86      /*** The wrapped <code>DataSource</code>. */
87      private DataSource ds;
88  
89      /***
90       * @see org.apache.torque.dsfactory.DataSourceFactory#getDataSource
91       */
92      public DataSource getDataSource()
93      {
94          return ds;
95      }
96  
97      /***
98       * @see org.apache.torque.dsfactory.DataSourceFactory#initialize
99       */
100     public void initialize(Configuration configuration) throws TorqueException
101     {
102         if (configuration == null)
103         {
104             throw new TorqueException(
105                 "Torque cannot be initialized without a valid configuration. "
106                 + "Please check the log files for further details.");
107         }
108 
109         ConnectionPoolDataSource cpds = initCPDS(configuration);
110         PerUserPoolDataSource ds = initJdbc2Pool(configuration);
111         ds.setConnectionPoolDataSource(cpds);
112         this.ds = ds;
113     }
114 
115     /***
116      * Initializes the Jdbc2PoolDataSource.
117      *
118      * @param configuration where to read the settings from
119      * @throws TorqueException if a property set fails
120      * @return a configured <code>Jdbc2PoolDataSource</code>
121      */
122     private PerUserPoolDataSource initJdbc2Pool(Configuration configuration)
123         throws TorqueException
124     {
125         log.debug("Starting initJdbc2Pool");
126         PerUserPoolDataSource ds = new PerUserPoolDataSource();
127         Configuration c = Torque.getConfiguration();
128 
129         if (c == null)
130         {
131             log.warn("Global Configuration not set,"
132                     + " no Default pool data source configured!");
133         }
134         else
135         {
136             Configuration conf = c.subset(DEFAULT_POOL_KEY);
137             applyConfiguration(conf, ds);
138         }
139 
140         Configuration conf = configuration.subset(POOL_KEY);
141         applyConfiguration(conf, ds);
142         return ds;
143     }
144 }