/* Version 1.0 based on Apache Software License 1.1
    *
    * Copyright (c) 2003 Piotr Maj and DBMonster developers. All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions are
    * met:
    *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in the
   *    documentation and/or other materials provided with the distribution.
   *
   * 3. The end-user documentation included with the redistribution, if any,
   *    must include the following acknowledgment:
   *
   *    "This product includes software developed by DBMonster developers
   *    (http://dbmonster.kernelpanic.pl/)."
   *
   *  Alternately, this acknowledgment may appear in the software itself,
   *  if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The name "DBMonster" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact pm@jcake.com.
   *
   * 5. Products derived from this software may not be called "DBMonster",
   *    nor may "DBMonster" appear in their name, without prior written
   *    permission of Piotr Maj.
   *
   * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   * IN NO EVENT SHALL THE DBMONSTER DEVELOPERS BE LIABLE FOR ANY DIRECT,
   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
   * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   */
  
  package pl.kernelpanic.dbmonster.connection;
  
  import java.sql.Connection;
  import java.sql.DatabaseMetaData;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  import java.util.Properties;
  
  import org.apache.commons.logging.Log;
  
  /***
   * The most simple connection provider. It uses the following properies
   * to establish connection:
   *
   * <ul>
   *   <li>dbmonster.jdbc.driver (ie. org.postgresql.Driver)</li>
   *   <li>dbmonster.jdbc.url (ie. jdbc:postgresql://127.0.0.1/dbmonster)</li>
   *   <li>dbmonster.jdbc.username (ie. dbmonster)</li>
   *   <li>dbmonster.jdbc.password (ie. dbmonster)</li>
   * </ul>
   *
   * By default these properties are taken from System.getProperty, but you may
   * also provide them on your own.
   *
   * @author Piotr Maj
   *
   * @version $Id: SimpleConnectionProvider.java,v 1.2 2006/01/05 16:29:37 majek Exp $
   */
  public class SimpleConnectionProvider
      implements ConnectionProvider, LogEnabled {
  
      /***
       * JDBC driver name.
       */
      private String driver = System.getProperty("dbmonster.jdbc.driver");
  
      /***
       * JDBC url.
       */
      private String url = System.getProperty("dbmonster.jdbc.url");
  
      /***
       * JDBC user name.
       */
      private String username = System.getProperty("dbmonster.jdbc.username");
  
      /***
       * JDBC user's password.
       */
      private String password = System.getProperty("dbmonster.jdbc.password");
  
      /***
       * Properties used to establish connection.
      */
     private Properties properties = null;
 
     /***
      * Logger.
      */
     private Log logger = null;
 
     private Connection connection;
 
     private boolean autoCommit = true;
 
     /***
      * Creates new SimpleConnectionProvider.
      *
      * @throws ClassNotFoundException if driver class could not be found.
      */
     public SimpleConnectionProvider() throws ClassNotFoundException {
         initDriver();
     }
 
     /***
      * Creates new SimpleConnectionProvider with given connection info.
      *
      * @param jdbcDriver JDBC driver
      * @param jdbcUrl JDBC url
      * @param jdbcUsername JDBC user name
      * @param jdbcPassword JDBC password
      *
      * @throws ClassNotFoundException if the driver class could not be found.
      */
     public SimpleConnectionProvider(
         String jdbcDriver,
         String jdbcUrl,
         String jdbcUsername,
         String jdbcPassword) throws ClassNotFoundException {
         driver = jdbcDriver;
         url = jdbcUrl;
         username = jdbcUsername;
         password = jdbcPassword;
         initDriver();
     }
 
     /***
      * Creates new SimpleConnectionProvider with properties (usefull
      * for interbase).
      *
      * @param jdbcDriver JDBC driver
      * @param jdbcUrl JDBC url
      * @param props properties
      *
      * @throws ClassNotFoundException if driver class could not be found.
      */
     public SimpleConnectionProvider(
         String jdbcDriver,
         String jdbcUrl,
         Properties props) throws ClassNotFoundException {
         driver = jdbcDriver;
         url = jdbcUrl;
         properties = props;
         initDriver();
     }
 
     /***
      * @see ConnectionProvider#getConnection()
      */
     public Connection getConnection() throws SQLException {
         connection = null;
         if (properties == null) {
             connection = DriverManager.getConnection(url, username, password);
         } else {
             connection = DriverManager.getConnection(url, properties);
         }
         connection.setAutoCommit(autoCommit);
         return connection;
     }
 
     /***
      * @see ConnectionProvider#testConnection()
      */
     public void testConnection() throws SQLException {
         Connection conn = getConnection();
         DatabaseMetaData dbmd = conn.getMetaData();
         if (logger != null && logger.isInfoEnabled()) {
             logger.info("Today we are feeding: "
                 + dbmd.getDatabaseProductName() + " "
                 + dbmd.getDatabaseProductVersion());
         }
         conn.close();
         dbmd = null;
         conn = null;
     }
 
     /***
      * Sets the logger.
      *
      * @param log a logger.
      */
     public void setLogger(Log log) {
         logger = log;
     }
 
     /***
      * Shutdown this connection provider.
      */
     public void shutdown() {
         try {
             if (connection != null && !connection.isClosed()) {
                 connection.close();
             }
         } catch (SQLException e) {
             logger.error("Counld not close the JDBC connection.", e);
             // ignoring the rest
         }
         logger = null;
         driver = null;
         password = null;
         properties = null;
         url = null;
         username = null;
     }
 
     /***
      * Initializes the JDBC driver.
      *
      * @throws ClassNotFoundException if driver class could not be found.
      */
     private void initDriver() throws ClassNotFoundException {
         Class.forName(driver);
     }
 
     public void setAutoCommit(boolean autoCommit) {
         this.autoCommit = autoCommit;
     }
 }