Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Administration Guide

Preface

The Administration Guide describes how to configure, manage, and deploy Application Server subsystems and components from the Administration Console.

Who Should Use This Book

This Administration Guide is intended for information technology administrators in production environments. This guide assumes you are familiar with the following topics:

Before You Read This Book

Application Server is a component of Sun JavaTM Enterprise System, a software infrastructure that supports enterprise applications distributed across a network or Internet environment. You should be familiar with the documentation provided with Sun Java Enterprise System, which can be accessed online at: http://docs.sun.com/app/docs/prod/entsys.05q4#hic

How This Book Is Organized

The organization of this guide corresponds to the layout of the Administration Console, the browser-based tool for administering the Application Server. Each chapter begins with conceptual information, followed by procedural sections that explain how to perform specific tasks with the Administration Console.

Conventions Used in This Book

The tables in this section describe the conventions used in this book.

Typographic Conventions

The following table describes the typographic changes used in this book.

Table P–1 Typographic Conventions

Typeface  

Meaning  

Examples  

AaBbCc123(Monospace)

API and language elements, HTML tags, web site URLs, command names, file names, directory path names, onscreen computer output, sample code. 

Edit your.login file.

Use ls -a to list all files.

% You have mail.

AaBbCc123(Monospace bold)

What you type, when contrasted with onscreen computer output. 

% suPassword:

AaBbCc123(Italic)

Book titles, new terms, words to be emphasized. 

A placeholder in a command or path name to be replaced with a real name or value. 

Read Chapter 6 in the User’s Guide.

These are called class options.

Do not save the file.

The file is located in the install-dir/bin directory.

Symbols

The following table describes the symbol conventions used in this book.

Table P–2 Symbol Conventions

Symbol  

Description  

Example  

Meaning  

[ ]

Contains optional command options. 

ls [-l]

The -l option is not required.

{ | }

Contains a set of choices for a required command option. 

-d {y|n}

The -d option requires that you use either the y argument or the n argument.

-

Joins simultaneous multiple keystrokes. 

Control-A 

Press the Control key while you press the A key. 

+

Joins consecutive multiple keystrokes. 

Ctrl+A+N 

Press the Control key, release it, and then press the subsequent keys. 

>

Indicates menu item selection in a graphical user interface. 

File > New > Templates 

From the File menu, choose New. From the New submenu, choose Templates. 

Default Paths and File Names

The following table describes the default paths and file names used in this book.

Table P–3 Default Paths and File Names

Term  

Description  

install-dir

By default, the Application Server installation directory is located here: 

  • Sun Java Enterprise System installations on the SolarisTM platform:

    /opt/SUNWappserver/appserver
  • Sun Java Enterprise System installations on the Linux platform:

    /opt/sun/appserver/
  • Other Solaris and Linux installations, non-root user:

    user’s home directory/SUNWappserver
  • Other Solaris and Linux installations, root user:

    /opt/SUNWappserver
  • Windows, all installations:

    SystemDrive:\Sun\AppServer

domain-root-dir

By default, the directory containing all domains is located here: 

  • Sun Java Enterprise System installations on the Solaris platform:

    /var/opt/SUNWappserver/domains/
  • Sun Java Enterprise System installations on the Linux platform:

    /var/opt/sun/appserver/domains/
  • All other installations:

    install-dir/domains/

domain-dir

By default, each domain directory is located here: 

domain-root-dir/domain-dir

In configuration files, you might see domain-dir represented as follows:

${com.sun.aas.instanceRoot}

instance-dir

By default, each instance directory is located here: 

domain-dir/instance-dir

Shell Prompts

The following table describes the shell prompts used in this book.

Table P–4 Shell Prompts

Shell  

Prompt  

C shell on UNIX or Linux 

machine-name%

C shell superuser on UNIX or Linux 

machine-name#

Bourne shell and Korn shell on UNIX or Linux 

$

Bourne shell and Korn shell superuser on UNIX or Linux 

#

Windows command line 

C:\

Symbols

The following table describes the symbol conventions used in this book.

Table P–5 Symbol Conventions

Symbol  

Description  

Example  

Meaning  

[ ]

Contains optional command options. 

ls [-l]

The -l option is not required.

{ | }

Contains a set of choices for a required command option. 

-d {y|n}

The -d option requires that you use either the y argument or the n argument.

-

Joins simultaneous multiple keystrokes. 

Control-A 

Press the Control key while you press the A key. 

+

Joins consecutive multiple keystrokes. 

Ctrl+A+N 

Press the Control key, release it, and then press the subsequent keys. 

>

Indicates menu item selection in a graphical user interface. 

File > New > Templates 

From the File menu, choose New. From the New submenu, choose Templates. 

Default Paths and File Names

The following table describes the default paths and file names used in this book.

Table P–6 Default Paths and File Names

Term  

Description  

install-dir

By default, the Application Server installation directory is located here: 

  • Sun Java Enterprise System installations on the Solaris platform:

    /opt/SUNWappserver/appserver
  • Sun Java Enterprise System installations on the Linux platform:

    /opt/sun/appserver/
  • Other Solaris and Linux installations, non-root user:

    user’s home directory/SUNWappserver
  • Other Solaris and Linux installations, root user:

    /opt/SUNWappserver
  • Windows, all installations:

    SystemDrive:\Sun\AppServer

domain-root-dir

By default, the directory containing all domains is located here: 

  • Sun Java Enterprise System installations on the Solaris platform:

    /var/opt/SUNWappserver/domains/
  • Sun Java Enterprise System installations on the Linux platform:

    /var/opt/sun/appserver/domains/
  • All other installations:

    install-dir/domains/

domain-dir

By default, each domain directory is located here: 

domain-root-dir/domain-dir

In configuration files, you might see domain-dir represented as follows:

${com.sun.aas.instanceRoot}

instance-dir

By default, each instance directory is located here: 

domain-dir/instance-dir

Related Documentation

The http://docs.sun.comSM web site enables you to access Sun technical documentation online. You can browse the archive or search for a specific book title or subject.

You can find a directory of URLs for the official specifications at install-dir/docs/index.htm. Additionally, the following resources might be useful.

General J2EE Information:

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

The J2EE Blueprints: http://java.sun.com/reference/blueprints/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 JSP files:

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

Javadocs:

Javadocs for packages provided with the Application Server are located in install-dir/docs/api.

Books in This Documentation Set

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

The following table summarizes the books included in the Application Server core documentation set.

Table P–7 Books in This Documentation Set

Book Title  

Description  

Release Notes

Late-breaking information about the software and the documentation. Includes a comprehensive, table-based summary of the supported hardware, operating system, JDK, and JDBC/RDBMS. 

Quick Start Guide

How to get started with the Application Server product. 

Installation Guide

Installing the Application Server software and its components. 

Deployment Planning Guide

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. 

Developer’s Guide

Creating and implementing JavaTM 2 Platform, Enterprise Edition (J2EETM platform) applications intended to run on the Sun Java System Application Server that follow the open Java standards model for J2EE components and APIs. Includes general information about developer tools, security, assembly, deployment, debugging, and creating lifecycle modules.

J2EE 1.4 Tutorial

Using J2EE 1.4 platform technologies and APIs to develop J2EE applications and deploying the applications on the Sun Java System Application Server. 

Administration Guide

Configuring, managing, and deploying the Sun Java System Application Server subsystems and components from the Administration Console. 

High Availability Administration Guide

Post-installation configuration and administration instructions for the high-availability database. 

Administration Reference

Editing the Sun Java System Application Server configuration file, domain.xml.

Upgrade and Migration Guide

Migrating your applications to the new Sun Java System Application Server programming model, specifically from Application Server 6.x and 7. This guide also describes differences between adjacent product releases and configuration options that can result in incompatibility with the product specifications. 

Performance Tuning Guide

Tuning the Sun Java System Application Server to improve performance. 

Troubleshooting Guide

Solving Sun Java System Application Server problems. 

Error Message Reference

Solving Sun Java System Application Server error messages. 

Reference Manual

Utility commands available with the Sun Java System Application Server; written in manpage style. Includes the asadmin command line interface.

Other Server Documentation

For other server documentation, go to the following:

Accessing Sun Resources Online

For product downloads, professional services, patches and support, and additional developer information, go to the following:

Contacting Sun Technical Support

If you have technical questions about this product that are not answered in the product documentation, go to http://www.sun.com/service/contacting.

Related Third-Party Web Site References

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions.

To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document. For example, the title of this book is Sun Java System Application Server 2005Q2 Administration Guide, and the part number is 819-2554.