Sun GlassFish Enterprise Server 2.1 Developer's Guide


This Developer's Guide describes how to create and run JavaTM Platform, Enterprise Edition (Java EE platform) applications that follow the open Java standards model for Java EE components and APIs in the Sun Java System Enterprise Server environment. Topics include developer tools, security, debugging, and creating lifecycle modules. This book is intended for use by software developers who create, assemble, and deploy Java EE applications using Sun GlassFish servers and software.

This preface contains information about and conventions for the entire Sun GlassFishTM Enterprise Server documentation set.

Enterprise Server Documentation Set

The Uniform Resource Locator (URL) for Enterprise Server documentation is For an introduction to Enterprise Server, refer to the books in the order in which they are listed in the following table.

Table P–1 Books in the Enterprise Server Documentation Set

Book Title 


Documentation Center

Enterprise Server documentation topics organized by task and subject. 

Release Notes

Late-breaking information about the software and the documentation. Includes a comprehensive, table-based summary of the supported hardware, operating system, Java Development Kit (JDKTM), and database drivers.

Quick Start Guide

How to get started with the Enterprise Server product. 

Installation Guide

Installing the software and its components. 

Application Deployment Guide

Deployment of applications and application components to the Enterprise Server. Includes information about deployment descriptors. 

Developer’s Guide

Creating and implementing Java Platform, Enterprise Edition (Java EE platform) applications intended to run on the Enterprise Server that follow the open Java standards model for Java EE components and APIs. Includes information about developer tools, security, debugging, and creating lifecycle modules. 

Java EE 5 Tutorial

Using Java EE 5 platform technologies and APIs to develop Java EE applications. 

Java WSIT Tutorial

Developing web applications using the Web Service Interoperability Technologies (WSIT). Describes how, when, and why to use the WSIT technologies and the features and options that each technology supports. 

Administration Guide

System administration for the Enterprise Server, including configuration, monitoring, security, resource management, and web services management. 

High Availability Administration Guide

Setting up clusters, working with node agents, and using load balancers. 

Administration Reference

Editing the Enterprise Server configuration file, domain.xml.

Performance Tuning Guide

Tuning the Enterprise Server to improve performance. 

Reference Manual

Utility commands available with the Enterprise Server; written in man page style. Includes the asadmin command line interface.

Related Documentation

For documentation about other stand-alone Sun GlassFish server products, go to the following:

A JavadocTM tool reference for packages provided with the Enterprise Server is located at Additionally, the following resources might be useful:

For information on creating enterprise applications in the NetBeansTM Integrated Development Environment (IDE), see

For information about the Java DB database included with the Enterprise Server, see

The GlassFish Samples project is a collection of sample applications that demonstrate a broad range of Java EE technologies. The GlassFish Samples are bundled with the Java EE Software Development Kit (SDK), and are also available from the GlassFish Samples project page at

Default Paths and File Names

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

Table P–2 Default Paths and File Names



Default Value 


Represents the base installation directory for Enterprise Server. 

SolarisTM and Linux installations, non-root user:


Solaris and Linux installations, root user: 


Windows, all installations: 



Represents the directory containing all domains. 

All installations: 



Represents the directory for a domain. 

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




Represents the directory for a server instance. 



Represents the directory containing sample applications.  



Represents the directory containing documentation.  


Typographic Conventions

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

Table P–3 Typographic Conventions





The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.


What you type, contrasted with onscreen computer output 

machine_name% su



A placeholder to be replaced with a real name or value 

The command to remove a file is rm filename.


Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online) 

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do not save the file.

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–4 Symbol Conventions





[ ]

Contains optional arguments and 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.

${ }

Indicates a variable reference. 


References the value of the com.sun.javaRoot variable.

Joins simultaneous multiple keystrokes. 


Press the Control key while you press the A key. 

Joins consecutive multiple keystrokes. 


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. 

Documentation, Support, and Training

The Sun web site provides information about the following additional resources:

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

Note –

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 and click Feedback. 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.