HHH-17971 - Remove ALLOW_REFRESH_DETACHED_ENTITY

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

Author: jrenaat

documentation/src/main/asciidoc/userguide/chapters/pc/PersistenceContext.adoc

@@ -886,16 +886,7 @@ See the discussion of non-identifier <<chapters/domain/basic_types.adoc#mapping-
 [IMPORTANT]
 ====
 Traditionally, Hibernate allowed detached entities to be refreshed.
-Unfortunately, Jakarta Persistence prohibits this practice and specifies that an `IllegalArgumentException` should be thrown instead.
-
-For this reason, when bootstrapping the Hibernate `SessionFactory` using the native API, the legacy detached entity refresh behavior is going to be preserved.
-On the other hand, when bootstrapping Hibernate through the Jakarta Persistence `EntityManagerFactory` building process, detached entities are not allowed to be refreshed by default.
-
-However, this default behavior can be overwritten through the `hibernate.allow_refresh_detached_entity` configuration property.
-If this property is explicitly set to `true`, then you can refresh detached entities even when using the Jakarta Persistence bootstraps mechanism, therefore bypassing the Jakarta Persistence specification restriction.
-
-For more about the `hibernate.allow_refresh_detached_entity` configuration property,
-check out the <<appendices/Configurations.adoc#misc,Configurations>> section as well.
+however, Jakarta Persistence prohibits this practice and specifies that an `IllegalArgumentException` should be thrown instead. This is the default behaviour from version 7.0 onwards.
 ====
 
 [[pc-refresh-gotchas]]

hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryBuilderImpl.java

@@ -426,11 +426,6 @@ public SessionFactoryBuilder applyXmlFormatMapper(FormatMapper xmlFormatMapper)
 		return this;
 	}
 
-	@Override
-	public void disableRefreshDetachedEntity() {
-		this.optionsBuilder.disableRefreshDetachedEntity();
-	}
-
 	@Override
 	public void disableJtaTransactionAccess() {
 		this.optionsBuilder.disableJtaTransactionAccess();

hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryOptionsBuilder.java

@@ -75,7 +75,6 @@
 import jakarta.persistence.criteria.Nulls;
 
 import static org.hibernate.cfg.AvailableSettings.ALLOW_JTA_TRANSACTION_ACCESS;
-import static org.hibernate.cfg.AvailableSettings.ALLOW_REFRESH_DETACHED_ENTITY;
 import static org.hibernate.cfg.AvailableSettings.ALLOW_UPDATE_OUTSIDE_TRANSACTION;
 import static org.hibernate.cfg.AvailableSettings.AUTO_CLOSE_SESSION;
 import static org.hibernate.cfg.AvailableSettings.AUTO_EVICT_COLLECTION_CACHE;
@@ -176,7 +175,6 @@ public class SessionFactoryOptionsBuilder implements SessionFactoryOptions {
 	private boolean jtaTransactionAccessEnabled;
 	private boolean allowOutOfTransactionUpdateOperations;
 	private boolean releaseResourcesOnCloseEnabled;
-	private boolean allowRefreshDetachedEntity;
 
 	// (JTA) transaction handling
 	private boolean jtaTrackByThread;
@@ -335,12 +333,6 @@ public SessionFactoryOptionsBuilder(StandardServiceRegistry serviceRegistry, Boo
 				true
 		);
 
-		this.allowRefreshDetachedEntity = configurationService.getSetting(
-				ALLOW_REFRESH_DETACHED_ENTITY,
-				BOOLEAN,
-				false
-		);
-
 		this.flushBeforeCompletionEnabled = configurationService.getSetting( FLUSH_BEFORE_COMPLETION, BOOLEAN, true );
 		this.autoCloseSessionEnabled = configurationService.getSetting( AUTO_CLOSE_SESSION, BOOLEAN, false );
 
@@ -906,11 +898,6 @@ public boolean isJtaTransactionAccessEnabled() {
 		return jtaTransactionAccessEnabled;
 	}
 
-	@Override
-	public boolean isAllowRefreshDetachedEntity() {
-		return allowRefreshDetachedEntity;
-	}
-
 	@Override
 	public boolean isAllowOutOfTransactionUpdateOperations() {
 		return allowOutOfTransactionUpdateOperations;
@@ -1624,10 +1611,6 @@ public void enableCollectionInDefaultFetchGroup(boolean enabled) {
 		this.collectionsInDefaultFetchGroupEnabled = enabled;
 	}
 
-	public void disableRefreshDetachedEntity() {
-		this.allowRefreshDetachedEntity = false;
-	}
-
 	public void disableJtaTransactionAccess() {
 		this.jtaTransactionAccessEnabled = false;
 	}

hibernate-core/src/main/java/org/hibernate/boot/spi/AbstractDelegatingSessionFactoryOptions.java

@@ -37,6 +37,8 @@
 
 import jakarta.persistence.criteria.Nulls;
 
+import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
+
 /**
  * Convenience base class for custom implementations of {@link SessionFactoryOptions}
  * using delegation.
@@ -77,8 +79,13 @@ public boolean isJtaTransactionAccessEnabled() {
 		return delegate.isJtaTransactionAccessEnabled();
 	}
 
+	/**
+	 * @deprecated with no replacement.
+	 */
+	@Deprecated(since = "7.0", forRemoval = true)
 	@Override
 	public boolean isAllowRefreshDetachedEntity() {
+		DEPRECATION_LOGGER.deprecatedRefreshLockDetachedEntity();
 		return delegate.isAllowRefreshDetachedEntity();
 	}
 

hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryBuilderImplementor.java

@@ -5,6 +5,7 @@
 package org.hibernate.boot.spi;
 
 import org.hibernate.boot.SessionFactoryBuilder;
+import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
 
 /**
  * Additional SPI contract for {@link SessionFactoryBuilder}, mainly intended for
@@ -21,10 +22,11 @@ public interface SessionFactoryBuilderImplementor extends SessionFactoryBuilder
 	void disableJtaTransactionAccess();
 
 	/**
-	 * Called if {@link org.hibernate.cfg.AvailableSettings#ALLOW_REFRESH_DETACHED_ENTITY}
-	 * is not enabled.
+	 * @deprecated with no replacement.
 	 */
+	@Deprecated(since = "7.0", forRemoval = true)
 	default void disableRefreshDetachedEntity() {
+		DEPRECATION_LOGGER.deprecatedRefreshLockDetachedEntity();
 	}
 
 	/**

hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryOptions.java

@@ -34,6 +34,8 @@
 
 import jakarta.persistence.criteria.Nulls;
 
+import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
+
 /**
  * Aggregator of special options used to build the {@link org.hibernate.SessionFactory}.
  *
@@ -76,7 +78,12 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
 
 	boolean isJtaTransactionAccessEnabled();
 
+	/**
+	 * @deprecated with no replacement.
+	 */
+	@Deprecated(since = "7.0", forRemoval = true)
 	default boolean isAllowRefreshDetachedEntity() {
+		DEPRECATION_LOGGER.deprecatedRefreshLockDetachedEntity();
 		return false;
 	}
 

hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java

@@ -120,24 +120,6 @@ public interface AvailableSettings
 	 */
 	String DELAY_ENTITY_LOADER_CREATIONS = "hibernate.loader.delay_entity_loader_creations";
 
-	/**
-	 * When enabled, allows calls to {@link jakarta.persistence.EntityManager#refresh(Object)}
-	 * and {@link org.hibernate.Session#refresh(Object)} on a detached entity instance.
-	 * <p>
-	 * Values are {@code true}, which allows refreshing a detached instance and {@code false},
-	 * which does not. When refreshing is disallowed, an {@link IllegalArgumentException}
-	 * is thrown.
-	 * <p>
-	 * The default behavior is to allow refreshing a detached instance unless Hibernate
-	 * is bootstrapped via JPA.
-	 *
-	 * @deprecated Will be removed with no replacement from ORM version 7 onwards
-	 *
-	 * @since 5.2
-	 */
-	@Deprecated(since="6.6", forRemoval = true)
-	String ALLOW_REFRESH_DETACHED_ENTITY = "hibernate.allow_refresh_detached_entity";
-
 	/**
 	 * Specifies how Hibernate should behave when multiple representations of the same
 	 * persistent entity instance, that is, multiple detached objects with the same

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

@@ -1245,10 +1245,8 @@ private void fireRefresh(final RefreshContext refreshedAlready, final RefreshEve
 	}
 
 	private void checkEntityManaged(String entityName, Object entity) {
-		if ( !getSessionFactory().getSessionFactoryOptions().isAllowRefreshDetachedEntity() ) {
-			if ( !managed( entityName, entity ) ) {
-				throw new IllegalArgumentException( "Given entity is not associated with the persistence context" );
-			}
+		if ( !managed( entityName, entity ) ) {
+			throw new IllegalArgumentException( "Given entity is not associated with the persistence context" );
 		}
 	}
 

hibernate-core/src/main/java/org/hibernate/internal/log/DeprecationLogger.java

@@ -187,4 +187,11 @@ void recognizedObsoleteHibernateNamespace(
 			value = "Encountered use of deprecated annotation [%s] at %s."
 	)
 	void deprecatedAnnotation(Class<? extends Annotation> annotationType, String locationDescription);
+
+	@LogMessage(level = WARN)
+	@Message(
+			id = 90000034,
+			value = "Refreshing/locking detached entities is no longer allowed."
+	)
+	void deprecatedRefreshLockDetachedEntity();
 }

hibernate-core/src/main/java/org/hibernate/jpa/boot/internal/EntityManagerFactoryBuilderImpl.java

@@ -1479,7 +1479,6 @@ protected SessionFactoryBuilder populateSessionFactoryBuilder() {
 //			builder.applyInterceptor( sessionFactoryInterceptor );
 //		}
 		handleAllowJtaTransactionAccess( builder );
-		handleAllowDetachedEntity( builder );
 		addConfiguredSessionFactoryObserver( builder );
 		builder.addSessionFactoryObservers( ServiceRegistryCloser.INSTANCE );
 		builder.applyEntityNotFoundDelegate( JpaEntityNotFoundDelegate.INSTANCE );
@@ -1500,16 +1499,6 @@ private void addConfiguredSessionFactoryObserver(SessionFactoryBuilder builder)
 		}
 	}
 
-	// will use user override value or default to false if not supplied to follow JPA spec
-	private void handleAllowDetachedEntity(SessionFactoryBuilder builder) {
-		final boolean allowRefreshDetachedEntity =
-				readBooleanConfigurationValue( AvailableSettings.ALLOW_REFRESH_DETACHED_ENTITY );
-		if ( !allowRefreshDetachedEntity
-				&& builder instanceof SessionFactoryBuilderImplementor implementor ) {
-			implementor.disableRefreshDetachedEntity();
-		}
-	}
-
 	// will use user override value or default to false if not supplied to follow JPA spec
 	private void handleAllowJtaTransactionAccess(SessionFactoryBuilder builder) {
 		final boolean jtaTransactionAccessEnabled =