HHH-18669 - resolve the driver name from the connection metadata, in case it wasn't explicitly set and access to the database metadata is allowed

jrenaat · jrenaat · commit d702496e4dfe · 2024-10-09T16:21:50.000+02:00
Signed-off-by: Jan Schatteman &lt;jschatte@redhat.com&gt;
diff --git a/hibernate-agroal/src/main/java/org/hibernate/agroal/internal/AgroalConnectionProvider.java b/hibernate-agroal/src/main/java/org/hibernate/agroal/internal/AgroalConnectionProvider.java
@@ -9,10 +9,11 @@
 
 import java.sql.Connection;
 import java.sql.SQLException;
+import java.sql.DatabaseMetaData;
+import javax.sql.DataSource;
 import java.util.Map;
 import java.util.function.Consumer;
 import java.util.function.Function;
-import javax.sql.DataSource;
 
 import org.hibernate.HibernateException;
 import org.hibernate.cfg.AgroalSettings;
@@ -36,6 +37,7 @@
 import io.agroal.api.security.SimplePassword;
 
 import static org.hibernate.cfg.AgroalSettings.AGROAL_CONFIG_PREFIX;
+import static org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.allowJdbcMetadataAccess;
 
 /**
  * ConnectionProvider based on Agroal connection pool
@@ -64,6 +66,7 @@ public class AgroalConnectionProvider implements ConnectionProvider, Configurabl
 	public static final String CONFIG_PREFIX = AGROAL_CONFIG_PREFIX + ".";
 	private static final long serialVersionUID = 1L;
 	private AgroalDataSource agroalDataSource = null;
+	private boolean isMetadataAccessAllowed = true;
 
 	// --- Configurable
 
@@ -92,6 +95,8 @@ private static <T> void copyProperty(Map<String, Object> properties, String key,
 
 	@Override
 	public void configure(Map<String, Object> props) throws HibernateException {
+		isMetadataAccessAllowed = allowJdbcMetadataAccess( props );
+
 		ConnectionInfoLogger.INSTANCE.configureConnectionPool( "Agroal" );
 		try {
 			AgroalPropertiesReader agroalProperties = new AgroalPropertiesReader( CONFIG_PREFIX )
@@ -139,9 +144,12 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
 		final AgroalConnectionPoolConfiguration acpc = agroalDataSource.getConfiguration().connectionPoolConfiguration();
 		final AgroalConnectionFactoryConfiguration acfc = acpc.connectionFactoryConfiguration();
 
+
 		return new DatabaseConnectionInfoImpl(
 				acfc.jdbcUrl(),
-				acfc.connectionProviderClass().toString(),
+				// Attempt to resolve the driver name from the dialect, in case it wasn't explicitly set and access to
+				// the database metadata is allowed
+				acfc.connectionProviderClass() != null ? acfc.connectionProviderClass().toString() : extractDriverNameFromMetadata(),
 				dialect.getVersion(),
 				Boolean.toString( acfc.autoCommit() ),
 				acfc.jdbcTransactionIsolation() != null
@@ -152,6 +160,19 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
 		);
 	}
 
+	private String extractDriverNameFromMetadata() {
+		if (isMetadataAccessAllowed) {
+			try ( Connection conn = getConnection() ) {
+				DatabaseMetaData dbmd = conn.getMetaData();
+				return dbmd.getDriverName();
+			}
+			catch (SQLException e) {
+				// Do nothing
+			}
+		}
+		return null;
+	}
+
 	@Override
 	public boolean isUnwrappableAs(Class<?> unwrapType) {
 		return ConnectionProvider.class.equals( unwrapType )
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/JdbcEnvironmentInitiator.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/JdbcEnvironmentInitiator.java
@@ -215,7 +215,7 @@ private static JdbcEnvironmentImpl getJdbcEnvironmentWithExplicitConfiguration(
 	 *
 	 * @see JdbcSettings#ALLOW_METADATA_ON_BOOT
 	 */
-	private static boolean allowJdbcMetadataAccess(Map<String, Object> configurationValues) {
+	public static boolean allowJdbcMetadataAccess(Map<String, Object> configurationValues) {
 		final Boolean allow = getBooleanWrapper( ALLOW_METADATA_ON_BOOT, configurationValues, null );
 		if ( allow != null ) {
 			return allow;
diff --git a/hibernate-hikaricp/src/main/java/org/hibernate/hikaricp/internal/HikariCPConnectionProvider.java b/hibernate-hikaricp/src/main/java/org/hibernate/hikaricp/internal/HikariCPConnectionProvider.java
@@ -8,23 +8,27 @@
 package org.hibernate.hikaricp.internal;
 
 import java.sql.Connection;
+import java.sql.DatabaseMetaData;
 import java.sql.SQLException;
-import java.util.Map;
 import javax.sql.DataSource;
+import java.util.Map;
 
 import org.hibernate.HibernateException;
 import org.hibernate.dialect.Dialect;
 import org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl;
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.internal.log.ConnectionInfoLogger;
+import org.hibernate.internal.util.StringHelper;
 import org.hibernate.service.UnknownUnwrapTypeException;
 import org.hibernate.service.spi.Configurable;
 import org.hibernate.service.spi.Stoppable;
 
 import com.zaxxer.hikari.HikariConfig;
 import com.zaxxer.hikari.HikariDataSource;
 
+import static org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.allowJdbcMetadataAccess;
+
 /**
  * HikariCP Connection provider for Hibernate.
  *
@@ -34,6 +38,7 @@
 public class HikariCPConnectionProvider implements ConnectionProvider, Configurable, Stoppable {
 
 	private static final long serialVersionUID = -9131625057941275711L;
+	private boolean isMetadataAccessAllowed = true;
 
 	/**
 	 * HikariCP configuration.
@@ -52,6 +57,8 @@ public class HikariCPConnectionProvider implements ConnectionProvider, Configura
 	@Override
 	public void configure(Map<String, Object> props) throws HibernateException {
 		try {
+			isMetadataAccessAllowed = allowJdbcMetadataAccess( props );
+
 			ConnectionInfoLogger.INSTANCE.configureConnectionPool( "HikariCP" );
 
 			hcfg = HikariConfigurationUtil.loadConfiguration( props );
@@ -86,7 +93,9 @@ public boolean supportsAggressiveRelease() {
 	public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
 		return new DatabaseConnectionInfoImpl(
 				hcfg.getJdbcUrl(),
-				hcfg.getDriverClassName(),
+				// Attempt to resolve the driver name from the dialect, in case it wasn't explicitly set and access to
+				// the database metadata is allowed
+				!StringHelper.isBlank( hcfg.getDriverClassName() ) ? hcfg.getDriverClassName() : extractDriverNameFromMetadata(),
 				dialect.getVersion(),
 				Boolean.toString( hcfg.isAutoCommit() ),
 				hcfg.getTransactionIsolation(),
@@ -95,6 +104,19 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
 		);
 	}
 
+	private String extractDriverNameFromMetadata() {
+		if (isMetadataAccessAllowed) {
+			try ( Connection conn = getConnection() ) {
+				DatabaseMetaData dbmd = conn.getMetaData();
+				return dbmd.getDriverName();
+			}
+			catch (SQLException e) {
+				// Do nothing
+			}
+		}
+		return null;
+	}
+
 	@Override
 	public boolean isUnwrappableAs(Class<?> unwrapType) {
 		return ConnectionProvider.class.equals( unwrapType )
diff --git a/hibernate-vibur/src/main/java/org/hibernate/vibur/internal/ViburDBCPConnectionProvider.java b/hibernate-vibur/src/main/java/org/hibernate/vibur/internal/ViburDBCPConnectionProvider.java
@@ -8,6 +8,7 @@
 package org.hibernate.vibur.internal;
 
 import java.sql.Connection;
+import java.sql.DatabaseMetaData;
 import java.sql.SQLException;
 import java.util.Map;
 import java.util.Properties;
@@ -17,6 +18,7 @@
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.internal.log.ConnectionInfoLogger;
+import org.hibernate.internal.util.StringHelper;
 import org.hibernate.service.UnknownUnwrapTypeException;
 import org.hibernate.service.spi.Configurable;
 import org.hibernate.service.spi.Stoppable;
@@ -29,6 +31,7 @@
 import static org.hibernate.cfg.AvailableSettings.PASS;
 import static org.hibernate.cfg.AvailableSettings.URL;
 import static org.hibernate.cfg.AvailableSettings.USER;
+import static org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.allowJdbcMetadataAccess;
 
 /**
  * <p>ViburDBCP connection provider for Hibernate integration.
@@ -60,9 +63,12 @@ public class ViburDBCPConnectionProvider implements ConnectionProvider, Configur
 	private static final String VIBUR_PREFIX = VIBUR_CONFIG_PREFIX + ".";
 
 	private ViburDBCPDataSource dataSource = null;
+	private boolean isMetadataAccessAllowed = true;
 
 	@Override
 	public void configure(Map<String, Object> configurationValues) {
+		isMetadataAccessAllowed = allowJdbcMetadataAccess( configurationValues );
+
 		ConnectionInfoLogger.INSTANCE.configureConnectionPool( "Vibur" );
 
 		dataSource = new ViburDBCPDataSource( transform( configurationValues ) );
@@ -97,7 +103,9 @@ public boolean supportsAggressiveRelease() {
 	public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
 		return new DatabaseConnectionInfoImpl(
 				dataSource.getJdbcUrl(),
-				dataSource.getDriverClassName(),
+				// Attempt to resolve the driver name from the dialect, in case it wasn't explicitly set and access to
+				// the database metadata is allowed
+				!StringHelper.isBlank( dataSource.getDriverClassName() ) ? dataSource.getDriverClassName() : extractDriverNameFromMetadata(),
 				dialect.getVersion(),
 				String.valueOf( dataSource.getDefaultAutoCommit() ),
 				dataSource.getDefaultTransactionIsolation(),
@@ -106,6 +114,19 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
 		);
 	}
 
+	private String extractDriverNameFromMetadata() {
+		if (isMetadataAccessAllowed) {
+			try ( Connection conn = getConnection() ) {
+				DatabaseMetaData dbmd = conn.getMetaData();
+				return dbmd.getDriverName();
+			}
+			catch (SQLException e) {
+				// Do nothing
+			}
+		}
+		return null;
+	}
+
 	@Override
 	public boolean isUnwrappableAs(Class<?> unwrapType) {
 		return ConnectionProvider.class.equals( unwrapType )

Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ private static JdbcEnvironmentImpl getJdbcEnvironmentWithExplicitConfiguration(`
`215`	`215`	`*`
`216`	`216`	`* @see JdbcSettings#ALLOW_METADATA_ON_BOOT`
`217`	`217`	`*/`
`218`		`- private static boolean allowJdbcMetadataAccess(Map<String, Object> configurationValues) {`
	`218`	`+ public static boolean allowJdbcMetadataAccess(Map<String, Object> configurationValues) {`
`219`	`219`	`final Boolean allow = getBooleanWrapper( ALLOW_METADATA_ON_BOOT, configurationValues, null );`
`220`	`220`	`if ( allow != null ) {`
`221`	`221`	`return allow;`