FWDPostgreSQLConnectionCustomizer.java

/*
** Module   : FWDPostgreSQLConnectionCustomizer.java
** Abstract : c3p0 connection customizer
**
** Copyright (c) 2021-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 IAS 20210803 Created initial version.
**     OM  20220721 Added copyright statement, javadoc and updated formatting to GC standard.
** 002 IAS 20230202 Renamed from FWDConnectionCustomizer.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
**
**   0. Attribution Requirement.
**
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
**
**   1. No License To Use Trademarks.
**
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
**
**   2. No Misrepresentation of Affiliation.
**
**     You may not represent yourself as Golden Code Development Corporation or FWD.
**
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
**
**   3. No Misrepresentation of Source or Origin.
**
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.persist.dialect;

import java.sql.*;
import org.slf4j.*;
import com.goldencode.p2j.*;
import com.mchange.v2.c3p0.*;

/**
 * Customizes the connection to database by setting up the {@code use.java.udfs} and {@code fwd.version}
 * SQL configuration variable. 
 */
public class FWDPostgreSQLConnectionCustomizer
extends AbstractConnectionCustomizer
{
   /** Logger */
   private static final Logger LOG = LoggerFactory.getLogger(FWDPostgreSQLConnectionCustomizer.class);
   
   /**
    * Called immediately after a {@code Connection} is acquired from the underlying database for 
    * incorporation into the pool.
    *
    * @param   c
    *          Connection to be customized.
    * @param   parentDataSourceIdentityToken
    *          The parent data source identity token.
    */
   @Override
   public void onAcquire(Connection c, String parentDataSourceIdentityToken)
   throws java.lang.Exception {
      String useJavaUDFs = (String) extensionsForToken(parentDataSourceIdentityToken).
               getOrDefault("useJavaUdfs", "y");
      
      try (ResultSet rs = c.prepareStatement(
               "select set_config('use.java.udfs', '" + useJavaUDFs + "', false)").
               executeQuery())
      {
         while (rs.next())
            /* empty body */;
      }
      catch (SQLException e)
      {
         LOG.warn("Failed to customize connection", e);
      }
      
      try (ResultSet rs = c.prepareStatement(
               "select set_config('fwd.version', '" + Version.getFWDVersion() + "', false)").
               executeQuery())
      {
         while (rs.next())
            /* empty body */;
      }
      catch(SQLException e)
      {
         LOG.warn("Failed to customize connection", e);
      }
   }
}