sun.com docs.sun.com | My Sun Worldwide Sites

|  | Products |  | Downloads |  | Service & Solutions |  | Support |  | Training |  | Research

|  | Previous | Contents |  | Next
### Preface This guide describes how to install, configure, and run the Technology Compatibility Kit (TCK) that is used to test the Java API for RESTful Web Services (JAX-RS 1.1) (JSR 311) technology. The JAX-RS 1.1 TCK is designed as a portable, configurable automated test suite for verifying the compatibility of a licensee's implementation of the JAX-RS 1.1 Specification (hereafter referred to as the licensee implementation). The JAX-RS 1.1 TCK uses the JavaTest harness version 3.2.1 to run the test suite 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. Refer to the Java Partner Engineering Web site for answers to frequently asked questions and send questions you may have to your Java Partner Engineering contact. ### Who Should Use This Book This guide is for licensees of Sun Microsystems's JAX-RS 1.1 technology to assist them in running the test suite that verifies compatibility of their implementation of the JAX-RS 1.1 Specification. ### Before You Read This Book Before reading this guide, you should familiarize yourself with the Java programming language and the JAX-RS 1.1 Specification. A good resource for the Java Programming language is the Sun Microsystems, Inc. Web site. Sun Microsystems recommends that before you run the tests in the JAX-RS 1.1 TCK you have read and are familiar with the JAX-RS 1.1 Specification and the JavaTest User's Guide, which describes the main JavaTest harness. The JavaTest User's Guide is located at `<install_dir>``/docs/javatest/javatest.pdf` in the JAX-RS 1.1 TCK distribution. ### How This Book is Organized If you are installing and using the JAX-RS 1.1 TCK for the first time, it is recommended that you read Chapter 1, Introduction and Chapter 2, Procedure for Java API for RESTful Web Services Certification completely for the necessary background information, and then perform the steps outlined in the remaining chapters, while referring to the appendixes as necessary. Chapter 1, Introduction gives an overview of the principles that apply generally to all Technology Compatibility Kits (TCKs) and describes the JAX-RS 1.1 TCK. It also includes a listing of the basic steps needed to get up and running with the JAX-RS 1.1 TCK. Chapter 2, Procedure for Java API for RESTful Web Services Certification describes the conformance testing procedure and testing requirements. Chapter 3, Installation explains how to install the JAX-RS 1.1 TCK. Chapter 4, Setup and Configuration describes how to set up the JAX-RS 1.1 TCK and how to start and configure the JavaTest harness software to be used with the JAX-RS 1.1 TCK. Chapter 5, Executing Tests describes how to start the JavaTest harness and use the JAX-RS 1.1 TCK. Chapter 6, Debugging Test Problems describes several approaches for dealing with tests that fail to execute properly. Appendix A, Frequently Asked Questions provides answers to frequently asked questions. ### Typographic Conventions The following table describes the typographic conventions that are used in this book. ###### Table P-1 Typographic Conventions
Typeface | Meaning | Example
--- | --- | ---
`AaBbCc123` | The names of commands, files, and directories, and onscreen computer output | Edit your `.login` file. Use `ls `-a`` to list all files. `machine_name% you have mail.`
`AaBbCc123` | What you type, contrasted with onscreen computer output | `machine_name%` `su` `Password:`
aabbcc123 | Placeholder: replace with a real name or value | The command to remove a file is `rm` filename.
AaBbCc123 | Book titles, new terms, and terms to be emphasized | Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file. Note: Some emphasized items appear bold online.
### 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. ###### Table P-2 Shell Prompts
Shell | Prompt
--- | ---
C shell | `machine_name%`
C shell for superuser | `machine_name#`
Bourne shell and Korn shell | `$`
Bourne shell and Korn shell for superuser | `#`
### Related Documentation ###### Table P-3 Related Documentation Titles
Application | Title
--- | ---
Using JavaTest software | JavaTest User's Guide and JavaTest online help (located in the `TS_HOME/docs` directory in the JAX-RS 1.1 TCK distribution)
JAX-RS reference | The Java API for RESTful Web Services Specification
Using Java technology | Java Programming Language, Java Language Specification Second Edition, Java Virtual Machine Specification Second Edition, Java 2 Platform
### Accessing Sun Documentation Online The Java Developer ConnectionSM Web site enables you to access Java platform technical documentation. ### Sun Welcomes Your Comments We are interested in improving our documentation and welcome your comments and suggestions. You can email your comments to us at docs@java.sun.com.
|  | Previous | Contents |  | Next

Company Info Contact Terms of Use Privacy Copyright 1994-2009 Sun Microsystems, Inc.