refactor: implement ConnectConfig class to simplify method parameters

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java

@@ -63,12 +63,12 @@
 import software.amazon.jdbc.PluginService;
 import software.amazon.jdbc.PropertyDefinition;
 import software.amazon.jdbc.benchmarks.testplugin.BenchmarkPluginFactory;
-import software.amazon.jdbc.dialect.Dialect;
 import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy;
 import software.amazon.jdbc.profile.ConfigurationProfile;
 import software.amazon.jdbc.profile.ConfigurationProfileBuilder;
 import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
 import software.amazon.jdbc.util.FullServicesContainer;
+import software.amazon.jdbc.util.connection.ConnectConfig;
 import software.amazon.jdbc.util.telemetry.DefaultTelemetryFactory;
 import software.amazon.jdbc.util.telemetry.GaugeCallable;
 import software.amazon.jdbc.util.telemetry.TelemetryContext;
@@ -88,16 +88,19 @@ public class ConnectionPluginManagerBenchmarks {
   private static final String WRITER_SESSION_ID = "MASTER_SESSION_ID";
   private static final String FIELD_SERVER_ID = "SERVER_ID";
   private static final String FIELD_SESSION_ID = "SESSION_ID";
-  private Properties propertiesWithoutPlugins;
-  private Properties propertiesWithPlugins;
+  private static final String url = "protocol//url";
+  private ConnectConfig pluginsContext;
+  private ConnectConfig noPluginsContext;
   private ConnectionPluginManager pluginManager;
   private ConnectionPluginManager pluginManagerWithNoPlugins;
 
   @Mock ConnectionProvider mockConnectionProvider;
   @Mock ConnectionWrapper mockConnectionWrapper;
+  @Mock ConnectConfig mockConnectConfig;
   @Mock FullServicesContainer mockServicesContainer;
   @Mock PluginService mockPluginService;
   @Mock PluginManagerService mockPluginManagerService;
+  @Mock TargetDriverDialect mockDriverDialect;
   @Mock TelemetryFactory mockTelemetryFactory;
   @Mock HostListProviderService mockHostListProvider;
   @Mock Connection mockConnection;
@@ -123,12 +126,7 @@ public static void main(String[] args) throws RunnerException {
   public void setUpIteration() throws Exception {
     closeable = openMocks(this);
 
-    when(mockConnectionProvider.connect(
-        anyString(),
-        any(Dialect.class),
-        any(TargetDriverDialect.class),
-        any(HostSpec.class),
-        any(Properties.class))).thenReturn(mockConnection);
+    when(mockConnectionProvider.connect(any(), any(HostSpec.class))).thenReturn(mockConnection);
     when(mockTelemetryFactory.openTelemetryContext(anyString(), any())).thenReturn(mockTelemetryContext);
     when(mockTelemetryFactory.openTelemetryContext(eq(null), any())).thenReturn(mockTelemetryContext);
     when(mockTelemetryFactory.createCounter(anyString())).thenReturn(mockTelemetryCounter);
@@ -153,24 +151,26 @@ public void setUpIteration() throws Exception {
         .withPluginFactories(pluginFactories)
         .build();
 
-    propertiesWithoutPlugins = new Properties();
-    propertiesWithoutPlugins.setProperty(PropertyDefinition.PLUGINS.name, "");
+    Properties noPluginsProps = new Properties();
+    noPluginsProps.setProperty(PropertyDefinition.PLUGINS.name, "");
+    this.noPluginsContext = new ConnectConfig(url, mockDriverDialect, noPluginsProps);
 
-    propertiesWithPlugins = new Properties();
-    propertiesWithPlugins.setProperty(PropertyDefinition.PROFILE_NAME.name, "benchmark");
-    propertiesWithPlugins.setProperty(PropertyDefinition.ENABLE_TELEMETRY.name, "false");
+    Properties pluginsProps = new Properties();
+    pluginsProps.setProperty(PropertyDefinition.PROFILE_NAME.name, "benchmark");
+    pluginsProps.setProperty(PropertyDefinition.ENABLE_TELEMETRY.name, "false");
+    this.pluginsContext = new ConnectConfig(url, mockDriverDialect, pluginsProps);
 
-    TelemetryFactory telemetryFactory = new DefaultTelemetryFactory(propertiesWithPlugins);
+    TelemetryFactory telemetryFactory = new DefaultTelemetryFactory(pluginsProps);
 
     pluginManager = new ConnectionPluginManager(mockConnectionProvider,
         null,
         mockConnectionWrapper,
         telemetryFactory);
-    pluginManager.init(mockServicesContainer, propertiesWithPlugins, mockPluginManagerService, configurationProfile);
+    pluginManager.init(mockServicesContainer, pluginsProps, mockPluginManagerService, configurationProfile);
 
     pluginManagerWithNoPlugins = new ConnectionPluginManager(mockConnectionProvider, null,
         mockConnectionWrapper, telemetryFactory);
-    pluginManagerWithNoPlugins.init(mockServicesContainer, propertiesWithoutPlugins, mockPluginManagerService, null);
+    pluginManagerWithNoPlugins.init(mockServicesContainer, noPluginsProps, mockPluginManagerService, null);
   }
 
   @TearDown(Level.Iteration)
@@ -182,34 +182,32 @@ public void tearDownIteration() throws Exception {
   public ConnectionPluginManager initConnectionPluginManagerWithNoPlugins() throws SQLException {
     final ConnectionPluginManager manager = new ConnectionPluginManager(mockConnectionProvider, null,
         mockConnectionWrapper, mockTelemetryFactory);
-    manager.init(mockServicesContainer, propertiesWithoutPlugins, mockPluginManagerService, configurationProfile);
+    manager.init(mockServicesContainer, this.noPluginsContext.getProps(), mockPluginManagerService, configurationProfile);
     return manager;
   }
 
   @Benchmark
   public ConnectionPluginManager initConnectionPluginManagerWithPlugins() throws SQLException {
     final ConnectionPluginManager manager = new ConnectionPluginManager(mockConnectionProvider, null,
         mockConnectionWrapper, mockTelemetryFactory);
-    manager.init(mockServicesContainer, propertiesWithPlugins, mockPluginManagerService, configurationProfile);
+    manager.init(mockServicesContainer, this.pluginsContext.getProps(), mockPluginManagerService, configurationProfile);
     return manager;
   }
 
   @Benchmark
   public Connection connectWithPlugins() throws SQLException {
     return pluginManager.connect(
-        "driverProtocol",
+        mockConnectConfig,
         new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host").build(),
-        propertiesWithPlugins,
         true,
         null);
   }
 
   @Benchmark
   public Connection connectWithNoPlugins() throws SQLException {
     return pluginManagerWithNoPlugins.connect(
-        "driverProtocol",
+        mockConnectConfig,
         new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host").build(),
-        propertiesWithoutPlugins,
         true,
         null);
   }
@@ -240,21 +238,13 @@ public Integer executeWithNoPlugins() {
 
   @Benchmark
   public ConnectionPluginManager initHostProvidersWithPlugins() throws SQLException {
-    pluginManager.initHostProvider(
-        "protocol",
-        "url",
-        propertiesWithPlugins,
-        mockHostListProvider);
+    pluginManager.initHostProvider(this.pluginsContext, mockHostListProvider);
     return pluginManager;
   }
 
   @Benchmark
   public ConnectionPluginManager initHostProvidersWithNoPlugins() throws SQLException {
-    pluginManagerWithNoPlugins.initHostProvider(
-        "protocol",
-        "url",
-        propertiesWithoutPlugins,
-        mockHostListProvider);
+    pluginManagerWithNoPlugins.initHostProvider(this.noPluginsContext, mockHostListProvider);
     return pluginManager;
   }
 

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java

@@ -63,7 +63,7 @@
 import software.amazon.jdbc.dialect.Dialect;
 import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy;
 import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
-import software.amazon.jdbc.util.connection.ConnectionService;
+import software.amazon.jdbc.util.connection.ConnectConfig;
 import software.amazon.jdbc.util.monitoring.MonitorService;
 import software.amazon.jdbc.util.storage.StorageService;
 import software.amazon.jdbc.util.telemetry.GaugeCallable;
@@ -94,7 +94,6 @@ public class PluginBenchmarks {
 
   @Mock private StorageService mockStorageService;
   @Mock private MonitorService mockMonitorService;
-  @Mock private ConnectionService mockConnectionService;
   @Mock private PluginService mockPluginService;
   @Mock private TargetDriverDialect mockTargetDriverDialect;
   @Mock private Dialect mockDialect;
@@ -124,7 +123,7 @@ public static void main(String[] args) throws RunnerException {
   @Setup(Level.Iteration)
   public void setUpIteration() throws Exception {
     closeable = MockitoAnnotations.openMocks(this);
-    when(mockConnectionPluginManager.connect(any(), any(), any(Properties.class), anyBoolean(), any()))
+    when(mockConnectionPluginManager.connect(any(), any(), anyBoolean(), any()))
         .thenReturn(mockConnection);
     when(mockConnectionPluginManager.execute(
         any(), any(), any(), eq(JdbcMethod.CONNECTION_CREATESTATEMENT), any(), any()))
@@ -135,12 +134,7 @@ public void setUpIteration() throws Exception {
     when(mockTelemetryFactory.createCounter(anyString())).thenReturn(mockTelemetryCounter);
     // noinspection unchecked
     when(mockTelemetryFactory.createGauge(anyString(), any(GaugeCallable.class))).thenReturn(mockTelemetryGauge);
-    when(mockConnectionProvider.connect(
-        anyString(),
-        any(Dialect.class),
-        any(TargetDriverDialect.class),
-        any(HostSpec.class),
-        any(Properties.class))).thenReturn(mockConnection);
+    when(mockConnectionProvider.connect(any(ConnectConfig.class), any(HostSpec.class))).thenReturn(mockConnection);
     when(mockConnection.createStatement()).thenReturn(mockStatement);
     when(mockStatement.executeQuery(anyString())).thenReturn(mockResultSet);
     when(mockResultSet.next()).thenReturn(true, true, false);
@@ -183,8 +177,7 @@ private ConnectionWrapper getConnectionWrapper(Properties props, String connStri
         mockHostListProviderService,
         mockPluginManagerService,
         mockStorageService,
-        mockMonitorService,
-        mockConnectionService);
+        mockMonitorService);
   }
 
   @Benchmark

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java

@@ -24,7 +24,6 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Properties;
 import java.util.Set;
 import java.util.logging.Logger;
 import software.amazon.jdbc.ConnectionPlugin;
@@ -37,6 +36,7 @@
 import software.amazon.jdbc.OldConnectionSuggestedAction;
 import software.amazon.jdbc.cleanup.CanReleaseResources;
 import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy;
+import software.amazon.jdbc.util.connection.ConnectConfig;
 
 public class BenchmarkPlugin implements ConnectionPlugin, CanReleaseResources {
   final List<String> resources = new ArrayList<>();
@@ -58,18 +58,21 @@ public <T, E extends Exception> T execute(Class<T> resultClass, Class<E> excepti
   }
 
   @Override
-  public Connection connect(String driverProtocol, HostSpec hostSpec, Properties props,
-      boolean isInitialConnection, JdbcCallable<Connection, SQLException> connectFunc)
-      throws SQLException {
+  public Connection connect(
+      final ConnectConfig connectConfig,
+      final HostSpec hostSpec,
+      final boolean isInitialConnection,
+      final JdbcCallable<Connection, SQLException> connectFunc) throws SQLException {
     LOGGER.finer(() -> String.format("connect=''%s''", hostSpec.getHost()));
     resources.add("connect");
     return connectFunc.call();
   }
 
   @Override
-  public Connection forceConnect(String driverProtocol, HostSpec hostSpec, Properties props,
-      boolean isInitialConnection, JdbcCallable<Connection, SQLException> forceConnectFunc)
-      throws SQLException {
+  public Connection forceConnect(
+      ConnectConfig connectConfig,
+      HostSpec hostSpec,
+      boolean isInitialConnection, JdbcCallable<Connection, SQLException> forceConnectFunc) throws SQLException {
     LOGGER.finer(() -> String.format("forceConnect=''%s''", hostSpec.getHost()));
     resources.add("forceConnect");
     return forceConnectFunc.call();
@@ -93,10 +96,11 @@ public HostSpec getHostSpecByStrategy(List<HostSpec> hosts, HostRole role, Strin
   }
 
   @Override
-  public void initHostProvider(String driverProtocol, String initialUrl, Properties props,
+  public void initHostProvider(
+      ConnectConfig connectConfig,
       HostListProviderService hostListProviderService,
       JdbcCallable<Void, SQLException> initHostProviderFunc) {
-    LOGGER.finer(() -> String.format("initHostProvider=''%s''", initialUrl));
+    LOGGER.finer(() -> String.format("initHostProvider=''%s''", connectConfig.getInitialConnectionString()));
     resources.add("initHostProvider");
   }
 

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java

@@ -25,7 +25,6 @@
 import software.amazon.jdbc.PluginManagerService;
 import software.amazon.jdbc.PluginService;
 import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
-import software.amazon.jdbc.util.connection.ConnectionService;
 import software.amazon.jdbc.util.monitoring.MonitorService;
 import software.amazon.jdbc.util.storage.StorageService;
 import software.amazon.jdbc.util.telemetry.TelemetryFactory;
@@ -45,8 +44,7 @@ public TestConnectionWrapper(
       @NonNull final HostListProviderService hostListProviderService,
       @NonNull final PluginManagerService pluginManagerService,
       @NonNull final StorageService storageService,
-      @NonNull final MonitorService monitorService,
-      @NonNull final ConnectionService connectionService)
+      @NonNull final MonitorService monitorService)
       throws SQLException {
     super(
         props,
@@ -58,6 +56,7 @@ public TestConnectionWrapper(
         pluginService,
         hostListProviderService,
         pluginManagerService,
-        storageService, monitorService, connectionService);
+        storageService,
+        monitorService);
   }
 }

docs/development-guide/LoadablePlugins.md

@@ -116,9 +116,12 @@ public class BadPlugin extends AbstractConnectionPlugin {
         return new HashSet<>(Collections.singletonList("*"));
     }
 
-    @Override
-    public Connection connect(String driverProtocol, HostSpec hostSpec, Properties props, boolean isInitialConnection,
-            JdbcCallable<Connection, SQLException> connectFunc) throws SQLException {
+  @Override
+  public Connection connect(
+      final ConnectConfig connectConfig,
+      final HostSpec hostSpec,
+      final boolean isInitialConnection,
+      final JdbcCallable<Connection, SQLException> connectFunc) throws SQLException {
         // Bad Practice #2: using driver-specific objects.
         // Not all drivers support the same configuration parameters. For instance, while MySQL Connector/J Supports "database",
         // PGJDBC uses "dbname" for database names.
@@ -167,9 +170,12 @@ public class GoodExample extends AbstractConnectionPlugin {
       return jdbcMethodFunc.call();
     }
 
-    @Override
-    public Connection connect(String driverProtocol, HostSpec hostSpec, Properties props, boolean isInitialConnection,
-            JdbcCallable<Connection, SQLException> connectFunc) throws SQLException {
+  @Override
+  public Connection connect(
+      final ConnectConfig connectConfig,
+      final HostSpec hostSpec,
+      final boolean isInitialConnection,
+      final JdbcCallable<Connection, SQLException> connectFunc) throws SQLException {
         if (PropertyDefinition.USER.getString(props) == null) {
             PropertyDefinition.TARGET_DRIVER_USER_PROPERTY_NAME.set(props, "defaultUser");
         }

examples/AWSDriverExample/src/main/java/software/amazon/ReadWriteSplittingPostgresExample.java

@@ -23,8 +23,6 @@
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.Properties;
-import software.amazon.jdbc.ConnectionProviderManager;
-import software.amazon.jdbc.HikariPooledConnectionProvider;
 import software.amazon.jdbc.HostSpec;
 import software.amazon.jdbc.PropertyDefinition;
 import software.amazon.jdbc.plugin.failover.FailoverFailedSQLException;

examples/AWSDriverExample/src/main/java/software/amazon/ReadWriteSplittingSpringJdbcTemplateMySQLExample.java

@@ -16,7 +16,6 @@
 
 package software.amazon;
 
-import com.mysql.cj.jdbc.MysqlDataSource;
 import com.zaxxer.hikari.HikariDataSource;
 import java.sql.Connection;
 import java.sql.SQLException;

examples/HikariExample/src/main/java/software/amazon/HikariExample.java

@@ -22,7 +22,6 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
-import java.util.Properties;
 
 public class HikariExample {
 

examples/SpringHibernateBalancedReaderTwoDataSourceExample/src/main/java/example/spring/Config.java

@@ -16,10 +16,7 @@
 
 package example.spring;
 
-import com.zaxxer.hikari.HikariConfig;
-import java.util.Arrays;
 import java.util.Properties;
-import java.util.concurrent.TimeUnit;
 import javax.persistence.EntityManagerFactory;
 import javax.sql.DataSource;
 import org.hibernate.exception.JDBCConnectionException;
@@ -40,10 +37,6 @@
 import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.transaction.annotation.EnableTransactionManagement;
-import software.amazon.jdbc.HikariPooledConnectionProvider;
-import software.amazon.jdbc.HostSpec;
-import software.amazon.jdbc.profile.ConfigurationProfileBuilder;
-import software.amazon.jdbc.profile.ConfigurationProfilePresetCodes;
 
 @Configuration
 @EnableTransactionManagement