About This Guide

This guide describes how to create and run Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications that follow the new open Java standards model for Java™ Servlet, JavaServer Pages™ (JSP™), Enterprise JavaBeans™ (EJB™), and other J2EE components on the J2EE 1.4 Application Server.

This preface contains information about the following topics:

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

---

Who Should Use This Guide

The intended audience for this guide is the person who develops, assembles, and deploys J2EE applications in a corporate enterprise.

This guide assumes you are familiar with the following topics:

J2EE specification
HTML
Java programming
Java APIs as defined in the Java™ Servlet, JavaServer Pages™ (JSP™), Enterprise JavaBeans™ (EJB™), and Java™ Database Connectivity (JDBC™) specifications
Structured database query languages such as SQL
Relational database concepts
Software development processes, including debugging and source code control

---

Using the Documentation

The J2EE 1.4 Application Server manuals are available as online files in Portable Document Format (PDF) and Hypertext Markup Language (HTML).

The following table lists tasks and concepts described in the J2EE 1.4 Application Server manuals.

Table 1  J2EE 1.4 Application Server Documentation Roadmap 

For information about	See the following
Late-breaking information about the software and the documentation, plus a comprehensive, table-based summary of supported hardware, operating system, JDK, and JDBC/RDBMS.	Release Notes
J2EE 1.4 Application Server overview, including the features available with each product edition.	Product Overview
Diagrams and descriptions of server architecture and the benefits of the J2EE 1.4 Application Server architectural approach.	Server Architecture
New enterprise, developer, and operational features of J2EE 1.4 Application Server.	What’s New
How to get started with the J2EE 1.4 Application Server product. Includes a sample application tutorial.	Getting Started Guide
Installing the J2EE 1.4 Application Server software and its components, such as sample applications, the Administration Console, and the high-availability components. Instructions for implementing a basic high-availability configuration are included.	Installation Guide
Evaluating your system needs and enterprise to ensure that you deploy J2EE 1.4 Application Server in a manner that best suits your site. General issues and concerns that you must be aware of when deploying an application server are also discussed.	System Deployment Guide
Creating and implementing Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications intended to run on the J2EE 1.4 Application Server that follow the open Java standards model for J2EE components and APIs. Includes general information about application design, developer tools, security, assembly, deployment, debugging, and creating lifecycle modules. A comprehensive J2EE 1.4 Application Server glossary is included.	Developer’s Guide
Information and instructions on the configuration, management, and deployment of the J2EE 1.4 Application Server subsystems and components, from both the Administration Console and the command-line interface. Topics include cluster management, the high-availability database, load balancing, and session persistence. A comprehensive J2EE 1.4 Application Server glossary is included.	Administrator’s Guide
Editing the J2EE 1.4 Application Server configuration file, domain.xml.	Administrator’s Configuration File Reference
Configuring and administering security for the J2EE 1.4 Application Server operational environment. Includes information on general security, certificates, and SSL/TLS encryption. HTTP server-based security is also addressed.	Administrator’s Guide to Security
Configuring and administering service provider implementation for J2EE™ Connector Architecture (CA) connectors for the J2EE 1.4 Application Server. Topics include the Administration Tool, Pooling Monitor, deploying a JCA connector, and sample connectors and sample applications.	J2EE CA Service Provider Implementation Administrator’s Guide
Migrating your applications to the new J2EE 1.4 Application Server programming model, specifically from iPlanet Application Server 6.x and from Netscape Application Server 4.0. Includes a sample migration.	Migrating and Redeploying Server Applications Guide
How and why to tune your J2EE 1.4 Application Server to improve performance.	Performance Tuning Guide
Information on solving J2EE 1.4 Application Server problems.	Troubleshooting Guide
Messages that you may encounter while running J2EE 1.4 Application Server. Includes a description of the likely cause and guidelines on how to address the condition that caused the message to be generated.	Error Message Reference
Utility commands available with the J2EE 1.4 Application Server; written in manpage style.	Utility Reference Manual
Using the Sun™ Open Net Environment (Sun ONE) Message Queue software.	The Sun ONE Message Queue documentation at: http://docs.sun.com/db?p=prod/s1.s1msgqu

---

How This Guide Is Organized

This guide provides a J2EE 1.4 Application Server environment overview for developing applications, and includes the following topics:

Chapter 1, “Securing J2EE Applications”
Chapter 2, “Using the JDBC API for Database Access”
Chapter 3, "Using Container-Managed Persistence for Entity Beans"
Chapter 4, “Debugging J2EE Applications”

Finally, an Index is provided.

---

Related Information

You can find a directory of URLs for the official specifications at install_dir/docs/index.htm. Additionally, the following resources may be useful:

General J2EE Information:

The J2EE 1.4 Tutorial:

http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html

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

Programming with Servlets and JSPs:

Java Servlet Programming, by Jason Hunter, O’Reilly Publishing

Java Threads, 2nd Edition, by Scott Oaks & Henry Wong, O’Reilly Publishing

Programming with EJB components:

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

Programming with JDBC:

Database Programming with JDBC and Java, by George Reese, O’Reilly Publishing

JDBC Database Access With Java: A Tutorial and Annotated Reference (Java Series), by Graham Hamilton, Rick Cattell, & Maydene Fisher

---

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 installations:

/opt/SUNWappserver

Windows, all installations:

C:\Sun\AppServer

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.

Domain root directories are indicated by domain_dir in this document, which by default is an abbreviation for the following:

install_dir/domains/domain_dir

However, the directory containing all the domains can be changed from install_dir/domains/ to another directory during installation. In configuration files, you may see domain_dir represented as follows:

${com.sun.aas.instanceRoot}

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 installation, the application server files are spread across several root directories. These directories are described in this section.

For Solaris 8 and 9 installations, this guide uses the following document conventions to correspond to the various default installation directories provided:
install_dir refers to /opt/SUNWappserver, 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/SUNWappserver/domains which is the default location for any domains that are created.
install_config_dir refers to /etc/opt/SUNWappserver/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 general feedback on the product or documentation, please send this to appserver-feedback@sun.com.

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

Previous      Contents      Index      Next

---

Copyright 2003 Sun Microsystems, Inc. All rights reserved.