Unexpected element name - confusion of types in client

Question

I have a web service definition that performs four operations:
- String getTitle(long) - returns a title for a single asset
- StringArrayType) getTitles(LongArrayType) - returns an ordered list of titles matching input list
- AssetSummaryType getSummary(long) - Returns a complex type, summary information of an asset
- AssetSummaryArrayType getSummaries(LongArrayType) - Returns an array of complex types
Based on the WSDL (included at the bottom of this posting) I then generate the service
endpoint using wscompile and -f:wsi option (JDK 1.4.2-05 and JWSDP-1.4).
This is built into a raw war file and then cooked using wsdeploy.
On the client side I create stubs using wscompile and -f:wsi and compile
the resultant code. My client invokes each of the operations in turn, having been
provided the relevant 'longs' as input.
The service is deployed in JBoss-3.2.2 and the client is then executed from a separate JVM.
I then see the following client error:
java.rmi.RemoteException: Runtime exception; nested exception is:
unexpected element name: expected={http://example.com/myAssetWebSvc}Str
ingElement, actual={http://example.com/MyAssetWebSvc}AssetSummaryElement
at com.sun.xml.rpc.client.StreamingSender._handleRuntimeExceptionInSend(
StreamingSender.java:318)
at com.sun.xml.rpc.client.StreamingSender._send(StreamingSender.java:300
at example.com.wsclient.asset.AssetService_Stub.getTitle(AssetService_St
ub.java:175)
at example.com.wsclient.asset.AssetClient.testAssetTitleRetrieval(AssetC
lient.java:82)
at example.com.wsclient.asset.AssetClient.main(AssetClient.java:51)
Caused by: unexpected element name: expected={http://example.com/MyAssetWebSvc}
StringElement, actual={http://example.com/MyAssetWebSvc}AssetSummaryElement
at com.sun.xml.rpc.encoding.literal.LiteralSimpleTypeSerializer.deserial
ize(LiteralSimpleTypeSerializer.java:106)
at example.com.wsclient.asset.AssetService_Stub._deserialize_getTitle(As
setService_Stub.java:318)
at example.com.wsclient.asset.AssetService_Stub._readFirstBodyElement(As
setService_Stub.java:276)
at com.sun.xml.rpc.client.StreamingSender._send(StreamingSender.java:215
... 3 more
If I deploy the same service with only the first two operations defined within wsdl,
the error is not seen.
I have also tried compilation on JWSDP 1.3 and JDK 1.4.1-03 and in this case the same error
occurs but the other way around. The two 'title' operations work but the summary
operations fail with the actual element encountered being a StringElement or StringArrayElement
and the expected an AssetSummaryElement or AssetSummaryArrayElement.
Further, if I change the name of the StringElement to for example 'MyStringElement', this is
reported as the actual - i.e. there is no confusion with a standard type at play here.
I also use handlers, one on the server side to inspect security information and one on the
client to insert relevant details and look for returned errors within the header.
Is this a known problem within JWSDP 1.3 and/or 1.4? Are there any workarounds.
My wsdl is provided below along with the wscompile options and the matching configuration
files used.
<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions name="MyAssetService" targetNamespace="http://example.com/MyAssetWebSvc"
     xmlns:tns="http://example.com/MyAssetWebSvc"
     xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
<wsdl:types>
<xsd:schema targetNamespace="http://example.com/MyAssetWebSvc"
          xmlns:tns="http://example.com/MyAssetWebSvc"
          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:complexType name="AssetSummaryType">
<xsd:all>
<xsd:element name="createdBy" type="xsd:string" />
<xsd:element name="createdDate" type="xsd:dateTime" />
<xsd:element name="description" type="xsd:string" />
<xsd:element name="fileSize" type="xsd:long" />
<xsd:element name="id" type="xsd:long" />
<xsd:element name="modifiedBy" type="xsd:string" />
<xsd:element name="modifiedDate" type="xsd:dateTime" />
<xsd:element name="organisation" type="xsd:string" />
<xsd:element name="owner" type="xsd:string" />
<xsd:element name="title" type="xsd:string" />
<xsd:element name="type" type="xsd:string" />
<xsd:element name="version" type="xsd:long" />
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ExceptionType">
<xsd:all>
<xsd:element name="rootCause" type="xsd:string" nillable="true" />
</xsd:all>
</xsd:complexType>
<xsd:complexType name="LongArrayType">
     <xsd:sequence>
          <xsd:element name="LongItem" type="xsd:long" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
     </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AssetSummaryArrayType">
     <xsd:sequence>
          <xsd:element name="AssetSummaryItem" type="tns:AssetSummaryType" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
     </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="StringArrayType">
     <xsd:sequence>
          <xsd:element name="StringItem" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
     </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CredentialsType">
<xsd:all>
<xsd:element name="principal" type="xsd:string" />
<xsd:element name="password" type="xsd:string" />
</xsd:all>
</xsd:complexType>
     <xsd:element name="LongElement" type="xsd:long"/>
<xsd:element name="StringElement" type="xsd:string"/>
<xsd:element name="LongArrayElement" type="tns:LongArrayType"/>
<xsd:element name="StringArrayElement" type="tns:StringArrayType"/>
<xsd:element name="AssetSummaryElement" type="tns:AssetSummaryType"/>
<xsd:element name="AssetSummaryArrayElement" type="tns:AssetSummaryArrayType"/>
     <xsd:element name="CredentialsElement" type="tns:CredentialsType"/>
     <xsd:element name="ExceptionElement" type="tns:ExceptionType"/>
</xsd:schema>
</wsdl:types>
<wsdl:message name="getSummaryMessage">
<wsdl:part name="resourceId" element="tns:LongElement" />
</wsdl:message>
<wsdl:message name="getSummaryResponse">
<wsdl:part name="assetSummary" element="tns:AssetSummaryElement" />
</wsdl:message>
<wsdl:message name="assetException">
<wsdl:part name="exception" element="tns:ExceptionElement" />
</wsdl:message>
<wsdl:message name="getTitle">
<wsdl:part name="resourceId" element="tns:LongElement" />
</wsdl:message>
<wsdl:message name="getTitleResponse">
<wsdl:part name="assetTitle" element="tns:StringElement" />
</wsdl:message>
<wsdl:message name="getSummaries">
<wsdl:part name="resourceIdList" element="tns:LongArrayElement" />
</wsdl:message>
<wsdl:message name="getSummariesResponse">
<wsdl:part name="assetSummaryList" element="tns:AssetSummaryArrayElement" />
</wsdl:message>
<wsdl:message name="getTitles">
<wsdl:part name="resourceIdList" element="tns:LongArrayElement" />
</wsdl:message>
<wsdl:message name="getTitlesResponse">
<wsdl:part name="assetTitleList" element="tns:StringArrayElement" />
</wsdl:message>
<wsdl:message name="securityHeader">
<wsdl:part name="credentials" element="tns:CredentialsElement" />
</wsdl:message>
<wsdl:portType name="AssetService">
<wsdl:operation name="getSummary" parameterOrder="resourceId">
<wsdl:input message="tns:getSummaryMessage" />
<wsdl:output message="tns:getSummaryResponse" />
<wsdl:fault name="AssetException" message="tns:assetException" />
</wsdl:operation>
<wsdl:operation name="getTitle" parameterOrder="resourceId">
<wsdl:input message="tns:getTitle" />
<wsdl:output message="tns:getTitleResponse" />
<wsdl:fault name="AssetException" message="tns:assetException" />
</wsdl:operation>
<wsdl:operation name="getSummaries" parameterOrder="resourceIdList">
<wsdl:input message="tns:getSummaries" />
<wsdl:output message="tns:getSummariesResponse" />
<wsdl:fault name="AssetException" message="tns:assetException" />
</wsdl:operation>
<wsdl:operation name="getTitles" parameterOrder="resourceIdList">
<wsdl:input message="tns:getTitles" />
<wsdl:output message="tns:getTitlesResponse" />
<wsdl:fault name="AssetException" message="tns:assetException" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="AssetServiceBinding" type="tns:AssetService">
<wsdl:operation name="getSummary">
<wsdl:input>
<soap:header required="true" message="tns:securityHeader" part="credentials" use="literal" actor="security"/>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
<wsdl:fault name="AssetException">
<soap:fault name="AssetException" use="literal"/>
</wsdl:fault>
<soap:operation soapAction="" />
</wsdl:operation>
<wsdl:operation name="getTitle">
<wsdl:input>
<soap:header required="true" message="tns:securityHeader" part="credentials" use="literal"/>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
<wsdl:fault name="AssetException">
<soap:fault name="AssetException" use="literal"/>
</wsdl:fault>
<soap:operation soapAction="" />
</wsdl:operation>
<wsdl:operation name="getSummaries">
<wsdl:input>
<soap:header required="true" message="tns:securityHeader" part="credentials" use="literal"/>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
<wsdl:fault name="AssetException">
<soap:fault name="AssetException" use="literal"/>
</wsdl:fault>
<soap:operation soapAction="" />
</wsdl:operation>
<wsdl:operation name="getTitles">
<wsdl:input>
<soap:header required="true" message="tns:securityHeader" part="credentials" use="literal"/>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
<wsdl:fault name="AssetException">
<soap:fault name="AssetException" use="literal"/>
</wsdl:fault>
<soap:operation soapAction="" />
</wsdl:operation>
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" />
</wsdl:binding>
<wsdl:service name="MyAssetService">
<wsdl:port name="AssetServicePort" binding="tns:AssetServiceBinding">
<soap:address location="http://localhost:9090/MyAssetWebSvc/asset" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Here is the wscompile for the server - this is within an ant script that substitutes the variables specified:
wscompile -keep -d ${path.classes} -s ${src.autojava} -import -model model.gz -f:wsi -f:documentliteral server-config.xml
and this is the server config:
<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://java.sun.com/xml/ns/jax-rpc/ri/config">
<wsdl location="file:///C:temp/MyAssetService_wsi.wsdl" packageName="example.com.wsserver.asset.wrapper">
<handlerChains>
<chain runAt="server">
<handler className="example.com.wsserver.security.SecurityServerHandler">
<property name="name" value="SecurityServerHandler"/>
</handler>
</chain>
</handlerChains>
</wsdl>
</configuration>
On the client side, here is the wscompile, again with ant variable substitution:
wscompile -gen:client -keep -d ${path.build.wsclient.class} -s ${path.build.wsclient.autojava} -classpath ${path.build.wsclient.class} -f:wsi -f:documentliteral client-config.xml
And here is the client config:
<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://java.sun.com/xml/ns/jax-rpc/ri/config">
<wsdl location="file:///C:/temp/MyAssetService_wsi.wsdl" packageName="example.com.wsclient.asset">
<handlerChains>
<chain runAt="client">
<handler className="example.com.wsclient.security.SecurityClientHandler">
<property name="name" value="SecurityClientHandler"/>
</handler>
</chain>
</handlerChains>
</wsdl>
</configuration>
Note that I generate slightly different packages on client and server side. The server includes a 'wrapper' path on the package name - purely because the
generated code wrappers an existent api that I am making available as a web service. This is not needed to be seen
on the client side - i.e. the service appears as is without the wrapper.
I have tried omitting the documentliteral from the wscompiles and this seems to have no effect.
Any help gratefully received.
Best regards
Lawrence

Answer 1

Thanks for the prompting. I was convinced that the error was occurring client side as I could see no activity on the server. However having captured the soap request and responses its evident that this is not the case (which I'm a little confused on based on my original tests, but the error makes more sense in this context).
The request is below:
<env:Envelope xmlns:enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://example.com/myAssetWebSvc" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<env:Header>
<ns1:mmsSecurity env:actor="security" env:mustUnderstand="1" xmlns:ns1="http://example.com/myAssetWebSvc">
<principal>example.user</principal>
<password>mypassword</password>
</ns1:mmsSecurity>
</env:Header>
<env:Body>
<ns0:LongElement>166333</ns0:LongElement>
</env:Body>
</env:Envelope>
I can see from the body that the signature is not unique - its the same as that of the Summary operation. In this case, the server side is performing the summary (rather than the title that I had intended) and returning that response. This gives rise to the deserialisation error on the client side for the response.
Presumably I need to move to the wrapped document literal style so that the request is uniquely identified on the server side.
To me this was not an obvious gotcha, Could the parser (wscompile) be enhanced to trap identical request message definitions within a single service/endpoint definition (i.e. WSDL)? If so where should I post the request?