HHH-18009 - Consolidate JdbcObserver and ConnectionObserver into JdbcEventHandler

Author: sebersole

hibernate-core/src/main/java/org/hibernate/engine/jdbc/batch/internal/BatchImpl.java

@@ -24,7 +24,7 @@
 import org.hibernate.engine.jdbc.spi.SqlStatementLogger;
 import org.hibernate.event.spi.EventManager;
 import org.hibernate.event.spi.HibernateMonitoringEvent;
-import org.hibernate.resource.jdbc.spi.JdbcObserver;
+import org.hibernate.resource.jdbc.spi.JdbcEventHandler;
 import org.hibernate.resource.jdbc.spi.JdbcSessionOwner;
 
 import static org.hibernate.engine.jdbc.JdbcLogging.JDBC_MESSAGE_LOGGER;
@@ -257,9 +257,8 @@ protected void performExecution() {
 			);
 		}
 
-		//noinspection deprecation
 		final JdbcSessionOwner jdbcSessionOwner = jdbcCoordinator.getJdbcSessionOwner();
-		final JdbcObserver observer = jdbcSessionOwner.getJdbcSessionContext().getObserver();
+		final JdbcEventHandler eventHandler = jdbcSessionOwner.getJdbcSessionContext().getEventHandler();
 		try {
 			getStatementGroup().forEachStatement( (tableName, statementDetails) -> {
 				final String sql = statementDetails.getSqlString();
@@ -275,12 +274,12 @@ protected void performExecution() {
 						final EventManager eventManager = jdbcSessionOwner.getEventManager();
 						final HibernateMonitoringEvent jdbcBatchExecutionEvent = eventManager.beginJdbcBatchExecutionEvent();
 						try {
-							observer.jdbcExecuteBatchStart();
+							eventHandler.jdbcExecuteBatchStart();
 							rowCounts = statement.executeBatch();
 						}
 						finally {
 							eventManager.completeJdbcBatchExecutionEvent( jdbcBatchExecutionEvent, sql );
-							observer.jdbcExecuteBatchEnd();
+							eventHandler.jdbcExecuteBatchEnd();
 						}
 						checkRowCounts( rowCounts, statementDetails );
 					}

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

@@ -14,7 +14,6 @@
 import java.util.StringTokenizer;
 
 import org.hibernate.boot.registry.StandardServiceInitiator;
-import org.hibernate.cfg.AvailableSettings;
 import org.hibernate.cfg.JdbcSettings;
 import org.hibernate.dialect.DatabaseVersion;
 import org.hibernate.dialect.Dialect;
@@ -41,7 +40,7 @@
 import org.hibernate.jdbc.AbstractReturningWork;
 import org.hibernate.jpa.internal.MutableJpaComplianceImpl;
 import org.hibernate.jpa.spi.JpaCompliance;
-import org.hibernate.resource.jdbc.spi.JdbcObserver;
+import org.hibernate.resource.jdbc.spi.JdbcEventHandler;
 import org.hibernate.resource.jdbc.spi.JdbcSessionContext;
 import org.hibernate.resource.jdbc.spi.JdbcSessionOwner;
 import org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode;
@@ -610,6 +609,7 @@ public Map<String, Object> getConfigurationValues() {
 	 * This is a temporary JdbcSessionOwner for the purpose of passing a connection to the Dialect for initialization.
 	 */
 	private static class TemporaryJdbcSessionOwner implements JdbcSessionOwner, JdbcSessionContext {
+		private static final JdbcEventHandler EMPTY_JDBC_EVENT_HANDLER = new JdbcEventHandler();
 
 		private final JdbcConnectionAccess jdbcConnectionAccess;
 		private final JdbcServices jdbcServices;
@@ -620,7 +620,6 @@ private static class TemporaryJdbcSessionOwner implements JdbcSessionOwner, Jdbc
 		private final PhysicalConnectionHandlingMode connectionHandlingMode;
 		private final JpaCompliance jpaCompliance;
 		private final SqlExceptionHelper sqlExceptionHelper;
-		private static final EmptyJdbcObserver EMPTY_JDBC_OBSERVER = EmptyJdbcObserver.INSTANCE;
 		TransactionCoordinator transactionCoordinator;
 		private final EmptyEventManager eventManager;
 
@@ -750,9 +749,9 @@ public StatisticsImplementor getStatistics() {
 			return null;
 		}
 
-		@Override @Deprecated
-		public JdbcObserver getObserver() {
-			return EMPTY_JDBC_OBSERVER;
+		@Override
+		public JdbcEventHandler getEventHandler() {
+			return EMPTY_JDBC_EVENT_HANDLER;
 		}
 
 		@Override
@@ -784,60 +783,5 @@ public boolean isActive() {
 		public SqlExceptionHelper getSqlExceptionHelper() {
 			return sqlExceptionHelper;
 		}
-
-		private static class EmptyJdbcObserver implements JdbcObserver{
-
-			public static final EmptyJdbcObserver INSTANCE = new EmptyJdbcObserver();
-
-			@Override
-			public void jdbcConnectionAcquisitionStart() {
-
-			}
-
-			@Override
-			public void jdbcConnectionAcquisitionEnd(Connection connection) {
-
-			}
-
-			@Override
-			public void jdbcConnectionReleaseStart() {
-
-			}
-
-			@Override
-			public void jdbcConnectionReleaseEnd() {
-
-			}
-
-			@Override
-			public void jdbcPrepareStatementStart() {
-
-			}
-
-			@Override
-			public void jdbcPrepareStatementEnd() {
-
-			}
-
-			@Override
-			public void jdbcExecuteStatementStart() {
-
-			}
-
-			@Override
-			public void jdbcExecuteStatementEnd() {
-
-			}
-
-			@Override
-			public void jdbcExecuteBatchStart() {
-
-			}
-
-			@Override
-			public void jdbcExecuteBatchEnd() {
-
-			}
-		}
 	}
 }

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

@@ -82,9 +82,7 @@ public JdbcCoordinatorImpl(
 			JdbcServices jdbcServices) {
 		this.isUserSuppliedConnection = userSuppliedConnection != null;
 
-		final ResourceRegistry resourceRegistry = new ResourceRegistryStandardImpl(
-				owner.getJdbcSessionContext().getObserver()
-		);
+		final ResourceRegistry resourceRegistry = new ResourceRegistryStandardImpl( owner.getJdbcSessionContext().getEventHandler() );
 		if ( isUserSuppliedConnection ) {
 			this.logicalConnection = new LogicalConnectionProvidedImpl( userSuppliedConnection, resourceRegistry );
 		}

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

@@ -16,7 +16,7 @@
 import org.hibernate.engine.jdbc.spi.SqlExceptionHelper;
 import org.hibernate.event.spi.EventManager;
 import org.hibernate.event.spi.HibernateMonitoringEvent;
-import org.hibernate.resource.jdbc.spi.JdbcObserver;
+import org.hibernate.resource.jdbc.spi.JdbcEventHandler;
 import org.hibernate.resource.jdbc.spi.JdbcSessionContext;
 import org.hibernate.resource.jdbc.spi.JdbcSessionOwner;
 import org.hibernate.resource.jdbc.spi.LogicalConnectionImplementor;
@@ -94,21 +94,18 @@ protected StatementPreparationTemplate(String incomingSql) {
 		public PreparedStatement prepareStatement() {
 			try {
 				final PreparedStatement preparedStatement;
-				//noinspection deprecation
 				final JdbcSessionOwner jdbcSessionOwner = jdbcCoordinator.getJdbcSessionOwner();
-				final JdbcObserver observer = jdbcSessionOwner
-						.getJdbcSessionContext()
-						.getObserver();
+				final JdbcEventHandler jdbcEventHandler = jdbcSessionOwner.getJdbcSessionContext().getEventHandler();
 				final EventManager eventManager = jdbcSessionOwner.getEventManager();
 				final HibernateMonitoringEvent jdbcPreparedStatementCreation = eventManager.beginJdbcPreparedStatementCreationEvent();
 				try {
-					observer.jdbcPrepareStatementStart();
+					jdbcEventHandler.jdbcPrepareStatementStart();
 					preparedStatement = doPrepare();
 					setStatementTimeout( preparedStatement );
 				}
 				finally {
 					eventManager.completeJdbcPreparedStatementCreationEvent( jdbcPreparedStatementCreation, sql );
-					observer.jdbcPrepareStatementEnd();
+					jdbcEventHandler.jdbcPrepareStatementEnd();
 				}
 				postProcess( preparedStatement );
 				return preparedStatement;

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

@@ -78,11 +78,11 @@ private JdbcSessionContext context() {
 	}
 
 	private void jdbcExecuteStatementEnd() {
-		jdbcCoordinator.getJdbcSessionOwner().getJdbcSessionContext().getObserver().jdbcExecuteStatementEnd();
+		jdbcCoordinator.getJdbcSessionOwner().getJdbcSessionContext().getEventHandler().jdbcExecuteStatementEnd();
 	}
 
 	private void jdbcExecuteStatementStart() {
-		jdbcCoordinator.getJdbcSessionOwner().getJdbcSessionContext().getObserver().jdbcExecuteStatementStart();
+		jdbcCoordinator.getJdbcSessionOwner().getJdbcSessionContext().getEventHandler().jdbcExecuteStatementStart();
 	}
 
 	@Override

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

@@ -19,7 +19,7 @@
 import org.hibernate.engine.jdbc.spi.StatementPreparer;
 import org.hibernate.event.spi.EventManager;
 import org.hibernate.event.spi.HibernateMonitoringEvent;
-import org.hibernate.resource.jdbc.spi.JdbcObserver;
+import org.hibernate.resource.jdbc.spi.JdbcEventHandler;
 import org.hibernate.resource.jdbc.spi.JdbcSessionContext;
 import org.hibernate.resource.jdbc.spi.JdbcSessionOwner;
 import org.hibernate.resource.jdbc.spi.LogicalConnectionImplementor;
@@ -172,7 +172,7 @@ public PreparedStatement prepareStatement() {
 
 				final PreparedStatement preparedStatement;
 				final JdbcSessionOwner jdbcSessionOwner = jdbcCoordinator.getJdbcSessionOwner();
-				final JdbcObserver observer = jdbcSessionOwner.getJdbcSessionContext().getObserver();
+				final JdbcEventHandler observer = jdbcSessionOwner.getJdbcSessionContext().getEventHandler();
 				final EventManager eventManager = jdbcSessionOwner.getEventManager();
 				final HibernateMonitoringEvent jdbcPreparedStatementCreation = eventManager.beginJdbcPreparedStatementCreationEvent();
 				try {

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

@@ -15,18 +15,15 @@
 import org.hibernate.persister.entity.EntityPersister;
 import org.hibernate.service.JavaServiceLoadable;
 
-@JavaServiceLoadable
-@Incubating
 /**
  * Defines the contract for monitoring low-level events
- * involving interactions between the {@link Session} and the database
- * or second-level cache.
- *
- * <p>
- * <em>This an incubating API, subject to change.</em>
- *
+ * involving interactions between the {@linkplain org.hibernate.Session}
+ * and the database or second-level cache.
  *
+ * @apiNote This an incubating API, subject to change.
  */
+@JavaServiceLoadable
+@Incubating
 public interface EventManager {
 	HibernateMonitoringEvent beginSessionOpenEvent();