About This Guide

This guide describes how to configure and administer Sun^™ ONE Application Server 7, Enterprise Edition. It is intended for information technology administrators in the corporate enterprise who want to extend client-server applications to a broader audience through the World Wide Web.

This preface includes the following sections:

What’s In This Guide?
How This Guide Is Organized
Documentation Conventions
Product Line Overview
Documentation Conventions
Product Support

---

What’s In This Guide?

This guide explains how to configure and administer the Sun ONE Application Server. After configuring your server, use this guide to help maintain your server.

---

How This Guide Is Organized

This guide is divided into four parts, plus a comprehensive index. Begin with Part I, “Server Basics and Administering Global Settings” for an overview of the product. Part II, “Managing an Individual Server Instance” introduces you to using the Administration Server, and to using other server functions that affect all server instances.

Once you are familiar with the fundamentals of using the Administration Server, you can refer to Part III, “Managing HTTP Server Features and Virtual Servers,” which provides information for using programs and configuration styles.

For configuring multiple application server instances, setting up clustering, configuring HTTP session load balancing and failover, refer to Part IV, “Configuring Multiple Server Instances.”

Finally, Appendixes addresses specific reference topics that describe various topics, including internationalization issues, server extensions, failover scenarios, and the Sun ONE Application Server command line interface documentation.

Part I: Server Basics and Administering Global Settings

This part provides an overview of the Sun ONE Application Server. The following chapters are included:

Chapter 1, "Getting Started with Sun ONE Application Server Administration," provides an overview of Sun ONE Application Server.
Chapter 2, "Setting Administration Server Preferences," describes how to manage your Administration Server.
Chapter 3, "Configuring Administrative Domains," describes how to use multiple domains.

Part II: Managing an Individual Server Instance

This part provides conceptual and procedural details about configuring, managing, and using server instances. The following chapters are included:

Chapter 4, "Using Application Server Instances," describes how to configure server preferences for your Sun ONE Application Server.
Chapter 5, "Using Logging," describes the foundation for logging, and the logging features and functions within Sun ONE Application Server.
Chapter 6, "Monitoring Sun ONE Application Server," contains information about the monitoring and Simple Network Management Protocol (SNMP) features and functions available within Sun ONE Application Server 7, Enterprise Edition.
Chapter 7, "Configuring J2EE Containers," explains how to configure and use the container that provide runtime support for J2EE application components such as Enterprise Java Beans (EJBs) and Message Driven Beans (MDBs).
Chapter 8, "Using Transaction Services," explains database transactions and how to use manage them.
Chapter 9, "Configuring Naming and Resources," explains how to configure J2EE resources.
Chapter 10, "Using the JMS Service," provides information needed to understand and administer the built-in JMS Service provided through Sun ONE Message Queue, the native JMS provider.
Chapter 11, "Configuring the Server For Corba/IIOP Clients," explains how to configure support for CORBA-based clients, using the RMI/IIOP protocol within an Sun ONE Application Server 7, Enterprise Edition environment.
Chapter 12, "Deploying Applications," describes how to deploy applications to the Sun ONE Application Server.

Part III: Managing HTTP Server Features and Virtual Servers

This part provides information for using the Administration interface to programs and configuration styles. The following chapters are included:

Chapter 13, "Configuring HTTP Features," describes how to configure preferences for your HTTP-related features of your Sun ONE Application Server.
Chapter 14, "Using Virtual Servers," describes how to set up and administer virtual servers using your Sun ONE Application Server.
Chapter 15, "Managing Virtual Server Content," describes how you can configure and manage your server’s content.

Part lV: Managing Multiple Server Instances

This section provides information for setting up and configuring clusters, load balancing, session persistence , and the Highly Available database. The following chapters are included:

Chapter 16, "Configuring Load Balancing," describes how to setup load balancing of HTTP requests, configure, and administer the load balancer plug-in.
Chapter 17, "Managing Clusters," describes how to set up and manage application server clusters. It also provides important information about clusters that will help you fully utilize the failover capabilities of Sun ONE Application Server 7, Enterprise Edition.
Chapter 18, "Configuring Session Persistence," describes how to configure session persistence for the Sun ONE Application Server.
Chapter 19, "Using the cladmin Command," describes the use of the cladmin command that is bundled with the product.
Chapter 20, "Administering the High-Availability Database," describes the High Availability Database (HADB) in the Sun ONE Application Server and explains how to configure and administer HADB.

Part V: Appendixes

This section includes various appendixes with reference material that you may wish to review. This section includes the following appendixes:

Appendix A, "Using the Command Line Interface," provides instructions for using command line utilities in place of the user interface screens.
Appendix B, "Failover Scenarios," describes how session persistence settings for application server instances and web applications affect the failover of session information.
Appendix C, "Compiling and Configuring Apache Web Server," explains how to compile and build Apache Web Server to work with Sun ONE Application Server 7, Enterprise Edition.
Appendix D, "Running Sun ONE Message Queue Broker with Trial Enterprise License," describes how to run the Sun ONE Message Queue (MQ) broker using a trial enterprise license so that you can evaluate enterprise features of the MQ broker.
Appendix E, "Third Party Copyright Notices," contains additional copyright information.

---

Product Line Overview

Sun ONE Application Server is a breakthrough product that raises the bar in application server technologies. It incorporates the latest Java technologies in an easy-to-use, developer-friendly package. The Sun ONE Application Server product leverages over six years of Sun expertise in delivering highly scalable application server technology, enabling developers to rapidly build robust applications that are based on JavaServer Pages™ (JSP™) technology, Java™ Servlet, and Enterprise JavaBeans™ (EJB™) technology. This technology supports a broad range of business requirements from small departmental applications to enterprise-scale, mission-critical services. Three editions of the application server are offered to suit a variety of needs for both production and development environments:

Platform Edition
Standard Edition
Enterprise Edition

Platform Edition

Platform Edition forms the core of the Sun ONE Application Server 7 product line. This product offers a high-performance, Java™ 2 Platform, Enterprise Edition (J2EE™ platform) 1.3 specification-compatible runtime environment that is ideally suited for basic operational deployments, as well as for embedding in third-party applications.

Platform Edition deployments are limited to single application server instances (that is, single virtual machines for the Java platform (Java™ virtual machine or JVM™)). Multi-tier deployment topologies are supported by the Platform Edition, but the web server tier proxy does not perform load balancing. In Platform Edition, administrative utilities are limited to local clients only.

The Platform Edition of Sun ONE Application Server 7 is bundled with Solaris 9.

Standard Edition

The Standard Edition builds on the functionality of the Platform Edition, and layers enhanced remote-management capabilities which allow the management of multiple application server instances from a central administration station. This edition also includes the ability to distribute web application traffic through a web server tier proxy. Standard Edition supports configuration of multiple application server instances per administrative domain. Additionally, you can use the Simple Network Monitoring Protocol (SNMP) to monitor your Standard Edition application server. Sun ONE Directory Server is bundled with Standard Edition for user authentication and limited application configuration storage.

Enterprise Edition

Enterprise Edition enhances the core application server platform with high availability, load balancing, and cluster management capabilities suited for the most demanding J2EE-based application deployments. The management capabilities of the Standard Edition are extended in Enterprise Edition to account for multiple-instance deployments.

Clustering support includes groups of cloned application server instances to which client requests can be load balanced. Both the web tier Load Balancing Plug-in and third-party hardware load balancers are supported by this edition. Session failover for various application server components are included in the Enterprise Edition. The patented “Always On” highly available database technology forms the basis for the high availability persistence store in the Enterprise Edition.

For more product information, see the Sun ONE Application Server page on the Sun Microsystems web site, http://www.sun.com. Also review the Supplemental Terms included in the product (accepted during installation or download) to understand your rights for each edition of the application server.

---

Using the Documentation

The Sun ONE Application Server 7, Enterprise Edition 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 Sun ONE Application Server manuals. The left column lists the tasks and concepts, and the right column lists the corresponding manuals.

Table 1  Sun ONE Application Server 7, Enterprise Edition Documentation Roadmap 

For information about	See the following
Late-breaking information about the software and the documentation.	Release Notes
Comprehensive, table-based summary of supported hardware, operating system, JDK, and JDBC/RDBMS.	Platform Summary
Sun ONE Application Server 7 overview, features available with each product edition.	Product Overview
Diagrams and descriptions of server architecture, benefits of the Sun ONE Application Server architectural approach.	Server Architecture
New enterprise, developer, and operational features of Sun ONE Application Server 7.	What’s New
How to get started with the Sun ONE Application Server 7 product. Includes new features, architectural overview, and sample application tutorial.	Getting Started Guide
Installing the Sun ONE Application Server software and its components, such as sample applications, the Administration interface, 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 Sun ONE 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
Best practices for HTTP session availability that application architects and developers can use.	Application Design Guidelines for Storing Session State
Creating and implementing Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications intended to run on the Sun ONE Application Server 7 that follow the open Java standards model for J2EE components such as servlets, Enterprise JavaBeans™ (EJBs™), and JavaServer Pages™ (JSPs™). Includes general information about application design, developer tools, security, assembly, deployment, debugging, and creating lifecycle modules. A comprehensive Sun ONE Application Server glossary is included.	Developer’s Guide
Creating and implementing J2EE web applications that follow the Java™ Servlet and JavaServer Pages (JSP) specifications on the Sun ONE Application Server 7. Discusses web application programming concepts and tasks, and provides sample code, implementation tips, and reference material. Topics include results caching, JSP precompilation, session management, security, deployment, SHTML, and CGI.	Developer’s Guide to Web Applications
Creating and implementing J2EE applications that follow the open Java standards model for enterprise beans on the Sun ONE Application Server 7. Discusses Enterprise JavaBeans (EJB) programming concepts and tasks, and provides sample code, implementation tips, and reference material. Topics include container-managed persistence, read-only beans, and the XML and DTD files associated with enterprise beans.	Developer’s Guide to Enterprise JavaBeans Technology
Creating Application Client Container (ACC) clients that access J2EE applications on the Sun ONE Application Server 7.	Developer’s Guide to Clients
Creating web services in the Sun ONE Application Server environment.	Developer’s Guide to Web Services
Java™ Database Connectivity (JDBC™), transaction, Java Naming and Directory Interface™ (JNDI), Java™ Message Service (JMS), and JavaMail™ APIs.	Developer’s Guide to J2EE Services and APIs
Creating custom NSAPI plug-ins.	Developer’s Guide to NSAPI
Information and instructions on the configuration, management, and deployment of the Sun ONE Application Server subsystems and components, from both the Administration interface and the command-line interface. Topics include cluster management, the high-availability database, load balancing, and session persistence. A comprehensive Sun ONE Application Server glossary is included.	Administrator’s Guide
Editing Sun ONE Application Server configuration files, such as the server.xml file.	Administrator’s Configuration File Reference
Configuring and administering security for the Sun ONE 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 Sun ONE Application Server 7. 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 Sun ONE Application Server 7 programming model, specifically from iPlanet Application Server 6.x and from Netscape Application Server 4.0. Includes a sample migration.	Migrating and Redploying Server Applications Guide
How and why to tune your Sun ONE Application Server to improve performance.	Performance Tuning Guide
Information on solving Sun ONE Application Server problems.	Troubleshooting Guide
Messages that you may encounter while running Sun ONE Application Server 7. 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 Sun ONE 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

---

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).
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

The directories, 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:

default_config_dir/domains/domain/instance

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/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 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.