Preface
This tutorial is a guide to developing enterprise applications for the JavaTM Platform, Enterprise Edition 6 (Java EE 6).
This preface
contains information about and conventions for the entire Sun GlassFishTM Enterprise Server (Enterprise Server) documentation set.
Enterprise Server v3 is developed
through the GlassFish project open-source community
at https://glassfish.dev.java.net/. The
GlassFish project provides a structured process for developing the Enterprise 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 Enterprise Server source code and to contribute
to the development of the Enterprise Server. The GlassFish project is designed
to encourage communication between Sun engineers and the community.
The following topics are addressed here:
Before You Read This Book
Before proceeding with this tutorial, you should have a good knowledge
of the Java programming language. A good way to get to that point is to work
through The Java Tutorial, Fourth Edition, Sharon Zakhour et al. (Addison-Wesley, 2006). You
should also be familiar with the Java DataBase Connectivity
(JDBCTM) and relational database features described in JDBC API Tutorial and Reference, Third Edition, Maydene Fisher
et al. (Addison-Wesley, 2003).
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.9. 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, Java 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.
|
|
Upgrade
Guide
|
Explains how to upgrade to the latest version of Enterprise 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 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.
|
|
Application
Deployment Guide
|
Explains how to assemble and deploy applications to the Enterprise 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 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.
|
|
Embedded
Server Guide
|
Explains how to run applications in embedded Enterprise Server and to develop
applications in which Enterprise 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 Enterprise Server.
|
|
Troubleshooting
Guide
|
Describes common problems that you might encounter when using Enterprise Server and
how to solve them.
|
|
Error
Message Reference
|
Describes error messages that you might encounter when using Enterprise Server.
|
|
Reference Manual
|
Provides reference information in man page format for Enterprise Server administration
commands, utility commands, and related concepts.
|
|
Domain
File Format Reference
|
Describes the format of the Enterprise Server configuration file, domain.xml.
|
|
Java EE
6 Tutorial, Volume I
|
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 Sun GlassFish Message
Queue.
|
|
Message
Queue Administration Guide
|
Explains how to set up and manage a Sun GlassFish Message Queue
messaging system.
|
|
Message
Queue Developer's Guide for JMX Clients
|
Describes the application programming interface in Sun GlassFish Message
Queue for programmatically configuring and monitoring Message Queue resources
in conformance with the Java Management Extensions (JMX).
|
|
System Virtualization Support in Sun Java System Products
|
Summarizes Sun support for Sun Java System products when used in conjunction
with system virtualization products and features.
|
Related Documentation
The Java EE 6 Tutorial, Volume II contains
all the topics in Java
EE 6 Tutorial, Volume I and adds advanced topics, additional
technologies, and case studies. The document is available to registered users
of Enterprise Server.
JavadocTM tool reference documentation for packages
that are provided with Enterprise 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 http://www.netbeans.org/kb/60/index.html.
For information about the Java DB for use with the Enterprise Server, see http://developers.sun.com/javadb/.
The sample
applications demonstrate a broad range of Java EE technologies.
The samples are bundled
with the Java EE Software Development Kit (SDK).
Symbol Conventions
The following table explains symbols that might be used in this book.
Table P–2 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.
|
Typographic Conventions
The following table describes the typographic changes that are used
in this book.
Table P–3 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.
|
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 the Enterprise Server or
the Software Development Kit (SDK) of which the Enterprise Server is a part.
|
Installations on the SolarisTM operating system,
Linux operating system, and Mac operating system:
user’s-home-directory/glassfishv3/glassfish
Windows, all installations:
SystemDrive:\glassfishv3\glassfish
|
|
as-install-parent
|
Represents the parent of the base installation directory for Enterprise Server.
|
Installations on the SolarisTM operating system,
Linux operating system, and Mac operating system:
user’s-home-directory/glassfishv3
Windows, all installations:
SystemDrive:\glassfishv3
|
|
tut-install
|
Represents the base installation directory for the Java EE Tutorial
after you install the Enterprise Server or the SDK and run the Update Tool.
|
as-install/docs/javaee-tutorial
|
|
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:
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-7627.
Download this book in PDF (5432 KB)