[CXF-5475] wadl2java fails when using representation reference

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Invalid
• Affects Version/s: 3.0.0-milestone1
• Labels: wadl2java
• Estimated Complexity: Unknown
• Assignee: Unassigned
• Reporter: Guus der Kinderen
• Created: 23/Dec/13 16:46
• Updated: 11/Jul/14 16:54
• Resolved: 23/Dec/13 19:22

Description

It appears that wadl2java fails to produce some code when a response representation is defined as a reference (as opposed to an inline definition).

To illustrate the issue, snippets of a WADL are provided below. Each snippet is followed by a snippet of code as generated by wadl2java.

The first WADL snippet defines a response representation inline:

<resource path="inline">
    <method name="GET">
        <response status="200">
            <representation element="SkuType" mediaType="application/xml"/>
        </response>
    </method>
</resource>

This Java code is generated:

@Path("inline")
public interface InlineResource {

    @GET
    @Produces("application/xml")
    Response get();

}

When the response representation is using a representation reference⁽¹⁾, then the generated code appears to be missing details. This modified WADL snippet illustrates the issue:

<resource path="reference">
    <method name="GET">
        <response status="200">
            <representation href="SkuRep"/>
        </response>
    </method>
</resource>

<representation id="SkuRep" element="SkuType" mediaType="application/xml"/>

Based on the last WADL snippet, this Java code is generated:

@Path("reference")
public interface ReferenceResource {

    @GET
    @Produces()
    Response get();

}

Observed behavior
Code details are missing (note that the media type is missing from the last snippet of Java code), when a representation reference is used.
Expected behavior
wadl2java should generate similar Java code for both WADL snippets that are provided above.

Side-note: when the mediaType attribute is added to the representation reference the generated code looks ok. However, this appears to be prohibited by the WADL specification: "A representation reference element MUST NOT have any other WADL-defined attributes or contain any WADL-defined child elements."

<resource path="illegal">
    <method name="GET">
        <response status="200">
            <representation href="SkuRep" mediaType="application/xml"/>
        </response>
    </method>
</resource>

@Path("illegal")
public interface IllegalResource {

    @GET
    @Produces("application/xml")
    Response get();

}

Note that for the purpose of illustrating the problem, the mediaType attribute was used. The issue might or might not affect other attributes or aspects of code generation (this remains untested).

The behavior described in this issue was reproduced using the wadl2java Maven plugin, version 3.0.0-milestone1.