Before You Begin

Welcome to the Sun Java Studio Enterprise 6 J2EE application tutorial. This tutorial shows you how to use the following features of the Java Studio Enterprise integrated development environment (IDE):

EJB 2.0 Builder--for creating and developing Enterprise JavaBeans components based on the Enterprise JavaBeans Specification, Version 2.0.

EJB module assembly--for assembling the EJB components into an EJB module, which you export into an EJB Java Archive (JAR) file

Test application facility--for testing enterprise beans without having to create a client manually, using the Sun Java System Application Server software as the application server.

Web Services features--for building a SOAP web service from the existing EJB component, and generating JSP pages viewable from a web browser

Deploying to Sun Java System Application Server--for testing the tutorial application

See the release notes for a list of environments in which you can create the example in this book. The release notes are available on this web page:

http://developers.sun.com/prodtech/javatools/jsenterprise/reference/docs/index.html

Screen shots vary slightly from one platform to another. Although almost all procedures use the interface of the Sun Java Studio Enterprise 6 software, occasionally you might be instructed to enter a command at the command line. Here too, there are slight differences from one platform to another. For example, a Microsoft Windows command might look like this:

c:>cd MyWorkDir\MyPackage

A UNIX^® command might look like this:

% cd MyWorkDir/MyPackage

Before You Read This Book

This tutorial creates an application that conforms to the architecture documented in Java 2 Platform, Enterprise Edition (J2EE) Blueprints. If you want to learn how to use the features of Sun Java Studio Enterprise 6 to create, develop, and deploy a J2EE compliant application, you will benefit from working through this tutorial.

Before starting, you should be familiar with the following subjects:

Java programming language

Enterprise JavaBeans concepts

Java Servlet syntax

JDBC enabled driver syntax

JavaServer Pages syntax

HTML syntax

Relational database concepts (such as tables and keys)

How to use the chosen database

J2EE application assembly and deployment concepts

This book requires a knowledge of J2EE concepts, as described in the following resources:

Java 2 Platform, Enterprise Edition Blueprints
http://java.sun.com/j2ee/blueprints

Java 2 Platform, Enterprise Edition Specification
http://java.sun.com/j2ee/download.html#platformspec

The J2EE Tutorial
http://java.sun.com/j2ee/tutorial

Java Servlet Specification Version 2.3
http://java.sun.com/products/servlet/download.html#specs

JavaServer Pages Specification Version 1.2
http://java.sun.com/products/jsp/download.html#specs

Familiarity with the Java API for XML-Based RPC (JAX-RPC) is helpful. For more information, see this web page:

http://java.sun.com/xml/jaxrpc

Note - Sun is not responsible for the availability of third-party web sites mentioned in this document and does not endorse and is not responsible or liable for any content, advertising, products, or other materials on or available from such sites or resources. Sun will not be responsible or liable for any 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 available on or through any such sites or resources.

How This Book Is Organized

This manual is designed to be read from beginning to end. Each chapter in the tutorial builds upon the code developed in earlier chapters.

Chapter 1 lists the software requirements for the DiningGuide tutorial, explains how to start the Java Studio Enterprise IDE and the Sun Java System Application Server, how to get the IDE and the application server to recognize each other and both communicating with a PointBase database, how to create the tutorial database tables, and then create a database schema in the IDE based on those tables.

Chapter 2 describes the functionality and architecture of the tutorial application.

Chapter 3 provides step-by-step instructions for creating the EJB tier of the tutorial application, and how use the IDE's test application facility to test each bean.

Chapter 4 describes how to use the IDE to generate the tutorial's web service from its EJB tier, and how to test the web service.

Chapter 5 explains how a provided Swing client accesses the output generated from the Web Services module in Chapter 4, and how to run the tutorial application.

Appendix A provides complete source files for the tutorial application.

Appendix B provides the database script for the tutorial application.

-A P P E N D I XAppendix C describes how to adapt the tutorial to create and run the application using an Oracle database.

Typographic Conventions

Typeface	Meaning	Examples
`AaBbCc123`	The names of commands, files, and directories; on-screen computer output	Edit your `.cvspass` file. Use `DIR` to list all files. `Search is complete.`
`AaBbCc123`	What you type, when contrasted with on-screen computer output	`>` `login` `Password:`
AaBbCc123	Book titles, new words or terms, words to be emphasized	Read Chapter 6 in the User's Guide. These are called class options. You must save your changes.
AaBbCc123	Command-line variable; replace with a real name or value	To delete a file, type `DEL` filename.

Related Documentation

Java Studio Enterprise documentation includes books delivered in Acrobat Reader (PDF) format, release notes, online help, and readme files for example applications.

Documentation Available Online

The documents described in this section are available from the docs.sun.com^SM web site and from the documentation page of the Sun Developer Resources portal at http://developers.sun.com/prodtech/javatools/jsenterprise/reference/docs/index.html.

The docs.sun.com web site (http://docs.sun.com) enables you to read, print, and buy Sun Microsystems manuals through the Internet.

Sun Java Studio Enterprise 6 Release Notes - part no. 817-5453-10

Describes last-minute release changes and technical notes.

Sun Java Studio Enterprise 6 Installation Guide - part no. 817-4662-10 (PDF format)

Describes how to install the Sun Java Studio Enterprise 6 integrated development environment (IDE) and associated servers on each supported platform and includes other pertinent information, such as system requirements, upgrade instructions, server information, command-line switches, database integration, and information on how to use the Update Center.

Sun Java Studio Enterprise 6 Examples Guide - part no. 817-6057-10

Describes the available code examples for Sun Java Studio Enterprise 6 software.

Sun Java Studio Enterprise 6 Programming series (PDF format)

This series provides in-depth information on how to use various Sun Java Studio Enterprise 6 features to develop well-formed J2EE applications.

Building Web Components - part no. 817-2334-10

Describes how to build a web application as a J2EE web module using JSP pages, servlets, tag libraries, and supporting classes and files.

Building J2EE Applications - part no. 817-2327-10

Describes how to assemble EJB modules and web modules into a J2EE application and how to deploy and run a J2EE application.

Building Enterprise JavaBeans Components - part no. 817-2330-10

Describes how to build EJB components (session beans, message-driven beans, and entity beans with container-managed persistence or bean-managed persistence) using the Sun Java Studio Enterprise 6 EJB Builder wizard and other components of the IDE.

Building Web Services - part no. 817-2324-10

Describes how to use the Sun Java Studio Enterprise 6 IDE to build web services, to make web services available to others through a UDDI registry, and to generate web service clients from a local web service or a UDDI registry.

Using Java DataBase Connectivity - part no. 817-2332-10

Describes how to use the JDBC productivity enhancement tools of the Sun Java Studio Enterprise 6 IDE, including how to use them to create a JDBC application.

Sun Java Studio's Web Application Framework documentation (PDF format)

Sun Java Studio's Web Application Framework IDE Guide - part no. 817-4802-10

Describes the various parts of the Sun Java Studio Enterprise 6 IDE and emphasizes the use of the visual tools for developing a Web Application Framework application.

Sun Java Studio's Web Application Framework Tutorial- part no. 817-5401-10

Introduces the mechanics and techniques to build a web application using the Web Application Framework tools.

Sun Java Studio's Web Application Framework Developer's Guide - part no. 817-5402-10

Provides the steps to create and use application components that can be assembled to develop an application using the Web Application Framework and explains how to deploy the application in most J2EE containers.

Sun Java Studio's Web Application Framework Overview - part no. 817-5403-10

Introduces the Web Application Framework and what it is, how it works, and what sets it apart from other application frameworks.

Sun Java Studio's Web Application Framework Tag Library Reference - part no. 817-4801-10

Gives a brief introduction to the Web Application Framework tag library, as well as a comprehensive reference to the tags available within the library.

Sun Java Studio's Web Application Framework Component Author's Guide - part no. 817-5404-10

Describes the Web Application Framework component architecture and the process to design, create, and distribute new components.

Sun Java Studio's Web Application Framework Component Reference Guide - part no. 817-5405-10

Describes the components available in the Web Application Framework Library.

Tutorials, Mini-Tutorials, and Examples

Sun Java Studio Enterprise 6 tutorials, mini-tutorials, and examples help you understand the features of the IDE. Each example or tutorial provides code samples that you can use or modify in developing more substantial applications. All examples and tutorials illustrate deployment with Sun Java System Application Server.

Completed examples ready to run target users who want to see quickly how a feature works and prefer to learn from browsing in source code. Completed examples can be installed, deployed, and executed in a few minutes.

Completed examples are available in the AboutExamples directory under your Java Studio Enterprise user directory.

Mini-tutorials focus on a single feature of the Sun Java Studio Enterprise 6 software. The target user is someone interested in a particular feature, or someone with time constraints looking for a relatively short example. Some mini-tutorials build an application from the beginning, while others build on provided source files. Mini-tutorials can be completed in an hour or less.

Mini-tutorials are available from the Tutorials and Code Camps page of the Sun Java Studio Enterprise 6 developers portal, at http://developers.sun.com/prodtech/javatools/jsenterprise/learning/tutorials/index.html.

Sun Java Studio Enterprise 6 tutorials (PDF format) demonstrate how to use the major features of Sun Java Studio Enterprise 6. These are:

Sun Java Studio Enterprise 6 Web Application Tutorial - part no. 817-5553-10

Provides step-by-step instructions for building a simple J2EE web application.

Sun Java Studio Enterprise 6 J2EE Application Tutorial - part no. 817-5554-10

Provides step-by-step instructions for building an application using EJB components and Web Services technology.

These documents are available from docs.sun.com. The documents, as well as zip files of the completed applications, are also available from the Tutorials and Code Camps page of the Sun Java Studio Enterprise 6 developers portal, at http://developers.sun.com/prodtech/javatools/jsenterprise/learning/tutorials/index.html.

Online Help

Online help is available inside the Java Studio Enterprise IDE. You can open help by pressing the help key (F1 in Microsoft Windows and Linux environments, Help key in the Solaris environment), or by choosing Help right arrow Contents. Either action displays a list of help topics and a search facility.

Documentation in Accessible Formats

The documentation is provided in accessible formats that are readable by assistive technologies for users with disabilities. You can find accessible versions of documentation as described in the following table.

Type of Documentation	Format and Location of Accessible Version
Books and tutorials	HTML at `http://docs.sun.com`
Mini-tutorials	HTML at `http://developers.sun.com/prodtech/javatools/jsenterprise/learning/tutorials/index.html`
Integrated example readmes	HTML in subdirectory of java-studio-install-dir`/examples`
Release notes	HTML at `http://docs.sun.com`

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. Email your comments to Sun at this address:

docfeedback@sun.com

Please include the part number (817-5554-10) of your document in the subject line of your email.