HHH-18455 - Change Binder.bind(InputStream, Origin) method signature to bind(InputStreamAccess, Origin) to allow repeatable access to the InputStream, needed for strict Jpa XML validation

jrenaat · jrenaat · commit 15b9357fe529 · 2025-01-03T23:41:44.000+01:00
Signed-off-by: Jan Schatteman &lt;jschatte@redhat.com&gt;
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/archive/internal/RepeatableInputStreamAccess.java b/hibernate-core/src/main/java/org/hibernate/boot/archive/internal/RepeatableInputStreamAccess.java
@@ -0,0 +1,43 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.boot.archive.internal;
+
+
+import org.hibernate.HibernateException;
+import org.hibernate.boot.archive.spi.InputStreamAccess;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * @author Jan Schatteman
+ */
+public class RepeatableInputStreamAccess implements InputStreamAccess {
+
+	private final String resourceName;
+	private byte[] bytes = new byte[0];
+
+	public RepeatableInputStreamAccess(String resourceName, InputStream inputStream) {
+		this.resourceName = resourceName;
+		try {
+			bytes = inputStream.readAllBytes();
+		}
+		catch (IOException | OutOfMemoryError e) {
+			throw new HibernateException( "Could not read resource " + resourceName, e );
+		}
+	}
+
+	@Override
+	public String getStreamName() {
+		return resourceName;
+	}
+
+	@Override
+	public InputStream accessInputStream() {
+		return new ByteArrayInputStream( bytes );
+	}
+
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/AbstractBinder.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/AbstractBinder.java
@@ -15,6 +15,7 @@
 
 import org.hibernate.boot.MappingException;
 import org.hibernate.boot.ResourceStreamLocator;
+import org.hibernate.boot.archive.spi.InputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.internal.stax.BufferedXMLEventReader;
 import org.hibernate.boot.jaxb.internal.stax.LocalXmlResourceResolver;
@@ -43,8 +44,8 @@ protected AbstractBinder(ResourceStreamLocator resourceStreamLocator) {
 	public abstract boolean isValidationEnabled();
 
 	@Override
-	public <X extends T> Binding<X> bind(InputStream stream, Origin origin) {
-		final XMLEventReader eventReader = createReader( stream, origin );
+	public <X extends T> Binding<X> bind(InputStreamAccess stream, Origin origin) {
+		final XMLEventReader eventReader = createReader( stream.accessInputStream(), origin );
 		try {
 			return doBind( eventReader, origin );
 		}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/InputStreamAccessXmlSource.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/InputStreamAccessXmlSource.java
@@ -27,8 +27,6 @@ public Binding doBind(Binder binder) {
 	}
 
 	public static Binding doBind(Binder binder, InputStreamAccess inputStreamAccess, Origin origin) {
-		return inputStreamAccess.fromStream(
-				inputStream -> binder.bind( inputStream, origin )
-		);
+		return binder.bind( inputStreamAccess, origin ) ;
 	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/InputStreamXmlSource.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/InputStreamXmlSource.java
@@ -8,6 +8,7 @@
 import java.io.InputStream;
 
 import org.hibernate.boot.InvalidMappingException;
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.spi.Binder;
 import org.hibernate.boot.jaxb.spi.Binding;
@@ -38,7 +39,7 @@ public Binding doBind(Binder binder) {
 
 	public static Binding doBind(Binder binder, InputStream inputStream, Origin origin, boolean autoClose) {
 		try {
-			return binder.bind( inputStream, origin );
+			return binder.bind( new RepeatableInputStreamAccess( origin.getName(), inputStream), origin );
 		}
 		catch ( Exception e ) {
 			throw new InvalidMappingException( origin, e );
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/Binder.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/Binder.java
@@ -4,9 +4,9 @@
  */
 package org.hibernate.boot.jaxb.spi;
 
-import java.io.InputStream;
 import javax.xml.transform.Source;
 
+import org.hibernate.boot.archive.spi.InputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 
 /**
@@ -31,5 +31,14 @@ public interface Binder<T> {
 	 * @param origin The descriptor of the stream origin
 	 * @return The bound JAXB model
 	 */
-	<X extends T> Binding<X> bind(InputStream stream, Origin origin);
+//	<X extends T> Binding<X> bind(InputStream stream, Origin origin);
+
+	/**
+	 * Bind from an InputStreamAccess
+	 *
+	 * @param streamAccess The {@link InputStreamAccess} providing access to the stream containing XML
+	 * @param origin The descriptor of the stream origin
+	 * @return The bound JAXB model
+	 */
+	<X extends T> Binding<X> bind(InputStreamAccess streamAccess, Origin origin);
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/process/spi/MetadataBuildingProcess.java b/hibernate-core/src/main/java/org/hibernate/boot/model/process/spi/MetadataBuildingProcess.java
@@ -23,6 +23,7 @@
 
 import org.hibernate.Internal;
 import org.hibernate.boot.MetadataSources;
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.internal.InFlightMetadataCollectorImpl;
 import org.hibernate.boot.internal.MetadataBuildingContextRootImpl;
 import org.hibernate.boot.internal.RootMappingDefaults;
@@ -571,7 +572,7 @@ public void contributeManagedClass(ClassDetails classDetails) {
 		@Override
 		public void contributeBinding(InputStream xmlStream) {
 			final Origin origin = new Origin( SourceType.INPUT_STREAM, null );
-			final Binding<JaxbBindableMappingDescriptor> binding = mappingBinder.bind( xmlStream, origin );
+			final Binding<JaxbBindableMappingDescriptor> binding = mappingBinder.bind( new RepeatableInputStreamAccess( SourceType.INPUT_STREAM.toString(), xmlStream ), origin );
 
 			final JaxbBindableMappingDescriptor bindingRoot = binding.getRoot();
 			if ( bindingRoot instanceof JaxbHbmHibernateMapping ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/source/internal/annotations/AdditionalManagedResourcesImpl.java b/hibernate-core/src/main/java/org/hibernate/boot/model/source/internal/annotations/AdditionalManagedResourcesImpl.java
@@ -10,6 +10,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.SourceType;
 import org.hibernate.boot.jaxb.internal.MappingBinder;
@@ -144,7 +145,7 @@ public Builder addXmlMappings(String resourceName) {
 
 		public Builder addXmlMappings(String resourceName, Origin origin) {
 			return addXmlBinding( mappingBinder.bind(
-					Builder.class.getClassLoader().getResourceAsStream( resourceName ),
+					new RepeatableInputStreamAccess( resourceName,  Builder.class.getClassLoader().getResourceAsStream( resourceName )),
 					origin
 			) );
 		}
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/boot/jaxb/mapping/PartialJaxbTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/boot/jaxb/mapping/PartialJaxbTests.java
@@ -4,6 +4,7 @@
  */
 package org.hibernate.orm.test.boot.jaxb.mapping;
 
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.SourceType;
 import org.hibernate.boot.jaxb.internal.MappingBinder;
@@ -27,10 +28,11 @@ public class PartialJaxbTests {
 	public void cachingTest(ServiceRegistryScope scope) {
 		final MappingBinder mappingBinder = new MappingBinder( scope.getRegistry() );
 		scope.withService( ClassLoaderService.class, (cls) -> {
+			final String resourceLocation = "xml/jaxb/mapping/partial/caching.xml";
 			//noinspection unchecked
 			final Binding<JaxbEntityMappingsImpl> binding = mappingBinder.bind(
-					cls.locateResourceStream( "xml/jaxb/mapping/partial/caching.xml" ),
-					new Origin( SourceType.RESOURCE, "xml/jaxb/mapping/partial/caching.xml" )
+					new RepeatableInputStreamAccess( resourceLocation, cls.locateResourceStream( resourceLocation )),
+					new Origin( SourceType.RESOURCE, resourceLocation )
 			);
 
 			final JaxbEntityMappingsImpl entityMappings = binding.getRoot();
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/boot/models/XmlHelper.java b/hibernate-core/src/test/java/org/hibernate/orm/test/boot/models/XmlHelper.java
@@ -9,6 +9,7 @@
 import java.net.URL;
 
 import org.hibernate.boot.ResourceStreamLocator;
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.SourceType;
 import org.hibernate.boot.jaxb.internal.MappingBinder;
@@ -28,7 +29,7 @@ public static JaxbEntityMappingsImpl loadMapping(String resourceName, ClassLoadi
 		final ResourceStreamLocatorImpl resourceStreamLocator = new ResourceStreamLocatorImpl( classLoadingAccess );
 		final MappingBinder mappingBinder = new MappingBinder( resourceStreamLocator, NON_VALIDATING );
 		final Binding<JaxbBindableMappingDescriptor> binding = mappingBinder.bind(
-				resourceStreamLocator.locateResourceStream( resourceName ),
+				new RepeatableInputStreamAccess( resourceName, resourceStreamLocator.locateResourceStream( resourceName )),
 				new Origin( SourceType.RESOURCE, resourceName )
 		);
 		return (JaxbEntityMappingsImpl) binding.getRoot();
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/internal/util/xml/XMLMappingHelper.java b/hibernate-core/src/test/java/org/hibernate/orm/test/internal/util/xml/XMLMappingHelper.java
@@ -7,6 +7,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.SourceType;
 import org.hibernate.boot.jaxb.internal.MappingBinder;
@@ -35,7 +36,7 @@ public JaxbEntityMappingsImpl readOrmXmlMappings(String name) throws IOException
 	public JaxbEntityMappingsImpl readOrmXmlMappings(InputStream is, String name) {
 		try {
 			Assert.assertNotNull( "Resource not found: " + name, is );
-			Binding<?> binding = binder.bind( is, new Origin( SourceType.JAR, name ) );
+			Binding<?> binding = binder.bind( new RepeatableInputStreamAccess( name, is), new Origin( SourceType.JAR, name ) );
 			return (JaxbEntityMappingsImpl) binding.getRoot();
 		}
 		catch (RuntimeException e) {
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/mapping/contributed/ContributorImpl.java b/hibernate-core/src/test/java/org/hibernate/orm/test/mapping/contributed/ContributorImpl.java
@@ -7,6 +7,7 @@
 import java.io.InputStream;
 
 import org.hibernate.boot.ResourceStreamLocator;
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.SourceType;
 import org.hibernate.boot.jaxb.hbm.spi.JaxbHbmHibernateMapping;
@@ -36,16 +37,17 @@ public void contribute(
 			InFlightMetadataCollector metadata,
 			ResourceStreamLocator resourceStreamLocator,
 			MetadataBuildingContext buildingContext) {
+		final String resourceLocation = "org/hibernate/orm/test/mapping/contributed/BasicContributorTests.hbm.xml";
 		final Origin origin = new Origin( SourceType.OTHER, "test" );
 
 		final ClassLoaderService classLoaderService = buildingContext.getBootstrapContext()
 				.getServiceRegistry()
 				.getService( ClassLoaderService.class );
 		final InputStream inputStream = classLoaderService.locateResourceStream(
-				"org/hibernate/orm/test/mapping/contributed/BasicContributorTests.hbm.xml" );
+				resourceLocation );
 
 		final MappingBinder mappingBinder = new MappingBinder( buildingContext.getBootstrapContext().getServiceRegistry() );
-		final Binding<JaxbHbmHibernateMapping> jaxbBinding = mappingBinder.bind( inputStream, origin );
+		final Binding<JaxbHbmHibernateMapping> jaxbBinding = mappingBinder.bind( new RepeatableInputStreamAccess( resourceLocation, inputStream), origin );
 		final JaxbHbmHibernateMapping jaxbRoot = jaxbBinding.getRoot();
 
 		contributions.contributeBinding( jaxbRoot );
diff --git a/tooling/hibernate-gradle-plugin/src/main/java/org/hibernate/orm/tooling/gradle/misc/TransformHbmXmlTask.java b/tooling/hibernate-gradle-plugin/src/main/java/org/hibernate/orm/tooling/gradle/misc/TransformHbmXmlTask.java
@@ -22,6 +22,7 @@
 import org.gradle.api.tasks.TaskAction;
 
 import org.hibernate.boot.MetadataSources;
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.hbm.spi.JaxbHbmHibernateMapping;
 import org.hibernate.boot.jaxb.hbm.transform.HbmXmlTransformer;
@@ -211,7 +212,7 @@ private void performTransformation(
 
 	private Binding<JaxbHbmHibernateMapping> bindMapping(MappingBinder mappingBinder, File hbmXmlFile, Origin origin) {
 		try ( final FileInputStream fileStream = new FileInputStream( hbmXmlFile ) ) {
-			return mappingBinder.bind( fileStream, origin );
+			return mappingBinder.bind( new RepeatableInputStreamAccess( hbmXmlFile.getPath(), fileStream), origin );
 		}
 		catch (IOException e) {
 			getProject().getLogger()
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/processor/xml/JpaDescriptorParser.java b/tooling/metamodel-generator/src/main/java/org/hibernate/processor/xml/JpaDescriptorParser.java
@@ -23,6 +23,7 @@
 import javax.tools.Diagnostic;
 
 import org.hibernate.MappingException;
+import org.hibernate.boot.archive.internal.RepeatableInputStreamAccess;
 import org.hibernate.boot.jaxb.Origin;
 import org.hibernate.boot.jaxb.SourceType;
 import org.hibernate.boot.jaxb.configuration.spi.JaxbPersistenceImpl;
@@ -129,7 +130,7 @@ private Collection<String> determineMappingFileNames() {
 
 		try {
 			final Binding<JaxbPersistenceImpl> binding = configurationBinder.bind(
-					stream,
+					new RepeatableInputStreamAccess( persistenceXmlLocation, stream ),
 					new Origin( SourceType.RESOURCE, persistenceXmlLocation )
 			);
 			persistence = binding.getRoot();
@@ -165,7 +166,7 @@ private void loadEntityMappings(Collection<String> mappingFileNames) {
 			}
 			try {
 				final Binding<JaxbBindableMappingDescriptor> binding = mappingBinder.bind(
-						inputStream,
+						new RepeatableInputStreamAccess( mappingFile, inputStream),
 						new Origin( SourceType.RESOURCE, mappingFile )
 				);
 				if ( binding != null ) {

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,6 @@ public Binding doBind(Binder binder) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`public static Binding doBind(Binder binder, InputStreamAccess inputStreamAccess, Origin origin) {`
`30`		`- return inputStreamAccess.fromStream(`
`31`		`- inputStream -> binder.bind( inputStream, origin )`
`32`		`- );`
	`30`	`+ return binder.bind( inputStreamAccess, origin ) ;`
`33`	`31`	`}`
`34`	`32`	`}`