[jbossws-issues] [JBoss JIRA] Commented: (JBWS-1968) Documentation support for WSDL->Java

[Richard Opalka (JIRA)]

    [ http://jira.jboss.com/jira/browse/JBWS-1968?page=comments#action_12400332 ] 
            
Richard Opalka commented on JBWS-1968:
--------------------------------------

This feature is already supported by underlying Sun RI tool to which JBossWS runtime and tools delegate WSDL compilation tasks.

Documentation is available here: 

https://jax-ws.dev.java.net/jax-ws-20-fcs/docs/customizations.html

And here's one example I succesfully tested locally.

Here's my annotated WSDL:

<definitions name='TestEndpointService' targetNamespace='http://org.jboss.ws/jaxws/asynchronous' xmlns='http://schemas.xmlsoap.org/wsdl/'
  xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/' xmlns:tns='http://org.jboss.ws/jaxws/asynchronous' xmlns:xsd='http://www.w3.org/2001/XMLSchema'
  xmlns:jaxws="http://java.sun.com/xml/ns/jaxws" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb">
  
  <jaxws:bindings>
    <jaxws:package name="wsdl.customized.pckg"/>
  </jaxws:bindings>
  
  <message name='TestEndpoint_echoResponse'>
    <part name='result' type='xsd:string'/>
  </message>
  <message name='TestEndpoint_echo'>
    <part name='String_1' type='xsd:string'/>
  </message>
  <portType name='TestEndpoint'>
    <jaxws:bindings>
      <jaxws:class name="CustomizedClassTestEndpoint">
        <jaxws:javadoc>This is the class javadoc that was specified in WSDL JAX-WS customizations</jaxws:javadoc>
      </jaxws:class>
    </jaxws:bindings>
    <operation name='echo' parameterOrder='String_1'>
    <jaxws:bindings>
      <jaxws:method name="customizedEcho">
        <jaxws:javadoc>This is the method javadoc that was specified in WSDL JAX-WS customizations</jaxws:javadoc>
      </jaxws:method>
    </jaxws:bindings>
      <input message='tns:TestEndpoint_echo'/>
      <output message='tns:TestEndpoint_echoResponse'/>
    </operation>
  </portType>
  <binding name='TestEndpointBinding' type='tns:TestEndpoint'>
    <soap:binding style='rpc' transport='http://schemas.xmlsoap.org/soap/http'/>
    <operation name='echo'>
      <soap:operation soapAction=''/>
      <input>
        <soap:body namespace='http://org.jboss.ws/jaxws/asynchronous' use='literal'/>
      </input>
      <output>
        <soap:body namespace='http://org.jboss.ws/jaxws/asynchronous' use='literal'/>
      </output>
    </operation>
  </binding>
  <service name='TestEndpointService'>
    <port binding='tns:TestEndpointBinding' name='TestEndpointPort'>
      <soap:address location='http://tdvaio:8080/jaxws-samples-asynchronous/TestEndpoint'/>
    </port>
  </service>
</definitions>

And here's the generated output when executing wsconsume commandline tool:


package wsdl.customized.pckg;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;


/**
 * This is the class javadoc that was specified in WSDL JAX-WS customizations
 * 
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.1.1-b03-
 * Generated source version: 2.0
 * 
 */
@WebService(name = "TestEndpoint", targetNamespace = "http://org.jboss.ws/jaxws/asynchronous")
@SOAPBinding(style = SOAPBinding.Style.RPC)
public interface CustomizedClassTestEndpoint {


    /**
     * This is the method javadoc that was specified in WSDL JAX-WS customizations
     * 
     * @param string1
     * @return returns java.lang.String
     */
    @WebMethod(operationName = "echo")
    @WebResult(name = "result", partName = "result")
    public String customizedEcho(@WebParam(name = "String_1", partName = "String_1") String string1);

}

As you can see we are able to specify like class name customizations, so method names customizations and their javadoc too.

> Documentation support for WSDL->Java
> ------------------------------------
>
>                 Key: JBWS-1968
>                 URL: http://jira.jboss.com/jira/browse/JBWS-1968
>             Project: JBoss Web Services
>          Issue Type: Feature Request
>      Security Level: Public(Everyone can see) 
>          Components: tools-jaxws
>            Reporter: Magesh Kumar B
>         Assigned To: Richard Opalka
>            Priority: Minor
>             Fix For: jbossws-native-2.0.4
>
>
> Alessio Soldano says in JBWS-1850:
> "Doc support for WSDL->Java would require changes to the wsconsume tool and will thus be covered in another issue. "
> --> Opened this JIRA to cover that

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira