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-2018 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  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.appc.dao.util;
  25
  26 import org.onap.appc.dao.util.api.JdbcConnectionFactory;
  27 import org.onap.appc.dao.util.exception.JdbcRuntimeException;
  28 import org.onap.appc.dao.util.message.Messages;
  29
  30 import java.sql.Connection;
  31 import java.sql.DriverManager;
  32 import java.sql.SQLException;
  33
  34 /**
  35  * @deprecated As of release 1802, replaced by {@link #(org.onap.appc.dao.util.dbcp.DBConnectionPool)}
  36  * <p>
  37  * This class provides the ability to access mysql database which has been deprecated because
  38  * {@link #openDbConnection()} for each database request is not a good practice especially
  39  * on appc performance.
  40  * <p>
  41  * If you would like to use appcctl (mysql database), bundle:appc-data-access-lib has created
  42  * a database connection pool bean and exported as a service by using blueprint.
  43  * If you would like to create a new database connection pool, refer to the way mentioned above.
  44  * {@link org.onap.appc.dao.util.api.DBConnectionPoolService} has an example of how to use
  45  * the connection pool.
  46  */
  47 @Deprecated
  48 public abstract class DefaultJdbcConnectionFactory implements JdbcConnectionFactory {
  49
  50     private static boolean driverRegistered = false;
  51
  52     private String jdbcURL;
  53     private String jdbcUserName;
  54     private String jdbcPassword;
  55
  56     public void setJdbcURL(String jdbcURL) {
  57         this.jdbcURL = jdbcURL;
  58     }
  59
  60     public void setJdbcUserName(String jdbcUserName) {
  61         this.jdbcUserName = jdbcUserName;
  62     }
  63
  64     public void setJdbcPassword(String jdbcPassword) {
  65         this.jdbcPassword = jdbcPassword;
  66     }
  67
  68
  69     protected abstract void registedDriver() throws SQLException;
  70
  71     @Override
  72     public Connection openDbConnection() {
  73         try {
  74             if (!driverRegistered) {
  75                 registedDriver();
  76                 driverRegistered = true;
  77             }
  78             return DriverManager.getConnection(jdbcURL, jdbcUserName, jdbcPassword);
  79         } catch (SQLException e) {
  80             throw new JdbcRuntimeException(Messages.EXP_JDBC_CONNECT.format(jdbcURL), e);
  81         }
  82     }
  83
  84     @Override
  85     public void closeDbConnection(Connection connection) {
  86         try {
  87             connection.close();
  88         } catch (SQLException e) {
  89             throw new JdbcRuntimeException(Messages.EXP_JDBC_DISCONNECT.format(jdbcURL), e);
  90         }
  91     }
  92 }