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 agroal}.
+ * <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;
@@ -38,8 +38,13 @@
 import static org.hibernate.internal.util.config.ConfigurationHelper.getInteger;
 
 /**
- * A connection provider that uses a C3P0 connection pool. Hibernate will use this by
- * default if the {@code hibernate.c3p0.*} properties are set.
+ * {@link ConnectionProvider} based on c3p0 connection pool.
+ * <p>
+ * To force the use of this {@code ConnectionProvider} set
+ * {@value org.hibernate.cfg.JdbcSettings#CONNECTION_PROVIDER}
+ * to {@code c3p0}.
+ * <p>
+ * Hibernate selects this by default if the {@code hibernate.c3p0.*} properties are set.
  *
  * @author various people
  * @see ConnectionProvider
@@ -141,8 +146,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 +202,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 +265,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-c3p0/src/main/java/org/hibernate/c3p0/internal/StrategyRegistrationProviderImpl.java

@@ -20,7 +20,6 @@
 public final class StrategyRegistrationProviderImpl implements StrategyRegistrationProvider {
 
 	@Override
-	@SuppressWarnings("unchecked")
 	public Iterable<StrategyRegistration> getStrategyRegistrations() {
 		final SimpleStrategyRegistrationImpl<ConnectionProvider> c3p0 = new SimpleStrategyRegistrationImpl<>(
 				ConnectionProvider.class,

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 ) ) {