soap fault return empty <detail> element.

[Ravinderjit Singh]

Hello All,

I have designed a web service in a top down manner. I am working with Axis2 stack.

Below is the WSDL for a simple web service with only one operation 'concat'

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://www.example.org/SimpleService/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="SimpleService" targetNamespace="http://www.example.org/SimpleService/" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" >
  <wsdl:types>
    <xsd:schema targetNamespace="http://www.example.org/SimpleService/">
      <xsd:element name="concatRequest">
        <xsd:complexType>
          <xsd:sequence>
          	<xsd:element name="S1" type="xsd:string" />
          	<xsd:element name="S2" type="xsd:string"></xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="concatResponse" type="xsd:string">
      </xsd:element>
      <xsd:element name="concatFault" type="xsd:string" />
    </xsd:schema>
  </wsdl:types>
  <wsdl:message name="concatRequest">
    <wsdl:part element="tns:concatRequest" name="concatRequest"/>
  </wsdl:message>
  <wsdl:message name="concatResponse">
    <wsdl:part element="tns:concatResponse" name="concatResponse"/>
  </wsdl:message>
  <wsdl:message name="concatFault">
  	<wsdl:part name="concatFault" element="tns:concatFault"></wsdl:part>
  </wsdl:message>
  <wsdl:portType name="SimpleService">
    <wsdl:operation name="concat">
      <wsdl:input message="tns:concatRequest"/>
      <wsdl:output message="tns:concatResponse"/>
      <wsdl:fault name="concatFault" message="tns:concatFault"></wsdl:fault>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="SimpleServiceSOAP" type="tns:SimpleService">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="concat">
      <soap:operation soapAction="http://www.example.org/SimpleService/concat"/>
      <wsdl:input>
        <soap:body use="literal"/>
      </wsdl:input>
      <wsdl:output>
        <soap:body use="literal"/>
      </wsdl:output>
      <wsdl:fault name="concatFault">
       <soap:fault name="concatFault" use="literal"/>
      </wsdl:fault>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="SimpleService">
    <wsdl:port binding="tns:SimpleServiceSOAP" name="p1">
      <soap:address location="http://localhost:8080/ss/p1"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

I generate the server side code using wsdl2java tool.

Concat method implementation.

                 public org.example.www.simpleservice.ConcatResponse concat
                  (
                  org.example.www.simpleservice.ConcatRequest concatRequest
                  )
            throws ConcatFaultException{
                String s1 = concatRequest.getS1();
				String s2 = concatRequest.getS2();
				
				String result = null;
				ConcatResponse response = new ConcatResponse();
				
				if((s1.equals("")) || (s2.equals("")))
					throw new ConcatFaultException("Please provide some string for cancat");
				else
				{
					result=s1+s2;
					response.setConcatResponse(result);
				}
				return response;

When I send the request to web service using SOAP-UI, It does return anything for <detail> element of soap fault.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <soapenv:Fault>
         <faultcode>soapenv:Server</faultcode>
         <faultstring>Please provide some string for cancat</faultstring>
         <detail/>
      </soapenv:Fault>
   </soapenv:Body>
</soapenv:Envelope>

Did I miss anything?

[Dan Drillich]

Based on the SOAP schema at Schema for the SOAP/1.1 envelope, what you posted seems to be valid -

<xs:element name="Fault" type="tns:Fault" /> <xs:complexType name="Fault" final="extension"> <xs:annotation> <xs:documentation>Fault reporting structure</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="faultcode" type="xs:QName" /> <xs:element name="faultstring" type="xs:string" /> <xs:element name="faultactor" type="xs:anyURI" minOccurs="0" /> <xs:element name="detail" type="tns:detail" minOccurs="0" /> </xs:sequence> </xs:complexType> <xs:complexType name="detail"> <xs:sequence> <xs:any namespace="##any" minOccurs="0" maxOccurs="unbounded" processContents="lax" /> </xs:sequence>

[Ravinderjit Singh]

I agree the schema is valid.

I was looking for soap fault like below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Please provide some string for cancat</faultstring> <detail> <sim:concatFault>Please provide some string for cancat</sim:concatFault> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

At present I am getting empty <detail/> element. How I can get the message part in <detail>?
Reason being the tool in which I will be using this WSDL, will be accessing the <detail> element, if its empty it would not work.

[Ravinderjit Singh]

I figured it out.

The concat function should be like.

                 public org.example.www.simpleservice.ConcatResponse concat
                  (
                  org.example.www.simpleservice.ConcatRequest concatRequest
                  )
            throws ConcatFaultException{
                String s1 = concatRequest.getS1();
				String s2 = concatRequest.getS2();
				
				String result = null;
				ConcatResponse response = new ConcatResponse();
				
				if((s1.equals("")) || (s2.equals("")))
					{
						ConcatFault fault = new ConcatFault();
						fault.setMessage("Please provide some string for cancat");
						ConcatFaultException ex = new ConcatFaultException("Please provide some string for cancat");
						ex.setFaultMessage(fault);
						throw ex;	
					}
				else
				{
					result=s1+s2;
					response.setConcatResponse(result);
				}
				return response;

[Dan Drillich]

Many thanks for the update.

[Dan Drillich]

Ravinderjit Singh wrote:

I was looking for soap fault like below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Please provide some string for cancat</faultstring> <detail> <sim:concatFault>Please provide some string for cancat</sim:concatFault> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

I wonder, where does this sim namespace come from?

Regards,
Dan

[Ravinderjit Singh]

That was a dummy soap-fault I posted.
Here is exact soap-fault I am getting.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Please provide some string for cancat</faultstring> <detail> <ns1:concatFault xmlns:ns1="http://www.example.org/SimpleService/"> <message>Please provide some string for cancat</message> </ns1:concatFault> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

[Anuj Kabra]

I am facing a similar issue in which i am not getting the user defined exception for fault case in detail section , rather getting it in fault string section. I dont understand what is ConcatFault in the fix suggested by you and did you write an implementation class for this ConcatFault which is described as an element of type string in xml schema.

[Ravinderjit Singh]

ContactFault is an auto generated class from the WSDL you can check in my very first post. You don't have to do anything with this class. Below is the code which I used to set the fault.

						ConcatFault fault = new ConcatFault();
						fault.setMessage("Please provide some string for cancat");
						ConcatFaultException ex = new ConcatFaultException("Please provide some string for cancat");
						ex.setFaultMessage(fault);
						throw ex;