Skip to content

HBX-3248: Use the MappingExporter in the Maven hbm2orm Mojo #5838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koentsje merged 1 commit into from
Dec 2, 2025
Merged

HBX-3248: Use the MappingExporter in the Maven hbm2orm Mojo #5838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 5 additions & 131 deletions maven/src/main/java/org/hibernate/tool/maven/TransformHbmMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@
import static org.apache.maven.plugins.annotations.LifecyclePhase.GENERATE_RESOURCES;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.Serial;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
Expand All @@ -36,24 +33,8 @@
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.hibernate.boot.MetadataSources;
import org.hibernate.boot.jaxb.Origin;
import org.hibernate.boot.jaxb.SourceType;
import org.hibernate.boot.jaxb.hbm.spi.JaxbHbmHibernateMapping;
import org.hibernate.boot.jaxb.hbm.transform.HbmXmlTransformer;
import org.hibernate.boot.jaxb.hbm.transform.UnsupportedFeatureHandling;
import org.hibernate.boot.jaxb.internal.MappingBinder;
import org.hibernate.boot.jaxb.mapping.spi.JaxbEntityMappingsImpl;
import org.hibernate.boot.jaxb.spi.Binding;
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.boot.spi.MetadataImplementor;
import org.hibernate.cfg.JdbcSettings;
import org.hibernate.dialect.H2Dialect;
import org.hibernate.service.ServiceRegistry;

import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Marshaller;
import org.hibernate.tool.api.xml.XMLPrettyPrinter;
import org.hibernate.tool.internal.export.mapping.MappingExporter;

@Mojo(
name = "hbm2orm",
Expand All @@ -76,105 +57,16 @@ public void execute() {
try {
Thread.currentThread().setContextClassLoader(createClassLoader(original));
getLog().info("Starting " + this.getClass().getSimpleName() + "...");
MappingBinder mappingBinder = new MappingBinder(
MappingBinder.class.getClassLoader()::getResourceAsStream,
UnsupportedFeatureHandling.ERROR);
List<File> hbmFiles = getHbmFiles(inputFolder);
List<Binding<JaxbHbmHibernateMapping>> hbmMappings = getHbmMappings(hbmFiles, mappingBinder);
performTransformation(hbmMappings, mappingBinder, createServiceRegistry());
MappingExporter mappingExporter = new MappingExporter();
mappingExporter.setHbmFiles(getHbmFiles(inputFolder));
mappingExporter.setFormatResult(format);
mappingExporter.start();
getLog().info("Finished " + this.getClass().getSimpleName() + "!");
} finally {
Thread.currentThread().setContextClassLoader(original);
}
}

private ServiceRegistry createServiceRegistry() {
StandardServiceRegistryBuilder ssrb = new StandardServiceRegistryBuilder();
ssrb.clearSettings();
ssrb.applySetting(JdbcSettings.ALLOW_METADATA_ON_BOOT, false);
// Choose the H2 dialect by default, make this configurable
ssrb.applySetting(JdbcSettings.DIALECT, H2Dialect.class.getName());
return ssrb.build();
}

private void performTransformation(
List<Binding<JaxbHbmHibernateMapping>> hbmBindings,
MappingBinder mappingBinder,
ServiceRegistry serviceRegistry) {
Marshaller marshaller = createMarshaller(mappingBinder);
MetadataSources metadataSources = new MetadataSources( serviceRegistry );
hbmBindings.forEach( metadataSources::addHbmXmlBinding );
List<Binding<JaxbEntityMappingsImpl>> transformedBindings = HbmXmlTransformer.transform(
hbmBindings,
(MetadataImplementor) metadataSources.buildMetadata(),
UnsupportedFeatureHandling.ERROR
);
for (int i = 0; i < hbmBindings.size(); i++) {
Binding<JaxbHbmHibernateMapping> hbmBinding = hbmBindings.get( i );
Binding<JaxbEntityMappingsImpl> transformedBinding = transformedBindings.get( i );

HbmXmlOrigin origin = (HbmXmlOrigin)hbmBinding.getOrigin();
File hbmXmlFile = origin.getHbmXmlFile();

marshall(marshaller, transformedBinding.getRoot(), hbmXmlFile);
}
}

private List<Binding<JaxbHbmHibernateMapping>> getHbmMappings(List<File> hbmXmlFiles, MappingBinder mappingBinder) {
List<Binding<JaxbHbmHibernateMapping>> result = new ArrayList<>();
hbmXmlFiles.forEach((hbmXmlFile) -> {
final String fullPath = hbmXmlFile.getAbsolutePath();
getLog().info("Adding file: '" + fullPath + "' to the list to be transformed.");
Origin origin = new HbmXmlOrigin( hbmXmlFile );
Binding<JaxbHbmHibernateMapping> binding = bindMapping( mappingBinder, hbmXmlFile, origin );
result.add(binding);
});
return result;
}

private void marshall(Marshaller marshaller, JaxbEntityMappingsImpl mappings, File hbmXmlFile) {
File mappingXmlFile = new File(
hbmXmlFile.getParentFile(),
hbmXmlFile.getName().replace(".hbm.xml", ".mapping.xml"));
getLog().info("Marshalling file: " + hbmXmlFile.getAbsolutePath() + " into " + mappingXmlFile.getAbsolutePath());
try {
marshaller.marshal( mappings, mappingXmlFile );
if (format) {
XMLPrettyPrinter.prettyPrintFile(mappingXmlFile);
}
}
catch (JAXBException e) {
throw new RuntimeException(
"Unable to marshall mapping JAXB representation to file `" + mappingXmlFile.getAbsolutePath() + "`",
e);
}
catch (IOException e) {
throw new RuntimeException(
"Unable to format XML file `" + mappingXmlFile.getAbsolutePath() + "`",
e);
}
}

private Binding<JaxbHbmHibernateMapping> bindMapping(
MappingBinder mappingBinder, File hbmXmlFile, Origin origin) {
try ( final FileInputStream fileStream = new FileInputStream(hbmXmlFile) ) {
return mappingBinder.bind( fileStream, origin );
}
catch (IOException e) {
getLog().warn( "Unable to open hbm.xml file `" + hbmXmlFile.getAbsolutePath() + "` for transformation", e );
return null;
}
}

private Marshaller createMarshaller(MappingBinder mappingBinder) {
try {
return mappingBinder.mappingJaxbContext().createMarshaller();
}
catch (JAXBException e) {
throw new RuntimeException("Unable to create JAXB Marshaller", e);
}
}

private List<File> getHbmFiles(File f) {
List<File> result = new ArrayList<>();
if (f.isFile()) {
Expand Down Expand Up @@ -202,22 +94,4 @@ private ClassLoader createClassLoader(ClassLoader parent) {
return new URLClassLoader(urls.toArray(new URL[0]), parent);
}

private static class HbmXmlOrigin extends Origin {

@Serial
private static final long serialVersionUID = 1L;

private final File hbmXmlFile;

public HbmXmlOrigin(File hbmXmlFile) {
super( SourceType.FILE, hbmXmlFile.getAbsolutePath() );
this.hbmXmlFile = hbmXmlFile;
}

public File getHbmXmlFile() {
return hbmXmlFile;
}

}

}