Installation

## 3 Installation

This chapter explains how to install the Jakarta XML Web Services TCK software.

After installing the software according to the instructions in this chapter, proceed to Chapter 4, "Setup and Configuration," for instructions on configuring your test environment.

### 3.1 Obtaining a Compatible Implementation

Each compatible implementation (CI) will provide instructions for obtaining their implementation. Eclipse Metro 4.0.0 is a compatible implementation which may be obtained from https://projects.eclipse.org/projects/ee4j.metro

### 3.2 Installing the Software

Before you can run the XML Web Services TCK tests, you must install and set up the following software components:

- Jakarta EE 10 Compatible Platform or, at a minimum, a Web server with a Servlet container

- Java SE 11+

- Apache Ant 1.10.0+

- A CI for XML Web Services 4.0, one example is Eclipse Metro 4.0.0

- XML Web Services TCK version 4.0, which includes:

  - JDOM 1.1.3

  - Apache Commons HTTP Client 3.1

  - Apache Commons Logging 1.1.3

  - Apache Commons Codec 1.9

- The XML Web Services 4.0 Vendor Implementation (VI)

Follow these steps:

1. Install the Java SE 11+ software, if it is not already installed.
   Download and install the Java SE 11+ software from http://www.oracle.com/technetwork/java/javase/downloads/index.html. Refer to the installation instructions that accompany the software for additional information.

2. Install the Apache Ant 1.10.0+ software, if it is not already installed.
   Download and install Apache Ant 1.10.0+ software from Apache Ant Project. For complete information about Ant, refer to the extensive documentation on the Apache Ant Project site. The Apache Ant Manual is available at `http://ant.apache.org/manual/index.html`. Apache Ant is protected under the Apache Software, License 2.0, which is is available on the Apache Ant Project license page at `http://ant.apache.org/license.html`.

3. Install the XML Web Services TCK 4.0 software.

   1. Copy or download the XML Web Services TCK software to your local system.
      You can obtain the XML Web Services TCK software from the Jakarta EE site https://jakarta.ee/specifications/xml-web-services/4.0/.

   2. Use the `unzip` command to extract the bundle in the directory of your choice:
      `unzip jakarta-xml-ws-tck-4.0.0.zip`
      This creates the TCK directory. The TCK is the test suite home, `<TS_HOME>`.

4. Install the Jakarta EE 10 Compatible Platform software (the servlet Web container used for running the XML Web Services TCK with the XML Web Services 4.0 Compatible Implementation), if it is not already installed.
   Download and install the Servlet Web container with the XML Web Services 4.0 Compatible Implementation used for running the XML Web Services TCK 4.0, represented by the Jakarta EE 10 Compatible Platform. This software can be obtained from the Java Licensee Engineering Web site. Refer to any installation instructions that accompany the software for additional information.

5. Install the Jakarta EE 10 Compatible Platform software which contains the XML-WS 4.0 Compatible Implementation or install the Standalone XML-WS 4.0 Compatible Implementation software. The Jakarta EE 10 Compatible Platform software contains the XML-WS 4.0 Compatible Implementation and is used to validate your initial configuration and setup of the XML-WS TCK 4.0, as well as to run the reverse tests which are explained further in Chapter 4, "Setup and Configuration" and Appendix B.
   The Standalone XML-WS 4.0 Compatible Implementation software contains the XML-WS 4.0 Compatible Implementation and can be used with any web container that meets the minimum requirements for a container as defined in the XML-WS 4.0 Specification such as the Apache Tomcat web container.
   If you use the Standalone XML-WS 4.0 Compatible Implementation software with the Apache Tomcat web container, you need to copy the JAR files/classes from the standalone XML-WS 4.0 Compatible Implementation software to the correct location under the Apache Tomcat web container. Assuming the Apache Tomcat web container is installed under `${CATALINA_HOME}`, XML-WS 4.0 Compatible Implementation under `${JAXWS_HOME}` and XML-WS TCK 4.0 under `${TS_HOME}`, you would copy the JAR files/classes as follows:

       mkdir -p ${CATALINA_HOME}/shared/lib

       cp ${JAXWS_HOME}/lib/*.jar ${JAXWS_HOME}/extra/*.jar \
          ${CATALINA_HOME}/shared/lib

       cp ${TS_HOME}/lib/tsharness.jar ${TS_HOME}/lib/jaxwstck.jar \
          ${CATALINA_HOME}/shared/lib

   Edit `${CATALINA_HOME}/conf/catalina.properties` and set value of `shared.loader` property to `${catalina.base}/shared/lib/*.jar`:

       shared.loader=${catalina.base}/shared/lib/*.jar

   If, instead of using Tomcat, you are using the Jakarta EE 10 Compatible Implementation, which already includes XML-WS 4.0, you only need to copy the `jaxwstck/lib/tsharness.jar` and `jaxwstck/lib/jaxwstck.jar` TCK JAR files to the domain’s `lib/ext` directory.

6. Install a XML Web Services 4.0 Compatible Implementation.
   A Compatible Implementation is used to validate your initial configuration and setup of the XML Web Services TCK 4.0 tests, which are explained further in Chapter 4, "Setup and Configuration."
   The Compatible Implementations for XML Web Services are listed on the Jakarta EE Specifications web site: https://jakarta.ee/specifications/xml-web-services/4.0/.

7. Install a Web server on which the XML Web Services TCK test applications can be published for testing the VI.

8. Install the XML Web Services VI to be tested.
   Follow the installation instructions for the particular VI under test.

Copyright © 2017, 2022 Oracle and/or its affiliates. All rights reserved.