Igor Kromin |   Consultant. Coder. Blogger. Tinkerer. Gamer.

I've been trying to get the maven-jaxb2-plugin to generate a JAXB jar out of XSDs that are stored inside a dependency that I have no control of. This was quite doable for a simple, single XSD Maven dependency that didn't import any other schemas, but when dealing with a more complex schema that did import multiple other XSDs from the same dependency jar, it didn't "just" work. After trying many approaches I found a solution however.

First lets see what the structure of the Maven dependency jar file looked like. This was the jar that contained XSDs that I was interested in.
 Jar Structure
my-dependency.jar
\-- org
\-- some
\-- package
\
|-- ns1.xsd
|-- ns2.xsd
|-- ns3.xsd


So the 'ns1.xsd' was the primary file for the schema. Inside it contained two imports, for both the other XSD files in the same package. That all looked like...
 XSD
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://mynamespace1" ...>
<xs:import namespace="http://mynamespace2" schemaLocation="ns2.xsd"/>
<xs:import namespace="http://mynamespace3" schemaLocation="ns3.xsd"/>
...


Simply referencing the schema as a Maven artifact either with or without using a catalog file produced the following error:
 Error
[ERROR] Error while parsing schema(s).Location [ maven:mygroup1:my-dependency:jar::!/org/some/package/ns1.xsd{30,534}].
org.xml.sax.SAXParseException; systemId: maven:mygroup1:my-dependency:jar::!/org/some/package/ns1.xsd; lineNumber: 30; columnNumber: 534; unknown protocol: maven
at com.sun.xml.xsom.impl.parser.NGCCRuntimeEx.resolveRelativeURL(NGCCRuntimeEx.java:229)
at com.sun.xml.xsom.impl.parser.NGCCRuntimeEx.importSchema(NGCCRuntimeEx.java:256)




After trying a myriad of different catalog REWRITE_SYSTEM combinations, I was ready to give up and just extract the XSDs to my project, but then I came across this which resolved all the errors that XJC was throwing at me. Incidentally when running as 'mvn -X' I could see that my rewrites were working and both ns2.xsd and ns3.xsd were being resolved to the correct Maven dependency, but for some reason they were still not being picked up.

The solution was to use a URL reference to the primary XSD and then in my catalog file to rewrite that URL to the Maven dependency location.

So my maven-jaxb2-plugin configuration contained the following (the URL didn't have to resolve to any public facing URL, it was just a placeholder in that case)...
 pom.xml
<strict>false</strict>
<catalog>src/main/resources/catalog.cat</catalog>
<schemas>
<schema>
<url>http://someurl/schema/ns1.xsd</url>
</schema>
</schemas>


The catalog file contained a single line that rewrote the URL above to the Maven dependency I was using. Note that the rewriting is done up to the package that the XSDs reside in.
 catalog.cat
REWRITE_SYSTEM "http://someurl/schema/" "maven:mygroup1:my-dependency:jar::!/org/some/package"



That was it! It worked like a charm! The only other place I had to change was in my binding.xml file. Because I had some property renaming to be do, I couldn't reference schemas by their file names and instead had to use the URL from above. For example...
 binding.xml
<jaxb:bindings schemaLocation="http://someurl/schema/ns2.xsd">
<jaxb:bindings node="//xs:attributeGroup[@name='attrGroup1']/xs:attribute[@name='attr1']">
<jaxb:property name="attr1_renamed"/>
</jaxb:bindings>
</jaxb:bindings>


-i

Please leave your comments or feedback below!
comments powered by Disqus
Other posts you may like...
Hi! You can search my blog here ⤵
Or browse the recent top tags...

Recent Blog Posts

How to stop macOS adding shadows to window screenshots

How to run Atari Lynx games on the SNES Classic Mini

Maven dependency scopes with relation to WAR file packaging and the WEB-INF/lib directory

Hacking the Sonoff B1 WiFi LED bulb to run custom firmware

What does an idle WebLogic server run on the hour to cause a CPU spike

How to open the Sonoff B1 wifi LED bulb to access its internal circuitry

Australian release SNES mini classic unboxing and a quick play through

Troubleshooting high CPU usage for JVM threads

How to fix WebLogic high CPU usage due to a corrupted file store

Mini review of the Sonoff B1 WiFi light bulb

Recent Galleries

Atari Lynx repair - Part 5 - McWill LED screen mod installation

Atari Lynx repair - Part 4 - screen cover replacement

Atari Lynx repair - Part 2 - re-capping the motherboard

Atari Lynx repair - Part 3 - broken speaker replacement

Atari Lynx repair - Part 1 - introduction and case disassembly

Building a custom Atari Lynx game box storage shelf unit in a day

Protecting old Atari Lynx game boxes with snug fit plastic sleeves

Monument Valley 2 is released and does not disappoint

Space Food - Chocolate Ice Cream with Chocolate Chips

Legeod Star Wars AT-DP kit

Blogs and Friends

Matt Moores Blog
Georgi's FlatPress Guide
Perplexing Permutations
The Security Sleuth
Ilia Rogatchevski
Travelling Fairy

Blog Activity

Blog Activity