Preface

This Developer’s Guide describes how to create and run Java™ 2 Platform, Enterprise Edition (J2EE™ 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.

Who Should Use This Book

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)

Before You Read This Book

Application Server is a component of Sun Java™ Enterprise System, a software infrastructure that supports enterprise applications distributed across a network or Internet environment. You should be familiar with the documentation provided with Sun Java Enterprise System, which can be accessed online at http://docs.sun.com/app/docs/prod/entsys.05q1#hic.

How This Book Is Organized

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 Sun Java System Application Server.

The following table summarizes the chapters in this book.

Table 1 How This Book Is Organized
Chapter	Description
Chapter 1, "Setting Up a Development Environment"	Describes setting up an application development environment in the Sun Java System Application Server.
Chapter 2, “Securing Applications”	Explains how to write secure J2EE applications, which contain components that perform user authentication and access authorization.
Chapter 3, “Assembling and Deploying Applications”	Describes Sun Java System Application Server modules and how these modules are assembled separately or together in an application. Also describes classloaders and tools for assembly and deployment.
Chapter 4, “Debugging Applications”	Provides guidelines for debugging applications in the Sun Java System Application Server.
Chapter 5, “Developing Web Applications”	Describes how web applications are supported in the Sun Java System Application Server.
Chapter 6, “Using Enterprise JavaBeans Technology”	Describes how Enterprise JavaBeans™ (EJB™) technology is supported in the Sun Java System Application Server.
Chapter 7, "Using Container-Managed Persistence for Entity Beans"	Provides information on how container-managed persistence (CMP) works in the Sun Java System Application Server.
Chapter 8, "Developing Java Clients"	Describes how to develop, assemble, and deploy J2EE Application Clients.
Chapter 9, "Developing Connectors"	Describes Sun Java System Application Server support for the J2EE Connector 1.5 architecture.
Chapter 10, "Developing Lifecycle Listeners"	Describes how to create and use a lifecycle listener module.
Chapter 11, “Using the JDBC API for Database Access”	Explains how to use the Java™ Database Connectivity (JDBC™) API for database access with the Sun Java System Application Server.
Chapter 12, "Using the Transaction Service"	Describes J2EE transactions and transaction support in the Sun Java System Application Server.
Chapter 13, “Using the Java Naming and Directory Interface”	Explains how to use the Java Naming and Directory Interface™ (JNDI) API for naming and references.
Chapter 14, “Using the Java Message Service”	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.
Chapter 15, “Using the JavaMail API”	Explains how to use the JavaMail™ API.
Chapter 16, "Using the Java Management Extensions (JMX) API"	Explains how to use the Java Management Extensions (JMX™) API.
Appendix A, “Deployment Descriptor Files”	Describes deployment descriptor files specific to the Sun Java System Application Server.

Conventions Used in This Book

The tables in this section describe the conventions used in this book.

Typographic Conventions

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

Table 2 Typographic Conventions
Typeface	Meaning	Examples
AaBbCc123 (Monospace)	API and language elements, HTML tags, web site URLs, command names, file names, directory path names, onscreen computer output, sample code.	Edit your.login file. Use ls -a to list all files. % You have mail.
AaBbCc123 (Monospace bold)	What you type, when contrasted with onscreen computer output.	% su Password:
AaBbCc123 (Italic)	Book titles, new terms, words to be emphasized. A placeholder in a command or path name to be replaced with a real name or value.	Read Chapter 6 in the User’s Guide. These are called class options. Do not save the file. The file is located in the install-dir/bin directory.

Symbols

The following table describes the symbol conventions used in this book.

Table 3 Symbol Conventions
Symbol	Description	Example	Meaning
[ ]	Contains optional 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.
-	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 used in this book.

Table 4 Default Paths and File Names
Term	Description
install_dir	By default, the Application Server installation directory is located here: Sun Java Enterprise System installations on the Solaris™ 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	By default, the directory containing all domains is located here: 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	By default, each domain directory is located here: domain_root_dir/domain_dir In configuration files, you might see domain_dir represented as follows: ${com.sun.aas.instanceRoot}

Shell Prompts

The following table describes the shell prompts used in this book.

Table 5 Shell Prompts
Shell	Prompt
C shell on UNIX or Linux	machine-name%
C shell superuser on UNIX or Linux	machine-name#
Bourne shell and Korn shell on UNIX or Linux	$
Bourne shell and Korn shell superuser on UNIX or Linux	#
Windows command line	C:\

Related Documentation

The http://docs.sun.comSM web site enables you to access Sun technical documentation online. You can browse the archive or search for a specific book title or subject.

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.

Books in This Documentation Set

The Sun Java System Application Server manuals are available as online files in Portable Document Format (PDF) and Hypertext Markup Language (HTML).

The following table summarizes the books included in the Application Server core documentation set.

Table 6 Books in This 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 Sun Java System Application Server product.
Installation Guide	Installing the Sun Java System Application Server software and its components.
Developer’s Guide	Creating and implementing Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications intended to run on the Sun Java System 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 and deploying the applications on the Sun Java System Application Server.
Administration Guide	Configuring, managing, and deploying the Sun Java System Application Server subsystems and components from the Administration Console.
Administration Reference	Editing the Sun Java System Application Server configuration file, domain.xml.
Upgrade and Migration Guide	Migrating your applications to the new Sun Java System 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 Sun Java System Application Server problems.
Error Message Reference	Solving Sun Java System Application Server error messages.
Reference Manual	Utility commands available with the Sun Java System Application Server; written in manpage style. Includes the asadmin command line interface.

Accessing Sun Resources Online

For product downloads, professional services, patches and support, and additional developer information, go to the following:

Download Center
http://wwws.sun.com/software/download/

Professional Services
http://www.sun.com/service/sunps/sunone/index.html

Sun Enterprise Services, Solaris Patches, and Support
http://sunsolve.sun.com/

Developer Information
http://developers.sun.com/prodtech/index.html

Contacting Sun Technical Support

If you have technical questions about this product that are not answered in the product documentation, go to http://www.sun.com/service/contacting.

Related Third-Party Web Site References

Information about the Ant tool is available through the Apache Software Foundation:

http://ant.apache.org/

For information about standard Ant tasks, see the Ant documentation:

http://computing.ee.ethz.ch/sepp/ant-1.5.4-ke/manual/index.html

For information about use of the fileset element in the Ant tool, see:

http://computing.ee.ethz.ch/sepp/ant-1.5.4-ke/manual/CoreTypes/fileset.html

For more information about SOAP, see the Apache SOAP web site:

http://xml.apache.org/soap/index.html

Information about Optimizeit™ from Borland is available at:

http://www.borland.com/optimizeit

For general information about DTD files and XML, see the XML specification at:

http://www.w3.org/TR/REC-xml

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 document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document. For example, the title of this book is Sun Java System Application Server 2005Q1 Developer’s Guide, and the part number is 819-0079.

Previous Contents Index Next

Previous Contents Index Next
Sun Java System Application Server Platform Edition 8.1 2005Q1 Developer's Guide