Assembling Apache SOAP Web services

Use the Simple Object Access Protocol (SOAP) EAR Enabler tool to assemble Apache SOAP Web services. The following tasks comprise assembling Web services:

 

  1. Create or locate the software resource to be exposed as a service.

    To expose the service, create a programming artifact, one of the supported types, or locate an existing piece of code of the supported type.

  2. Assemble an Enterprise Archive file.

    Package the code artifact into an EAR file. This step is a deployment packaging requirement of WebSphere Application Server. Use the Application Assembly Tool (AAT) to package the artifact.

  3. Create the Apache SOAP deployment descriptor for the desired service.

    In order to deploy an artifact as a SOAP service, create a Apache SOAP deployment descriptor that describes the service you are creating. This step exposes the programming artifact as a service. The descriptor describes and defines the parts of the code that will be invoked with the SOAP calls.

    The information contained in the deployment descriptor varies, depending on the type of artifact you are exposing. For more information about various deployment descriptor types see the article Simple Object Access Protocol deployment descriptor. For example, the following deployment descriptor might be used with the StockQuoteSample:

    <isd:service xmlns:isd="http://xml.apache.org/xml-soap/deployment"
                 id="urn:service-urn" [type="message"]>
                 <isd:provider type="java" 
                 scope="Request | Session | Application"
                 methods="exposed-methods">
                 <isd:java class="implementing-class" [static="true|false"]/>
                 </isd:provider>
      <isd:faultListener>org.apache.soap.server.DOMFaultListener</isd:faultListener>
                 </isd:service>
    

  4. Execute the SoapEarEnabler tool to enable your Web service.

    Your code artifact must first be packaged into an EAR file. Next, using the deployment descriptor as input, add the necessary pieces to the EAR file to enable the artifact as a Web service. To facilitate this process, use the Java based tool called SoapEarEnabler. Depending on whether you secure the Web service, this tool will add two Web modules: soap.war and soap-sec.war to the EAR file. These Web modules include the SOAP deployment descriptors, plus the necessary parts to deploy the service into the WebSphere Application Server run time.

    The service does not become available until the soap-enabled EAR file is installed, and the server is restarted.


Assembling applications
Apache SOAP deployment descriptor

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.