ClassPathJaxb2TypeScanner which scans packagesToScan for Jaxb2Marshaller does not scan for @XmlRegistry annotation [SPR-10714]

[spring-projects-issues]

Sebastiaan van Erk opened SPR-10714 and commented

The ClassPathJaxb2TypeScanner class is a helper class for Jaxb2Marshaller that scans given packages for classes marked with JAXB2 annotations. However, it does not scan for the @XmlRegistry annotation, which is used on ObjectFactory classes.

In some cases, the ObjectFactory classes contain crucial annotations for JAXB such as the following:

@XmlElementDecl(namespace = "http://www.example.com/schemas/mymodule", 
    name = "myElement", substitutionHeadNamespace = "http://www.example.com/schemas/core", 
    substitutionHeadName = "myBaseElement")

Without have scanned these annotations, JAXB will not recognize "myElement" as a valid substitution for "myBaseElement" and unmarshalling will fail.

I have attached a very simple maven project with two test cases which illustrates the issue (pure JAXB).

The resolution of the issue is simple (I have also tested this in the project where we ran into the problem). All that is necessary is to add XmlRegistry to the list of scanned annotations in ClassPathJaxb2TypeScanner, i.e.:

private final TypeFilter[] jaxb2TypeFilters =
          new TypeFilter[]{new AnnotationTypeFilter(XmlRootElement.class, false),
                        new AnnotationTypeFilter(XmlType.class, false), new AnnotationTypeFilter(XmlSeeAlso.class, false),
                        new AnnotationTypeFilter(XmlEnum.class, false), new AnnotationTypeFilter(XmlRegistry.class, false)};

---

Attachments:

• jaxb-test-simple.zip (4.30 kB)

[spring-projects-issues]

Arjen Poutsma commented

Moved from SWS to SPR.

[spring-projects-issues]

Phil Webb commented

#324

[spring-projects-issues]

Juergen Hoeller commented

Looks entirely reasonable - Phil, please roll this into 3.2.4 right away...

[spring-projects-issues]

Phil Webb commented

Thanks for the pull request! This has been merged to master and also for the upcoming 3.2.4 release.