About This Document

This guide describes how to create and run Web services and Java^TM based clients that invoke them on Sun^TM Open Net Environment (Sun ONE) Application Server 7. In addition to describing programming concepts and tasks, this guide offers sample code, implementation tips, reference material, and a glossary.

This preface contains information about the following topics:

• Who Should Use This Guide
• Using the Documentation
• How This Guide Is Organized
• Reference Information
• Documentation Conventions
• Product Support

Who Should Use This Guide

---

The intended audience for this guide are the information technology developers in a corporate enterprise who develop and publish Web services, and build clients that invoke them.

This guide assumes you are familiar with the following topics:

• Java(2) Platform, Enterprise Edition^TM specification
• HTML
• Java^TM and XML programming
• Java APIs as defined in specifications for EJB^TM, JSP^TM, and JDBC^TM
• Software development processes, including debugging and source code control

Using the Documentation

---

The Sun ONE Application Server manuals are available as online files in Portable Document Format (PDF) and Hypertext Markup Language (HTML) formats, at:

http://docs.sun.com/

The following table lists tasks and concepts described in the Sun ONE Application Server manuals. The left column lists the tasks and concepts, and the right column lists the corresponding manuals.

   Sun ONE Application Server Documentation Roadmap

For information about	See the following
Late-breaking information about the software and the documentation	Release Notes
Supported platforms and environments	Platform Summary
Introduction to the application server, including new features, general installation information, migration details, and architectural overview	Getting Started Guide
Installing Sun ONE Application Server and its various components (sample applications, Administration interface, Sun ONE Message Queue).	Installation Guide
Creating and implementing J2EE applications that follow the open Java standards model on the Sun ONE Application Server 7. Includes general information about application design, developer tools, security, assembly, deployment, debugging, and creating lifecycle modules.	Developer's Guide
Creating and implementing J2EE applications that follow the open Java standards model for web applications on the Sun ONE Application Server 7. Discusses web application programming concepts and tasks, and provides sample code, implementation tips, and reference material.	Developer's Guide to Web Applications
Creating and implementing J2EE applications that follow the open Java standards model for EJBs on the Sun ONE Application Server 7. Discusses EJB programming concepts and tasks, and provides sample code, implementation tips, and reference material.	Developer's Guide to Enterprise JavaBeans Technology
Creating Web services and clients in Sun ONE Application Server environment.	Developer's Guide to Web Services
Creating clients that access J2EE applications on the Sun ONE Application Server.	Developer's Guide to Clients
J2EE features such as JDBC, JNDI, JTS, JMS, JavaMail, resources, and connectors	Developer's Guide to J2EE Features and Services
Creating custom NSAPI plug-ins	Developer's Guide to NSAPI
Performing the following administration tasks: Using the Administration interface and the command line interface Configuring server preferences Using server instances Monitoring and logging server activity Configuring the web server plug-in Configuring the Java Messaging Service Using J2EE features Configuring support for CORBA-based clients Configuring database connectivity Configuring transaction management Configuring the web container Deploying applications Managing virtual servers	Administrator's Guide
Editing server configuration files	Administrator's Configuration File Reference
Configuring and administering security for the Sun ONE Application Server 7 operational environment. Includes information on general security, certificates, and SSL/TLS encryption. Web-core-based security is also addressed.	Administrator's Guide to Security
Configuring and administering service provider implementation for J2EE CA connectors for the Sun ONE Application Server 7. Includes information about the Administration Tool, DTDs and provides sample XML files.	J2EE CA Service Provider Implementation Administrator's Guide
Migrating your applications to the new Sun ONE Application Server 7 programming model from the Netscape Application Server version 2.1, including a sample migration of an Online Bank application provided with Sun ONE Application Server	Migration Guide
Using Sun ONE Message Queue	The Sun ONE Message Queue documentation at http://docs.iplanet.com/docs/manuals/javamq.html

How This Guide Is Organized

---

This guide provides instructions for the development and the deployment of Web services to Sun ONE Application Server. The guide also provides information on developing client applications that can invoke Web services.

• "About Web Services"

This module introduces you to Web services and the standards used in implementing Web services. Also discusses about the working of Web services in the Sun ONE Application Server environment.

• "Services and Clients Using JAX-RPC"

This module describes the procedure to develop, deploy, execute JAX-RPC Web services and clients that access such services.

• "SOAP Clients and Services Using SAAJ and JAXM"

This module introduces you to the SAAJ and JAXM APIs, how to use these APIs to develop message-oriented services and clients in Sun ONE Application Server environment.

• "Clients Using JAXR"

This module introduces you to the JAXR API, how to use the API to build clients, and how to manage the registry data.

• "XML Schema Definitions"

This appendix provides XML Schema Definitions for the various configuration files used in developing JAX-RPC Web services and clients.

Finally, a Glossary and Index are provided.

Reference Information

---

In addition to the information in the Sun ONE Application Server documentation collection listed in "Using the Documentation"", we recommend the following resources:

General J2EE Information:

Core J2EE Patterns: Best Practices and Design Strategies by Deepak Alur, John Crupi, & Dan Malks, Prentice Hall Publishing

Java Security, by Scott Oaks, O'Reilly Publishing

Web Services:

Java Web Services, by David Chappell and Tyler Jewell, O'Reilly Publishing

Programming with EJB components:

Enterprise JavaBeans, by Richard Monson-Haefel, O'Reilly Publishing

Java API Specifications:

http://java.sun.com/xml/download.html

Java Web Services Tutorial:

http://java.sun.com/webservices/docs/1.0/tutorial/index.html

Documentation Conventions

---

This section describes the types of conventions used throughout this guide:

• General Conventions
• Conventions Referring to Directories

General Conventions

The following general conventions are used in this guide:

• File and directory paths are given in UNIX^® format (with forward slashes separating directory names). For Windows versions, the directory paths are the same, except that backslashes are used to separate directories.
• URLs are given in the format:

http://server.domain/path/file.html

In these URLs, server is the server name where applications are run; domain is your Internet domain name; path is the server's directory structure; and file is an individual filename. Italic items in URLs are placeholders.

• Font conventions include:

• The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, pathnames, directory names, and HTML tags.
• Italic type is used for code variables.
• Italic type is also used for book titles, emphasis, variables and placeholders, and words used in the literal sense.
• Bold type is used as either a paragraph lead-in or to indicate words used in the literal sense.
• Installation root directories for most platforms are indicated by install_dir in this document. Exceptions are noted in Conventions Referring to Directories.

By default, the location of install_dir on most platforms is:

• Solaris 8 non-package-based Evaluation installations:

user's home directory/sun/appserver7

• Solaris unbundled, non-evaluation installations:

/opt/SUNWappserver7

• Windows, all installations:

C:\Sun\AppServer7

For the platforms listed above, default_config_dir and install_config_dir are identical to install_dir. See Conventions Referring to Directories for exceptions and additional information.

• Instance root directories are indicated by instance_dir in this document, which is an abbreviation for the following path:

default_config_dir/domains/domain/instance

• UNIX-specific descriptions throughout this manual apply to the Linux operating system as well, except where Linux is specifically mentioned.

Conventions Referring to Directories

By default, when using the Solaris 8 and 9 package-based installation and the Solaris 9 bundled installation, the application server files are spread across several root directories. These directories are described in this section.

• For Solaris 9, bundled installations, this guide uses the following document conventions to correspond to the various default installation directories provided:

• install_dir refers to /usr/appserver/, which contains the static portion of the installation image. All utilities, executables, and libraries that make up the application server reside in this location.
• default_config_dir refers to /var/appserver/domains, which is the default location for any domains that are created.
• install_config_dir refers to /etc/appserver/config, which contains installation-wide configuration information such as licenses and the master list of administrative domains configured for this installation.
• For Solaris 8 and 9 package-based, non-evaluation, unbundled installations, this guide uses the following document conventions to correspond to the various default installation directories provided:

• install_dir refers to /opt/SUNWappserver7, which contains the static portion of the installation image. All utilities, executables, and libraries that make up the application server reside in this location.
• default_config_dir refers to /var/opt/SUNWappserver7/domains which is the default location for any domains that are created.
• install_config_dir refers to /etc/opt/SUNWappserver7/config, which contains installation-wide configuration information such as licenses and the master list of administrative domains configured for this installation.

Product Support

---

If you have problems with your system, contact customer support using one of the following mechanisms:

• The online support web site at:

http://www.sun.com/supportraining/

• The telephone dispatch number associated with your maintenance contract

Please have the following information available prior to contacting support. This helps to ensure that our support staff can best assist you in resolving problems:

• Description of the problem, including the situation where the problem occurs and its impact on your operation
• Machine type, operating system version, and product version, including any patches and other software that might be affecting the problem
• Detailed steps on the methods you have used to reproduce the problem
• Any error logs or core dumps