appc-dispatcher/appc-dispatcher-common/appc-data-access-lib/src/main/java/org/onap/appc/dao/util/DefaultJdbcConnectionFactory.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.appc.dao.util;
  26
  27 import org.onap.appc.dao.util.api.JdbcConnectionFactory;
  28 import org.onap.appc.dao.util.exception.JdbcRuntimeException;
  29 import org.onap.appc.dao.util.message.Messages;
  30
  31 import java.sql.Connection;
  32 import java.sql.DriverManager;
  33 import java.sql.SQLException;
  34
  35 /**
  36  * @deprecated As of release 1802, replaced by {@link #(org.onap.appc.dao.util.dbcp.DBConnectionPool)}
  37  * <p>
  38  * This class provides the ability to access mysql database which has been deprecated because
  39  * {@link #openDbConnection()} for each database request is not a good practice especially
  40  * on appc performance.
  41  * <p>
  42  * If you would like to use appcctl (mysql database), bundle:appc-data-access-lib has created
  43  * a database connection pool bean and exported as a service by using blueprint.
  44  * If you would like to create a new database connection pool, refer to the way mentioned above.
  45  * {@link org.onap.appc.dao.util.api.DBConnectionPoolService} has an example of how to use
  46  * the connection pool.
  47  */
  48 @Deprecated
  49 public abstract class DefaultJdbcConnectionFactory implements JdbcConnectionFactory {
  50
  51     private static boolean driverRegistered = false;
  52
  53     private String jdbcURL;
  54     private String jdbcUserName;
  55     private String jdbcPassword;
  56
  57     public void setJdbcURL(String jdbcURL) {
  58         this.jdbcURL = jdbcURL;
  59     }
  60
  61     public void setJdbcUserName(String jdbcUserName) {
  62         this.jdbcUserName = jdbcUserName;
  63     }
  64
  65     public void setJdbcPassword(String jdbcPassword) {
  66         this.jdbcPassword = jdbcPassword;
  67     }
  68
  69
  70     protected abstract void registedDriver() throws SQLException;
  71
  72     @Override
  73     public Connection openDbConnection() {
  74         try {
  75             if (!driverRegistered) {
  76                 registedDriver();
  77                 driverRegistered = true;
  78             }
  79             return DriverManager.getConnection(jdbcURL, jdbcUserName, jdbcPassword);
  80         } catch (SQLException e) {
  81             throw new JdbcRuntimeException(Messages.EXP_JDBC_CONNECT.format(jdbcURL), e);
  82         }
  83     }
  84
  85     @Override
  86     public void closeDbConnection(Connection connection) {
  87         try {
  88             connection.close();
  89         } catch (SQLException e) {
  90             throw new JdbcRuntimeException(Messages.EXP_JDBC_DISCONNECT.format(jdbcURL), e);
  91         }
  92     }
  93 }