Preface


The iPlanet Application Server Foundation Class Reference (Java) provides specification-level documentation for the public classes and interfaces, and their methods, in the iPlanet Application Server Foundation Class Library. Use this book to look up how a particular class or interface method works, what syntax is required, and for examples on how to use it.

For conceptual and task-oriented information on designing and developing iPlanet Application Server applications, read the Programmer's Guide (Java).

This preface contains the following sections:

• Using the Documentation

• How This Guide Is Organized

• Documentation Conventions

• Naming Conventions

Using the Documentation

---

The following table lists the tasks and concepts that are described in the iPlanet Application Server manuals and Release Notes. If you are trying to accomplish a specific task or learn more about a specific concept, refer to the appropriate manual.

Note that the printed manuals are also available online in PDF and HTML format, at: http://docs.iplanet.com/docs/manuals/ias.html

For information about	See the following	Shipped with
Late-breaking information about the software and the documentation	Release Notes	Available on the Web, at http://docs.iplanet.com
Installing iPlanet Application Server and its various components (Web Connector plug-in, iPlanet Application Server Administrator), and configuring the sample applications	Installation Guide	iPlanet Application Server 6.5
Creating iPlanet Application Server 6.5 applications that follow the open Java standards model (Servlets, EJBs, JSPs, and JDBC), by performing the following tasks: Creating the presentation and execution layers of an application Placing discrete pieces of business logic and entities into Enterprise Java Bean (EJB) components Using JDBC to communicate with databases Using iterative testing, debugging, and application fine-tuning procedures to generate applications that execute correctly and quickly	Developer's Guide	iPlanet Application Server 6.5
Administering one or more application servers using iPlanet Application Server Administrator Tool to perform the following tasks: Monitoring and logging server activity Implementing security for iPlanet Application Server Enabling high availability of server resources Configuring web-connector plugin Administering database connectivity Administering transactions Configuring multiple servers Administering multiple-server applications Load balancing servers Managing distributed data synchronization Setting up iPlanet Application Server for development	Administrator's Guide	iPlanet Application Server 6.5
Migrating your applications to the new iPlanet Application Server 6.5 programming model from the Netscape Application Server version 2.1, including a sample migration of an Online Bank application provided with iPlanet Application Server	Migration Guide	iPlanet Application Server 6.5
Using the public classes and interfaces, and their methods in the iPlanet Application Server class library to write Java applications	Server Foundation Class Reference (Java)	iPlanet Application Server 6.5
Using the public classes and interfaces, and their methods in the iPlanet Application Server class library to write C++ applications	Server Foundation Class Reference (C++)	Order separately

How This Guide Is Organized

---

This guide is organized into three chapters and an appendix, as follows:

• Chapter 1 "About the Application Server Foundation Class Library"

• Chapter 2 "Classes"

• Chapter 3 "Interfaces"

• Appendix A "Return Codes"

Documentation Conventions

---

File and directory paths are given in Microsoft Windows format (with backslashes separating directory names). For Unix versions, the directory paths are the same, except that forward slashes are used to separate directories.

This guide uses URLs of the form:

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.

This guide uses the following font conventions:

• 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 emphasis words used in the literal sense.

Naming Conventions

---

This guide uses the Java naming conventions detailed in the following table.

Table 0.1

Item	Convention
Package name	Lowercase with periods indicating directory levels. For example, com.iPlanet.server.servlet.extension.
Class name	Mixed case with initial uppercase. For example, AppLogic class.
Interface name	Mixed case with initial uppercase. For example, IAppEventObj.
Method name	Mixed case with initial lowercase. For example, getTables( ).
Parameters	Mixed case with initial lowercase. For example, myQuery.