HHH-19587 - Easier access to LobHelper

The getLobHelper method was moved to the org.hibernate.Hibernate class and deprecated in Session

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

Author: jrenaat

hibernate-community-dialects/src/test/java/org/hibernate/community/dialect/AltibaseFunctionsTest.java

@@ -21,6 +21,7 @@
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hibernate.Hibernate.getLobHelper;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 @DomainModel(annotatedClasses = Person.class)
@@ -49,8 +50,8 @@ public void createTestData(SessionFactoryScope scope) {
 					{
 						arry[i] = (byte)i;
 					}
-					person.setBinaryData( session.getLobHelper().createBlob(arry) );
-					person.setComments( session.getLobHelper().createClob("blahblah") );
+					person.setBinaryData( getLobHelper().createBlob(arry) );
+					person.setComments( getLobHelper().createClob("blahblah") );
 					session.persist( person );
 				}
 		);

hibernate-community-dialects/src/test/java/org/hibernate/community/dialect/functional/cache/SQLFunctionsInterSystemsTest.java

@@ -32,6 +32,7 @@
 import org.hibernate.orm.test.legacy.Single;
 import org.junit.Test;
 
+import static org.hibernate.Hibernate.getLobHelper;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
@@ -470,8 +471,8 @@ public void testBlobClob() throws Exception {
 		Session s = openSession();
 		s.beginTransaction();
 		Blobber b = new Blobber();
-		b.setBlob( s.getLobHelper().createBlob( "foo/bar/baz".getBytes() ) );
-		b.setClob( s.getLobHelper().createClob("foo/bar/baz") );
+		b.setBlob( getLobHelper().createBlob( "foo/bar/baz".getBytes() ) );
+		b.setClob( getLobHelper().createClob("foo/bar/baz") );
 		s.persist(b);
 		//s.refresh(b);
 		//assertTrue( b.getClob() instanceof ClobImpl );
@@ -502,7 +503,7 @@ public void testBlobClob() throws Exception {
 		s = openSession();
 		s.beginTransaction();
 		b = s.getReference( Blobber.class, b.getId() );
-		b.setClob( s.getLobHelper().createClob("xcvfxvc xcvbx cvbx cvbx cvbxcvbxcvbxcvb") );
+		b.setClob( getLobHelper().createClob("xcvfxvc xcvbx cvbx cvbx cvbxcvbxcvbxcvb") );
 		s.flush();
 		s.getTransaction().commit();
 		s.close();

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

@@ -4,6 +4,11 @@
  */
 package org.hibernate;
 
+import java.io.InputStream;
+import java.io.Reader;
+import java.sql.Blob;
+import java.sql.Clob;
+import java.sql.NClob;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
@@ -27,6 +32,8 @@
 import org.hibernate.collection.spi.PersistentSortedMap;
 import org.hibernate.collection.spi.PersistentSortedSet;
 import org.hibernate.collection.spi.PersistentCollection;
+import org.hibernate.engine.jdbc.LobCreator;
+import org.hibernate.engine.jdbc.env.internal.NonContextualLobCreator;
 import org.hibernate.engine.spi.PersistentAttributeInterceptor;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.persister.entity.EntityPersister;
@@ -111,6 +118,8 @@ private Hibernate() {
 		throw new UnsupportedOperationException();
 	}
 
+	private static final LobHelperImpl lobHelper = new LobHelperImpl();
+
 	/**
 	 * Force initialization of a proxy or persistent collection. In the case of a
 	 * many-valued association, only the collection itself is initialized. It is not
@@ -587,7 +596,56 @@ else if (collectionClass == Collection.class) {
 		}
 	}
 
+	/**
+	 * Obtain a {@linkplain LobHelper} for instances of {@link java.sql.Blob}
+	 * and {@link java.sql.Clob}.
+	 *
+	 * @return an instance of {@link LobHelper}
+	 */
+	public static LobHelper getLobHelper() {
+		return lobHelper;
+	}
+
 	private static PersistentAttributeInterceptor getAttributeInterceptor(Object entity) {
 		return asPersistentAttributeInterceptable( entity ).$$_hibernate_getInterceptor();
 	}
+
+	private static class LobHelperImpl implements LobHelper {
+		@Override
+		public Blob createBlob(byte[] bytes) {
+			return lobCreator().createBlob( bytes );
+		}
+
+		private LobCreator lobCreator() {
+			// Always use NonContextualLobCreator.  If ContextualLobCreator is
+			// used both here and in WrapperOptions,
+			return NonContextualLobCreator.INSTANCE;
+		}
+
+		@Override
+		public Blob createBlob(InputStream stream, long length) {
+			return lobCreator().createBlob( stream, length );
+		}
+
+		@Override
+		public Clob createClob(String string) {
+			return lobCreator().createClob( string );
+		}
+
+		@Override
+		public Clob createClob(Reader reader, long length) {
+			return lobCreator().createClob( reader, length );
+		}
+
+		@Override
+		public NClob createNClob(String string) {
+			return lobCreator().createNClob( string );
+		}
+
+		@Override
+		public NClob createNClob(Reader reader, long length) {
+			return lobCreator().createNClob( reader, length );
+		}
+	}
+
 }

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

@@ -15,7 +15,7 @@
  *
  * @author Steve Ebersole
  *
- * @see Session#getLobHelper()
+ * @see Hibernate#getLobHelper()
  */
 public interface LobHelper {
 

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

@@ -1321,11 +1321,15 @@ public interface Session extends SharedSessionContract, EntityManager {
 	void disableFetchProfile(String name) throws UnknownProfileException;
 
 	/**
-	 * Obtain a {@linkplain LobHelper factory} for instances of {@link java.sql.Blob}
+	 * Obtain a {@linkplain LobHelper} for instances of {@link java.sql.Blob}
 	 * and {@link java.sql.Clob}.
 	 *
 	 * @return an instance of {@link LobHelper}
+	 *
+	 * @deprecated 	This method will be removed.
+	 * 				use {@link Hibernate#getLobHelper()} instead
 	 */
+	@Deprecated(since="7.0", forRemoval = true)
 	LobHelper getLobHelper();
 
 	/**

hibernate-core/src/main/java/org/hibernate/engine/jdbc/LobCreator.java

@@ -14,7 +14,7 @@
  * Contract for creating various LOB references.
  *
  * @apiNote This class is not intended to be called directly by the application program.
- *          Instead, use {@link org.hibernate.Session#getLobHelper()}.
+ *          Instead, use {@link org.hibernate.Hibernate#getLobHelper()}.
  *
  * @author Steve Ebersole
  * @author Gail Badner

hibernate-core/src/main/java/org/hibernate/engine/jdbc/proxy/BlobProxy.java

@@ -22,7 +22,7 @@
  * Manages aspects of representing {@link Blob} objects.
  *
  * @apiNote This class is not intended to be called directly by the application program.
- *          Instead, use {@link org.hibernate.Session#getLobHelper()}.
+ *          Instead, use {@link org.hibernate.Hibernate#getLobHelper()}.
  *
  * @see ClobProxy
  * @see LobCreator

hibernate-core/src/main/java/org/hibernate/engine/jdbc/proxy/ClobProxy.java

@@ -26,7 +26,7 @@
  * handling proxy invocations.  We use proxies here solely to avoid JDBC version incompatibilities.
  *
  * @apiNote This class is not intended to be called directly by the application program.
- *          Instead, use {@link org.hibernate.Session#getLobHelper()}.
+ *          Instead, use {@link org.hibernate.Hibernate#getLobHelper()}.
  *
  * @see NClobProxy
  * @see BlobProxy

hibernate-core/src/main/java/org/hibernate/engine/jdbc/proxy/NClobProxy.java

@@ -16,7 +16,7 @@
  * handling proxy invocations.  We use proxies here solely to avoid JDBC version incompatibilities.
  *
  * @apiNote This class is not intended to be called directly by the application program.
- *          Instead, use {@link org.hibernate.Session#getLobHelper()}.
+ *          Instead, use {@link org.hibernate.Hibernate#getLobHelper()}.
  *
  * @see ClobProxy
  * @see BlobProxy

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

@@ -26,8 +26,6 @@
 import org.hibernate.bytecode.enhance.spi.interceptor.EnhancementAsProxyLazinessInterceptor;
 import org.hibernate.collection.spi.PersistentCollection;
 import org.hibernate.engine.internal.PersistenceContexts;
-import org.hibernate.engine.jdbc.LobCreator;
-import org.hibernate.engine.jdbc.env.internal.NonContextualLobCreator;
 import org.hibernate.engine.jdbc.spi.JdbcCoordinator;
 import org.hibernate.engine.spi.ActionQueue;
 import org.hibernate.engine.spi.ActionQueue.TransactionCompletionProcesses;
@@ -86,16 +84,11 @@
 import org.hibernate.type.descriptor.WrapperOptions;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
-import java.io.Reader;
 import java.io.Serial;
 import java.io.Serializable;
-import java.sql.Blob;
-import java.sql.Clob;
 import java.sql.Connection;
-import java.sql.NClob;
 import java.sql.SQLException;
 import java.util.Collection;
 import java.util.HashMap;
@@ -2026,14 +2019,9 @@ public int getFetchBatchSize() {
 
 	@Override
 	public LobHelper getLobHelper() {
-		if ( lobHelper == null ) {
-			lobHelper = new LobHelperImpl();
-		}
-		return lobHelper;
+		return Hibernate.getLobHelper();
 	}
 
-	private transient LobHelperImpl lobHelper;
-
 	@Override
 	public void beforeTransactionCompletion() {
 		log.trace( "SessionImpl#beforeTransactionCompletion()" );
@@ -2067,45 +2055,6 @@ public void afterTransactionCompletion(boolean successful, boolean delayed) {
 		super.afterTransactionCompletion( successful, delayed );
 	}
 
-	private static class LobHelperImpl implements LobHelper {
-
-		@Override
-		public Blob createBlob(byte[] bytes) {
-			return lobCreator().createBlob( bytes );
-		}
-
-		private LobCreator lobCreator() {
-			// Always use NonContextualLobCreator.  If ContextualLobCreator is
-			// used both here and in WrapperOptions,
-			return NonContextualLobCreator.INSTANCE;
-		}
-
-		@Override
-		public Blob createBlob(InputStream stream, long length) {
-			return lobCreator().createBlob( stream, length );
-		}
-
-		@Override
-		public Clob createClob(String string) {
-			return lobCreator().createClob( string );
-		}
-
-		@Override
-		public Clob createClob(Reader reader, long length) {
-			return lobCreator().createClob( reader, length );
-		}
-
-		@Override
-		public NClob createNClob(String string) {
-			return lobCreator().createNClob( string );
-		}
-
-		@Override
-		public NClob createNClob(Reader reader, long length) {
-			return lobCreator().createNClob( reader, length );
-		}
-	}
-
 	private static class SharedSessionBuilderImpl
 			extends SessionFactoryImpl.SessionBuilderImpl
 			implements SharedSessionBuilder, SharedSessionCreationOptions {