JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server 3.1 Application Deployment Guide
search filter icon
search icon

Document Information


1.  Overview of Oracle GlassFish Server 3.1 Application Deployment

2.  Deploying Applications

A.  The asadmin Deployment Subcommands

B.  GlassFish Server Deployment Descriptor Files

C.  Elements of the GlassFish Server Deployment Descriptors



This Application Deployment Guide describes deployment of applications and application components to the Oracle GlassFish 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.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. 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
Provides late-breaking information about the software and the documentation and includes a comprehensive, table-based summary of the supported hardware, operating system, Java Development Kit (JDK), and database drivers.
Explains how to get started with the GlassFish Server product.
Explains how to install the software and its components.
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.
Explains how to build a production deployment of GlassFish Server that meets the requirements of your system and enterprise.
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.
Provides instructions for configuring and administering GlassFish Server security.
Explains how to assemble and deploy applications to the GlassFish Server and provides information about deployment descriptors.
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 application programmer interfaces (APIs). This guide provides information about developer tools, security, and debugging.
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.
Explains how to run applications in embedded GlassFish Server and to develop applications in which GlassFish Server is embedded.
Explains how to configure GlassFish Server to provide higher availability and scalability through failover and load balancing.
Explains how to optimize the performance of GlassFish Server.
Describes common problems that you might encounter when using GlassFish Server and explains how to solve them.
Describes error messages that you might encounter when using GlassFish Server.
Provides reference information in man page format for GlassFish Server administration commands, utility commands, and related concepts.
Describes new features, compatibility issues, and existing bugs for GlassFish Server Message Queue.
Provides an introduction to the technology, concepts, architecture, capabilities, and features of the Message Queue messaging service.
Explains how to set up and manage a Message Queue messaging system.
Describes the application programming interface in Message Queue for programmatically configuring and monitoring Message Queue resources in conformance with the Java Management Extensions (JMX).
Provides information about concepts and procedures for developing Java messaging applications (Java clients) that work with GlassFish Server.
Provides programming and reference information for developers working with Message Queue who want to use the C language binding to the Message Queue messaging service to send, receive, and process Message Queue messages.

Related Documentation

The following tutorials explain how to develop Java EE applications:

Javadoc tool reference documentation for packages that are provided with GlassFish Server is available as follows.

Additionally, the Java EE Specifications might be useful.

For information about creating enterprise applications in the NetBeans Integrated Development Environment (IDE), see the NetBeans Documentation, Training & Support page.

For information about the Java DB database for use with the GlassFish Server, see the Java DB product page.

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

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 Solaris operating system, Linux operating system, and Mac OS 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 Oracle Documentation 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:


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.