Sun ONE logo     Previous      Contents      Index      Next     
Sun ONE Connector Builder 2.0 Developer's Guide



Installing Apache SOAP 2.2

This module describes the following topics:

Overview

SOAP is an XML based protocol for exchange of information in the distributed environment. Apache SOAP 2.2 (referred as Apache SOAP) provides a framework and runtime that support SOAP 1.1 specification.

For more details on Apache SOAP, refer to

http://xml.apache.org/soap/

Refer to http://xml.apache.org/soap/docs/install/index.html for detailed instructions on installation from Apache.

The Connector Builder generated SOAP layer on the resource adapter uses HTTP transport support available in Apache SOAP runtime. Apache SOAP ships a web application archive named soap.war, in addition to the runtime jar files and other related documentation. The soap.war contains the HTTP transport support servlet and other web based deployment helper JSPs.

Installing Apache SOAP 2.2 on iPlanet Web Server 6.0

Before proceeding with the installation, make sure that Apache SOAP is downloaded and extracted into a local directory. The following lists the high level steps involved in configuring the Apache SOAP in iPlanet Web Server (iWS) 6.0. For more details on each of the individual steps, refer to the iWS documentation.

Configuring iWS with JDK1.3.1

By default, iWS is installed with JRE 1.2.2. iWS must be configured with JDK1.3.1 in order to use Apache SOAP servlets and JSPs.

To Configure iWS

  1. Start your iWS administration server.

  2. Log into iWS administration console.

    3. Point your browser to http://[hostname]:<admin port>

    (Default admin port is 8888)

    Alternatively, on windows platforms you may be able to use Start menu to navigate to the `Administer Web Server' option under the `iPlanet Web Server' programs group.

  3. Click on the `Global Settings' tab.

  4. Click on `Configure JRE/JDK Paths' link.

  5. Select JDK and enter the location of the JDK1.3.1 (For example, /usr/jdk1.3.1). No other information related to libpath or classpath needs to be entered.

Add Apache SOAP Runtime and Other Jar Files to the iWS Classpath

The iWS classpath needs to be configured to include the Apache SOAP runtime and other dependent jar files.

To Configure the iWS Classpath

  1. Log into the iWS admin console as described in To Configure iWS.

  2. Click on the `Servers' tab.

  3. Choose `Manage Servers'.

  4. Select the server to manage and click `Manage'.

    5. The administration screen with `Preferences', `Security' etc. tabs appears.

  5. Click on the `Java' tab.

  6. Click on 'Configure JVM Attributes' and append the classpath with [ApacheSOAP_install_location]/lib/soap.jar;[connector_builder_install_root]/lib/mail-1.0.jar;[connector_builder_install_root]/lib/activation.jar;[connector_builder_install_root]/lib/icontools.jar;

  7. Click OK to update the server configuration.

Deploying Apache SOAP Web Application Module (soap.war)

The soap.war web module should be deployed into iWS for completing the Apache SOAP installation.

To Deploy Apache SOAP Web Application Module (soap.war)

  1. Make sure that [iWS_install_location]/bin/https/httpsadmin/bin is in your path and IWS_SERVER_HOME is set to your [iWS_install_location].

  2. The `wdeploy' utility available under [iWS_install_location]/bin/https/httpsadmin/bin should be used to deploy the soap.war file into iWS. Refer to iWS documentation for the correct usage of the `wdeploy' utility.

    3. From the command line, run

    wdeploy deploy -u /soap -i [server_instance_name] -v [virtual_server_id] [ApacheSOAP_install_location]/webapps/soap.war.

    For example:

    wdeploy deploy -u /soap -i myhost.acme.com -v https-myhost.acme.com /usr/soap2.2/webapps/soap.war


    Note

    The server should be restarted for all the above configurations to take effect.

Verifying Your Installation

Upon completing the above steps and restarting the iWS, the Apache SOAP should be available for service deployment and invocation.

HTTP Transport Support Verification

To check whether the Apache SOAP RPC router servlet is available for SOAP over HTTP interaction:

  • Open the browser and point it to http://[hostname:portnumber]/soap/servlet/rpcrouter.

    • If the Apache SOAP is installed properly, you should see the following message:

    SOAP RPC Router. Sorry, I don't speak via HTTP GET- you have to use HTTP POST to talk to me.

Deployment Tools Verification

To check whether the Apache SOAP deployment and admin services are deployed properly:

  1. Open the browser and point it to http://[hostname:portnumber]/soap/admin.

    2. If the Apache SOAP is installed properly, you should see the screen with `Apache SOAP Admin' heading with `List', `Deploy' and `Un-deploy' links.

  2. Click on `Deploy'

    3. You should get the `Deploy a Service' page with `Service Deployment Descriptor Template' information and related GUI elements.

This indicates that Apache SOAP installation is complete.

Installing Apache SOAP 2.2 on J2EE Reference Implementation (J2EE RI) 1.3.1

Before proceeding with the installation, make sure that Apache SOAP is downloaded and extracted into a local directory.

Add Apache SOAP Runtime and Other Jar Files to the J2EE RI Classpath

The J2EE RI server classpath needs to be updated to include the Apache SOAP runtime and other jar files.

To Update the J2EE RI Classpath

  • Modify the CPATH variable in the setenv.bat/setenv.sh available in [J2EE_RI_Install_Location]/bin to include [ApacheSOAP_Install_Location]/lib/soap.jar, <connector_builder_install_root >/lib/activation.jar, <connector_builder_install_root >/lib/mail-1.0.jar, <connector_builder_install_root >/lib/icontools.jar.

Deploy Apache SOAP Web Application Module (soap.war)

The soap.war web module should be deployed into J2EE RI for completing the Apache SOAP installation.

To Deploy the Apache SOAP Web Application Module (soap.war)

  • Deploy the Apache SOAP web application war file (soap.war) located in your [ApacheSOAP_install_location]/webapps, using J2EE RI deployment tool.

Verifying Your Installation

Upon completing the above steps and restarting the J2EE RI, Apache SOAP should be available for service deployment and invocation.

HTTP Transport Support Verification

To check whether the Apache SOAP RPC router servlet is available for SOAP over HTTP interaction:

  • Open the browser and point it to http://[hostname:portnumber]/soap/servlet/rpcrouter.

    • If the Apache SOAP is installed properly, you should see the following message:

    SOAP RPC Router. Sorry, I don't speak via HTTP GET- you have to use HTTP POST to talk to me.

Deployment Tools Verification

To check whether the Apache SOAP deployment and admin services are deployed properly:

  1. Open the browser and point it to http://[hostname:portnumber]/soap/admin.

    2. If the Apache SOAP is installed properly, you should see the screen with `Apache SOAP Admin' heading with `List', `Deploy' and `Un-deploy' links.

  2. Click on `Deploy'

    3. You should get the `Deploy a Service' page with `Service Deployment Descriptor Template' information and related GUI elements.

This indicates that Apache SOAP installation is complete.

Installing Apache SOAP 2.2 on iPlanet Application Server 6.5

For information on installing Apache SOAP 2.2 on iPlanet Application Server 6.5, refer to the documentation available at http://xml.apache.org/soap/docs/install/iPlanet.html

Currently this document refers to iAS 6.0 SP2 or SP3. The same procedure can be used for iPlanet Application Server 6.5.

Installing Apache SOAP 2.2 on Sun ONE Application Server 7

For information on installing Apache SOAP 2.2 on Sun ONE Application Server 7.0, refer to the "Developer's Guide to Clients for Sun ONE Application Server 7.0" document.

Previous      Contents      Index      Next     
Copyright 2002 Sun Microsystems, Inc. All rights reserved.

Last Updated October 20, 2002