Installation Instructions

NEEDS TO BE UPDATED FOR 2.1

August, 2000.

The Apache-SOAP distribution can be installed for use as a client or as a server. This document provides installation instructions for both cases and also has a trouble shooting section to help sort out common installation related problems.

Common Instructions

We assume that you have downloaded the binary distribution of Apache-SOAP and have extracted the archive into the directory /foo. Thus the files from the distribution are in the directory /foo/soap-2_0/.

Note that if you are on a Win32 machine then you should replace "/" with "\" as you follow these instructions.

XML Parser: Apache-SOAP requires Apache Xerces (Java) version 1.1.2 or higher. These versions support the DOM level 2 candidate recommendation which provides namespace support. If you have any other XML parsers (or other JAR files which may have the org.w3c.dom.* interfaces), then it is very important that you place the JAR file xerces.jar from Xerces at the front of your classpath. Apache-SOAP will not work otherwise.

While it is possible to use another parser, the current codebase does not support making this change conveniently; hence the mechanism is not documented here.

JavaMail and JavaBeans Activation Framework: Apache-SOAP requires JavaMail and the JavaBeans Activation Framework, downloadable from Sun. Place mail.jar and activation.jar in your classpath.

Classpath: Add /foo/soap-2_0/lib/soap.jar to your classpath. If you want to run the samples, you also need to add /foo/soap-2_0 to your classpath.

Client-Side Instructions

Once you have followed the common instructions, you are ready to go!

Server-Side Instructions

To install the server-side of Apache-SOAP, you need a Web application server that supports servlets and JSPs (if you want to run the admin client as well).

Installing the RPC router and admin client: The instructions for how to install varies from one app server to another. Here are instructions for the following servers:

Didn't find yours listed? See whether the instructions for Tomcat (for example) gives you enough hints on how to do it. If not, you should try asking on the Apache-SOAP user's list; more than likely someone else has done it already. You can subscribe to the list here: http://xml.apache.org/soap/mail.html.

Troubleshooting Installation Problems

Problem Comments
I get an exception saying getAttributeNS is not found Classpath is not correctly set - you still have some old parser or some other JAR file that has the org.w3c.dom.* classes ahead of xerces.jar from Xerces 1.1.2 or later.
x y
x2 y2
x3 y3