1244 db pool configuration using environment variables

components/xnwh/pools/DefaultConnectionPoolTypes/build.xml

@@ -23,7 +23,7 @@
 	<property name="project.name.local2" value="DefaultConnectionPoolTypes" />
 
 	<!--Next release version for the archive file-->
-	<property name="release.number" value="1.0.0"/>
+	<property name="release.number" value="1.0.1"/>
 
 	<property name="target.dir" value="${basedir}/deploy" />
 

components/xnwh/pools/DefaultConnectionPoolTypes/pom.xml

@@ -27,7 +27,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.gip.xyna</groupId>
     <artifactId>DefaultConnectionPoolTypes</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
     <packaging>jar</packaging>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

components/xnwh/pools/DefaultConnectionPoolTypes/src/com/gip/xyna/xnwh/pools/MySQLPoolType.java

@@ -1,6 +1,6 @@
 /*
  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- * Copyright 2022 Xyna GmbH, Germany
+ * Copyright 2024 Xyna GmbH, Germany
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.util.List;
+import java.util.Optional;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.RejectedExecutionException;
 import java.util.concurrent.SynchronousQueue;
@@ -38,11 +39,13 @@
 import com.gip.xyna.utils.db.ConnectionPool.NoConnectionAvailableException.Reason;
 import com.gip.xyna.utils.db.ConnectionPool.NoConnectionAvailableReasonDetector;
 import com.gip.xyna.utils.db.DBConnectionData;
+import com.gip.xyna.utils.db.DBConnectionData.DBConnectionDataBuilder;
 import com.gip.xyna.utils.db.pool.ConnectionBuildStrategy;
 import com.gip.xyna.utils.db.pool.DefaultValidationStrategy;
 import com.gip.xyna.utils.db.pool.ValidationStrategy;
 import com.gip.xyna.utils.misc.Documentation;
 import com.gip.xyna.utils.misc.StringParameter;
+import com.gip.xyna.utils.misc.EnvironmentVariable.StringEnvironmentVariable;
 import com.gip.xyna.utils.timing.Duration;
 import com.gip.xyna.xmcp.PluginDescription;
 import com.gip.xyna.xmcp.PluginDescription.ParameterUsage;
@@ -87,8 +90,29 @@ public class MySQLPoolType extends ConnectionPoolType {
       defaultValue(Duration.valueOf("10 s")).
       build();
 
-  public static final List<StringParameter<?>> additionalParameters = 
-      StringParameter.asList( CONNECT_TIMEOUT, SOCKET_TIMEOUT, VALIDATION_TIMEOUT );
+  public static final StringParameter<StringEnvironmentVariable> USERNAME_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "usernameEnv")
+      .label("Username environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the db username.")
+          .de("Name der Umgebungsvariable, die den DB Nutzernamen enthält.").build())
+      .optional().build();
+
+  public static final StringParameter<StringEnvironmentVariable> PASSWORD_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "passwordEnv")
+      .label("Password environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the db password.")
+          .de("Name der Umgebungsvariable, die das DB Passwort enthält.").build())
+      .optional().build();
+
+  public static final StringParameter<StringEnvironmentVariable> CONNECT_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "connectStringEnv")
+      .label("Connectstring environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the JDBC connect string.")
+          .de("Name der Umgebungsvariable mit den JDBC Verbindungsdaten.").build())
+      .optional().build();
+
+  public static final List<StringParameter<?>> additionalParameters = StringParameter.asList(CONNECT_TIMEOUT,
+      SOCKET_TIMEOUT, VALIDATION_TIMEOUT, USERNAME_ENV, PASSWORD_ENV, CONNECT_ENV);
 
   private PluginDescription pluginDescription;
 
@@ -168,16 +192,7 @@ public PluginDescription getPluginDescription() {
   public ConnectionBuildStrategy createConnectionBuildStrategy(TypedConnectionPoolParameter cpp) {
     Duration connectTimeout = CONNECT_TIMEOUT.getFromMap(cpp.getAdditionalParams());
     Duration socketTimeout = SOCKET_TIMEOUT.getFromMap(cpp.getAdditionalParams());
-    DBConnectionData dbdata =
-        DBConnectionData.newDBConnectionData().
-            user(cpp.getUser()).password(cpp.getPassword()).url(cpp.getConnectString())
-            .connectTimeoutInSeconds((int)connectTimeout.getDuration(TimeUnit.SECONDS))
-            .socketTimeoutInSeconds((int)socketTimeout.getDuration(TimeUnit.SECONDS))
-            .classLoaderToLoadDriver(MySQLPoolType.class.getClassLoader()) // enforcing the connector jar to be stored in userlib
-            .property("rewriteBatchedStatements", "true")
-            .build();
-
-    return new MySQLConnectionBuildStrategy(dbdata, (int)connectTimeout.getDuration(TimeUnit.SECONDS) );
+    return new MySQLConnectionBuildStrategy(cpp, (int)connectTimeout.getDuration(TimeUnit.SECONDS), (int)socketTimeout.getDuration(TimeUnit.SECONDS) );
   }
 
 
@@ -191,16 +206,55 @@ public ValidationStrategy createValidationStrategy(TypedConnectionPoolParameter
   public static class MySQLConnectionBuildStrategy implements ConnectionBuildStrategy {
 
     private static ThreadPoolExecutor threadpool = new ThreadPoolExecutor(1, 1000, 10, TimeUnit.SECONDS, new SynchronousQueue<Runnable>());
+    private TypedConnectionPoolParameter tcpp;
     private DBConnectionData dbdata;
     private int connectTimeout;
+    private int socketTimeout;
     private String poolId;
 
-    public MySQLConnectionBuildStrategy(DBConnectionData dbdata, int connectTimeout) {
-      this.dbdata = dbdata;
+    private final Optional<StringEnvironmentVariable> userEnv;
+    private final Optional<StringEnvironmentVariable> pwdEnv;
+    private final Optional<StringEnvironmentVariable> connectStringEnv;
+
+    public MySQLConnectionBuildStrategy(TypedConnectionPoolParameter tcpp, int connectTimeout, int socketTimeout) {
+      this.tcpp = tcpp;
+      this.dbdata = null;
       this.connectTimeout = connectTimeout;
+      this.socketTimeout = socketTimeout;
+
+      userEnv = Optional
+          .ofNullable(USERNAME_ENV.getFromMap(tcpp.getAdditionalParams()));
+      pwdEnv = Optional
+          .ofNullable(PASSWORD_ENV.getFromMap(tcpp.getAdditionalParams()));
+      connectStringEnv = Optional
+          .ofNullable(CONNECT_ENV.getFromMap(tcpp.getAdditionalParams()));
+    }
+
+    private void updateDBConnectData() {
+      String user = userEnv.flatMap(u -> u.getValue()).filter(s -> !s.isEmpty()).orElse(tcpp.getUser()).trim();
+      String pwd = pwdEnv.flatMap(p -> p.getValue()).filter(s -> !s.isEmpty()).orElse(tcpp.getPassword()).trim();
+      String connString = connectStringEnv.flatMap(c -> c.getValue()).filter(s -> !s.isEmpty())
+          .orElse(tcpp.getConnectString()).trim();
+
+      if (dbdata == null) {
+        dbdata = DBConnectionData.newDBConnectionData().user(user).password(pwd).url(connString)
+            .connectTimeoutInSeconds(connectTimeout)
+            .socketTimeoutInSeconds(socketTimeout)
+            .classLoaderToLoadDriver(MySQLPoolType.class.getClassLoader()) // enforcing the connector jar to be stored
+                                                                           // in userlib
+            .property("rewriteBatchedStatements", "true")
+            .build();
+      } else {
+        if (dbdata.getUrl().equals(connString) && dbdata.getUser().equals(user) && dbdata.getPassword().equals(pwd))
+          return;
+
+        dbdata = (new DBConnectionDataBuilder(dbdata)).user(user).password(pwd).url(connString).build();
+      }
     }
 
     public Connection createNewConnection() {
+      updateDBConnectData();
+
       Connection con = createNewConnectionInternal();
       if (con == null) {
         throw new RuntimeException("Could not create connection but returned null.");

components/xnwh/pools/DefaultConnectionPoolTypes/src/com/gip/xyna/xnwh/pools/OraclePoolType.java

@@ -21,6 +21,7 @@
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.util.List;
+import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 
 import org.apache.log4j.Logger;
@@ -30,11 +31,13 @@
 import com.gip.xyna.utils.db.ConnectionPool.NoConnectionAvailableException.Reason;
 import com.gip.xyna.utils.db.ConnectionPool.NoConnectionAvailableReasonDetector;
 import com.gip.xyna.utils.db.DBConnectionData;
+import com.gip.xyna.utils.db.DBConnectionData.DBConnectionDataBuilder;
 import com.gip.xyna.utils.db.pool.ConnectionBuildStrategy;
 import com.gip.xyna.utils.db.pool.FastValidationStrategy;
 import com.gip.xyna.utils.db.pool.ValidationStrategy;
 import com.gip.xyna.utils.misc.Documentation;
 import com.gip.xyna.utils.misc.StringParameter;
+import com.gip.xyna.utils.misc.EnvironmentVariable.StringEnvironmentVariable;
 import com.gip.xyna.utils.timing.Duration;
 import com.gip.xyna.xmcp.PluginDescription;
 import com.gip.xyna.xmcp.PluginDescription.ParameterUsage;
@@ -87,9 +90,30 @@ public class OraclePoolType extends ConnectionPoolType {
                     build()).
       defaultValue(false).
       build();
-
-  public static final List<StringParameter<?>> additionalParameters = 
-      StringParameter.asList( CONNECT_TIMEOUT, SOCKET_TIMEOUT, VALIDATION_TIMEOUT, DURABLE_STATEMENT_CACHE );
+
+  public static final StringParameter<StringEnvironmentVariable> USERNAME_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "usernameEnv")
+      .label("Username environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the db username.")
+          .de("Name der Umgebungsvariable, die den DB Nutzernamen enthält.").build())
+      .optional().build();
+
+  public static final StringParameter<StringEnvironmentVariable> PASSWORD_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "passwordEnv")
+      .label("Password environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the db password.")
+          .de("Name der Umgebungsvariable, die das DB Passwort enthält.").build())
+      .optional().build();
+
+  public static final StringParameter<StringEnvironmentVariable> CONNECT_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "connectStringEnv")
+      .label("Connectstring environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the JDBC connect string.")
+          .de("Name der Umgebungsvariable mit den JDBC Verbindungsdaten.").build())
+      .optional().build();
+
+  public static final List<StringParameter<?>> additionalParameters = StringParameter.asList(CONNECT_TIMEOUT,
+      SOCKET_TIMEOUT, VALIDATION_TIMEOUT, DURABLE_STATEMENT_CACHE, USERNAME_ENV, PASSWORD_ENV, CONNECT_ENV);
 
   private PluginDescription pluginDescription;
 
@@ -121,32 +145,65 @@ public ConnectionBuildStrategy createConnectionBuildStrategy(TypedConnectionPool
     Duration connectTimeout = CONNECT_TIMEOUT.getFromMap(cpp.getAdditionalParams());
     Duration socketTimeout = SOCKET_TIMEOUT.getFromMap(cpp.getAdditionalParams());
     Boolean useDurableStatementCache = DURABLE_STATEMENT_CACHE.getFromMap(cpp.getAdditionalParams());
-
-    DBConnectionData dbdata =
-      DBConnectionData.newDBConnectionData().
-          user(cpp.getUser()).password(cpp.getPassword()).url(cpp.getConnectString())
-          .connectTimeoutInSeconds((int)connectTimeout.getDuration(TimeUnit.SECONDS))
-          .socketTimeoutInSeconds((int)socketTimeout.getDuration(TimeUnit.SECONDS))
-          .classLoaderToLoadDriver(OraclePoolType.class.getClassLoader()) // enforcing the connector jar to be stored in userlib
-          .property("rewriteBatchedStatements", "true")
-          .build();
-
-    return new OracleConnectionBuildStrategy(dbdata, useDurableStatementCache);
+
+    return new OracleConnectionBuildStrategy(cpp, useDurableStatementCache,
+        (int) connectTimeout.getDuration(TimeUnit.SECONDS), (int) socketTimeout.getDuration(TimeUnit.SECONDS));
   }
 
 
   public static class OracleConnectionBuildStrategy implements ConnectionBuildStrategy {
 
+    private TypedConnectionPoolParameter tcpp;
     private DBConnectionData dbdata;
+    private int connectTimeout;
+    private int socketTimeout;
     private boolean useDurableStatementCache;
     private String poolId;
 
-    public OracleConnectionBuildStrategy(DBConnectionData dbdata, boolean useDurableStatementCache) {
-      this.dbdata = dbdata;
+    private final Optional<StringEnvironmentVariable> userEnv;
+    private final Optional<StringEnvironmentVariable> pwdEnv;
+    private final Optional<StringEnvironmentVariable> connectStringEnv;
+
+    public OracleConnectionBuildStrategy(TypedConnectionPoolParameter tcpp, boolean useDurableStatementCache, int connectTimeout, int socketTimeout) {
+      this.tcpp = tcpp;
+      this.socketTimeout = socketTimeout;
+      this.connectTimeout = connectTimeout;
+      this.dbdata = null;
       this.useDurableStatementCache = useDurableStatementCache;
+
+      userEnv = Optional
+          .ofNullable(USERNAME_ENV.getFromMap(tcpp.getAdditionalParams()));
+      pwdEnv = Optional
+          .ofNullable(PASSWORD_ENV.getFromMap(tcpp.getAdditionalParams()));
+      connectStringEnv = Optional
+          .ofNullable(CONNECT_ENV.getFromMap(tcpp.getAdditionalParams()));
+    }
+
+    private void updateDBConnectData() {
+      String user = userEnv.flatMap(u -> u.getValue()).filter(s -> !s.isEmpty()).orElse(tcpp.getUser()).trim();
+      String pwd = pwdEnv.flatMap(p -> p.getValue()).filter(s -> !s.isEmpty()).orElse(tcpp.getPassword()).trim();
+      String connString = connectStringEnv.flatMap(c -> c.getValue()).filter(s -> !s.isEmpty())
+          .orElse(tcpp.getConnectString()).trim();
+
+      if (dbdata == null) {
+        dbdata = DBConnectionData.newDBConnectionData().user(user).password(pwd).url(connString)
+            .connectTimeoutInSeconds(connectTimeout)
+            .socketTimeoutInSeconds(socketTimeout)
+            .classLoaderToLoadDriver(OraclePoolType.class.getClassLoader()) // enforcing the connector jar to be stored
+                                                                            // in userlib
+            .property("rewriteBatchedStatements", "true")
+            .build();
+      } else {
+        if (dbdata.getUrl().equals(connString) && dbdata.getUser().equals(user) && dbdata.getPassword().equals(pwd))
+          return;
+
+        dbdata = (new DBConnectionDataBuilder(dbdata)).user(user).password(pwd).url(connString).build();
+      }
     }
 
     public Connection createNewConnection() {
+      updateDBConnectData();
+
       try {
         Connection con = dbdata.createConnection();
         if (useDurableStatementCache) { 

components/xnwh/pools/MockConnectionPoolTypes/build.xml

@@ -23,7 +23,7 @@
     <property name="project.name.local2" value="MockConnectionPoolTypes" />
 
     <!--Next release version for the archive file-->
-    <property name="release.number" value="1.0.0"/>
+    <property name="release.number" value="1.0.1"/>
 
     <property name="target.dir" value="${basedir}/deploy" />
 

components/xnwh/pools/MockConnectionPoolTypes/pom.xml

@@ -27,7 +27,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.gip.xyna</groupId>
     <artifactId>MockConnectionPoolTypes</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
     <packaging>jar</packaging>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

components/xnwh/pools/MockConnectionPoolTypes/src/com/gip/xyna/xnwh/pools/mock/MockMySQLPoolType.java

@@ -28,6 +28,7 @@
 import com.gip.xyna.utils.db.pool.ValidationStrategy;
 import com.gip.xyna.utils.misc.Documentation;
 import com.gip.xyna.utils.misc.StringParameter;
+import com.gip.xyna.utils.misc.EnvironmentVariable.StringEnvironmentVariable;
 import com.gip.xyna.utils.timing.Duration;
 import com.gip.xyna.xmcp.PluginDescription;
 import com.gip.xyna.xmcp.PluginDescription.ParameterUsage;
@@ -70,8 +71,29 @@ public class MockMySQLPoolType extends ConnectionPoolType {
       defaultValue(Duration.valueOf("10 s")).
       build();
 
-  public static final List<StringParameter<?>> additionalParameters = 
-      StringParameter.asList( CONNECT_TIMEOUT, SOCKET_TIMEOUT, VALIDATION_TIMEOUT );
+  public static final StringParameter<StringEnvironmentVariable> USERNAME_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "usernameEnv")
+      .label("Username environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the db username.")
+          .de("Name der Umgebungsvariable, die den DB Nutzernamen enthält.").build())
+      .optional().build();
+
+  public static final StringParameter<StringEnvironmentVariable> PASSWORD_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "passwordEnv")
+      .label("Password environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the db password.")
+          .de("Name der Umgebungsvariable, die das DB Passwort enthält.").build())
+      .optional().build();
+
+  public static final StringParameter<StringEnvironmentVariable> CONNECT_ENV = StringParameter
+      .typeEnvironmentVariable(StringEnvironmentVariable.class, "connectStringEnv")
+      .label("Connectstring environment variable.")
+      .documentation(Documentation.en("Name of the environment variable containing the JDBC connect string.")
+          .de("Name der Umgebungsvariable mit den JDBC Verbindungsdaten.").build())
+      .optional().build();
+
+  public static final List<StringParameter<?>> additionalParameters = StringParameter.asList(CONNECT_TIMEOUT,
+      SOCKET_TIMEOUT, VALIDATION_TIMEOUT, USERNAME_ENV, PASSWORD_ENV, CONNECT_ENV);
 
   private PluginDescription pluginDescription;
 

installation/build.sh

@@ -152,7 +152,7 @@ build_conpooltypes() {
   echo "building connectionpooltypes..."
   cd $SCRIPT_DIR/build
   ant -Doracle.home=/tmp conpooltypes
-  mvn install:install-file -Dfile=../../common/lib/xyna/DefaultConnectionPoolTypes-1.0.0.jar -DpomFile=../../components/xnwh/pools/DefaultConnectionPoolTypes/pom.xml
+  mvn install:install-file -Dfile=../../common/lib/xyna/DefaultConnectionPoolTypes-1.0.1.jar -DpomFile=../../components/xnwh/pools/DefaultConnectionPoolTypes/pom.xml
 }
 
 build_persistencelayers() {

installation/build/pom.xml

@@ -71,7 +71,7 @@
             <dependency>
                 <groupId>com.gip.xyna</groupId>
                 <artifactId>DefaultConnectionPoolTypes</artifactId>
-                <version>1.0.0</version>
+                <version>1.0.1</version>
             </dependency>
             <dependency>
                 <groupId>com.gip.xyna</groupId>