introduce ConnectionProviderConfigurationException

Author: gavinking

hibernate-agroal/src/main/java/org/hibernate/agroal/internal/AgroalConnectionProvider.java

@@ -4,6 +4,7 @@
  */
 package org.hibernate.agroal.internal;
 
+import java.io.Serial;
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.sql.DatabaseMetaData;
@@ -19,6 +20,7 @@
 import org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator;
 import org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl;
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
+import org.hibernate.engine.jdbc.connections.spi.ConnectionProviderConfigurationException;
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.internal.log.ConnectionInfoLogger;
 import org.hibernate.service.UnknownUnwrapTypeException;
@@ -38,10 +40,13 @@
 import static org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.allowJdbcMetadataAccess;
 
 /**
- * ConnectionProvider based on Agroal connection pool
- * To use this ConnectionProvider set: <pre> hibernate.connection.provider_class AgroalConnectionProvider </pre>
- *
- * Usual hibernate properties are supported:
+ * {@link ConnectionProvider} based on Agroal connection pool.
+ * <p>
+ * To force the use of this {@code ConnectionProvider} set:
+ * {@value org.hibernate.cfg.JdbcSettings#CONNECTION_PROVIDER}
+ * to {@code AgroalConnectionProvider}.
+ * <p>
+ * Usual hibernate connection properties are supported:
  * <pre>
  *     hibernate.connection.driver_class
  *     hibernate.connection.url
@@ -50,8 +55,8 @@
  *     hibernate.connection.autocommit
  *     hibernate.connection.isolation
  * </pre>
- *
- * Other configuration options are available, using the {@code hibernate.agroal} prefix
+ * <p>
+ * Other configuration options are available, using the {@code hibernate.agroal} prefix.
  *
  * @see AgroalSettings
  * @see AgroalPropertiesReader
@@ -62,6 +67,8 @@
 public class AgroalConnectionProvider implements ConnectionProvider, Configurable, Stoppable {
 
 	public static final String CONFIG_PREFIX = AGROAL_CONFIG_PREFIX + ".";
+
+	@Serial
 	private static final long serialVersionUID = 1L;
 	private AgroalDataSource agroalDataSource = null;
 	private boolean isMetadataAccessAllowed = true;
@@ -113,7 +120,8 @@ public void configure(Map<String, Object> properties) throws HibernateException
 		}
 		catch ( Exception e ) {
 			ConnectionInfoLogger.INSTANCE.unableToInstantiateConnectionPool( e );
-			throw new HibernateException( e );
+			throw new ConnectionProviderConfigurationException(
+					"Could not configure Agroal: " + e.getMessage(),  e );
 		}
 	}
 

hibernate-c3p0/src/main/java/org/hibernate/c3p0/internal/C3P0ConnectionProvider.java

@@ -14,7 +14,6 @@
 
 import com.mchange.v2.c3p0.DataSources;
 
-import org.hibernate.HibernateException;
 import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
 import org.hibernate.boot.registry.classloading.spi.ClassLoadingException;
 import org.hibernate.cfg.C3p0Settings;
@@ -23,6 +22,7 @@
 import org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator;
 import org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl;
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
+import org.hibernate.engine.jdbc.connections.spi.ConnectionProviderConfigurationException;
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.internal.log.ConnectionInfoLogger;
 import org.hibernate.internal.util.PropertiesHelper;
@@ -141,8 +141,8 @@ public void configure(Map<String, Object> props) {
 			}
 		}
 
-		Integer minPoolSize = null;
-		Integer maxPoolSize = null;
+		final Integer minPoolSize;
+		final Integer maxPoolSize;
 		try {
 
 			//swaldman 2004-02-07: modify to allow null values to signify fall through to c3p0 PoolConfig defaults
@@ -197,7 +197,8 @@ public void configure(Map<String, Object> props) {
 		}
 		catch (Exception e) {
 			ConnectionInfoLogger.INSTANCE.unableToInstantiateConnectionPool( e );
-			throw new HibernateException( e );
+			throw new ConnectionProviderConfigurationException(
+					"Could not configure c3p0: " + e.getMessage(),  e );
 		}
 
 		isolation = ConnectionProviderInitiator.extractIsolation( props );
@@ -259,17 +260,6 @@ public void stop() {
 		}
 	}
 
-	/**
-	 * Close the provider.
-	 *
-	 * @deprecated Use {@link #stop} instead
-	 */
-	@SuppressWarnings("unused")
-	@Deprecated
-	public void close() {
-		stop();
-	}
-
 	@Override
 	public void injectServices(ServiceRegistryImplementor serviceRegistry) {
 		this.serviceRegistry = serviceRegistry;

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DatasourceConnectionProviderImpl.java

@@ -14,6 +14,7 @@
 import org.hibernate.cfg.JdbcSettings;
 import org.hibernate.dialect.Dialect;
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
+import org.hibernate.engine.jdbc.connections.spi.ConnectionProviderConfigurationException;
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.engine.jndi.spi.JndiService;
 import org.hibernate.internal.log.ConnectionInfoLogger;
@@ -70,7 +71,7 @@ public boolean isUnwrappableAs(Class<?> unwrapType) {
 	}
 
 	@Override
-	@SuppressWarnings( {"unchecked"})
+	@SuppressWarnings("unchecked")
 	public <T> T unwrap(Class<T> unwrapType) {
 		if ( ConnectionProvider.class.equals( unwrapType )
 				|| DatasourceConnectionProviderImpl.class.isAssignableFrom( unwrapType ) ) {
@@ -88,26 +89,23 @@ else if ( DataSource.class.isAssignableFrom( unwrapType ) ) {
 	public void configure(Map<String, Object> configValues) {
 		if ( dataSource == null ) {
 			final Object dataSourceSetting = configValues.get( DATASOURCE );
-			if ( dataSourceSetting instanceof DataSource ds ) {
-				dataSource = ds;
+			if ( dataSourceSetting instanceof DataSource instance ) {
+				dataSource = instance;
 			}
-			else {
-				final String dataSourceJndiName = (String) dataSourceSetting;
-				if ( dataSourceJndiName == null ) {
-					throw new HibernateException(
-							"DataSource to use was not injected nor specified by [" + DATASOURCE
-									+ "] configuration property"
-					);
-				}
-				this.dataSourceJndiName = dataSourceJndiName;
+			else if ( dataSourceSetting instanceof String jndiName ) {
+				dataSourceJndiName = jndiName;
 				if ( jndiService == null ) {
-					throw new HibernateException( "Unable to locate JndiService to lookup Datasource" );
+					throw new ConnectionProviderConfigurationException( "Unable to locate JndiService to lookup Datasource" );
 				}
-				dataSource = (DataSource) jndiService.locate( dataSourceJndiName );
+				dataSource = (DataSource) jndiService.locate( jndiName );
+			}
+			else {
+				throw new ConnectionProviderConfigurationException(
+						"DataSource to use was not injected nor specified by '" + DATASOURCE + "'" );
 			}
 		}
 		if ( dataSource == null ) {
-			throw new HibernateException( "Unable to determine appropriate DataSource to use" );
+			throw new ConnectionProviderConfigurationException( "Unable to determine appropriate DataSource to use" );
 		}
 
 		if ( configValues.containsKey( AvailableSettings.AUTOCOMMIT ) ) {

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DriverManagerConnectionProviderImpl.java

@@ -28,6 +28,7 @@
 import org.hibernate.dialect.Dialect;
 import org.hibernate.dialect.SimpleDatabaseVersion;
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
+import org.hibernate.engine.jdbc.connections.spi.ConnectionProviderConfigurationException;
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.internal.util.config.ConfigurationHelper;
 import org.hibernate.service.UnknownUnwrapTypeException;
@@ -90,20 +91,18 @@ private PooledConnections buildPool(Map<String,Object> configurationValues, Serv
 		final int maxSize = ConfigurationHelper.getInt( AvailableSettings.POOL_SIZE, configurationValues, 20 );
 		final int initialSize = ConfigurationHelper.getInt( INITIAL_SIZE, configurationValues, minSize );
 
-		ConnectionCreator connectionCreator = buildCreator( configurationValues, serviceRegistry );
-		PooledConnections.Builder pooledConnectionBuilder = new PooledConnections.Builder(
-				connectionCreator,
-				autoCommit
-		);
+		final ConnectionCreator creator = buildCreator( configurationValues, serviceRegistry );
+		final PooledConnections.Builder pooledConnectionBuilder = new PooledConnections.Builder( creator, autoCommit );
 		pooledConnectionBuilder.initialSize( initialSize );
 		pooledConnectionBuilder.minSize( minSize );
 		pooledConnectionBuilder.maxSize( maxSize );
 		pooledConnectionBuilder.validator( this );
 		return pooledConnectionBuilder.build();
 	}
 
-	private static ConnectionCreator buildCreator(Map<String,Object> configurationValues, ServiceRegistryImplementor serviceRegistry) {
-		final String url = (String) configurationValues.get( AvailableSettings.URL );
+	private static ConnectionCreator buildCreator(
+			Map<String,Object> configurationValues, ServiceRegistryImplementor serviceRegistry) {
+		final String url = jdbcUrl( configurationValues );
 
 		String driverClassName = (String) configurationValues.get( AvailableSettings.DRIVER );
 		boolean success = false;
@@ -112,14 +111,14 @@ private static ConnectionCreator buildCreator(Map<String,Object> configurationVa
 			driver = loadDriverIfPossible( driverClassName, serviceRegistry );
 			success = true;
 		}
-		else if ( url != null ) {
+		else {
 			//try to guess the driver class from the JDBC URL
 			for ( Database database: Database.values() ) {
 				if ( database.matchesUrl( url ) ) {
 					driverClassName = database.getDriverClassName( url );
 					if ( driverClassName != null ) {
 						try {
-							loadDriverIfPossible(driverClassName, serviceRegistry);
+							loadDriverIfPossible( driverClassName, serviceRegistry );
 							success = true;
 						}
 						catch (Exception e) {
@@ -132,49 +131,24 @@ else if ( url != null ) {
 			}
 		}
 
-		StringBuilder list = new StringBuilder();
-		if ( !success ) {
-			//we're hoping that the driver is already loaded
-			ConnectionInfoLogger.INSTANCE.jdbcDriverNotSpecified();
-			Enumeration<Driver> drivers = DriverManager.getDrivers();
-			while ( drivers.hasMoreElements() ) {
-				if ( list.length() != 0) {
-					list.append(", ");
-				}
-				list.append( drivers.nextElement().getClass().getName() );
-			}
-		}
-
-		if ( url == null ) {
-			throw new HibernateException( "No JDBC URL specified by property " + JAKARTA_JDBC_URL );
-		}
+		final String driverList = success ? driverClassName : driverList();
 
 		final Properties connectionProps = ConnectionProviderInitiator.getConnectionProperties( configurationValues );
 
 		final boolean autoCommit = ConfigurationHelper.getBoolean( AvailableSettings.AUTOCOMMIT, configurationValues );
 		final Integer isolation = ConnectionProviderInitiator.extractIsolation( configurationValues );
 		final String initSql = (String) configurationValues.get( INIT_SQL );
 
-		final Object connectionCreatorFactory = configurationValues.get( CONNECTION_CREATOR_FACTORY );
-		ConnectionCreatorFactory factory = null;
-		if ( connectionCreatorFactory instanceof ConnectionCreatorFactory ) {
-			factory = (ConnectionCreatorFactory) connectionCreatorFactory;
-		}
-		else if ( connectionCreatorFactory != null ) {
-			factory = loadConnectionCreatorFactory( connectionCreatorFactory.toString(), serviceRegistry );
-		}
-		if ( factory == null ) {
-			factory = ConnectionCreatorFactoryImpl.INSTANCE;
-		}
+		final ConnectionCreatorFactory factory = getConnectionCreatorFactory( configurationValues, serviceRegistry );
 
 		dbInfo = new DatabaseConnectionInfoImpl(
 				url,
-				success ? driverClassName : list.toString(),
+				driverList,
 				SimpleDatabaseVersion.ZERO_VERSION,
 				Boolean.toString( autoCommit ),
-				isolation != null ? ConnectionProviderInitiator.toIsolationNiceName(isolation) : null,
-				ConfigurationHelper.getInt(MIN_SIZE, configurationValues, 1),
-				ConfigurationHelper.getInt(AvailableSettings.POOL_SIZE, configurationValues, 20)
+				isolation != null ? ConnectionProviderInitiator.toIsolationNiceName( isolation ) : null,
+				ConfigurationHelper.getInt( MIN_SIZE, configurationValues, 1 ),
+				ConfigurationHelper.getInt( AvailableSettings.POOL_SIZE, configurationValues, 20 )
 		);
 
 		return factory.create(
@@ -189,38 +163,77 @@ else if ( connectionCreatorFactory != null ) {
 		);
 	}
 
+	private static String driverList() {
+		//we're hoping that the driver is already loaded
+		ConnectionInfoLogger.INSTANCE.jdbcDriverNotSpecified();
+		final StringBuilder list = new StringBuilder();
+		final Enumeration<Driver> drivers = DriverManager.getDrivers();
+		while ( drivers.hasMoreElements() ) {
+			if ( !list.isEmpty() ) {
+				list.append(", ");
+			}
+			list.append( drivers.nextElement().getClass().getName() );
+		}
+		return list.toString();
+	}
+
+	private static String jdbcUrl(Map<String, Object> configurationValues) {
+		final String url = (String) configurationValues.get( AvailableSettings.URL );
+		if ( url == null ) {
+			throw new ConnectionProviderConfigurationException( "No JDBC URL specified by property '" + JAKARTA_JDBC_URL + "'" );
+		}
+		return url;
+	}
+
+	private static ConnectionCreatorFactory getConnectionCreatorFactory(
+			Map<String, Object> configurationValues, ServiceRegistryImplementor serviceRegistry) {
+		final Object connectionCreatorFactory = configurationValues.get( CONNECTION_CREATOR_FACTORY );
+		final ConnectionCreatorFactory factory;
+		if ( connectionCreatorFactory instanceof ConnectionCreatorFactory instance ) {
+			factory = instance;
+		}
+		else if ( connectionCreatorFactory != null ) {
+			factory = loadConnectionCreatorFactory( connectionCreatorFactory.toString(), serviceRegistry );
+		}
+		else {
+			factory = null;
+		}
+		return factory == null ? ConnectionCreatorFactoryImpl.INSTANCE : factory;
+	}
+
 	private static Driver loadDriverIfPossible(String driverClassName, ServiceRegistryImplementor serviceRegistry) {
 		if ( driverClassName == null ) {
 			ConnectionInfoLogger.INSTANCE.debug( "No driver class specified" );
 			return null;
 		}
-
-		if ( serviceRegistry != null ) {
-			final ClassLoaderService classLoaderService = serviceRegistry.requireService( ClassLoaderService.class );
-			final Class<Driver> driverClass = classLoaderService.classForName( driverClassName );
+		else if ( serviceRegistry != null ) {
+			final Class<Driver> driverClass =
+					serviceRegistry.requireService( ClassLoaderService.class )
+							.classForName( driverClassName );
 			try {
 				return driverClass.newInstance();
 			}
 			catch ( Exception e ) {
 				throw new ServiceException( "Specified JDBC Driver " + driverClassName + " could not be loaded", e );
 			}
 		}
-
-		try {
-			return (Driver) Class.forName( driverClassName ).newInstance();
-		}
-		catch ( Exception e1 ) {
-			throw new ServiceException( "Specified JDBC Driver " + driverClassName + " could not be loaded", e1 );
+		else {
+			try {
+				return (Driver) Class.forName( driverClassName ).newInstance();
+			}
+			catch (Exception e1) {
+				throw new ServiceException( "Specified JDBC Driver " + driverClassName + " could not be loaded", e1 );
+			}
 		}
 	}
 
-	private static ConnectionCreatorFactory loadConnectionCreatorFactory(String connectionCreatorFactoryClassName, ServiceRegistryImplementor serviceRegistry) {
+	private static ConnectionCreatorFactory loadConnectionCreatorFactory(
+			String connectionCreatorFactoryClassName, ServiceRegistryImplementor serviceRegistry) {
 		if ( connectionCreatorFactoryClassName == null ) {
 			ConnectionInfoLogger.INSTANCE.debug( "No connection creator factory class specified" );
 			return null;
 		}
-
-		if ( serviceRegistry != null ) {
+		else if ( serviceRegistry != null ) {
 			final ClassLoaderService classLoaderService = serviceRegistry.requireService( ClassLoaderService.class );
 			final Class<ConnectionCreatorFactory> factoryClass =
 					classLoaderService.classForName( connectionCreatorFactoryClassName );
@@ -231,12 +244,15 @@ private static ConnectionCreatorFactory loadConnectionCreatorFactory(String conn
 				throw new ServiceException( "Specified ConnectionCreatorFactory " + connectionCreatorFactoryClassName + " could not be loaded", e );
 			}
 		}
-
-		try {
-			return (ConnectionCreatorFactory) Class.forName( connectionCreatorFactoryClassName ).newInstance();
-		}
-		catch ( Exception e1 ) {
-			throw new ServiceException( "Specified ConnectionCreatorFactory " + connectionCreatorFactoryClassName + " could not be loaded", e1 );
+		else {
+			try {
+				return (ConnectionCreatorFactory) Class.forName( connectionCreatorFactoryClassName ).newInstance();
+			}
+			catch (Exception e1) {
+				throw new ServiceException(
+						"Specified ConnectionCreatorFactory " + connectionCreatorFactoryClassName + " could not be loaded",
+						e1 );
+			}
 		}
 	}