FWD » Core Development » Base Language

Debugging the SimpleOperations converted web service test case in P2J an AxisFault is throw in WebServiceHelper line 897

   sc = new ServiceClient(null, wsdlDef, new QName(ns, srvName), portTypeName);   

Looking into the source code the ServiceClient constructor looks like:

    
   /**
   * This is WSDL4J based constructor to configure the Service Client/ TODO: make this policy
   * aware
   *
   * @param configContext    active ConfigurationContext
   * @param wsdl4jDefinition the WSDL we're going to be using to configure ourselves
   * @param wsdlServiceName  QName of the WSDL service we'd like to access
   * @param portName         name of the WSDL port we'd like to access
   * @throws AxisFault in case of error
   */

   public ServiceClient(ConfigurationContext configContext, Definition wsdl4jDefinition,
                      QName wsdlServiceName, String portName) throws AxisFault {
     configureServiceClient(configContext, AxisService.createClientSideAxisService(
             wsdl4jDefinition, wsdlServiceName, portName, options));
   }

which means that the portName parameter is the name of the port from WSDL that we have to use (bind).
Further debugging inside WSDL11ToAxisServiceBuilder on findBinding() method the portName parameter is used as a key in a Map of available ports.
Here is a snippet of code from WSDL11ToAxisServiceBuilder class containing the code for findBinding() method.

public class WSDL11ToAxisServiceBuilder extends WSDLToAxisServiceBuilder {
    /**
     * Look for the relevant binding!
     * if user has spcifed a port get it
     * otherwise find first soap port or pick random one if there is no soap port
     *
     * @param dif
     * @param service service can not be null
     * @throws AxisFault
     */
    private Binding findBinding(Definition dif, Service service) throws AxisFault {

        Binding binding = null;
        Port port = null;
        copyExtensibleElements(service.getExtensibilityElements(), dif, axisService, SERVICE);
        if (portName != null) {
            // i.e if user has specified a service
            port = service.getPort(portName);
            if (port == null) {
                throw new AxisFault("No port found for the given name :" + portName);
            }
        } else {
            Map ports = service.getPorts();
            if (ports != null && ports.size() > 0) {
                // pick the port with the SOAP address as the default port
                port = findPort(ports);
                if (port == null) {
                    // a SOAP port was not found - log a warning
                    // and use the first port in the list
                    log.info("A SOAP port was not found - " 
                             + "picking a random port!");
                    port = (Port) ports.values().toArray()[0];
                }

                if (port != null) {
                    // i.e we have find a correct port
                    // this is only use full in codegen time.
                    if (this.isCodegen && !this.isAllPorts) {
                        // if user has not set all option
                        // we have to generate code only for that option.
                        this.portName = port.getName();
                    }
                }
            }
        }

        axisService.setName(service.getQName().getLocalPart());

        if (port != null) {
            copyExtensibleElements(port.getExtensibilityElements(), dif,
                                   axisService, PORT);
            Definition parentDefinition = getParentDefinition(dif,
                    port.getBinding().getQName(), COMPONENT_BINDING, new HashSet());
            binding = parentDefinition.getBinding(port.getBinding().getQName());
            if (binding == null) {
                binding = port.getBinding();
            }
        }

        return binding;
    }
}   

The available ports from WSDL are stored on a Map in ServiceImpl class which is an implementation of Service interface.

   protected Map ports = new HashMap();

   /**
   * Get the specified port.
   *
   * @param name the name of the desired port.
   * @return the corresponding port, or null if there wasn't
   * any matching port
   */
   public Port getPort(String name)
   {
      return (Port)ports.get(name);
   }

If the portName is not a key in the Map set of keys an AxisFault exception is throw.
If no portName is specified a port with the SOAP address is selected automatically from the existing ports in the Map.

       if (portName != null) {
            // i.e if user has specified a service
            port = service.getPort(portName);
            if (port == null) {
                throw new AxisFault("No port found for the given name :" + portName);
            }
        } else {
            Map ports = service.getPorts();
            if (ports != null && ports.size() > 0) {
                // pick the port with the SOAP address as the default port
                port = findPort(ports);
 

In conclusion if we specify a portName this port should be a key in the in the Map set of keys.
In WebServiceHelper when the ServiceClient constructor is invoked the portTypeName is the name of the port type and not the name of a port.

   sc = new ServiceClient(null, wsdlDef, new QName(ns, srvName), portTypeName);   

1 For http://www.webservicex.net/CovertPressure.asmx?wsdl ChangePressureUnit service the portType name and binding name are equals
and no AxisFault exception is throw.

 
<wsdl:portType name="PressureUnitSoap">
 <wsdl:operation name="ChangePressureUnit">
  <wsdl:input message="tns:ChangePressureUnitSoapIn"/>
  <wsdl:output message="tns:ChangePressureUnitSoapOut"/>
 </wsdl:operation>
</wsdl:portType>
.....
<wsdl:binding name="PressureUnitSoap" type="tns:PressureUnitSoap">
 <soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
  <wsdl:operation name="ChangePressureUnit">
   <soap:operation soapAction="http://www.webserviceX.NET/ChangePressureUnit" style="document"/>
    <wsdl:input>
     <soap:body use="literal"/>
    </wsdl:input>
    <wsdl:output>
     <soap:body use="literal"/>
    </wsdl:output>
  </wsdl:operation>
 </wsdl:binding>

2. For http://localhost:8080/axis2/services/SimpleOperations?wsdl SimpleOperations service the port type name is SimpleOperationsPortType
and the name of the ports are SimpleOperationsSoap11Binding, SimpleOperationsSoap12Binding and SimpleOperationsHttpBinding
so an AxisFalut exception is throw with the message

No port found for the given name : SimpleOperationsPortType

<wsdl:portType name="SimpleOperationsPortType">
 <wsdl:operation name="getData">
  <wsdl:input message="tns:getDataRequest" wsaw:Action="urn:getData"/>
  <wsdl:output message="tns:getDataResponse" wsaw:Action="urn:getDataResponse"/>
 </wsdl:operation> 
.....
<wsdl:binding name="SimpleOperationsSoap11Binding" type="tns:SimpleOperationsPortType">
 <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
  <wsdl:operation name="getData">
   <soap:operation soapAction="urn:getData" style="document"/>
    <wsdl:input>
     <soap:body use="literal"/>
    </wsdl:input>
    <wsdl:output>
     <soap:body use="literal"/>
    </wsdl:output>
   </wsdl:operation>

3. I've fixed this bug by providing a getPortName method which search the WSDL binding list for a port name equals with the parameter port type name.
If a port having the same name like the port type name is found the port type name is returned otherwise a null value is returned and the port will be
automatically selected from the list of available ports. The ServiceClient constructor call became:

sc = new ServiceClient(null, wsdlDef, new QName(ns, srvName), getPortName(portTypeName))

Having these fixes all tested web services are working in P2J.

Bellow are the request and response SOAP messages on P4GL and P2J.

1. Industry standards supported by OpenEdge according to web services manual:
- WSDL 1.1 is the de facto standard according to the W3C.
- SOAP 1.1 HTTP Binding is the de facto standard according to the W3C.
- XML Schema — W3C 2001 XML Schema Recommendation.

By default axis2 use SOAP 1.2 for binding. For compatibility when port name is automatically choose from the list of available ports by axis2 client we
force also the use of SOAP 1.1 binding as default.

Looking to request SOAP messages on both P4GL and P2J SOAP 1.1 is used for binding.
The content of the Body element is the same on both cases and is provided when we call de service as input parameter.

<ns0:getData xmlns:ns0="http://goldencode.com/xsd"><ns0:str>test</ns0:str></ns0:getData>

2. The response is obviously identical in both P4GL and P2J because is generated by the same server.

3. The messages displayed on test case are also the same because I implemented the code to merge SOAP Envelope namespaces
with namespaces in response. I tested also the wsdl_test1.p test case on http://www.webservicex.net/CovertPressure.asmx
service and now the generated message match the expected message.

4. I tested also some fault messages and I didn't find differences. However in P2J in case of a WS fault
message the error message is displayed twice so I provided a quick fix.

P4GL Request:
=============
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:s0="http://goldencode.com/xsd" xmlns:s1="http://www.w3.org/2001/XMLSchema">
      <ns0:getData xmlns:ns0="http://goldencode.com/xsd">
         <ns0:str>test</ns0:str>
      </ns0:getData>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

P2J Request:
============     
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns0:getData xmlns:ns0="http://goldencode.com/xsd">
         <ns0:str>test</ns0:str>
      </ns0:getData>
   </soapenv:Body>
</soapenv:Envelope>

Response:
=========
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:getDataResponse xmlns:ns="http://goldencode.com/xsd">
         <ns:return>1.7976931348623157E308</ns:return>
      </ns:getDataResponse>
   </soapenv:Body>
</soapenv:Envelope>

P4GL client display:
====================
<ns:getDataResponse xmlns:ns="http://goldencode.com/xsd" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <ns:return>1.7976931348623157E308</ns:return>
</ns:getDataResponse>

P2J client display:
===================
<ns:getDataResponse xmlns:ns="http://goldencode.com/xsd" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <ns:return>1.7976931348623157E308</ns:return>
</ns:getDataResponse>

1. I fixed the issues form WebServiceHelper.

2. For FAULT test I used for example the wsdl_test1.p and I did a change on bar parameter to xbar in the input string like:

chi = "<tns:ChangePressureUnit xmlns:tns='http://www.webserviceX.NET/'><tns:PressureValue>100.0</tns:PressureValue><tns:fromPressureUnit>xbar</tns:fromPressureUnit><tns:toPressureUnit>atmosphere</tns:toPressureUnit></tns:ChangePressureUnit>".

The fault message generated by the server is displayed twice.
Indeed seems to be a more general bug because I tried the same test case but doing a change like:

run ChangePressureUnitX in hp(input chi, output cho).

I created a simple JAX-WS using Netbeans IDE deployed on GlassFish AS which allow easily to insert a SOAP header.

@WebService(serviceName = "MyService")
public class MyService 
{
    @WebMethod(operationName = "hello")
    public String hello(@WebParam(name = "name") String txt, 
                        @WebParam(header = true, mode = Mode.OUT) Holder<String> headerParam) 
    {
        headerParam.value = "Test header";
        return "Hello " + txt + " !";
    }
}

<?xml version = "1.0" encoding = "UTF-8" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Header>
    <ns2:arg1 xmlns:ns2="http://soap.goldencode.com/">Test header</ns2:arg1>
  </S:Header>
  <S:Body>
    <ns2:helloResponse xmlns:ns2="http://soap.goldencode.com/">
      <return>Hello Marius !</return>
    </ns2:helloResponse>
  </S:Body>
</S:Envelope>

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <header xmlns="http://schemas.xmlsoap.org/soap/envelope/">
         <AuthHeader xmlns="http://ServiceHost/SOAPHeader">
            <UserName>usr</UserName>
            <Password>psw</Password>
         </AuthHeader>
      </header>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:hello xmlns:ns1="http://soap.goldencode.com/">
         <name>test</name>
      </ns1:hello>
   </soapenv:Body>
</soapenv:Envelope>

hXdoc:IMPORT-NODE(hXnoderef2, hXnoderef1, v-log).

1. I've just tested the script on P4GL and I changed the test script. In 4GL the order of procedure parameters is mandatory else an error is throw.
The generated request looks like:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Header>
      <ns0:AuthHeader xmlns:ns0="http://ServiceHost/SOAPHeader">
         <ns0:UserName>usr</ns0:UserName>
         <ns1:Password xmlns:ns1="http://ServiceHost/SOAPHeader">psw</ns1:Password>
      </ns0:AuthHeader>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body xmlns:s0="http://soap.goldencode.com/" xmlns:s1="http://www.w3.org/2001/XMLSchema">
      <ns1:hello xmlns:ns1="http://soap.goldencode.com/">
         <name>test</name>
      </ns1:hello>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

3. The case of prefix must be the same as described in namspece. For example xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
define prefix as SOAP-ENV in upper case and is used exactly as is described SOAP-ENV:Body. It is not mandatory to have the same prefix like on P4GL

The previous JAX-WS servcie used to test the SOAP header in response does not send the header OOB (Out Of Band)
P4G when parse the WSDL for this service interpret the header as a service method parameter and an error is throw indicating that the actual number of parameters does not match the number of expected parameters.
Then I created an axis2 module which inject the SOAP Header in the response in an OOB manner. Testing the script with SimpleOperations service and the injected SOAP Header it works on both
P4GL and P2J and produces the same results. Bellow is the description of the axis2 module project.
In conclusion P2J SOAP Header implementation is OK.

This project is an axis2 module designed to inject a simple SOAP Header on response.
1. Build the project using the ant script. On success a module archive headers.mar is created.
2. Copy the module headers.mar into AXIS2_HOME/repository/modules directory.
3. Change the AXIS2_HOME/conf/axis2.xml as follow:
a). Register module by add the following line:

    <module ref="sampleModule"/>

    <!-- ================================================= -->
    <!-- Global Modules  -->
    <!-- ================================================= -->
    <!-- Comment this to disable Addressing -->
    <module ref="addressing"/>
    <module ref="sampleModule"/>

b). Add the following line

   <phase name="SamplePhase"/>

    <phaseOrder type="OutFlow">
        <!--      user can add his own phases to this area  -->
        <phase name="soapmonitorPhase"/>
        <phase name="OperationOutPhase"/>
        <phase name="SamplePhase"/>
        <!--system predefined phase-->
        <!--these phase will run irrespective of the service-->

<?xml version = "1.0" encoding = "UTF-8" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <ns1:SampleOutHeader xmlns:ns1="http://sample.module">Test Header</ns1:SampleOutHeader>
  </soapenv:Header>
  <soapenv:Body>
    <ns:getDataResponse xmlns:ns="http://goldencode.com/xsd">
      <ns:return>1.7976931348623157E308</ns:return>
    </ns:getDataResponse>
  </soapenv:Body>
</soapenv:Envelope>

<ns1:SampleOutHeader xmlns:ns1="http://sample.module">Test Header</ns1:SampleOutHeader>

No regression tests are mandatory for this changes.
Committed revision 10557.