JDBCServiceManagerBase.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it).
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */
  20. package org.openspcoop2.generic_project.dao.jdbc;


  23. import java.io.File;
  24. import java.sql.Connection;
  25. import java.sql.DriverManager;
  26. import java.sql.SQLException;
  27. import java.util.Date;
  28. import java.util.Properties;

  30. import javax.sql.DataSource;

  32. import org.openspcoop2.generic_project.beans.IProjectInfo;
  33. import org.openspcoop2.generic_project.exception.ServiceException;
  34. import org.openspcoop2.generic_project.utils.ServiceManagerProperties;
  35. import org.openspcoop2.utils.LoggerWrapperFactory;
  36. import org.openspcoop2.utils.date.DateManager;
  37. import org.openspcoop2.utils.jdbc.JDBCUtilities;
  38. import org.openspcoop2.utils.resources.ClassLoaderUtilities;
  39. import org.openspcoop2.utils.resources.GestoreJNDI;
  40. import org.slf4j.Logger;

  42. /**
  43.  * JDBCServiceManager
  44.  * 
  45.  * @author Poli Andrea (apoli@link.it)
  46.  * @author $Author$
  47.  * @version $Rev$, $Date$
  48.  */
  49. public class JDBCServiceManagerBase {

  51.     /** DataSource. */
  52.     protected DataSource datasource;
  53.     /** Connection */
  54.     protected Connection connection = null;
  55.     /** Logger */
  56.     protected Logger log = null;
  57.     /** JDBC Properties */
  58.     protected JDBCServiceManagerProperties jdbcProperties = null;
  59.     
  60.     /** Parametri per rinegoziare la connessione */
  61.     private String connectionUrl;
  62.     private String username;
  63.     private String password;
  64.     private int secondsToRefreshConnection = -1;
  65.     private Date connectionDate;
  66.     
  67.     private void logError(String msg, Exception e) {
  68.         if(this.log!=null) {
  69.             this.log.error(msg, e);
  70.         }
  71.     }
  72.     
  73.     private static final String CREATE_ERROR_PREFIX = "Creating failure: ";
  74.     
  75.     /** Tipo di costruttore */
  76.     private JDBCServiceManagerTipoCostruttore tipoCostruttore = null;
  77.     
  78.     protected JDBCServiceManagerBase(){}
  79.     
  80.     public JDBCServiceManagerBase(String jndiName, Properties contextJNDI,ServiceManagerProperties serviceManagerProperties) throws ServiceException{
  81.         this(jndiName, contextJNDI, new JDBCServiceManagerProperties(serviceManagerProperties), null);
  82.     }
  83.     public JDBCServiceManagerBase(String jndiName, Properties contextJNDI,JDBCServiceManagerProperties jdbcProperties) throws ServiceException{
  84.         this(jndiName, contextJNDI, jdbcProperties, null);
  85.     }
  86.     public JDBCServiceManagerBase(String jndiName, Properties contextJNDI,ServiceManagerProperties serviceManagerProperties,Logger alog) throws ServiceException{
  87.         this(jndiName, contextJNDI, new JDBCServiceManagerProperties(serviceManagerProperties), alog);
  88.     }
  89.     public JDBCServiceManagerBase(String jndiName, Properties contextJNDI,JDBCServiceManagerProperties jdbcProperties,Logger alog) throws ServiceException{
  90.         
  91.         this.tipoCostruttore = JDBCServiceManagerTipoCostruttore.DATASOURCE_CFG;
  92.         
  93.         if(alog==null){
  94.             this.log = LoggerWrapperFactory.getLogger(JDBCServiceManagerBase.class);
  95.         }else
  96.             this.log = alog;
  97.         
  98.         try{
  99.             
  100.             GestoreJNDI gestoreJNDI = new GestoreJNDI(contextJNDI);
  101.             this.datasource = (DataSource) gestoreJNDI.lookup(jndiName);
  102.             if(this.datasource == null){
  103.                 throw new ServiceException("Datasource is null");
  104.             }
  105.             
  106.             this.jdbcProperties = jdbcProperties;
  107.             jdbcProperties.getDatabase(); // check tipoDatabase fornito
  108.                         
  109.         } catch(Exception e) {
  110.             this.logError(CREATE_ERROR_PREFIX+e.getMessage(),e);
  111.             throw new ServiceException(CREATE_ERROR_PREFIX+e.getMessage(),e);
  112.         }
  113.     }
  114.     
  115.     public JDBCServiceManagerBase(DataSource ds,ServiceManagerProperties serviceManagerProperties) throws ServiceException{
  116.         this(ds, new JDBCServiceManagerProperties(serviceManagerProperties), null);
  117.     }
  118.     public JDBCServiceManagerBase(DataSource ds,JDBCServiceManagerProperties jdbcProperties) throws ServiceException{
  119.         this(ds, jdbcProperties, null);
  120.     }
  121.     public JDBCServiceManagerBase(DataSource ds,ServiceManagerProperties serviceManagerProperties,Logger alog) throws ServiceException{
  122.         this(ds, new JDBCServiceManagerProperties(serviceManagerProperties), alog);
  123.     }
  124.     public JDBCServiceManagerBase(DataSource ds,JDBCServiceManagerProperties jdbcProperties,Logger alog) throws ServiceException{
  125.         
  126.         this.tipoCostruttore = JDBCServiceManagerTipoCostruttore.DATASOURCE_OBJECT;
  127.         
  128.         if(alog==null){
  129.             this.log = LoggerWrapperFactory.getLogger(JDBCServiceManagerBase.class);
  130.         }else
  131.             this.log = alog;
  132.         
  133.         try{
  134.             
  135.             this.datasource = ds;
  136.             if(this.datasource == null){
  137.                 throw new ServiceException("Datasource is null");
  138.             }
  139.             
  140.             this.jdbcProperties = jdbcProperties;
  141.             jdbcProperties.getDatabase(); // check tipoDatabase fornito
  142.             
  143.         } catch(Exception e) {
  144.             this.logError(CREATE_ERROR_PREFIX+e.getMessage(),e);
  145.             throw new ServiceException(CREATE_ERROR_PREFIX+e.getMessage(),e);
  146.         }
  147.     }
  148.     
  149.     public JDBCServiceManagerBase(String connectionUrl,String driverJDBC,String username,String password,ServiceManagerProperties serviceManagerProperties) throws ServiceException{
  150.         this(connectionUrl,driverJDBC,username,password,new JDBCServiceManagerProperties(serviceManagerProperties),null);
  151.     }
  152.     public JDBCServiceManagerBase(String connectionUrl,String driverJDBC,String username,String password,JDBCServiceManagerProperties jdbcProperties) throws ServiceException{
  153.         this(connectionUrl,driverJDBC,username,password,jdbcProperties,null);
  154.     }
  155.     public JDBCServiceManagerBase(String connectionUrl,String driverJDBC,String username,String password,ServiceManagerProperties serviceManagerProperties,Logger alog) throws ServiceException{
  156.         this(connectionUrl,driverJDBC,username,password,new JDBCServiceManagerProperties(serviceManagerProperties),alog);
  157.     }
  158.     public JDBCServiceManagerBase(String connectionUrl,String driverJDBC,String username,String password,JDBCServiceManagerProperties jdbcProperties,Logger alog) throws ServiceException{
  159.         
  160.         this.tipoCostruttore = JDBCServiceManagerTipoCostruttore.CONNECTION_CFG;
  161.         
  162.         if(alog==null){
  163.             this.log = LoggerWrapperFactory.getLogger(JDBCServiceManagerBase.class);
  164.         }else
  165.             this.log = alog;
  166.         
  167.         try{
  168.             
  169.             this.connectionUrl = connectionUrl;
  170.             this.username = username;
  171.             this.password = password;
  172.             this.secondsToRefreshConnection = jdbcProperties.getSecondsToRefreshConnection();
  173.             
  174.             ClassLoaderUtilities.newInstance(driverJDBC);
  175.             
  176.             setConnection();
  177.             
  178.             this.jdbcProperties = jdbcProperties;
  179.             jdbcProperties.getDatabase(); // check tipoDatabase fornito
  180.             
  181.         } catch(Exception e) {
  182.             this.logError(CREATE_ERROR_PREFIX+e.getMessage(),e);
  183.             throw new ServiceException(CREATE_ERROR_PREFIX+e.getMessage(),e);
  184.         }
  185.     }
  186.     private void setConnection() throws SQLException {
  187.         if(this.username!=null){
  188.             this.connection = DriverManager.getConnection(this.connectionUrl,this.username,this.password);
  189.         }else{
  190.             this.connection = DriverManager.getConnection(this.connectionUrl);
  191.         }
  192.         /**if(this.connection == null){
  193.             throw new Exception("Connection is null");
  194.         }*/
  195.         this.connectionDate = DateManager.getDate();
  196.     }
  197.     private boolean isConnectionExpired() {
  198.         if(this.secondsToRefreshConnection>0) {
  199.             Date now = DateManager.getDate();
  200.             Date expireDate = new Date(this.connectionDate.getTime()+(this.secondsToRefreshConnection*1000));
  201.             if(expireDate.before(now)) {
  202.                 return true;
  203.             }
  204.         }
  205.         return false;
  206.     }
  207.     private void refreshConnection() throws SQLException {
  208.         if(this.isConnectionExpired()) {
  209.             this.internalRefreshConnection();
  210.         }
  211.     }
  212.     private synchronized void internalRefreshConnection() throws SQLException {
  213.         if(this.isConnectionExpired()) {
  214.             /**System.out.println("REFRESH (user:"+this.username+" connection-url: "+this.connectionUrl+")");*/
  215.             try {
  216.                 if(this.connection!=null) {
  217.                     JDBCUtilities.closeConnection(checkLogger, this.connection, checkAutocommit, checkIsClosed);
  218.                 }
  219.             }catch(Exception t) {
  220.                 // ignore
  221.             }
  222.             setConnection();
  223.         }
  224.     }
  225.     
  226.     public JDBCServiceManagerBase(Connection connection,ServiceManagerProperties serviceManagerProperties) throws ServiceException{
  227.         this(connection, new JDBCServiceManagerProperties(serviceManagerProperties), null);
  228.     }
  229.     public JDBCServiceManagerBase(Connection connection,JDBCServiceManagerProperties jdbcProperties) throws ServiceException{
  230.         this(connection, jdbcProperties, null);
  231.     }
  232.     public JDBCServiceManagerBase(Connection connection,ServiceManagerProperties serviceManagerProperties,Logger alog) throws ServiceException{
  233.         this(connection, new JDBCServiceManagerProperties(serviceManagerProperties), alog);
  234.     }
  235.     public JDBCServiceManagerBase(Connection connection,JDBCServiceManagerProperties jdbcProperties,Logger alog) throws ServiceException{
  236.         
  237.         this.tipoCostruttore = JDBCServiceManagerTipoCostruttore.CONNECTION_OBJECT;
  238.         
  239.         if(alog==null){
  240.             this.log = LoggerWrapperFactory.getLogger(JDBCServiceManagerBase.class);
  241.         }else
  242.             this.log = alog;
  243.         
  244.         try{
  245.             
  246.             this.connection = connection;
  247.             if(this.connection == null){
  248.                 throw new ServiceException("Connection is null");
  249.             }
  250.             
  251.             this.jdbcProperties = jdbcProperties;
  252.             jdbcProperties.getDatabase(); // check tipoDatabase fornito
  253.             
  254.         } catch(Exception e) {
  255.             this.logError(CREATE_ERROR_PREFIX+e.getMessage(),e);
  256.             throw new ServiceException(CREATE_ERROR_PREFIX+e.getMessage(),e);
  257.         }
  258.     }
  259.     
  260.     
  261.     /* ** Destrory Service Manager */
  262.     
  263.     public void close() throws ServiceException{
  264.         try{
  265.             if(this.tipoCostruttore!=null && JDBCServiceManagerTipoCostruttore.CONNECTION_CFG.equals(this.tipoCostruttore) &&
  266.                     this.connection!=null){
  267.                 /**System.out.println("CLOSE (user:"+this.username+" connection-url: "+this.connectionUrl+")");*/
  268.                 JDBCUtilities.closeConnection(checkLogger, this.connection, checkAutocommit, checkIsClosed);
  269.             }
  270.         }catch(Exception e){
  271.             throw new ServiceException("Close failure: "+e.getMessage(),e);
  272.         }
  273.     }
  274.     
  275.     
  276.     /* ** Utilities */
  277.         
  278.     // Metodi che non devono essere utilizzati dagli sviluppatori jdbc che implementano i metodi veri e propri
  279.     
  280.     private static Logger checkLogger = null;
  281.     private static boolean checkIsClosed = true;
  282.     private static boolean checkAutocommit = true;
  283.     public static boolean isCheckIsClosed() {
  284.         return checkIsClosed;
  285.     }
  286.     public static void setCheckIsClosed(boolean checkIsClosed) {
  287.         JDBCServiceManagerBase.checkIsClosed = checkIsClosed;
  288.     }
  289.     public static boolean isCheckAutocommit() {
  290.         return checkAutocommit;
  291.     }
  292.     public static void setCheckAutocommit(boolean checkAutocommit) {
  293.         JDBCServiceManagerBase.checkAutocommit = checkAutocommit;
  294.     }
  295.     public static Logger getCheckLogger() {
  296.         return checkLogger;
  297.     }
  298.     public static void setCheckLogger(Logger checkLogger) {
  299.         JDBCServiceManagerBase.checkLogger = checkLogger;
  300.     }
  301.     
  302.     protected Connection getConnection() throws ServiceException {
  303.         try{
  304.             if(this.datasource!=null){
  305.                 return this.datasource.getConnection();
  306.             }
  307.             else if(this.connection!=null){
  308.                 if(JDBCServiceManagerTipoCostruttore.CONNECTION_CFG.equals(this.tipoCostruttore)) {
  309.                     this.refreshConnection();
  310.                 }
  311.                 return this.connection;
  312.             }else{
  313.                 throw new ServiceException("ServiceManager not initialized");
  314.             }
  315.         }catch(Exception e){
  316.             throw new ServiceException("Get Connection failure: "+e.getMessage(),e);
  317.         }
  318.     }
  319.     protected void closeConnection(Connection connection) throws ServiceException {
  320.         try{
  321.             if(connection==null){
  322.                 throw new ServiceException("Connection is null");
  323.             }
  324.             if(this.datasource!=null){
  325.                 // DATASOURCE_*
  326.                 JDBCUtilities.closeConnection(checkLogger, connection, checkAutocommit, checkIsClosed);
  327.             }
  328.             else if(this.connection!=null){
  329.                 // CONNECTION_*
  330.                 // se la connessione e' stata fornita come parametro del costruttore del service manager (quindi salvata in this.connection instance variable)
  331.                 // non deve essere mai chiusa. La gestione e' a carico di chi ha inizializzato il service manager fornendo la connessione:
  332.                 // - se ha usato il costruttore fornendo l'oggetto connection, deve fare lui la close sulla clonnection
  333.                 // - se ha usato il costruttore fornendo i dati per creare una connessione (url,username,password) deve chiamare il metodo close del service manager.
  334.                 if(connection.isClosed()){
  335.                     throw new ServiceException("The connection provided shall not be closed");
  336.                 }
  337.             }else{
  338.                 throw new ServiceException("ServiceManager not initialized");
  339.             }
  340.         }catch(Exception e){
  341.             throw new ServiceException("Get Connection failure: "+e.getMessage(),e);
  342.         }
  343.     }
  344.     public Logger getLog() {
  345.         return this.log;
  346.     }
  347.     public JDBCServiceManagerProperties getJdbcProperties() {
  348.         return this.jdbcProperties;
  349.     }
  350.     
  351.     /* Logger */
  352.     public static void configureDefaultLog4jProperties(IProjectInfo project) throws ServiceException{
  353.         JDBCLoggerProperties loggerProperties = new JDBCLoggerProperties(project);
  354.         loggerProperties.configureLog4j();
  355.     }
  356.     public static void configureLog4jProperties(File log4jProperties) throws ServiceException{
  357.         JDBCLoggerProperties loggerProperties = new JDBCLoggerProperties(null,log4jProperties);
  358.         loggerProperties.configureLog4j();
  359.     }
  360. }
Created with JaCoCo 0.8.8.202204050719