Sun GlassFish Enterprise Server v3 Prelude Application Deployment Guide

Preface

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

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

The following topics are addressed here:

Enterprise Server Documentation Set

The Enterprise Server documentation set describes deployment planning and system installation. The Uniform Resource Locator (URL) for Enterprise Server documentation is http://docs.sun.com/coll/1343.7. 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 

Description 

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 Enterprise Server product. 

Installation Guide

Explains how to install the software and its components. 

Application Deployment Guide

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

Developer’s Guide

Explains how to create and implement Java Platform, Enterprise Edition (Java EE platform) applications that are intended to run on the Enterprise 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 Enterprise Server to develop add-on components for Enterprise Server. This document explains how to perform only those tasks that ensure that the add-on component is suitable for Enterprise Server.

RESTful Web Services Developer’s Guide

Explains how to develop Representational State Transfer (RESTful) web services for Enterprise Server. 

Getting Started With JRuby on Rails for Sun GlassFish Enterprise Server

Explains how to develop Ruby on Rails applications for deployment to Enterprise Server. 

Getting Started With Project jMaki for Sun GlassFish Enterprise Server

Explains how to use the jMaki framework to develop Ajax-enabled web applications that are centered on JavaScriptTM technology for deployment to Enterprise Server.

Roadmap to the Java EE 5 Tutorial

Explains which information in the Java EE 5 Tutorial is relevant to users of the v3 Prelude release of the Enterprise Server.

Java EE 5 Tutorial

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

Java WSIT Tutorial

Explains how to develop web applications by using the Web Service Interoperability Technologies (WSIT). The tutorial focuses on developing web service endpoints and clients that can interoperate with Windows Communication Foundation (WCF) endpoints and clients. 

Administration Guide

Explains how to configure, monitor, and manage Enterprise 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.

Administration Reference

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

Reference Manual

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

Related Documentation

A JavadocTM tool reference for packages that are provided with the Enterprise Server is located at https://glassfish.dev.java.net/nonav/api/v3-prelude/index.html. Additionally, the following resources might be useful:

For information about creating enterprise applications in the NetBeansTM Integrated Development Environment (IDE), see http://www.netbeans.org/kb/60/index.html.

For information about the Java DB database for use with the Enterprise Server, see http://developers.sun.com/javadb/.

Typographic Conventions

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

Table P–2 Typographic Conventions

Typeface 

Meaning 

Example 

AaBbCc123

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.

AaBbCc123

What you type, contrasted with onscreen computer output 

machine_name% su

Password:

AaBbCc123

A placeholder to be replaced with a real name or value 

The command to remove a file is rm filename.

AaBbCc123

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

Symbol 

Description 

Example 

Meaning 

[ ]

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. 

${com.sun.javaRoot}

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

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 that are used in this book.

Table P–4 Default Paths and File Names

Placeholder 

Description 

Default Value 

as-install

Represents the base installation directory for Enterprise Server. 

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

${com.sun.aas.installRoot}

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

user’s-home-directory/glassfishv3-prelude/glassfish

Windows, all installations: 

SystemDrive:\glassfishv3-prelude\glassfish

domain-root-dir

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

as-install/domains/

domain-dir

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

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

${com.sun.aas.instanceRoot}

domain-root-dir/domain-name

Documentation, Support, and Training

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

Searching Sun Product Documentation

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


search-term site:docs.sun.com

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


broker site:docs.sun.com

To include other Sun web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use sun.com in place of docs.sun.com in the search field.

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 http://docs.sun.com and click Send Comments. In the online form, provide the full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the book's title page or in the document's URL. For example, the part number of this book is 820-4502.