This Developer's Guide describes how to create and run JavaTM 2 Platform, Enterprise Edition (J2EETM platform) applications that follow the open Java standards model for J2EE components and APIs in the Sun Java System Application Server environment. Topics include developer tools, security, assembly, deployment, debugging, and creating lifecycle modules.
This Developer's Guide is intended for use by software developers who create, assemble, and deploy J2EE applications using Sun Java System servers and software. Application Server software developers should already understand the following technologies:
Java technology
The Java 2 Platform, Enterprise Edition (J2EE platform), version 1.4
Hypertext Transfer Protocol (HTTP)
Hypertext Markup Language (HTML)
Extensible Markup Language (XML)
The Developer's Guide has three parts and an Appendix:
Part I, Developing and Deploying Applications includes general development topics relevant to the Application Server, such as security and debugging.
Part II, Developing Applications and Application Components describes J2EE application components, such as servlets and message-driven beans, that can run on the Application Server.
Part III, Using Services and APIs describes services and APIs that provide Application Server resources, such as JDBC and JNDI.
Appendix A, Deployment Descriptor Files describes deployment descriptor files specific to the Application Server.
The following table summarizes the chapters in this book.
Table P–1 How This Book Is Organized
Chapter |
Description |
---|---|
Describes setting up an application development environment in the Application Server. |
|
Explains how to write secure J2EE applications, which contain components that perform user authentication and access authorization. |
|
Describes Application Server modules and how these modules are assembled separately or together in an application. Also describes class loaders and tools for assembly and deployment. |
|
Provides guidelines for debugging applications in the Application Server. |
|
Describes how web applications are supported in the Application Server. |
|
Describes how Enterprise JavaBeansTM (EJBTM) technology is supported in the Application Server. |
|
Chapter 7, Using Container-Managed Persistence for Entity Beans |
Provides information on how container-managed persistence (CMP) works in the Application Server. |
Describes how to develop, assemble, and deploy J2EE Application Clients. |
|
Describes Application Server support for the J2EE Connector 1.5 architecture. |
|
Describes how to create and use a lifecycle listener module. |
|
Explains how to use the Java Database Connectivity (JDBCTM) API for database access with the Application Server. |
|
Describes J2EE transactions and transaction support in the Application Server. |
|
Explains how to use the Java Naming and Directory InterfaceTM (JNDI) API for naming and references. |
|
Explains how to use the Java Message Service (JMS) API, and describes the Application Server’s fully integrated JMS provider: the Sun Java System Message Queue software. |
|
Explains how to use the JavaMailTM API. |
|
Explains how to use the Java Management Extensions (JMXTM) API. |
|
Describes deployment descriptor files specific to the Application Server. |
The Application Server documentation set describes deployment planning and system installation. The URL for stand-alone Application Server documentation is http://docs.sun.com/app/docs/coll/1343.1. For an introduction to Application Server, refer to the books in the order in which they are listed in the following table.
Table P–2 Books in the Application Server Documentation Set
Book Title |
Description |
---|---|
Release Notes |
Late-breaking information about the software and the documentation. Includes a comprehensive, table-based summary of the supported hardware, operating system, JDK, and JDBC/RDBMS. |
Quick Start Guide |
How to get started with the Application Server product. |
Installation Guide |
Installing the software and its components. |
Developer’s Guide |
Creating and implementing Java 2 Platform, Enterprise Edition (J2EE platform) applications intended to run on the Application Server that follow the open Java standards model for J2EE components and APIs. Includes general information about developer tools, security, assembly, deployment, debugging, and creating lifecycle modules. |
J2EE 1.4 Tutorial |
Using J2EE 1.4 platform technologies and APIs to develop J2EE applications. |
Administration Guide |
Configuring, managing, and deploying Application Server subsystems and components from the Administration Console. |
Administration Reference |
Editing the Application Server configuration file, domain.xml. |
Upgrade and Migration Guide |
Migrating your applications to the new Application Server programming model, specifically from Application Server 6.x and 7. This guide also describes differences between adjacent product releases and configuration options that can result in incompatibility with the product specifications. |
Troubleshooting Guide |
Solving Application Server problems. |
Error Message Reference |
Solving Application Server error messages. |
Reference Manual |
Utility commands available with the Application Server; written in man page style. Includes the asadmin command line interface. |
For other Sun Java System server documentation, go to the following:
Message Queue documentation
Directory Server documentation
Web Server documentation
The URL for all documentation about Java ES and its components is http://docs.sun.com/prod/entsys.05q4.
You can find a directory of URLs for the official specifications at install-dir/docs/index.htm. Additionally, the following resources might be useful.
General J2EE Information:
The J2EE 1.4 Tutorial: http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html
The J2EE Blueprints: http://java.sun.com/reference/blueprints/index.html
Core J2EE Patterns: Best Practices and Design Strategies by Deepak Alur, John Crupi, & Dan Malks, Prentice Hall Publishing
Java Security, by Scott Oaks, O’Reilly Publishing
Programming with Servlets and JSP files:
Java Servlet Programming, by Jason Hunter, O’Reilly Publishing
Java Threads, 2nd Edition, by Scott Oaks & Henry Wong, O’Reilly Publishing
Programming with EJB components:
Enterprise JavaBeans, by Richard Monson-Haefel, O’Reilly Publishing
Programming with JDBC:
Database Programming with JDBC and Java, by George Reese, O’Reilly Publishing
JDBC Database Access With Java: A Tutorial and Annotated Reference (Java Series), by Graham Hamilton, Rick Cattell, & Maydene Fisher
Javadocs:
Javadocs for packages provided with the Application Server are located in install-dir/docs/api.
The following table describes the default paths and file names that are used in this book.
Table P–3 Default Paths and File Names
Placeholder |
Description |
Default Value |
---|---|---|
install-dir |
Represents the base installation directory for Application Server. |
Sun Java Enterprise System installations on the SolarisTM platform: /opt/SUNWappserver/appserver Sun Java Enterprise System installations on the Linux platform: /opt/sun/appserver/ Other Solaris and Linux installations, non-root user: user’s home directory/SUNWappserver Other Solaris and Linux installations, root user: /opt/SUNWappserver Windows, all installations: SystemDrive:\Sun\AppServer |
domain-root-dir |
Represents the directory containing all domains. |
Sun Java Enterprise System installations on the Solaris platform: /var/opt/SUNWappserver/domains/ Sun Java Enterprise System installations on the Linux platform: /var/opt/sun/appserver/domains/ All other installations: install-dir/domains/ |
domain-dir |
Represents the directory for a domain. In configuration files, you might see domain-dir represented as follows: ${com.sun.aas.instanceRoot} |
domain-root-dir/domain-dir |
The following table describes the typographic changes that are used in this book.
Table P–4 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. |
The following table explains symbols that might be used in this book.
Table P–5 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. |
The docs.sun.comSM web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. Books are available as online files in PDF and HTML formats. Both formats are readable by assistive technologies for users with disabilities.
To access the following Sun resources, go to http://www.sun.com:
Downloads of Sun products
Services and solutions
Support (including patches and updates)
Training
Research
Communities (for example, Sun Developer Network)
Third-party URLs are referenced in this document and provide additional, related information.
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 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 819-2642.