From: Marc CARRÉ <carre.marc_at_gmail.com>
Date: Sun, 3 Jun 2012 14:14:00 +0100

Hi,

I have been working on a REST web service using Jersey for a few days now,
and managed to have all CRUD operations working, with several exchange
formats: XML, JSON, Google Protobuf.
However, I am facing some issues related to automatically generated WADL
and XSD.


*Context*:

To define the objects exchanged in these three formats, I have
followed a *"contract-first"
approach*:

   - - from a XSD I wrote, I generated my model classes using JAXB;
   - - from an equivalent proto file I wrote, I generated the Google
   Protobuf classes (and internally have a way to convert these to the
   JAXB-generated objects, in order to have an unique model).


However, as I would like my users to be able to *generate their classes *too,
I would like to share these schema files (.xsd and .proto) and have them *well
integrated with the automatically generated WADL*.

For that purpose, thanks to
this<https://wikis.oracle.com/display/Jersey/HowToConfigureExtendedWADL>wiki
page:

   - I have exposed the two files under:
   /schema/schema.xsd
   /schema/schema.proto


   - I have added an application-grammar file:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<grammars xmlns="http://wadl.dev.java.net/2009/02"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xi="http://www.w3.org/1999/XML/xinclude">
    <include href="../schema/schema.xsd" />
</grammars>

   - I have added a customized WADL generator:

public class RichWadlGeneratorConfig extends WadlGeneratorConfig {
    @Override
    public List<WadlGeneratorDescription> configure() {
        return generator(WadlGeneratorApplicationDoc.class)
                .prop("applicationDocsStream", "application-doc.xml")
                .generator(WadlGeneratorGrammarsSupport.class)
                .prop("grammarsStream", "application-grammars.xml")
                .descriptions();
    }
}

This way the below appears in the WADL, when I hit /rest/application.wadl:

<grammars>
     <include href="../schema/schema.xsd"/>
     <include href="application.wadl/xsd0.xsd">
          <doc title="Generated" xml:lang="en"/>
     </include>
</grammars>


*Problem*:

application.wadl/xsd0.xsd is automatically generated from my classes, but
is quite *different* from what I initially had in schema.xsd.
In addition to that, calling a tool like wadl2java on this WADL fails
miserably, presumably because

   - ../schema/schema.xsd
   and
   - application.wadl/xsd0.xsd

are now conflicting (two definitions for the same objects).

*Questions*:

   1. Is there a way to disable the generation and diffusion of this
   automatically generated XSD?
   (As I don't need it since I'm following this "contract-first" approach)

   2. If not, is there a way to "override" its content with my manually
   written XSD when /rest/application.wadl/xsd0.xsd is hit?
   (I have googled around and found about WadlResource to generate
   customized WADL, but found nothing about the XSD generation itself)


Thanks in advance for your help!

M.


PS: I have also posted on
Stackoverflow<http://stackoverflow.com/questions/10870583/troubles-with-wadl-generated-xsd-using-jersey-with-a-contract-first-approach>and
plan to diffuse the solution when I finally find it.