Preface

## Preface

This guide describes how to install, configure, and run the Technology Compatibility Kit (TCK) that is used to test the Jakarta RESTful Web Services (Jakarta REST 3.1) technology.

The Jakarta REST TCK is a portable, configurable automated test suite for verifying the compatibility of a vendor’s implementation of the Jakarta REST 3.1 Specification (hereafter referred to as the vendor implementation or VI). The Jakarta REST TCK uses the Junit framework to run the test suite along with Arquillian to run container tests.

Note | Note All references to specific Web URLs are given for the sake of your convenience in locating the resources quickly. These references are always subject to changes that are in many cases beyond the control of the authors of this guide.

Jakarta EE is a community sponsored and community run program. Organizations contribute, along side individual contributors who use, evolve and assist others. Commercial support is not available through the Eclipse Foundation resources. Please refer to the Eclipse EE4J project site (https://projects.eclipse.org/projects/ee4j). There, you will find additional details as well as a list of all the associated sub-projects (Implementations and APIs), that make up Jakarta EE and define these specifications. If you have questions about this Specification you may send inquiries to jaxrs-dev@eclipse.org. If you have questions about this TCK, you may send inquiries to jaxrs-dev@eclipse.org.

### Who Should Use This Book

This guide is for vendors that implement the Jakarta REST 3.1 technology to assist them in running the test suite that verifies compatibility of their implementation of the Jakarta REST 3.1 Specification.

### Before You Read This Book

You should be familiar with the Jakarta REST 3.1, version 3.1 Specification, which can be found at https://jakarta.ee/specifications/restful-ws/3.1/.

### Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Convention | Meaning | Example
--- | --- | ---
Boldface | Boldface type indicates graphical user interface elements associated with an action, terms defined in text, or what you type, contrasted with onscreen computer output. | From the File menu, select Open Project. A cache is a copy that is stored locally. `machine_name% *su*` `Password:`
`Monospace` | Monospace type indicates the names of files and directories, commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. | Edit your `.login` file. Use `ls` `-a` to list all files. `machine_name% you have mail.`
Italic | Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. | Read Chapter 6 in the User’s Guide. Do not save the file. The command to remove a file is `rm` filename.

### Shell Prompts in Command Examples

The following table shows the default UNIX system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Shell | Prompt
--- | ---
C shell | `machine_name%`
C shell for superuser | `machine_name#`
Bourne shell and Korn shell | `$`
Bourne shell and Korn shell for superuser | `#`
Bash shell | `shell_name-shell_version$`
Bash shell for superuser | `shell_name-shell_version#`

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