Query Regarding WSIMPORT generated Artifacts

[Jolly Tiwari]

Hi! Everyone,

I have a query regarding the Artifacts (especially the Port class) generated by wsimport.
I took following two documents :
1. StringProcessorService.wsdl
2. StringProcessorService_Payload.xsd

Reference: snippets taken from IVAN's guide

I Placed both the documents in a directory and then executed wsimport on my command prompt:

c:\wsdl\>wsimport -p clientside -s . StringProcessorService.wsdl


StringProcessorService.wsdl

<definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
	     xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
	     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	     xmlns:tns="http://www.instinct.com/stringprocessor"
	     targetNamespace="http://www.instinct.com/stringprocessor">
	     
<types>
<xsd:schema>
<xsd:import namespace="http://www.instinct.com/stringprocessor" schemaLocation="StringProcessorService_Payload.xsd"/>
</xsd:schema>
</types>



<message name="inputmessage">
<part name="parameters" element="tns:reverseStringReq"/>
</message>

<message name="returnmessage">
<part name="result"  element="tns:reverseStringRes"/>
</message>


<portType name="StringProcessorPort">
	<operation name="reverseString">
		<input message="tns:inputmessage"/>
		<output message="tns:returnmessage"/>
	</operation>
</portType>


<binding name="StringProcessorPortBinding" type="tns:StringProcessorPort">
	<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
	<operation name="reverseString">
	<soap:operation soapAction=""/>
	<input>
	<soap:body use="literal"/> 
	</input>
	<output>
	<soap:body use="literal"/> 
	</output>
	</operation>
</binding>

<service name="StringProcessorService">
<port name="StringProcessorServicePort" binding="tns:StringProcessorPortBinding">
<soap:address location="REPLACE_WITH_ACTUAL_URL"/>
</port>
</service>
	     
	     
</definitions>	     

StringProcessorService_Payload.xsd

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	     targetNamespace="http://www.instinct.com/stringprocessor"
	     xmlns:tns="http://www.instinct.com/stringprocessor">
	     <xsd:element name="reverseStringReq" type="tns:reverseStringRequest"/>
	     <xsd:element name="reverseStringRes" type="tns:reverseStringResponse"/>
	     <xsd:complexType name="reverseStringRequest">
		     <xsd:sequence>
		     <xsd:element name="inString" type="xsd:string"/>
		     </xsd:sequence>
	     </xsd:complexType>
	     <xsd:complexType name="reverseStringResponse">
		     <xsd:sequence>
		     <xsd:element name="return" type="xsd:string"/>
		     </xsd:sequence>
	     </xsd:complexType>
</xsd:schema>

Doubt:
When I am looking at the code generated inside the Port class(StringProcessorPort.java) I found following

public ReverseStringResponse reverseString(
@WebParam(name = "reverseStringReq", targetNamespace = "http://www.instinct.com/stringprocessor", partName = "parameters")
ReverseStringRequest parameters);

The parameters and return type are of ReverseStringRequest and ReverseStringResponse respectively.
I guess the wsdl and xsd tells that they should be of String type.

Please correct me if i am wrong.

Regards

Jolly

[Ivan Krizsan]

Hi!

Jolly Tiwari wrote:
The parameters and return type are of ReverseStringRequest and ReverseStringResponse respectively.
I guess the wsdl and xsd tells that they should be of String type.

No, the WSDL does not say that they are of the type String, however, both the request and response objects do contain one string. How can you tell? Well, look at the <portType> element of the WSDL. I have added some comments.

<!-- Defines the input message of the reverseString operation. -->
<message name="inputmessage">  
    <part name="parameters" element="tns:reverseStringReq"/>  
</message>  

<!-- Defines the output message of the reverseString operation. -->
<message name="returnmessage">  
    <part name="result"  element="tns:reverseStringRes"/>  
</message>  
   
<portType name="StringProcessorPort">  
    <operation name="reverseString">
        <!-- Here, the format of the indata of the reverseString operation is specified. Message defined above. --> 
        <input message="tns:inputmessage"/>

        <!-- Here, the format of the outdata of the reverseString operation is specified. Message defined above. -->
        <output message="tns:returnmessage"/>  
     </operation>  
</portType>  

Next, we take a look at the XML schema that defines the reverseStringReq and reverseStringRes elements:

<xsd:element name="reverseStringReq" type="tns:reverseStringRequest"/>  
<xsd:element name="reverseStringRes" type="tns:reverseStringResponse"/>

<!-- Definition of the datatype holding the request. It contains a single string. -->
<xsd:complexType name="reverseStringRequest">  
    <xsd:sequence>  
        <xsd:element name="inString" type="xsd:string"/>  
    </xsd:sequence>  
</xsd:complexType>

<!-- Definition of the datatype holding the response. It contains a single string. -->
<xsd:complexType name="reverseStringResponse">  
    <xsd:sequence>  
        <xsd:element name="return" type="xsd:string"/>  
    </xsd:sequence>  
</xsd:complexType> 

It declares two datatypes, one for the request and one for the response, that both contains a single string each. If we look at the request, then the <inString> element that will contain the string indata of the request will be contained in a <reverseStringReq> element - the name of the complex type of the element in the request message.
Hope this makes things more clear!

[Jolly Tiwari]

Thanks Ivan for your quick response

Well that means one of the class generated by wsimport,StringProcessorPort is fine.

public ReverseStringResponse reverseString(
@WebParam(name = "reverseStringReq", targetNamespace = "http://www.instinct.com/stringprocessor", partName = "parameters")
ReverseStringRequest parameters);

To invoke this service operation through Proxy mechanism , We will have to create an instance of JAXB mapping class for Request data and then call its setter method to provide input data which is a String in this case.

ReverseStringRequest  ref=new ReverseStringRequest ();
ref.setInString("hello");
StringProcessorService srvc=new StringProcessorService();
StringProcessorPort port=srvc.getStringProcessorPort();
ReverseStringResponse res=port.reverseString(ref);
System.out.println(res.getReturn());

Query
What changes need to be done to enable the client to invoke service operation as follows

StringProcessorService srvc=new StringProcessorService();
StringProcessorPort port=srvc.getStringProcessorPort();
String res=port.reverseString("Hello");

Please correct me wherever you feel i am wrong as that would be of great help.

Regards

Jolly

[Ivan Krizsan]

Hi!

Jolly Tiwari wrote:
Query
What changes need to be done to enable the client to invoke service operation as follows

StringProcessorService srvc=new StringProcessorService();
StringProcessorPort port=srvc.getStringProcessorPort();
String res=port.reverseString("Hello");

You would need to modify the WSDL or write the proxy classes by hand.
The main point with this example in my study notes is to show how a web service that consumes entire protocol messages, such as SOAP messages or XML messages. This is something that is more likely to be used when developing a document-based web service (as opposed to a RPC web service). If you are implementing a web service endpoint class that implements the Provider interface, you are not very likely to have simple types as parameters.
Best wishes!