HHH-19063 - Deprecate SchemaNameResolver

Author: sebersole

hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java

@@ -3653,7 +3653,12 @@ public String[] getDropSchemaCommand(String schemaName) {
 	 * make use of the Java 1.7 {@link Connection#getSchema()} method.
 	 *
 	 * @return The current schema retrieval SQL
+	 *
+	 * @deprecated Since Hibernate now baselines on Java 17,
+	 * {@link Connection#getSchema()} is always available directly.
+	 * Never used internally.
 	 */
+	@Deprecated
 	public String getCurrentSchemaCommand() {
 		return null;
 	}
@@ -3663,7 +3668,12 @@ public String getCurrentSchemaCommand() {
 	 * {@link Connection}, usually {@link DefaultSchemaNameResolver}.
 	 *
 	 * @return The schema name resolver strategy
+	 *
+	 * @deprecated Since Hibernate now baselines on Java 17,
+	 * {@link Connection#getSchema()} is always available directly.
+	 * Never used internally.
 	 */
+	@Deprecated
 	public SchemaNameResolver getSchemaNameResolver() {
 		return DefaultSchemaNameResolver.INSTANCE;
 	}

hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/DefaultSchemaNameResolver.java

@@ -4,108 +4,30 @@
  */
 package org.hibernate.engine.jdbc.env.internal;
 
-import java.lang.reflect.Method;
-import java.sql.Connection;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.sql.Statement;
-
-import org.hibernate.HibernateException;
 import org.hibernate.dialect.Dialect;
 import org.hibernate.engine.jdbc.env.spi.SchemaNameResolver;
 
-import org.jboss.logging.Logger;
+import java.sql.Connection;
+import java.sql.SQLException;
 
 /**
  * Default implementation of {@link SchemaNameResolver}.
  *
+ * @deprecated Since Hibernate now baselines on Java 17,
+ * {@link Connection#getSchema()} is always available directly.
+ *
  * @author Steve Ebersole
  */
+@Deprecated
 public class DefaultSchemaNameResolver implements SchemaNameResolver {
-	private static final Logger log = Logger.getLogger( DefaultSchemaNameResolver.class );
-
 	public static final DefaultSchemaNameResolver INSTANCE = new DefaultSchemaNameResolver();
 
-	// NOTE: The actual delegate should not be cached in DefaultSchemaNameResolver because,
-	//       in the case of multiple data sources, there may be a data source that
-	//       requires a different delegate. See HHH-12392.
-
 	private DefaultSchemaNameResolver() {
 	}
 
-	private SchemaNameResolver determineAppropriateResolverDelegate(Connection connection) {
-		// unfortunately Connection#getSchema is only available in Java 1.7 and above
-		// and Hibernate still baselines on 1.6.  So for now, use reflection and
-		// leverage the Connection#getSchema method if it is available.
-		try {
-			final Class<? extends Connection> jdbcConnectionClass = connection.getClass();
-			final Method getSchemaMethod = jdbcConnectionClass.getMethod( "getSchema" );
-			if ( getSchemaMethod.getReturnType().equals( String.class ) ) {
-				try {
-					// If the JDBC driver does not implement the Java 7 spec, but the JRE is Java 7
-					// then the getSchemaMethod is not null but the call to getSchema() throws an java.lang.AbstractMethodError
-					connection.getSchema();
-					return new SchemaNameResolverJava17Delegate();
-				}
-				catch (AbstractMethodError e) {
-					log.debugf( "Unable to use Java 1.7 Connection#getSchema" );
-					return SchemaNameResolverFallbackDelegate.INSTANCE;
-				}
-			}
-			else {
-				log.debugf( "Unable to use Java 1.7 Connection#getSchema" );
-				return SchemaNameResolverFallbackDelegate.INSTANCE;
-			}
-		}
-		catch (Exception e) {
-			log.debugf(
-					"Unable to use Java 1.7 Connection#getSchema : An error occurred trying to resolve the connection default schema resolver: %s",
-					e.getMessage() );
-			return SchemaNameResolverFallbackDelegate.INSTANCE;
-		}
-	}
-
 	@Override
 	public String resolveSchemaName(Connection connection, Dialect dialect) throws SQLException {
-		// NOTE: delegate should not be cached in DefaultSchemaNameResolver because,
-		//       in the case of multiple data sources, there may be a data source that
-		//       requires a different delegate. See HHH-12392.
-		final SchemaNameResolver delegate = determineAppropriateResolverDelegate( connection );
-		return delegate.resolveSchemaName( connection, dialect );
-	}
-
-	public static class SchemaNameResolverJava17Delegate implements SchemaNameResolver {
-
-		@Override
-		public String resolveSchemaName(Connection connection, Dialect dialect) throws SQLException {
-			return connection.getSchema();
-		}
+		return connection.getSchema();
 	}
 
-	public static class SchemaNameResolverFallbackDelegate implements SchemaNameResolver {
-		/**
-		 * Singleton access
-		 */
-		public static final SchemaNameResolverFallbackDelegate INSTANCE = new SchemaNameResolverFallbackDelegate();
-
-		@Override
-		public String resolveSchemaName(Connection connection, Dialect dialect) throws SQLException {
-			final String command = dialect.getCurrentSchemaCommand();
-			if ( command == null ) {
-				throw new HibernateException(
-						"Use of DefaultSchemaNameResolver requires Dialect to provide the " +
-								"proper SQL statement/command but provided Dialect [" +
-								dialect.getClass().getName() + "] did not return anything " +
-								"from Dialect#getCurrentSchemaCommand"
-				);
-			}
-
-			try (
-				final Statement statement = connection.createStatement();
-				final ResultSet resultSet = statement.executeQuery( dialect.getCurrentSchemaCommand() )
-			) {
-				return resultSet.next() ? resultSet.getString( 1 ) : null;
-			}
-		}
-	}
 }

hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/JdbcEnvironmentImpl.java

@@ -8,7 +8,6 @@
 import java.sql.SQLException;
 
 import org.hibernate.boot.model.naming.Identifier;
-import org.hibernate.boot.registry.selector.spi.StrategySelector;
 import org.hibernate.cfg.AvailableSettings;
 import org.hibernate.dialect.Dialect;
 import org.hibernate.engine.config.spi.ConfigurationService;
@@ -22,7 +21,6 @@
 import org.hibernate.engine.jdbc.env.spi.LobCreatorBuilder;
 import org.hibernate.engine.jdbc.env.spi.NameQualifierSupport;
 import org.hibernate.engine.jdbc.env.spi.QualifiedObjectNameFormatter;
-import org.hibernate.engine.jdbc.env.spi.SchemaNameResolver;
 import org.hibernate.engine.jdbc.spi.SqlExceptionHelper;
 import org.hibernate.exception.internal.SQLExceptionTypeDelegate;
 import org.hibernate.exception.internal.SQLStateConversionDelegate;
@@ -294,7 +292,7 @@ public JdbcEnvironmentImpl(
 		this.extractedMetaDataSupport =
 				new ExtractedDatabaseMetaDataImpl.Builder( this, true, jdbcConnectionAccess )
 						.apply( databaseMetaData )
-						.setConnectionSchemaName( determineCurrentSchemaName( databaseMetaData, serviceRegistry, dialect ) )
+						.setConnectionSchemaName( determineCurrentSchemaName( databaseMetaData ) )
 						.setSupportsNamedParameters( dialect.supportsNamedParameters( databaseMetaData ) )
 						.build();
 
@@ -330,33 +328,16 @@ private static IdentifierHelper identifierHelper(
 		return identifierHelperBuilder.build();
 	}
 
-	public static final String SCHEMA_NAME_RESOLVER = "hibernate.schema_name_resolver";
-
-	private String determineCurrentSchemaName(
-			DatabaseMetaData databaseMetaData,
-			ServiceRegistry serviceRegistry,
-			Dialect dialect) {
-		final SchemaNameResolver resolver = getSchemaNameResolver( serviceRegistry, dialect );
+	private String determineCurrentSchemaName(DatabaseMetaData databaseMetaData) {
 		try {
-			return resolver.resolveSchemaName( databaseMetaData.getConnection(), dialect );
+			return databaseMetaData.getConnection().getSchema();
 		}
 		catch (Exception e) {
 			log.debug( "Unable to resolve connection default schema", e );
 			return null;
 		}
 	}
 
-	private static SchemaNameResolver getSchemaNameResolver(ServiceRegistry serviceRegistry, Dialect dialect) {
-		final Object setting =
-				serviceRegistry.requireService( ConfigurationService.class )
-						.getSettings().get( SCHEMA_NAME_RESOLVER );
-		return setting == null
-				? dialect.getSchemaNameResolver()
-				: serviceRegistry.requireService( StrategySelector.class )
-						.resolveDefaultableStrategy( SchemaNameResolver.class, setting,
-								dialect.getSchemaNameResolver() );
-	}
-
 	private static SqlExceptionHelper buildSqlExceptionHelper(Dialect dialect, boolean logWarnings) {
 		final SQLExceptionConversionDelegate dialectDelegate = dialect.buildSQLExceptionConversionDelegate();
 		final SQLExceptionConversionDelegate[] delegates = dialectDelegate == null

hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/spi/JdbcEnvironment.java

@@ -35,17 +35,18 @@ public interface JdbcEnvironment extends Service {
 	ExtractedDatabaseMetaData getExtractedDatabaseMetaData();
 
 	/**
-	 * Get the current database catalog.  Typically will come from either {@link java.sql.Connection#getCatalog()}
-	 * or {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
+	 * Get the current database catalog.  Typically, will come from either
+	 * {@link java.sql.Connection#getCatalog()} or
+	 * {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
 	 *
 	 * @return The current catalog.
 	 */
 	Identifier getCurrentCatalog();
 
 	/**
-	 * Get the current database catalog.  Typically will come from either
-	 * {@link SchemaNameResolver#resolveSchemaName(java.sql.Connection, Dialect)} or
-	 * {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
+	 * Get the current database catalog.  Typically, will come from either
+	 * {@link java.sql.Connection#getSchema()} or
+	 * {@value org.hibernate.cfg.AvailableSettings#DEFAULT_SCHEMA}.
 	 *
 	 * @return The current schema
 	 */

hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/spi/SchemaNameResolver.java

@@ -12,16 +12,20 @@
 /**
  * Contract for resolving the schema of a {@link Connection}.
  *
+ * @deprecated Since Hibernate now baselines on Java 17,
+ * {@link Connection#getSchema()} is always available directly.
+ *
  * @author Steve Ebersole
  */
+@Deprecated
 public interface SchemaNameResolver {
 	/**
 	 * Given a JDBC {@link Connection}, resolve the name of the schema (if one) to which it connects.
 	 *
 	 * @param connection The JDBC connection
 	 * @param dialect The {@link Dialect}
 	 *
-	 * @return The name of the schema (may be null).
+	 * @return The name of the schema; may be null.
 	 */
 	String resolveSchemaName(Connection connection, Dialect dialect) throws SQLException;
 }