Installation

## 3 Installation

This chapter explains how to install the Jakarta XML Binding 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 Implementation of JAXB is a compatible implementation which may be obtained from https://github.com/eclipse-ee4j/jaxb-ri

### 3.2 Installing the Software

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

- Java SE 8

- A CI for XML Binding 3.0, one example is Eclipse Implementation of JAXB

- XML Binding TCK version 3.0, which includes:

  - (no additional libraries)

- The XML Binding 3.0 Vendor Implementation (VI)

Follow these steps:

1. Install the Java SE 8 software, if it is not already installed.
   Download and install the Java SE 8 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 XML Binding TCK 3.0 software.

   1. Copy or download the XML Binding TCK software to your local system.
      You can obtain the XML Binding TCK software from the Jakarta EE site https://jakarta.ee/specifications/xml-binding/3.0/.

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

3. The zip file above contains the XML Binding TCK installer jar file; use this installer to install the XML Binding TCK.

   1. Extract the XML Binding TCK 3.0 product bundle in the directory of your choice:
      ``java -jar PATH-TO-XML-BINDING-TCK-JAR options [-o outputdir]``
      The following descriptions are provided for the installation command:

      - `java`: Java SE 8 or later platform reference implementation.

      - `PATH-TO-XML-BINDING-TCK-JAR`: The path of the XML Binding TCK 3.0 JAR file to install.

      - `options`: Unless a user specifies options, the default behavior installs XML Binding TCK 3.0 in verbose mode (writes the file names it is installing to standard out) into the current directory. The installation utility accepts the following options:

        - `-q`: Installs XML Binding TCK 2.3 in quiet mode.

        - `-l`: Prints a list to standard output of the options that will be installed.

        - `-onError mode` : Sets the mode of sensitivity that the installer has to errors. The `–onError` : Instructs what to do when it encounters an error while installing XML Binding TCK 3.0. This option has three valid modes:

          - `ignore`: Instructs the installer to ignore any errors and continue installation.

          - `report`: Instructs the installer to continue with the installation but report any errors when the installation is completed.

          - `fail`: Instructs the installer to stop installation once an error is encountered.

        - `–usage`: Prints a usage message to standard out and exits (not listed as an option in the usage message).

        - `–help`: Prints a help message to standard out and exits (not listed as an option in the help message).

      - `[-o outputdir]`: Installs XML Binding TCK 3.0 into the directory specified by `outputdir`.

   2. This action creates the `jaxb-tck23` directory. The topmost XML Binding TCK installation directory is referred to as the Test Suite Home, or `<TS_HOME>`.

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

5. Install the XML Binding VI to be tested.
   Follow the installation instructions for the particular VI under test.

Copyright © 2018, 2020 Oracle and/or its affiliates. All rights reserved.