Before You Begin

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

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://forte.sun.com/ffj/documentation/index.html

Screen shots vary slightly from one platform to another. Although almost all procedures use the interface of the Sun ONE Studio 5 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 (J2EEtrademark) Blueprints. If you want to learn how to use the features of Sun ONE Studio 5, Standard Edition 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
  • Javatrademark Servlet syntax
  • JDBCtrademark enabled driver syntax
  • JavaServer Pagestrademark 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:

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 Sun ONE Studio 5 IDE and the Sun ONE Application Server, how to get the IDE and the application server to recognize each other and both communicating with an Oracle 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.

Appendix 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

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

Documentation Available Online

The documents described in this section are available from the docs.sun.comSM web site and from the documentation page of the Sun ONE Studio Developer Resources portal (http://forte.sun.com/ffj/documentation).

The docs.sun.com web site (http://docs.sun.com) enables you to read, print, and buy Sun Microsystems manuals through the Internet. If you cannot find a manual, see the documentation index installed with the product on your local system or network.

  • Release notes (HTML format)
Available for each Sun ONE Studio 5 edition. Describe last-minute release changes and technical notes.
    • Sun ONE Studio 5, Standard Edition Release Notes - part no. 817-2337-10
  • Getting Started guides (PDF format)
Describe how to install the Sun ONE Studio 5 integrated development environment (IDE) on each supported platform and include other pertinent information, such as system requirements, upgrade instructions, application server information, command-line switches, installed subdirectories, database integration, and information on how to use the Update Center.
    • Sun ONE Studio 5, Standard Edition Getting Started Guide - part no. 817-2318-10
    • Sun ONE Studio 4, Mobile Edition Getting Started Guide - part no. 817-1145-10
  • Sun ONE Studio 5 Programming series (PDF format)
This series provides in-depth information on how to use various Sun ONE Studio 5 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 or bean-managed persistence) using the Sun ONE Studio 5 EJB Builder wizard and other components of the IDE.
    • Building Web Services - part no. 817-2324-10
Describes how to use the Sun ONE Studio 5 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 ONE Studio 5 IDE, including how to use them to create a JDBC application.
  • Sun ONE Studio 5 tutorials (PDF format)
These tutorials demonstrate how to use the major features of Sun ONE Studio 5, Standard Edition.
    • Sun ONE Studio 5 Web Application Tutorial - part no. 817-2320-10
Provides step-by-step instructions for building a simple J2EE web application.
    • Sun ONE Studio 5 J2EE Application Tutorial - part no. 817-2322-10
Provides step-by-step instructions for building an application using EJB components and Web Services technology.
    • Sun ONE Studio 4, Mobile Edition Tutorial - part no. 816-7873-10
Provides step-by-step instructions for building a simple application for a wireless device, such as a cellular phone or personal digital assistant (PDA). The application will be compliant with the Java 2 Platform, Micro Edition (J2MEtrademark platform) and conform to the Mobile Information Device Profile (MIDP) and Connected, Limited Device Configuration (CLDC).

You can also find the completed tutorial applications at: http://forte.sun.com/ffj/documentation/tutorialsandexamples.html

Online Help

Online help is available inside the Sun ONE Studio 5 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.

Examples

You can download examples that illustrate a particular Sun ONE Studio 5 feature, as well as completed tutorial applications, from the Sun ONE Studio Developer Resources portal at:

http://forte.sun.com/ffj/documentation/tutorialsandexamples.html

The site includes the applications used in this document.

Javadoc Documentation

Javadoc documentation is available within the IDE for many Sun ONE Studio 5 modules. Refer to the release notes for instructions on installing this documentation.

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://forte.sun.com/ffj/tutorialsandexamples.html

Integrated example readmes

HTML in the example subdirectories of s1studio-install-directory/examples

Release notes

HTML at http://docs.sun.com



Contacting Sun Technical Support

If you have technical questions about this product that are not answered in this document, go to:

http://www.sun.com/service/contacting


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-2322-10) of your document in the subject line of your email.