About This Guide

This Developer’s Guide to Enterprise JavaBeans Technology describes how to create and implement Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications that follow the Enterprise JavaBeans™ (EJB™) specification in the Sun™ Open Net Environment (Sun ONE) Application Server 7, Enterprise Edition environment. In addition to briefly describing EJB programming concepts and tasks, this guide offers sample code, implementation tips, and reference material. Topics include container-managed persistence, read-only beans, and the XML and DTD files associated with enterprise beans.

This preface addresses the following topics:

Who Should Use This Guide
Using the Documentation
How This Guide Is Organized
Related Information
Documentation Conventions
Product Support

---

Who Should Use This Guide

The intended audience for this guide is the person who develops, assembles, and deploys beans in a corporate enterprise.

This guide assumes you are familiar with the following topics:

Java programming
Java APIs as defined in the Java™ Servlet, JavaServer Pages™ (JSP™), Enterprise JavaBeans™ (EJB™), and Java™ Database Connectivity (JDBC™) specifications
The SQL structured database query languages
Relational database concepts
Software development processes, including debugging and source code control

---

Using the Documentation

The Sun ONE Application Server 7, Enterprise Edition manuals are available as online files in Portable Document Format (PDF) and Hypertext Markup Language (HTML).

The following table lists tasks and concepts described in the Sun ONE Application Server manuals.

Table 1  Sun ONE Application Server Documentation Roadmap 

For information about	See the following
Late-breaking information about the software and the documentation.	Release Notes
Comprehensive, table-based summary of supported hardware, operating system, JDK, and JDBC/RDBMS.	Platform Summary
Sun ONE Application Server 7 overview, including the features available with each product edition.	Product Overview
Diagrams and descriptions of server architecture and the benefits of the Sun ONE Application Server architectural approach.	Server Architecture
New enterprise, developer, and operational features of Sun ONE Application Server 7.	What’s New
How to get started with the Sun ONE Application Server 7 product. Includes a sample application tutorial.	Getting Started Guide
Installing the Sun ONE Application Server software and its components, such as sample applications, the Administration interface, and the high-availability components. Instructions for implementing a basic high-availability configuration are included.	Installation Guide
Evaluating your system needs and enterprise to ensure that you deploy Sun ONE Application Server in a manner that best suits your site. General issues and concerns that you must be aware of when deploying an application server are also discussed.	System Deployment Guide
Best practices for HTTP session availability that application architects and developers can use.	Application Design Guidelines for Storing Session State
Creating and implementing Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications intended to run on the Sun ONE Application Server 7 that follow the open Java standards model for J2EE components such as servlets, Enterprise JavaBeans™ (EJBs™), and JavaServer Pages™ (JSPs™). Includes general information about application design, developer tools, security, assembly, deployment, debugging, and creating lifecycle modules. A comprehensive Sun ONE Application Server glossary is included.	Developer’s Guide
Creating and implementing J2EE web applications that follow the Java™ Servlet and JavaServer Pages (JSP) specifications on the Sun ONE Application Server 7. Discusses web application programming concepts and tasks, and provides sample code, implementation tips, and reference material. Topics include results caching, JSP precompilation, session management, security, deployment, SHTML, and CGI.	Developer’s Guide to Web Applications
Creating and implementing J2EE applications that follow the open Java standards model for enterprise beans on the Sun ONE Application Server 7. Discusses Enterprise JavaBeans (EJB) programming concepts and tasks, and provides sample code, implementation tips, and reference material. Topics include container-managed persistence, read-only beans, and the XML and DTD files associated with enterprise beans.	Developer’s Guide to Enterprise JavaBeans Technology
Creating Application Client Container (ACC) clients that access J2EE applications on the Sun ONE Application Server 7.	Developer’s Guide to Clients
Creating web services in the Sun ONE Application Server environment.	Developer’s Guide to Web Services
Java™ Database Connectivity (JDBC™), transaction, Java Naming and Directory Interface™ (JNDI), Java™ Message Service (JMS), and JavaMail™ APIs.	Developer’s Guide to J2EE Services and APIs
Creating custom NSAPI plug-ins.	Developer’s Guide to NSAPI
Information and instructions on the configuration, management, and deployment of the Sun ONE Application Server subsystems and components, from both the Administration interface and the command-line interface. Topics include cluster management, the high-availability database, load balancing, and session persistence. A comprehensive Sun ONE Application Server glossary is included.	Administrator’s Guide
Editing Sun ONE Application Server configuration files, such as the server.xml file.	Administrator’s Configuration File Reference
Configuring and administering security for the Sun ONE Application Server operational environment. Includes information on general security, certificates, and SSL/TLS encryption. HTTP server-based security is also addressed.	Administrator’s Guide to Security
Configuring and administering service provider implementation for J2EE™ Connector Architecture (CA) connectors for the Sun ONE Application Server 7. Topics include the Administration Tool, Pooling Monitor, deploying a JCA connector, and sample connectors and sample applications.	J2EE CA Service Provider Implementation Administrator’s Guide
Migrating your applications to the new Sun ONE Application Server 7 programming model, specifically from iPlanet Application Server 6.x and from Netscape Application Server 4.0. Includes a sample migration.	Migrating and Redeploying Server Applications Guide
How and why to tune your Sun ONE Application Server to improve performance.	Performance Tuning Guide
Information on solving Sun ONE Application Server problems.	Troubleshooting Guide
Messages that you may encounter while running Sun ONE Application Server 7. Includes a description of the likely cause and guidelines on how to address the condition that caused the message to be generated.	Error Message Reference
Utility commands available with the Sun ONE Application Server; written in manpage style.	Utility Reference Manual
Using the Sun™ Open Net Environment (Sun ONE) Message Queue software.	The Sun ONE Message Queue documentation at: http://docs.sun.com/db?p=prod/s1.s1msgqu

---

How This Guide Is Organized

This guide contains the following documentation components:

"Introducing the Sun ONE Application Server Enterprise JavaBeans Technology"
“Using Session Beans”
“Using Entity Beans”
"Using Container-Managed Persistence for Entity Beans"
“Using Message-Driven Beans”
“Handling Transactions with Enterprise Beans”
“Developing Secure Enterprise Beans”
“Assembling and Deploying Enterprise Beans”
"CMP Mapping with the Sun ONE Studio 4 Interface"
"Elements Listings"

---

Related Information

In addition to the information in the Sun ONE Application Server documentation collection listed in "Using the Documentation", the following resources may be helpful:

J2EE Specifications

http://java.sun.com/products/

Enterprise JavaBeans Specification, Version 2.0

http://java.sun.com/products/ejb/docs.html#specs

General EJB product information:

http://java.sun.com/products/ejb

Java Software tutorials:

http://java.sun.com/docs/books/tutorial/

Enterprise JavaBeans, by Richard Monson-Haefel, O’Reilly Publishing,
ISBN 0-596-00226-2

http://www.oreilly.com/catalog/entjbeans3/

Enterprise Beans Technology book index

http://developer.java.sun.com/developer/Books/ejbtechnology.html

Enterprise JavaBeans Design Patterns, ISBN 0-471-20831-0
Core J2EE Patterns, ISBN 0-13-064884-1

---

Documentation Conventions

This section describes the types of conventions used throughout this guide:

General Conventions
Conventions Referring to Directories

General Conventions

The following general conventions are used in this guide:

File and directory paths are given in UNIX^® format (with forward slashes separating directory names).
URLs are given in the format:

http://server.domain/path/file.html

In these URLs, server is the server name where applications are run; domain is your Internet domain name; path is the server’s directory structure; and file is an individual filename. Italic items in URLs are placeholders.

Font conventions include:
The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, pathnames, directory names, and HTML tags.
Italic type is used for code variables.
Italic type is also used for book titles, emphasis, variables and placeholders, and words used in the literal sense.
Bold type is used as either a paragraph lead-in or to indicate words used in the literal sense.
Installation root directories for most platforms are indicated by install_dir in this document. Exceptions are noted in "Conventions Referring to Directories".

By default, the location of install_dir on most platforms is:

/opt/SUNWappserver7

For the platforms listed above, default_config_dir and install_config_dir are identical to install_dir. See "Conventions Referring to Directories" for exceptions and additional information.

Instance root directories are indicated by instance_dir in this document, which is an abbreviation for the following:

default_config_dir/domains/domain/instance

UNIX-specific descriptions throughout this manual apply to the Linux operating system as well, except where Linux is specifically mentioned.

Conventions Referring to Directories

By default, when using the Solaris 8 and 9 installation, the application server files are spread across several root directories. These directories are described in this section.

For Solaris 8 and 9 installations, this guide uses the following document conventions to correspond to the various default installation directories provided:
install_dir refers to /opt/SUNWappserver7, which contains the static portion of the installation image. All utilities, executables, and libraries that make up the application server reside in this location.
default_config_dir refers to /var/opt/SUNWappserver7/domainswhich is the default location for any domains that are created.
install_config_dir refers to /etc/opt/SUNWappserver7/config, which contains installation-wide configuration information such as licenses and the master list of administrative domains configured for this installation.

---

Product Support

If you have general feedback on the product or documentation, please send this to appserver-feedback@sun.com.

If you have problems with your system, contact customer support using one of the following mechanisms:

The online support web site at:

http://www.sun.com/supportraining/

The telephone dispatch number associated with your maintenance contract

Please have the following information available prior to contacting support. This helps to ensure that our support staff can best assist you in resolving problems:

Description of the problem, including the situation where the problem occurs and its impact on your operation
Machine type, operating system version, and product version, including any patches and other software that might be affecting the problem
Detailed steps on the methods you have used to reproduce the problem
Any error logs or core dumps

Previous      Contents      Index      Next

---

Copyright 2003 Sun Microsystems, Inc. All rights reserved.