Previous      Contents      Index      Next
Sun Java System Application Server Standard and Enterprise Edition 7 2004Q2 Update 3 Administration Guide

About This Guide

This guide describes how to configure and administer Sun Java™ System Application Server Standard and Enterprise Edition 7 2004Q2 Update 1.

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 addresses the following topics:

Who Should Use This Guide
Using the Documentation
How This Guide Is Organized
Product Line Overview
Documentation Conventions
Contacting Sun

---

Who Should Use This Guide

The intended audience for this guide is the person who configures, administers, and deploys the Application Server subsystems and components.

This guide assumes you are familiar with the following topics:

Java programming and concepts
Client/server programming model
Installation of enterprise-level software products
Familiarity in managing large enterprise systems.

---

Using the Documentation

The Sun Java System Application Server Standard and 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 Java System Application Server manuals. The manuals marked (updated for 7 2004Q2) have been updated for the Sun Java System Application Server Standard and Enterprise Edition 7 2004Q2 release. The manuals not marked in this way have not been updated since the version 7 Enterprise Edition release.

Table 1  Sun Java System Application Server Documentation Roadmap 

For information about	See the following
(Updated for 7 2004Q2 Update 2) Late-breaking information about the software and the documentation. Includes a comprehensive, table-based summary of supported hardware, operating system, JDK, and JDBC/RDBMS.	Release Notes
Sun Java System Application Server 7 overview, including the features available with each product edition.	Product Overview
Diagrams and descriptions of server architecture and the benefits of the Sun Java System Application Server architectural approach.	Server Architecture
(Updated for 7 2004Q2 Update 2) How to get started with the Sun Java System Application Server product. Includes a sample application tutorial. There are two guides, one for Standard Edition and one for Enterprise Edition.	Getting Started Guide
(Updated for 7 2004Q2 Update 2) Installing the Sun Java System Application Server Standard Edition and Enterprise Edition software and its components, such as sample applications and the Administration interface. For the Enterprise Edition software, instructions are provided for implementing the high-availability configuration.	Installation Guide
(Updated for 7 2004Q2 Update 2) Evaluating your system needs and enterprise to ensure that you deploy Sun Java System 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 Sun Java System Application Server 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 Java System 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 Java System Application Server. 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
(Updated for 7 2004Q2 Update 2) Creating and implementing J2EE applications that follow the open Java standards model for enterprise beans on the Sun Java System Application Server. 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 Java System Application Server.	Developer’s Guide to Clients
Creating web services in the Sun Java System Application Server environment.	Developer’s Guide to Web Services
(Updated for 7 2004Q2) 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
(Updated for 7 2004Q2 Update 2) Information and instructions on the configuration, management, and deployment of the Sun Java System 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 Java System Application Server glossary is included.	Administration Guide
(Updated for 7 2004Q2) Editing Sun Java System Application Server configuration files, such as the server.xml file.	Administrator’s Configuration File Reference
Configuring and administering security for the Sun Java System 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 Java System 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
(Updated for 7 2004Q2) Migrating your applications to the new Sun Java System Application Server programming model, specifically from iPlanet Application Server 6.x and Sun ONE Application Server 7.0. Includes a sample migration.	Migrating and Redeploying Server Applications Guide
(Updated for 7 2004Q2 Update 2) How and why to tune your Sun Java System Application Server to improve performance.	Performance Tuning Guide
(Updated for 7 2004Q2 Update 2) Information on solving Sun Java System Application Server problems.	Troubleshooting Guide
(Updated for 7 2004Q2 Update 2) Information on solving Sun Java System Application Server error messages.	Error Message Reference
(Updated for 7 2004Q2 Update 2) Utility commands available with the Sun Java System Application Server; written in manpage style.	Utility Reference Manual
Using the Sun™ Java System Message Queue 3.5 software.	The Sun Java System Message Queue documentation at: http://docs.sun.com/db?p= prod/s1.s1msgqu

---

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, Part V, "Appendixes" addresses specific reference topics that describe various topics, including internationalization issues, server extensions, failover scenarios, and the Sun Java System Application Server command line interface documentation.

Part I: Server Basics and Administering Global Settings

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

Chapter 1, "Getting Started with Sun Java System Application Server Administration," provides an overview of 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 Sun Java System Application Server Instances," describes how to configure server preferences for your Application Server.
Chapter 5, "Using Logging," describes the foundation for logging, and the logging features and functions within Application Server.
Chapter 6, "Monitoring Sun Java System Application Server," contains information about the monitoring and Simple Network Management Protocol (SNMP) features and functions available within Application Server.
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 Java System 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 Application Server environment.
Chapter 12, "Configuring the Web Server Plug-in," explains how Sun Java System Application Server Standard Edition 7 processes HyperText Transfer Protocol (HTTP) requests, how to configure and use the web server plug-in with the Application Server.
Chapter 13, "Deploying Applications," describes how to deploy applications to the 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 14, "Configuring HTTP Features," describes how to configure preferences for your HTTP-related features of your Application Server.
Chapter 15, "Using Virtual Servers," describes how to set up and administer virtual servers using your Application Server.
Chapter 16, "Managing Virtual Server Content," describes how you can configure and manage your server’s content.

Part lV: Configuring 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 17, "Configuring HTTP Load Balancing and Failover (Enterprise Edition)," describes how to setup load balancing of HTTP requests, configure, and administer the load balancer plug-in.
Chapter 18, "Configuring RMI/IIOP Load Balancing and Failover (Enterprise Edition)," describes how to setup load balancing and failover of RMI-IIOP requests
Chapter 19, "Managing Clusters (Enterprise Edition)," 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 Application Server 7, Enterprise Edition.
Chapter 20, "Configuring Session Persistence (Enterprise Edition)," describes how to configure session persistence for the Application Server 7, Enterprise Edition.
Chapter 21, "Administering the High-Availability Database (Enterprise Edition)," describes the High Availability Database (HADB) in the Application Server 7, Enterprise Edition 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 (Enterprise Edition)," 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 (Enterprise Edition)," explains how to compile and build Apache Web Server to work with Application Server.
Appendix D, "Running Message Queue Broker with Trial Enterprise License," describes how to run the Sun Java System Message Queue (MQ) broker using a trial enterprise license so that you can evaluate enterprise features of the MQ broker.
Appendix E, "HTTP Load Balancer Configuration File," describes loadbalancer.xml and sun-loadbalancer_1_1.dtd files
Appendix F, "Using the cladmin Command for Administration (Enterprise Edition)," describes the use of the cladmin script that is bundled with Sun Java System Application Server.

---

Product Line Overview

Sun Java System 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 Java System 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. Two editions of the application server are offered to suit a variety of needs:

Standard Edition
Enterprise Edition

Standard Edition

The Standard Edition 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.

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 Java System 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.

---

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 and Linux file-based installations:

  user’s home directory/sun/appserver7

Windows, all installations:

  system drive:\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:

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 package-based or Linux RPM-based installation, the application server files are spread across several root directories. 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.

---

Contacting Sun

You might want to contact Sun Microsystems in order to:

Give Us Feedback
Obtain Training
Contact Product Support

Give Us Feedback

If you have general feedback on the documentation, please use the following URL:

http://www.sun.com/hwdocs/feedback

Obtain Training

Application Server training courses are available at:

http://training.sun.com/US/catalog/enterprise/web_application.html/

Visit this site often for new course availability on the Sun Java System Application Server.

Contact 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. Here are some of the commonly used commands:
Solaris: pkginfo, showrev
Linux: rpm
All: asadmin version --verbose
Detailed steps on the methods you have used to reproduce the problem
Any error logs or core dumps
Configuration files such as:
instance_dir/config/server.xml
a web application’s web.xml file,
when a web application is involved in the problem
For an application, whether the problem appears when it is running in a cluster or standalone

Previous      Contents      Index      Next

---

Copyright 2005 Sun Microsystems, Inc. All rights reserved.