binder) {
+ /**
+ * Create a mapping {@linkplain Binding binding} from a URL
+ *
+ * @param url The url from which to read the mapping information
+ * @param origin Description of the source from which the url came
+ * @param binder The JAXB binder to use
+ */
+ public static Binding fromUrl(
+ URL url,
+ Origin origin,
+ MappingBinder binder) {
+ JAXB_LOGGER.tracef( "Reading mapping document from URL: %s", origin.getName() );
+
try {
InputStream stream = url.openStream();
- return InputStreamXmlSource.doBind( binder, stream, getOrigin(), true );
+ return InputStreamXmlSource.fromStream( stream, origin, true, binder );
}
catch (UnknownHostException e) {
- throw new MappingNotFoundException( "Invalid URL", e, getOrigin() );
+ throw new MappingNotFoundException( "Invalid URL", e, origin );
}
catch (IOException e) {
- throw new MappingException( "Unable to open URL InputStream", e, getOrigin() );
+ throw new MappingException( "Unable to open URL InputStream", e, origin );
}
}
}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/XmlSources.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/XmlSources.java
deleted file mode 100644
index fdc653f33fdd..000000000000
--- a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/internal/XmlSources.java
+++ /dev/null
@@ -1,147 +0,0 @@
-/*
- * SPDX-License-Identifier: Apache-2.0
- * Copyright Red Hat Inc. and Hibernate Authors
- */
-package org.hibernate.boot.jaxb.internal;
-
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URL;
-import java.util.Enumeration;
-import java.util.function.Consumer;
-import java.util.jar.JarEntry;
-import java.util.jar.JarFile;
-import javax.xml.transform.dom.DOMSource;
-
-import org.hibernate.boot.MappingNotFoundException;
-import org.hibernate.boot.archive.spi.InputStreamAccess;
-import org.hibernate.boot.jaxb.Origin;
-import org.hibernate.boot.jaxb.SourceType;
-import org.hibernate.boot.jaxb.spi.XmlSource;
-import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
-
-import org.w3c.dom.Document;
-
-import static org.hibernate.boot.jaxb.JaxbLogger.JAXB_LOGGER;
-
-/**
- * Helper for building and handling {@link XmlSource} references.
- *
- * An {@code XmlSource} represents an XML document containing
- * O/R mapping metadata, either a JPA {@code orm.xml} file, or a
- * Hibernate {@code .hbm.xml} file.
- *
- * @author Steve Ebersole
- */
-public class XmlSources {
- /**
- * Create an {@link XmlSource} from a named resource
- */
- public static XmlSource fromResource(String resourceName, ClassLoaderService classLoaderService) {
- JAXB_LOGGER.tracef( "Reading mappings from resource: %s", resourceName );
-
- final Origin origin = new Origin( SourceType.RESOURCE, resourceName );
- final URL url = classLoaderService.locateResource( resourceName );
- if ( url == null ) {
- throw new MappingNotFoundException( origin );
- }
-
- return new UrlXmlSource( origin, url );
- }
-
- /**
- * Create an {@link XmlSource} from a URL
- */
- public static XmlSource fromUrl(URL url) {
- final String urlExternalForm = url.toExternalForm();
- JAXB_LOGGER.tracef( "Reading mapping document from URL: %s", urlExternalForm );
-
- final Origin origin = new Origin( SourceType.URL, urlExternalForm );
- return new UrlXmlSource( origin, url );
- }
-
- public static XmlSource fromFile(File file) {
- final String filePath = file.getPath();
- JAXB_LOGGER.tracef( "Reading mappings from file: %s", filePath );
-
- final Origin origin = new Origin( SourceType.FILE, filePath );
-
- if ( !file.exists() ) {
- throw new MappingNotFoundException( origin );
- }
-
- return new FileXmlSource( origin, file );
- }
-
- public static XmlSource fromCacheableFile(File file) {
- return fromCacheableFile( file, file.getParentFile() );
- }
-
- public static XmlSource fromCacheableFile(File file, File cacheableDir) {
- return fromCacheableFile( file, cacheableDir, false );
- }
-
- public static XmlSource fromCacheableFile(File file, boolean strict) {
- return fromCacheableFile( file, file.getParentFile(), strict );
- }
-
- public static XmlSource fromCacheableFile(File file, File cacheableDir, boolean strict) {
- final String filePath = file.getPath();
- JAXB_LOGGER.tracef( "Reading mappings from cacheable file: %s", filePath );
-
- final Origin origin = new Origin( SourceType.FILE, filePath );
- return new CacheableFileXmlSource( origin, file, cacheableDir, strict );
- }
-
- public static XmlSource fromStream(InputStreamAccess inputStreamAccess) {
- final String streamName = inputStreamAccess.getStreamName();
- JAXB_LOGGER.tracef( "Reading mappings from InputStreamAccess: %s", streamName );
-
- final Origin origin = new Origin( SourceType.INPUT_STREAM, streamName );
- return new InputStreamAccessXmlSource( origin, inputStreamAccess );
- }
-
- public static XmlSource fromStream(InputStream inputStream) {
- JAXB_LOGGER.trace( "reading mappings from InputStream" );
-
- final Origin origin = new Origin( SourceType.INPUT_STREAM, null );
- return new InputStreamXmlSource( origin, inputStream, false );
- }
-
- public static XmlSource fromDocument(Document document) {
- JAXB_LOGGER.trace( "reading mappings from DOM" );
- final Origin origin = new Origin( SourceType.DOM, Origin.UNKNOWN_FILE_PATH );
- return new JaxpSourceXmlSource( origin, new DOMSource( document ) );
- }
-
- /**
- * Read all {@code .hbm.xml} mappings from a jar file and pass them
- * to the given {@link Consumer}.
- *
- * Assumes that any file named {@code *.hbm.xml} is a mapping document.
- * This method does not support {@code orm.xml} files!
- *
- * @param jar a jar file
- * @param consumer a consumer of the resulting {@linkplain XmlSource XML sources}
- */
- public static void fromJar(File jar, Consumer consumer) {
- JAXB_LOGGER.tracef( "Seeking mapping documents in jar file: %s", jar.getName() );
-
- final Origin origin = new Origin( SourceType.JAR, jar.getAbsolutePath() );
-
- try ( JarFile jarFile = new JarFile(jar) ) {
- final Enumeration entries = jarFile.entries();
- while ( entries.hasMoreElements() ) {
- final JarEntry jarEntry = entries.nextElement();
- if ( jarEntry.getName().endsWith(".hbm.xml") ) {
- JAXB_LOGGER.tracef( "Found 'hbm.xml' mapping in jar: %s", jarEntry.getName() );
- consumer.accept( new JarFileEntryXmlSource( origin, jarFile, jarEntry ) );
- }
- }
- }
- catch ( IOException e ) {
- throw new MappingNotFoundException( e, origin );
- }
- }
-}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/JaxbBindableMappingDescriptor.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/JaxbBindableMappingDescriptor.java
index 2d74e3c3f272..831a700f35ed 100644
--- a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/JaxbBindableMappingDescriptor.java
+++ b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/JaxbBindableMappingDescriptor.java
@@ -4,6 +4,8 @@
*/
package org.hibernate.boot.jaxb.spi;
+import java.io.Serializable;
+
/**
* Common type for things that can get be bound to a {@link Binding} for
* mapping documents.
@@ -13,5 +15,5 @@
*
* @author Steve Ebersole
*/
-public interface JaxbBindableMappingDescriptor {
+public interface JaxbBindableMappingDescriptor extends Serializable {
}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/XmlSource.java b/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/XmlSource.java
deleted file mode 100644
index 799567bcb319..000000000000
--- a/hibernate-core/src/main/java/org/hibernate/boot/jaxb/spi/XmlSource.java
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * SPDX-License-Identifier: Apache-2.0
- * Copyright Red Hat Inc. and Hibernate Authors
- */
-package org.hibernate.boot.jaxb.spi;
-
-import org.hibernate.boot.jaxb.Origin;
-
-/**
- * An XML document containing O/R mapping metadata, either:
- *
- * - a JPA {@code orm.xml} file, or
- *
- a Hibernate {@code .hbm.xml} file.
- *
- *
- * @author Steve Ebersole
- */
-public abstract class XmlSource {
- private final Origin origin;
-
- protected XmlSource(Origin origin) {
- this.origin = origin;
- }
-
- public Origin getOrigin() {
- return origin;
- }
-
- public abstract Binding doBind(Binder binder);
-}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/process/internal/ScanningCoordinator.java b/hibernate-core/src/main/java/org/hibernate/boot/model/process/internal/ScanningCoordinator.java
index 76651ce90cfc..a6bc6eae4043 100644
--- a/hibernate-core/src/main/java/org/hibernate/boot/model/process/internal/ScanningCoordinator.java
+++ b/hibernate-core/src/main/java/org/hibernate/boot/model/process/internal/ScanningCoordinator.java
@@ -4,12 +4,6 @@
*/
package org.hibernate.boot.model.process.internal;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
import org.hibernate.boot.MappingException;
import org.hibernate.boot.archive.internal.StandardArchiveDescriptorFactory;
import org.hibernate.boot.archive.internal.UrlInputStreamAccess;
@@ -26,6 +20,8 @@
import org.hibernate.boot.internal.ClassLoaderAccessImpl;
import org.hibernate.boot.jaxb.Origin;
import org.hibernate.boot.jaxb.SourceType;
+import org.hibernate.boot.jaxb.internal.InputStreamAccessXmlSource;
+import org.hibernate.boot.jaxb.spi.Binding;
import org.hibernate.boot.model.convert.internal.ConverterDescriptors;
import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
import org.hibernate.boot.registry.classloading.spi.ClassLoadingException;
@@ -33,6 +29,12 @@
import org.hibernate.boot.spi.ClassLoaderAccess;
import org.hibernate.boot.spi.XmlMappingBinderAccess;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
import static org.hibernate.boot.archive.scan.internal.ScannerLogger.SCANNER_LOGGER;
/**
@@ -222,17 +224,27 @@ public void applyScanResultsToManagedResources(
if ( xmlMappingBinderAccess != null ) { // xml mapping is not disabled
for ( MappingFileDescriptor mappingFileDescriptor : scanResult.getLocatedMappingFiles() ) {
- managedResources.addXmlBinding( xmlMappingBinderAccess.bind( mappingFileDescriptor.getStreamAccess() ) );
+ //noinspection unchecked,rawtypes
+ managedResources.addXmlBinding( (Binding) InputStreamAccessXmlSource.fromStreamAccess(
+ mappingFileDescriptor.getStreamAccess(),
+ xmlMappingBinderAccess.getMappingBinder()
+ ) );
nonLocatedMappingFileNames.remove( mappingFileDescriptor.getName() );
}
for ( String name : nonLocatedMappingFileNames ) {
+ final Origin origin = new Origin( SourceType.RESOURCE, name );
final URL url = classLoaderService.locateResource( name );
if ( url == null ) {
- throw new MappingException( "Unable to resolve explicitly named mapping file: " + name,
- new Origin( SourceType.RESOURCE, name ) );
+ throw new MappingException( "Unable to resolve explicitly named mapping file: " + name, origin );
}
- managedResources.addXmlBinding( xmlMappingBinderAccess.bind( new UrlInputStreamAccess( url ) ) );
+ final UrlInputStreamAccess urlInputStreamAccess = new UrlInputStreamAccess( url );
+ //noinspection unchecked,rawtypes
+ managedResources.addXmlBinding( (Binding) InputStreamAccessXmlSource.fromStreamAccess(
+ urlInputStreamAccess,
+ origin,
+ xmlMappingBinderAccess.getMappingBinder()
+ ) );
}
}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/spi/XmlMappingBinderAccess.java b/hibernate-core/src/main/java/org/hibernate/boot/spi/XmlMappingBinderAccess.java
index 896f6d1ee9c6..41e2aa140bc8 100644
--- a/hibernate-core/src/main/java/org/hibernate/boot/spi/XmlMappingBinderAccess.java
+++ b/hibernate-core/src/main/java/org/hibernate/boot/spi/XmlMappingBinderAccess.java
@@ -4,37 +4,31 @@
*/
package org.hibernate.boot.spi;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URL;
-import java.util.function.Function;
-
-import org.hibernate.boot.MappingNotFoundException;
import org.hibernate.boot.archive.spi.InputStreamAccess;
-import org.hibernate.boot.jaxb.Origin;
-import org.hibernate.boot.jaxb.SourceType;
import org.hibernate.boot.jaxb.internal.FileXmlSource;
+import org.hibernate.boot.jaxb.internal.InputStreamAccessXmlSource;
import org.hibernate.boot.jaxb.internal.InputStreamXmlSource;
import org.hibernate.boot.jaxb.internal.MappingBinder;
import org.hibernate.boot.jaxb.internal.UrlXmlSource;
-import org.hibernate.boot.jaxb.spi.JaxbBindableMappingDescriptor;
import org.hibernate.boot.jaxb.spi.Binding;
+import org.hibernate.boot.jaxb.spi.JaxbBindableMappingDescriptor;
import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
import org.hibernate.service.ServiceRegistry;
-import org.jboss.logging.Logger;
+import java.io.File;
+import java.io.InputStream;
+import java.net.URL;
+import java.util.function.Function;
/**
- * Holds the XML binder and a classloader used for binding mappings.
+ * Holds the XML binder and a classloader used for binding mappings, as well
+ * as access to methods to perform binding of sources of mapping XML.
*
* @apiNote This class is very poorly named.
*
* @author Steve Ebersole
*/
public class XmlMappingBinderAccess {
- private static final Logger LOG = Logger.getLogger( XmlMappingBinderAccess.class );
-
private final ClassLoaderService classLoaderService;
private final MappingBinder mappingBinder;
@@ -54,65 +48,51 @@ public MappingBinder getMappingBinder() {
/**
* Create a {@linkplain Binding binding} from a named URL resource
+ *
+ * @see UrlXmlSource#fromUrl
*/
public Binding bind(String resource) {
- LOG.tracef( "Reading mappings from resource: %s", resource );
- final Origin origin = new Origin( SourceType.RESOURCE, resource );
- final URL url = classLoaderService.locateResource( resource );
- if ( url == null ) {
- throw new MappingNotFoundException( origin );
- }
- return new UrlXmlSource( origin, url ).doBind( getMappingBinder() );
+ //noinspection unchecked,rawtypes
+ return (Binding) UrlXmlSource.fromResource( resource, classLoaderService, getMappingBinder() );
}
/**
* Create a {@linkplain Binding binding} from a File reference
+ *
+ * @see FileXmlSource#fromFile
*/
public Binding bind(File file) {
- final Origin origin = new Origin( SourceType.FILE, file.getPath() );
- LOG.tracef( "Reading mappings from file: %s", origin.getName() );
- if ( !file.exists() ) {
- throw new MappingNotFoundException( origin );
- }
- return new FileXmlSource( origin, file ).doBind( getMappingBinder() );
+ //noinspection unchecked,rawtypes
+ return (Binding) FileXmlSource.fromFile( file, getMappingBinder() );
}
/**
* Create a {@linkplain Binding binding} from an input stream
+ *
+ * @see InputStreamAccessXmlSource#fromStreamAccess
*/
public Binding bind(InputStreamAccess xmlInputStreamAccess) {
- LOG.tracef( "Reading mappings from InputStreamAccess: %s", xmlInputStreamAccess.getStreamName() );
- final Origin origin = new Origin( SourceType.INPUT_STREAM, xmlInputStreamAccess.getStreamName() );
- final InputStream xmlInputStream = xmlInputStreamAccess.accessInputStream();
- try {
- return new InputStreamXmlSource( origin, xmlInputStream, false ).doBind( mappingBinder );
- }
- finally {
- try {
- xmlInputStream.close();
- }
- catch (IOException e) {
- LOG.debugf( "Unable to close InputStream obtained from InputStreamAccess : %s", xmlInputStreamAccess.getStreamName() );
- }
- }
+ //noinspection unchecked,rawtypes
+ return (Binding) InputStreamAccessXmlSource.fromStreamAccess( xmlInputStreamAccess, getMappingBinder() );
}
/**
* Create a {@linkplain Binding binding} from an input stream
+ *
+ * @see InputStreamXmlSource#fromStream
*/
public Binding bind(InputStream xmlInputStream) {
- LOG.trace( "Reading mappings from InputStream" );
- final Origin origin = new Origin( SourceType.INPUT_STREAM, null );
- return new InputStreamXmlSource( origin, xmlInputStream, false ).doBind( getMappingBinder() );
+ //noinspection unchecked,rawtypes
+ return (Binding) InputStreamXmlSource.fromStream( xmlInputStream, getMappingBinder() );
}
/**
* Create a {@linkplain Binding binding} from a URL
+ *
+ * @see UrlXmlSource#fromUrl
*/
public Binding bind(URL url) {
- final String urlExternalForm = url.toExternalForm();
- LOG.tracef( "Reading mapping document from URL: %s", urlExternalForm );
- final Origin origin = new Origin( SourceType.URL, urlExternalForm );
- return new UrlXmlSource( origin, url ).doBind( getMappingBinder() );
+ //noinspection unchecked,rawtypes
+ return (Binding) UrlXmlSource.fromUrl( url, getMappingBinder() );
}
}
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/annotations/xml/ejb3/PreParsedOrmXmlTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/annotations/xml/ejb3/PreParsedOrmXmlTest.java
index b6c0e7f080c7..7837cc580d9f 100644
--- a/hibernate-core/src/test/java/org/hibernate/orm/test/annotations/xml/ejb3/PreParsedOrmXmlTest.java
+++ b/hibernate-core/src/test/java/org/hibernate/orm/test/annotations/xml/ejb3/PreParsedOrmXmlTest.java
@@ -8,6 +8,7 @@
import java.io.InputStream;
import java.io.UncheckedIOException;
+import org.hibernate.boot.jaxb.internal.InputStreamXmlSource;
import org.hibernate.boot.jaxb.spi.Binding;
import org.hibernate.boot.registry.BootstrapServiceRegistryBuilder;
import org.hibernate.cfg.Configuration;
@@ -38,7 +39,7 @@ protected void addMappings(Configuration configuration) {
super.addMappings( configuration );
try (InputStream xmlStream = Thread.currentThread().getContextClassLoader()
.getResourceAsStream( "org/hibernate/orm/test/annotations/xml/ejb3/pre-parsed-orm.xml" )) {
- Binding parsed = configuration.getXmlMappingBinderAccess().bind( xmlStream );
+ Binding parsed = InputStreamXmlSource.fromStream( xmlStream, configuration.getXmlMappingBinderAccess().getMappingBinder() );
configuration.addXmlMapping( parsed );
}
catch (IOException e) {
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScanningCoordinatorTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScanningCoordinatorTest.java
index 2e5b4d75c92c..96282cf8fd79 100644
--- a/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScanningCoordinatorTest.java
+++ b/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScanningCoordinatorTest.java
@@ -23,6 +23,7 @@
import org.hibernate.boot.archive.scan.spi.ScanResult;
import org.hibernate.boot.archive.scan.spi.Scanner;
import org.hibernate.boot.archive.spi.InputStreamAccess;
+import org.hibernate.boot.jaxb.internal.MappingBinder;
import org.hibernate.boot.spi.ClassmateContext;
import org.hibernate.boot.model.convert.spi.ConverterDescriptor;
import org.hibernate.boot.model.process.internal.ManagedResourcesImpl;
@@ -69,6 +70,7 @@ public class ScanningCoordinatorTest {
private BootstrapContext bootstrapContext = Mockito.mock( BootstrapContext.class );
private ClassmateContext classmateContext = new ClassmateContext();
private XmlMappingBinderAccess xmlMappingBinderAccess = Mockito.mock( XmlMappingBinderAccess.class );
+ private MappingBinder mappingBinder = Mockito.mock( MappingBinder.class );
private MetadataBuildingOptions metadataBuildingOptions = Mockito.mock( MetadataBuildingOptions.class );
private ScanEnvironment scanEnvironment = Mockito.mock( ScanEnvironment.class );
@@ -92,6 +94,8 @@ public void init() {
when( serviceRegistry.requireService( ClassLoaderService.class ) ).thenReturn( classLoaderService );
when( bootstrapContext.getClassLoaderService() ).thenReturn( classLoaderService );
+ when( xmlMappingBinderAccess.getMappingBinder() ).thenReturn( mappingBinder );
+
when( metadataBuildingOptions.isXmlMappingEnabled() ).thenReturn( true );
when( scanEnvironment.getExplicitlyListedClassNames() ).thenReturn( List.of( "a.b.C" ) );