Oracle GlassFish Server 3.0.1 Application Deployment Guide


This Application Deployment Guide describes deployment of applications and application components to the Oracle GlassFishTM Server, and includes information about deployment descriptors.

This preface contains information about and conventions for the entire Oracle GlassFish Server (GlassFish Server) documentation set.

GlassFish Server 3.0.1 is developed through the GlassFish project open-source community at The GlassFish project provides a structured process for developing the GlassFish Server platform that makes the new features of the Java EE platform available faster, while maintaining the most important feature of Java EE: compatibility. It enables Java developers to access the GlassFish Server source code and to contribute to the development of the GlassFish Server. The GlassFish project is designed to encourage communication between Oracle engineers and the community.

GlassFish Server Documentation Set

The GlassFish Server documentation set describes deployment planning and system installation. The Uniform Resource Locator (URL) for GlassFish Server documentation is For an introduction to GlassFish Server, refer to the books in the order in which they are listed in the following table.

Table P–1 Books in the GlassFish Server Documentation Set

Book Title 


Release Notes

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

Quick Start Guide

Explains how to get started with the GlassFish Server product. 

Installation Guide

Explains how to install the software and its components. 

Upgrade Guide

Explains how to upgrade to the latest version of GlassFish Server. This guide also describes differences between adjacent product releases and configuration options that can result in incompatibility with the product specifications. 

Administration Guide

Explains how to configure, monitor, and manage GlassFish Server subsystems and components from the command line by using the asadmin(1M) utility. Instructions for performing these tasks from the Administration Console are provided in the Administration Console online help.

Application Deployment Guide

Explains how to assemble and deploy applications to the GlassFish Server and provides information about deployment descriptors. 

Your First Cup: An Introduction to the Java EE Platform

Provides a short tutorial for beginning Java EE programmers that explains the entire process for developing a simple enterprise application. The sample application is a web application that consists of a component that is based on the Enterprise JavaBeansTM specification, a JAX-RS web service, and a JavaServerTM Faces component for the web front end.

Application Development Guide

Explains how to create and implement Java Platform, Enterprise Edition (Java EE platform) applications that are intended to run on the GlassFish Server. These applications follow the open Java standards model for Java EE components and APIs. This guide provides information about developer tools, security, and debugging. 

Add-On Component Development Guide

Explains how to use published interfaces of GlassFish Server to develop add-on components for GlassFish Server. This document explains how to perform only those tasks that ensure that the add-on component is suitable for GlassFish Server.

Embedded Server Guide

Explains how to run applications in embedded GlassFish Server and to develop applications in which GlassFish Server is embedded.  

Scripting Framework Guide

Explains how to develop scripting applications in languages such as Ruby on Rails and Groovy on Grails for deployment to GlassFish Server. 

Troubleshooting Guide

Describes common problems that you might encounter when using GlassFish Server and how to solve them. 

Error Message Reference

Describes error messages that you might encounter when using GlassFish Server. 

Reference Manual

Provides reference information in man page format for GlassFish Server administration commands, utility commands, and related concepts. 

Domain File Format Reference

Describes the format of the GlassFish Server configuration file, domain.xml.

Java EE 6 Tutorial

Explains how to use Java EE 6 platform technologies and APIs to develop Java EE applications. 

Message Queue Release Notes

Describes new features, compatibility issues, and existing bugs for GlassFish Message Queue. 

Message Queue Administration Guide

Explains how to set up and manage a Message Queue messaging system. 

Message Queue Developer's Guide for JMX Clients

Describes the application programming interface in Message Queue for programmatically configuring and monitoring Message Queue resources in conformance with the Java Management Extensions (JMX). 

Related Documentation

JavadocTM tool reference documentation for packages that are provided with GlassFish Server is available as follows:

Additionally, the following resources might be useful:

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

For information about the Java DB for use with the GlassFish 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

Typographic Conventions

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

Table P–2 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–3 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. 

Default Paths and File Names

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

Table P–4 Default Paths and File Names



Default Value 


Represents the base installation directory for GlassFish Server. 

In configuration files, as-install is represented as follows:


Installations on the Oracle SolarisTM operating system, Linux operating system, and Mac operating system:


Windows, all installations: 



Represents the parent of the base installation directory for GlassFish Server. 

Installations on the Oracle Solaris operating system, Linux operating system, and Mac operating system: 


Windows, all installations: 



Represents the directory in which a domain is created by default. 



Represents the directory in which a domain's configuration is stored. 

In configuration files, domain-dir is represented as follows:



Documentation, Support, and Training

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

Searching Oracle Product Documentation

Besides searching Oracle product documentation from the docs.sun.comSM web site, you can use a search engine by typing the following syntax in the search field:


For example, to search for “broker,” type the following:


To include other Oracle web sites in your search (for example,,, and, use in place of in the search field.

Third-Party Web Site References

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

Note –

Oracle is not responsible for the availability of third-party web sites mentioned in this document. Oracle 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. Oracle 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.