cleanups after introduction of DetachedObjectException

Author: gavinking

hibernate-core/src/main/java/org/hibernate/engine/internal/ProxyUtil.java

@@ -0,0 +1,107 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.engine.internal;
+
+import org.hibernate.DetachedObjectException;
+import org.hibernate.PersistentObjectException;
+import org.hibernate.bytecode.enhance.spi.interceptor.BytecodeLazyAttributeInterceptor;
+import org.hibernate.bytecode.enhance.spi.interceptor.EnhancementAsProxyLazinessInterceptor;
+import org.hibernate.engine.spi.SharedSessionContractImplementor;
+
+import static org.hibernate.engine.internal.ManagedTypeHelper.asPersistentAttributeInterceptable;
+import static org.hibernate.engine.internal.ManagedTypeHelper.isPersistentAttributeInterceptable;
+import static org.hibernate.proxy.HibernateProxy.extractLazyInitializer;
+
+/**
+ * @author Gavin King
+ * @since 7.2
+ */
+public class ProxyUtil {
+
+/**
+ * Get the entity instance underlying the given proxy, throwing
+ * an exception if the proxy is uninitialized. If the given
+ * object is not a proxy, simply return the argument.
+ */
+public static Object assertInitialized(Object maybeProxy) {
+final var lazyInitializer = extractLazyInitializer( maybeProxy );
+if ( lazyInitializer != null ) {
+if ( lazyInitializer.isUninitialized() ) {
+throw new PersistentObjectException( "Object was an uninitialized proxy for "
++ lazyInitializer.getEntityName() );
+}
+//unwrap the object and return
+return lazyInitializer.getImplementation();
+}
+else {
+return maybeProxy;
+}
+}
+
+/**
+ * Get the entity instance underlying the given proxy, forcing
+ * initialization if the proxy is uninitialized. If the given
+ * object is not a proxy, simply return the argument.
+ * @throws DetachedObjectException if the given proxy does not
+ * belong to the given session
+ */
+public static Object forceInitialize(Object maybeProxy, SharedSessionContractImplementor session) {
+final var lazyInitializer = extractLazyInitializer( maybeProxy );
+if ( lazyInitializer != null ) {
+if ( lazyInitializer.getSession() != session ) {
+throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
+}
+//initialize + unwrap the object and return it
+return lazyInitializer.getImplementation();
+}
+else if ( isPersistentAttributeInterceptable( maybeProxy ) ) {
+final var interceptor =
+asPersistentAttributeInterceptable( maybeProxy )
+.$$_hibernate_getInterceptor();
+if ( interceptor instanceof EnhancementAsProxyLazinessInterceptor lazinessInterceptor ) {
+if ( lazinessInterceptor.getLinkedSession() != session ) {
+throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
+}
+lazinessInterceptor.forceInitialize( maybeProxy, null );
+}
+return maybeProxy;
+}
+else {
+return maybeProxy;
+}
+}
+
+/**
+ * Determine of the given proxy is uninitialized. If the given
+ * object is not a proxy, simply return false.
+ * @throws DetachedObjectException if the given proxy does not
+ * belong to the given session
+ */
+public static boolean isUninitialized(Object value, SharedSessionContractImplementor session) {
+// could be a proxy
+final var lazyInitializer = extractLazyInitializer( value );
+if ( lazyInitializer != null ) {
+if ( lazyInitializer.getSession() != session ) {
+throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
+}
+return lazyInitializer.isUninitialized();
+}
+// or an uninitialized enhanced entity ("bytecode proxy")
+else if ( isPersistentAttributeInterceptable( value ) ) {
+final var interceptor =
+(BytecodeLazyAttributeInterceptor)
+asPersistentAttributeInterceptable( value )
+.$$_hibernate_getInterceptor();
+if ( interceptor != null && interceptor.getLinkedSession() != session ) {
+throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
+}
+return interceptor instanceof EnhancementAsProxyLazinessInterceptor enhancementInterceptor
+&& !enhancementInterceptor.isInitialized();
+}
+else {
+return false;
+}
+}
+}

hibernate-core/src/main/java/org/hibernate/engine/internal/StatefulPersistenceContext.java

@@ -23,13 +23,11 @@
 import java.util.function.Supplier;
 
 import org.hibernate.AssertionFailure;
-import org.hibernate.DetachedObjectException;
 import org.hibernate.Hibernate;
 import org.hibernate.HibernateException;
 import org.hibernate.LockMode;
 import org.hibernate.MappingException;
 import org.hibernate.NonUniqueObjectException;
-import org.hibernate.PersistentObjectException;
 import org.hibernate.bytecode.enhance.spi.interceptor.BytecodeLazyAttributeInterceptor;
 import org.hibernate.bytecode.enhance.spi.interceptor.EnhancementAsProxyLazinessInterceptor;
 import org.hibernate.collection.spi.PersistentCollection;
@@ -709,33 +707,6 @@ else if ( isPersistentAttributeInterceptable( value ) ) {
 }
 }
 
-@Override
-public boolean isUninitializedProxy(Object value) throws MappingException {
-// could be a proxy
-final var lazyInitializer = extractLazyInitializer( value );
-if ( lazyInitializer != null ) {
-if ( lazyInitializer.getSession() != session ) {
-throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
-}
-return lazyInitializer.isUninitialized();
-}
-// or an uninitialized enhanced entity ("bytecode proxy")
-else if ( isPersistentAttributeInterceptable( value ) ) {
-final var interceptor =
-(BytecodeLazyAttributeInterceptor)
-asPersistentAttributeInterceptable( value )
-.$$_hibernate_getInterceptor();
-if ( interceptor != null && interceptor.getLinkedSession() != session ) {
-throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
-}
-return interceptor instanceof EnhancementAsProxyLazinessInterceptor enhancementInterceptor
-&& !enhancementInterceptor.isInitialized();
-}
-else {
-return false;
-}
-}
-
 @Override
 public void reassociateProxy(Object value, Object id) throws MappingException {
 final var lazyInitializer = extractLazyInitializer( value );
@@ -773,50 +744,6 @@ private void reassociateProxy(LazyInitializer li, HibernateProxy proxy) {
 }
 }
 
-@Override
-public Object unproxy(Object maybeProxy) throws HibernateException {
-final var lazyInitializer = extractLazyInitializer( maybeProxy );
-if ( lazyInitializer != null ) {
-if ( lazyInitializer.isUninitialized() ) {
-throw new PersistentObjectException( "Object was an uninitialized proxy for "
-+ lazyInitializer.getEntityName() );
-}
-//unwrap the object and return
-return lazyInitializer.getImplementation();
-}
-else {
-return maybeProxy;
-}
-}
-
-@Override
-public Object unproxyLoadingIfNecessary(final Object maybeProxy) throws HibernateException {
-final var lazyInitializer = extractLazyInitializer( maybeProxy );
-if ( lazyInitializer != null ) {
-if ( lazyInitializer.getSession() != session ) {
-throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
-}
-//initialize + unwrap the object and return it
-return lazyInitializer.getImplementation();
-}
-else if ( isPersistentAttributeInterceptable( maybeProxy ) ) {
-final var interceptor =
-asPersistentAttributeInterceptable( maybeProxy )
-.$$_hibernate_getInterceptor();
-if ( interceptor instanceof EnhancementAsProxyLazinessInterceptor lazinessInterceptor ) {
-if ( lazinessInterceptor.getLinkedSession() != session ) {
-throw new DetachedObjectException( "Given proxy does not belong to this persistence context" );
-}
-lazinessInterceptor.forceInitialize( maybeProxy, null );
-}
-return maybeProxy;
-}
-else {
-return maybeProxy;
-}
-}
-
-
 @Override
 public Object unproxyAndReassociate(final Object maybeProxy) throws HibernateException {
 final var lazyInitializer = extractLazyInitializer( maybeProxy );

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

@@ -16,6 +16,7 @@
 import org.hibernate.Internal;
 import org.hibernate.LockMode;
 import org.hibernate.collection.spi.PersistentCollection;
+import org.hibernate.engine.internal.ProxyUtil;
 import org.hibernate.internal.util.MarkerObject;
 import org.hibernate.persister.collection.CollectionPersister;
 import org.hibernate.persister.entity.EntityPersister;
@@ -293,14 +294,12 @@ EntityEntry addReferenceEntry(
  * Get the entity instance underlying the given proxy, throwing
  * an exception if the proxy is uninitialized. If the given object
  * is not a proxy, simply return the argument.
+ * @deprecated No longer used
  */
-Object unproxy(Object maybeProxy);
-
-@Incubating
-Object unproxyLoadingIfNecessary(final Object maybeProxy);
-
-@Incubating
-boolean isUninitializedProxy(Object value);
+@Deprecated(since = "7.2", forRemoval = true)
+default Object unproxy(Object maybeProxy) {
+return ProxyUtil.assertInitialized( maybeProxy );
+}
 
 /**
  * Possibly unproxy the given reference and reassociate it with the current session.

hibernate-core/src/main/java/org/hibernate/event/internal/DefaultLockEventListener.java

@@ -11,7 +11,7 @@
 import org.hibernate.event.spi.LockEventListener;
 
 
-
+import static org.hibernate.engine.internal.ProxyUtil.forceInitialize;
 import static org.hibernate.loader.ast.internal.LoaderHelper.upgradeLock;
 
 /**
@@ -41,16 +41,15 @@ public void onLock(LockEvent event) throws HibernateException {
 }
 
 final var source = event.getSession();
-final var persistenceContext = source.getPersistenceContextInternal();
-final Object entity = persistenceContext.unproxyLoadingIfNecessary( instance );
+final Object entity = forceInitialize( instance, source );
 //TODO: if instance was an uninitialized proxy, this is inefficient,
 // resulting in two SQL selects
 
-final var entry = persistenceContext.getEntry( entity );
+final var entry = source.getPersistenceContextInternal().getEntry( entity );
 if ( entry == null && instance == entity ) {
 throw new DetachedObjectException( "Given entity is not associated with the persistence context" );
 }
 
-upgradeLock( entity, entry, event.getLockOptions(), event.getSession() );
+upgradeLock( entity, entry, event.getLockOptions(), source );
 }
 }

hibernate-core/src/main/java/org/hibernate/event/internal/DefaultMergeEventListener.java

@@ -40,6 +40,7 @@
 import static org.hibernate.engine.internal.ManagedTypeHelper.isHibernateProxy;
 import static org.hibernate.engine.internal.ManagedTypeHelper.isPersistentAttributeInterceptable;
 import static org.hibernate.engine.internal.ManagedTypeHelper.isSelfDirtinessTracker;
+import static org.hibernate.engine.internal.ProxyUtil.assertInitialized;
 import static org.hibernate.event.internal.EntityState.getEntityState;
 import static org.hibernate.event.internal.EventListenerLogging.EVENT_LISTENER_LOGGER;
 import static org.hibernate.event.internal.EventUtil.getLoggableName;
@@ -515,7 +516,7 @@ private static Object unproxyManagedForDetachedMerging(
 EntityPersister persister,
 EventSource source) {
 if ( isHibernateProxy( managed ) ) {
-return source.getPersistenceContextInternal().unproxy( managed );
+return assertInitialized( managed );
 }
 
 if ( isPersistentAttributeInterceptable( incoming )

hibernate-core/src/main/java/org/hibernate/event/internal/DefaultPersistEventListener.java

@@ -18,6 +18,7 @@
 import org.hibernate.jpa.event.spi.CallbackRegistryConsumer;
 import org.hibernate.persister.entity.EntityPersister;
 
+import static org.hibernate.engine.internal.ProxyUtil.assertInitialized;
 import static org.hibernate.event.internal.EntityState.getEntityState;
 import static org.hibernate.event.internal.EventListenerLogging.EVENT_LISTENER_LOGGER;
 import static org.hibernate.event.internal.EventUtil.getLoggableName;
@@ -118,14 +119,13 @@ protected void entityIsPersistent(PersistEvent event, PersistContext createCache
 final var source = event.getSession();
 final String entityName = event.getEntityName();
 //TODO: check that entry.getIdentifier().equals(requestedId)
-final Object entity = source.getPersistenceContextInternal().unproxy( event.getObject() );
+final Object entity = assertInitialized( event.getObject() );
+final var persister = source.getEntityPersister( entityName, entity );
 if ( EVENT_LISTENER_LOGGER.isTraceEnabled() ) {
-final var persister = source.getEntityPersister( entityName, entity );
 EVENT_LISTENER_LOGGER.ignoringPersistentInstance(
 infoString( entityName, persister.getIdentifier( entity ) ) );
 }
 if ( createCache.add( entity ) ) {
-final var persister = source.getEntityPersister( entityName, entity );
 justCascade( createCache, source, entity, persister );
 }
 }
@@ -138,21 +138,20 @@ private void justCascade(PersistContext createCache, EventSource source, Object
 
 protected void entityIsTransient(PersistEvent event, PersistContext createCache) {
 EVENT_LISTENER_LOGGER.persistingTransientInstance();
-final var source = event.getSession();
-final Object entity = source.getPersistenceContextInternal().unproxy( event.getObject() );
+final Object entity = assertInitialized( event.getObject() );
 if ( createCache.add( entity ) ) {
+final var source = event.getSession();
 saveWithGeneratedId( entity, event.getEntityName(), createCache, source, false );
 }
 }
 
 private void entityIsDeleted(PersistEvent event, PersistContext createCache) {
 final var source = event.getSession();
-final Object entity = source.getPersistenceContextInternal().unproxy( event.getObject() );
+final Object entity = assertInitialized( event.getObject() );
 final var persister = source.getEntityPersister( event.getEntityName(), entity );
 if ( EVENT_LISTENER_LOGGER.isTraceEnabled() ) {
-final Object id = persister.getIdentifier( entity, source );
 EVENT_LISTENER_LOGGER.unschedulingEntityDeletion(
-infoString( persister, id, source.getFactory() ) );
+infoString( persister, persister.getIdentifier( entity, source ), source.getFactory() ) );
 }
 if ( createCache.add( entity ) ) {
 justCascade( createCache, source, entity, persister );