<documentation> element should not be wrapped as java.lang.Object

• Key: WODEN-142
• Type: Improvement
• Status: Resolved
• Resolution: Fixed
• Priority: Major
• Assignee: Dan Harvey
• Reporter: John Kaputin
• Fix Version/s: M8

Description

DocumentationElement has the methods set/getContent which wrap the <wsdl:documentation> element as a java.lang.Object. The convention in the Woden API for wrapping WSDL elements is to use XMLElement as the wrapper. At the very least this interface should use XMLElement. A better approach might be to represent mixed content in this interface.

Comments

[John Kaputin]

I think it will be sufficient just to change DocumentElement API to represent the <document> element as an org.apache.woden.XMLElement, rather than java.lang.Object. However, I have posted to the woden-dev list to see if there are any particular requirements for handling mixed content directly from the DocumentElement API.

[Dan Harvey]

As there where no requests for any particular requirements to handle the content directly from the DocumentElement API I have changed the set/GetContent methods to use the XMLElement.

[John Kaputin]

Dan has contributed the fix, so assigning JIRA to him.

[John Kaputin]

Dan is going to check if the Axis2 codegen uses the documentation element and if so, what affect this JIRA has so that we can sync up any Axis2 code changes required.

[Dan Harvey]

There is only one place in the Axis2 code that they use the DocumentationElement which is in the file

/axis2/modules/kernel/src/org/apache/axis2/description/WSDL20ToAxisServiceBuilder.java

this uses getContent() to get an Object then cast it to a org.w3c.dom.Element object. This just needs one line adding to get the Element out of our XMLElement holder.

I've attached a patch to this Jira which would do this for them.

[John Kaputin]

I have confirmed with Keith Chapman that this fix is OK. Will apply the Woden patches, then notify him to apply the patch for the Axis2 codegen (WSDL20ToAxisServiceBuilder).

[John Kaputin]

r565209
DocumetationElement
DocumentationElementTest
DocumentationImpl
BaseWSDLReader

(WSDL20ToAxisServiceBuilder patch to be applied next)

[Keith Godwin Chapman]

Fixed Axis2 Build. Thanks for the patch Dan.