InfoCenter Home >
4: Developing applications >
4.8: Web services - an overview >
4.8.1: Web services components >
4.8.1.2: SOAP support >
4.8.1.2.3: Deploying a programming artifact as a SOAP accessible Web service

4.8.1.2.3: Deploying a programming artifact as a SOAP accessible Web service

Complete these steps to deploy a SOAP accessible Web service in WebSphere Application Server:

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

    To deploy a 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 (EAR) file

    Package the code artifact into an Enterprise Archive (EAR). This step is a deployment packaging requirement of WebSphere Application Server. Use the Application Assembly Tool (AAT) to package the artifact. See article Application Assembly Tool for information on using the tool.

  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 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>
    View the Apache SOAP deployment descriptor documentation for more information.

  4. Execute the SoapEarEnabler tool to enable your Web service

    As mentioned above, your code artifact must first be packaged into an Enterprise Archive (EAR). 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 runtime.

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

    View the SoapEarEnabler tool documentation for more information on SoapEarEnabler.

  5. Install the service-enabled EAR file

    Take the modified EAR file, created in the previous step, and install it in WebSphere Application Server.

    View article Installing application files for information on installing EAR files.

  6. Update the Web server plugin configuration

    Run the GenPluginCfg.bat file on Windows NT or the GenPluginCfg.sh script on UNIX to regenerate the plugin configuration.

  7. Restart the application server

See the related information links for an enablement scenario.

Go to previous article: Accessing enterprise beans  through SOAP Go to next article: Apache SOAP deployment descriptors

 

 
Go to previous article: Accessing enterprise beans  through SOAP Go to next article: Apache SOAP deployment descriptors