HHH-18224 - db info logging cleanup

Signed-off-by: Jan Schatteman <[email protected]>

Author: jrenaat

design/logger_id_ranges.adoc

@@ -73,8 +73,8 @@ public interface MappingModelCreationLogger extends BasicLogger {
 
 
 |[[connections-pooling]]org.hibernate.orm.connections.pooling
-|<<ConnectionPoolingLogger>>
-|Logging related to connection pooling
+|<<ConnectionInfoLogger>>
+|Logging related to connections and connection pooling
 
 |org.hibernate.orm.boot
 |n/a
@@ -93,9 +93,9 @@ public interface MappingModelCreationLogger extends BasicLogger {
 |Sub-system (?)
 
 
-|[[ConnectionPoolingLogger]]10001001
+|[[ConnectionInfoLogger]]10001001
 |10001500
-|org.hibernate.internal.log.ConnectionPoolingLogger
+|org.hibernate.internal.log.ConnectionInfoLogger
 | <<connections-pooling>>
 
 |1

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

@@ -21,6 +21,7 @@
 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.service.UnknownUnwrapTypeException;
 import org.hibernate.service.spi.Configurable;
 import org.hibernate.service.spi.Stoppable;
@@ -32,8 +33,6 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
-import org.jboss.logging.Logger;
-
 import static org.hibernate.cfg.AgroalSettings.AGROAL_CONFIG_PREFIX;
 
 /**
@@ -62,7 +61,6 @@ public class AgroalConnectionProvider implements ConnectionProvider, Configurabl
 
 	public static final String CONFIG_PREFIX = AGROAL_CONFIG_PREFIX + ".";
 	private static final long serialVersionUID = 1L;
-	private static final Logger LOGGER = Logger.getLogger( AgroalConnectionProvider.class );
 	private AgroalDataSource agroalDataSource = null;
 	private DatabaseConnectionInfo dbInfo;
 
@@ -93,7 +91,7 @@ private static <T> void copyProperty(Map<String, Object> properties, String key,
 
 	@Override
 	public void configure(Map<String, Object> props) throws HibernateException {
-		LOGGER.debug( "Configuring Agroal" );
+		ConnectionInfoLogger.INSTANCE.configureConnectionPool( "Agroal" );
 		try {
 			AgroalPropertiesReader agroalProperties = new AgroalPropertiesReader( CONFIG_PREFIX )
 					.readProperties( (Map) props ); //TODO: this is a garbage cast
@@ -122,9 +120,9 @@ public void configure(Map<String, Object> props) throws HibernateException {
 					.setDBMaxPoolSize( String.valueOf(acpc.maxSize()) );
 		}
 		catch ( Exception e ) {
+			ConnectionInfoLogger.INSTANCE.unableToInstantiateConnectionPool( e );
 			throw new HibernateException( e );
 		}
-		LOGGER.debug( "Agroal Configured" );
 	}
 
 	// --- ConnectionProvider
@@ -177,6 +175,8 @@ public <T> T unwrap(Class<T> unwrapType) {
 	@Override
 	public void stop() {
 		if ( agroalDataSource != null ) {
+			ConnectionInfoLogger.INSTANCE.cleaningUpConnectionPool( agroalDataSource.getConfiguration().connectionPoolConfiguration().
+																			connectionFactoryConfiguration().jdbcUrl() );
 			agroalDataSource.close();
 		}
 	}

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

@@ -24,15 +24,14 @@
 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.PropertiesHelper;
-import org.hibernate.internal.util.config.ConfigurationHelper;
 import org.hibernate.service.UnknownUnwrapTypeException;
 import org.hibernate.service.spi.Configurable;
 import org.hibernate.service.spi.ServiceRegistryAwareService;
 import org.hibernate.service.spi.ServiceRegistryImplementor;
 import org.hibernate.service.spi.Stoppable;
 
-import static org.hibernate.c3p0.internal.C3P0MessageLogger.C3P0_LOGGER;
 import static org.hibernate.c3p0.internal.C3P0MessageLogger.C3P0_MSG_LOGGER;
 import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.extractSetting;
 import static org.hibernate.internal.util.config.ConfigurationHelper.getBoolean;
@@ -111,6 +110,8 @@ else if ( DataSource.class.isAssignableFrom( unwrapType ) ) {
 
 	@Override
 	public void configure(Map<String, Object> props) {
+		ConnectionInfoLogger.INSTANCE.configureConnectionPool( "C3p0" );
+
 		final String jdbcDriverClass = extractSetting(
 				props,
 				JdbcSettings.JAKARTA_JDBC_DRIVER,
@@ -126,19 +127,17 @@ public void configure(Map<String, Object> props) {
 
 		final Properties connectionProps = ConnectionProviderInitiator.getConnectionProperties( props );
 
-		C3P0_MSG_LOGGER.connectionProperties( ConfigurationHelper.maskOut( connectionProps, "password" ) );
-
 		autocommit = getBoolean( JdbcSettings.AUTOCOMMIT, props );
 
 		if ( jdbcDriverClass == null ) {
-			C3P0_MSG_LOGGER.jdbcDriverNotSpecified();
+			ConnectionInfoLogger.INSTANCE.jdbcDriverNotSpecified();
 		}
 		else {
 			try {
 				serviceRegistry.requireService( ClassLoaderService.class ).classForName( jdbcDriverClass );
 			}
 			catch (ClassLoadingException e) {
-				throw new ClassLoadingException( C3P0_MSG_LOGGER.jdbcDriverNotFound( jdbcDriverClass ), e );
+				throw new ClassLoadingException( "JDBC Driver class " + jdbcDriverClass + " not found", e );
 			}
 		}
 
@@ -197,8 +196,8 @@ public void configure(Map<String, Object> props) {
 			ds = DataSources.pooledDataSource( unpooled, allProps );
 		}
 		catch (Exception e) {
-			C3P0_LOGGER.error( C3P0_MSG_LOGGER.unableToInstantiateC3p0ConnectionPool(), e );;
-			throw new HibernateException( C3P0_MSG_LOGGER.unableToInstantiateC3p0ConnectionPool(), e );
+			ConnectionInfoLogger.INSTANCE.unableToInstantiateConnectionPool( e );
+			throw new HibernateException( e );
 		}
 
 		isolation = ConnectionProviderInitiator.extractIsolation( props );
@@ -247,12 +246,12 @@ private void warnPropertyConflict(String hibernateStyle, String c3p0Style) {
 
 	@Override
 	public void stop() {
+		ConnectionInfoLogger.INSTANCE.cleaningUpConnectionPool( C3p0Settings.C3P0_CONFIG_PREFIX );
 		try {
 			DataSources.destroy( ds );
 		}
 		catch (SQLException sqle) {
-			C3P0_MSG_LOGGER.unableToDestroyC3p0ConnectionPool( sqle );
-			throw new HibernateException( "Unable to destroy the connection pool", sqle );
+			ConnectionInfoLogger.INSTANCE.unableToDestroyConnectionPool( sqle );
 		}
 	}
 

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

@@ -6,19 +6,15 @@
  */
 package org.hibernate.c3p0.internal;
 
-import java.sql.SQLException;
-
-import org.hibernate.internal.log.ConnectionPoolingLogger;
+import org.hibernate.internal.log.ConnectionInfoLogger;
 import org.hibernate.internal.log.SubSystemLogging;
 
 import org.jboss.logging.Logger;
-import org.jboss.logging.annotations.Cause;
 import org.jboss.logging.annotations.LogMessage;
 import org.jboss.logging.annotations.Message;
 import org.jboss.logging.annotations.MessageLogger;
 import org.jboss.logging.annotations.ValidIdRange;
 
-import static org.jboss.logging.Logger.Level.INFO;
 import static org.jboss.logging.Logger.Level.WARN;
 
 /**
@@ -33,10 +29,9 @@
 		name = C3P0MessageLogger.NAME,
 		description = "Logging related to the C3P0 connection pool"
 )
-public interface C3P0MessageLogger extends ConnectionPoolingLogger {
-	String NAME = ConnectionPoolingLogger.LOGGER_NAME + ".c3p0";
+public interface C3P0MessageLogger extends ConnectionInfoLogger {
+	String NAME = ConnectionInfoLogger.LOGGER_NAME + ".c3p0";
 
-	Logger C3P0_LOGGER = Logger.getLogger( NAME );
 	C3P0MessageLogger C3P0_MSG_LOGGER = Logger.getMessageLogger( C3P0MessageLogger.class, NAME );
 
 	/**
@@ -49,31 +44,4 @@ public interface C3P0MessageLogger extends ConnectionPoolingLogger {
 	@Message(value = "Both hibernate-style property '%1$s' and c3p0-style property '%2$s' have been set in Hibernate "
 			+ "properties.  Hibernate-style property '%1$s' will be used and c3p0-style property '%2$s' will be ignored!", id = 10001)
 	void bothHibernateAndC3p0StylesSet(String hibernateStyle,String c3p0Style);
-
-	/**
-	 * Build a message about not being able to find the JDBC driver class
-	 *
-	 * @param jdbcDriverClass The JDBC driver class we could not find
-	 *
-	 * @return The message
-	 */
-	@Message(value = "JDBC Driver class not found: %s", id = 10003)
-	String jdbcDriverNotFound(String jdbcDriverClass);
-
-	/**
-	 * Log a message (WARN) about not being able to stop the underlying c3p0 pool.
-	 *
-	 * @param e The exception when we tried to stop pool
-	 */
-	@LogMessage(level = WARN)
-	@Message(value = "Could not destroy C3P0 connection pool", id = 10004)
-	void unableToDestroyC3p0ConnectionPool(@Cause SQLException e);
-
-	/**
-	 * Build a message about not being able to start the underlying c3p0 pool.
-	 *
-	 * @return The message
-	 */
-	@Message(value = "Could not instantiate C3P0 connection pool", id = 10005)
-	String unableToInstantiateC3p0ConnectionPool();
 }

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

@@ -18,6 +18,7 @@
  */
 public class DatabaseConnectionInfoImpl implements DatabaseConnectionInfo {
 
+	// Means either the value was not explicitly set, or simply not offered by the connection provider
 	public static final String DEFAULT = "undefined/unknown";
 
 	protected String dbUrl = DEFAULT;
@@ -86,7 +87,12 @@ public DatabaseConnectionInfo setDBMaxPoolSize(String maxPoolSize) {
 	}
 
 	private boolean checkValidInteger(String integerString) {
-		return checkValidString( integerString ) && Integer.parseInt( integerString, 10 ) >= 0;
+		try {
+			return checkValidString( integerString ) && Integer.parseInt( integerString, 10 ) >= 0;
+		}
+		catch (NumberFormatException e) {
+			return false;
+		}
 	}
 
 	private boolean checkValidString(String value) {
@@ -101,7 +107,8 @@ private boolean isDefaultStringValue(String value) {
 		return DEFAULT.equalsIgnoreCase( value );
 	}
 
-	public String toString() {
+	@Override
+	public String getDBInfoAsString() {
 		StringBuilder sb = new StringBuilder();
 		sb.append( "\tDatabase JDBC URL [" ).append( dbUrl ).append(']');
 		sb.append(sb.length() > 0 ? "\n\t" : "" ).append( "Database driver: " ).append( dbDriverName );