HHH-18444 Remove deprecate Session#refresh methods

Author: dreab8

hibernate-core/src/main/java/org/hibernate/Session.java

@@ -791,29 +791,6 @@ public interface Session extends SharedSessionContract, EntityManager {
 	 */
 	void refresh(Object object);
 
-	/**
-	 * Reread the state of the given managed instance associated with this session
-	 * from the underlying database. This may be useful:
-	 * <ul>
-	 * <li>when a database trigger alters the object state upon insert or update,
-	 * <li>after {@linkplain #createMutationQuery(String) executing} any HQL update
-	 *     or delete statement,
-	 * <li>after {@linkplain #createNativeMutationQuery(String) executing} a native
-	 *     SQL statement, or
-	 * <li>after inserting a {@link java.sql.Blob} or {@link java.sql.Clob}.
-	 * </ul>
-	 * <p>
-	 * This operation cascades to associated instances if the association is mapped
-	 * with {@link jakarta.persistence.CascadeType#REFRESH}.
-	 *
-	 * @param entityName the name of the entity
-	 * @param object a persistent instance associated with this session
-	 *
-	 * @deprecated use {@link #refresh(Object)}
-	 */
-	@Deprecated(since = "6.0")
-	void refresh(String entityName, Object object);
-
 	/**
 	 * Reread the state of the given managed instance from the underlying database,
 	 * obtaining the given {@link LockMode}.
@@ -836,19 +813,6 @@ public interface Session extends SharedSessionContract, EntityManager {
 	 */
 	void refresh(Object object, LockOptions lockOptions);
 
-	/**
-	 * Reread the state of the given managed instance from the underlying database,
-	 * obtaining the given {@link LockMode}.
-	 *
-	 * @param entityName the name of the entity
-	 * @param object a persistent instance associated with this session
-	 * @param lockOptions contains the lock mode to use
-	 *
-	 * @deprecated use {@link #refresh(Object, LockOptions)}
-	 */
-	@Deprecated(since = "6.0")
-	void refresh(String entityName, Object object, LockOptions lockOptions);
-
 	/**
 	 * Mark a persistence instance associated with this session for removal from
 	 * the underlying database. Ths operation cascades to associated instances if

hibernate-core/src/main/java/org/hibernate/engine/spi/SessionDelegatorBaseImpl.java

@@ -972,11 +972,6 @@ public void refresh(Object entity, RefreshOption... options) {
 		delegate.refresh( entity, options );
 	}
 
-	@Override
-	public void refresh(String entityName, Object object) {
-		delegate.refresh( entityName, object );
-	}
-
 	@Override
 	public void refresh(Object object, LockMode lockMode) {
 		delegate.refresh( object, lockMode );
@@ -987,11 +982,6 @@ public void refresh(Object object, LockOptions lockOptions) {
 		delegate.refresh( object, lockOptions );
 	}
 
-	@Override
-	public void refresh(String entityName, Object object, LockOptions lockOptions) {
-		delegate.refresh( entityName, object, lockOptions );
-	}
-
 	@Override
 	public LockMode getCurrentLockMode(Object object) {
 		return delegate.getCurrentLockMode( object );
@@ -1197,11 +1187,6 @@ public void persistOnFlush(String entityName, Object object, PersistContext copi
 		delegate.persistOnFlush( entityName, object, copiedAlready );
 	}
 
-	@Override
-	public void refresh(String entityName, Object object, RefreshContext refreshedAlready) throws HibernateException {
-		delegate.refresh( entityName, object, refreshedAlready );
-	}
-
 	@Override
 	public void removeOrphanBeforeUpdates(String entityName, Object child) {
 		delegate.removeOrphanBeforeUpdates( entityName, child );

hibernate-core/src/main/java/org/hibernate/engine/spi/SessionImplementor.java

@@ -121,12 +121,6 @@ default SessionImplementor getSession() {
 	@Deprecated
 	void persistOnFlush(String entityName, Object object, PersistContext copiedAlready);
 
-	/**
-	 * @deprecated  OperationalContext should cover this overload I believe
-	 */
-	@Deprecated
-	void refresh(String entityName, Object object, RefreshContext refreshedAlready) throws HibernateException;
-
 	/**
 	 * @deprecated  OperationalContext should cover this overload I believe
 	 */

hibernate-core/src/main/java/org/hibernate/engine/spi/SessionLazyDelegator.java

@@ -285,12 +285,6 @@ public void refresh(Object object) {
 		this.lazySession.get().refresh( object );
 	}
 
-	@Override
-	@Deprecated
-	public void refresh(String entityName, Object object) {
-		this.lazySession.get().refresh( entityName, object );
-	}
-
 	@Override
 	public void refresh(Object object, LockMode lockMode) {
 		this.lazySession.get().refresh( object, lockMode );
@@ -301,12 +295,6 @@ public void refresh(Object object, LockOptions lockOptions) {
 		this.lazySession.get().refresh( object, lockOptions );
 	}
 
-	@Override
-	@Deprecated
-	public void refresh(String entityName, Object object, LockOptions lockOptions) {
-		this.lazySession.get().refresh( entityName, object, lockOptions );
-	}
-
 	@Override
 	public void remove(Object object) {
 		this.lazySession.get().remove( object );

hibernate-core/src/main/java/org/hibernate/event/spi/RefreshEvent.java

@@ -49,6 +49,11 @@ public RefreshEvent(Object object, LockOptions lockOptions, EventSource source)
 		}
 		this.lockOptions = lockOptions;
 	}
+
+	/**
+	 * @deprecated use {@link #RefreshEvent(Object, LockOptions, EventSource)} instead.
+	 */
+	@Deprecated(since = "7.0")
 	public RefreshEvent(String entityName, Object object, LockOptions lockOptions, EventSource source){
 		this(object,lockOptions,source);
 		this.entityName = entityName;

hibernate-core/src/main/java/org/hibernate/internal/SessionImpl.java

@@ -1178,13 +1178,7 @@ private void fireResolveNaturalId(final ResolveNaturalIdEvent event) {
 	@Override
 	public void refresh(Object object) throws HibernateException {
 		checkOpen();
-		fireRefresh( new RefreshEvent( null, object, this ) );
-	}
-
-	@Override @Deprecated
-	public void refresh(String entityName, Object object) throws HibernateException {
-		checkOpen();
-		fireRefresh( new RefreshEvent( entityName, object, this ) );
+		fireRefresh( new RefreshEvent( object, this ) );
 	}
 
 	@Override
@@ -1196,13 +1190,7 @@ public void refresh(Object object, LockMode lockMode) throws HibernateException
 	@Override
 	public void refresh(Object object, LockOptions lockOptions) throws HibernateException {
 		checkOpen();
-		refresh( null, object, lockOptions );
-	}
-
-	@Override @Deprecated
-	public void refresh(String entityName, Object object, LockOptions lockOptions) throws HibernateException {
-		checkOpen();
-		fireRefresh( new RefreshEvent( entityName, object, lockOptions, this ) );
+		fireRefresh( new RefreshEvent( object, lockOptions, this ) );
 	}
 
 	@Override

hibernate-core/src/test/java/org/hibernate/orm/test/locking/LockModeTest.java

@@ -210,8 +210,6 @@ public void testRefreshLockedEntity() {
 			checkLockMode( a, LockMode.PESSIMISTIC_READ, session );
 			session.refresh( a );
 			checkLockMode( a, LockMode.PESSIMISTIC_READ, session );
-			session.refresh( A.class.getName(), a );
-			checkLockMode( a, LockMode.PESSIMISTIC_READ, session );
 			session.refresh( a, Collections.emptyMap() );
 			checkLockMode( a, LockMode.PESSIMISTIC_READ, session );
 			session.refresh( a, null, Collections.emptyMap() );

hibernate-core/src/test/java/org/hibernate/orm/test/refresh/RefreshUsingEntityNameTest.java

@@ -46,7 +46,7 @@ public void tearDown(SessionFactoryScope scope) {
 	public void testRefreshUsingEntityName(SessionFactoryScope scope) {
 		scope.inSession(
 				session ->
-						session.refresh( "CustomName", customer )
+						session.refresh( customer )
 		);
 	}
 }

migration-guide.adoc

@@ -135,6 +135,8 @@ All such cases though are already controllable by the application.
 
 The effect can also often be mitigated using Hibernate's bytecode-based laziness (possibly combined with `@ConcreteProxy`).
 
+* Removed `org.hibernate.Session#refresh(String entityName, Object object)` in favor of `org.hibernate.Session#refresh(Object object)`
+* Removed `org.hibernate.Session#refresh(String entityName, Object object, LockOptions lockOptions)` in favor of `org.hibernate.Session#refresh(Object object, LockOptions lockOptions)`
 
 [[flush-persist]]
 == Session flush and persist