Before You Begin

This Web Application Framework Component Author's Guide describes the component architecture of the Web Application Framework and the process whereby component authors can design, create, and distribute new components. This book is intended for prospective Web Application Framework component authors, and assumes that these component authors are already familiar with the Web Application Framework architecture and the Sun Java Studio Enterprise 7 2004Q4 development environment (hereafter referred to as the IDE).

Before You Read This Book

Before starting, you should be familiar with concepts used in building web applications using existing J2EE web technologies, such as servlets and JavaServlet Pages (JSP pages). You should be also already familiar with the Web Application Framework architecture by reading the related Web Application Framework documentation listed later in this chapter.

The following resources can provide additional information:

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

Note - 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 by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

How This Book Is Organized

Chapter 1, Overview and Component Architecture provides an overview of Component-Based Development (CBD), Web Application Framework Component Library, the Component Class, and the ComponentInfo Class.

Chapter 2, Developing Components provides a description of the fundamental steps involved in creating, distributing, and using a Web Application Framework component.

Chapter 3, Developing View Components provides a description of the fundamental steps involved in developing view components.

Chapter 4, Developing Model Components provides a description of the fundamental steps involved in developing model components.

Chapter 5, Developing Command Components provides a description of the fundamental steps involved in developing command components.

Chapter 6, ConfigurableBeans (Non-Visual Components) introduces how the IDE toolset makes use of the ConfigurableBean, the role it plays, and the relationship between Web Application Framework and the ConfigurableBean types.

Chapter 7, Developing and Distributing Non-Extensible Model, Command and ContainerView Components introduces the steps to develop and distribute non-extensible Model, Command, and ContainerView components.

Chapter 8, Design Actions describes developing extensible components which have component design actions, defines a component design action, and shows how to expose design action in ComponentInfo.

Chapter A, Component Library Structure offers an overview of the component library and the component library structure, and details the component manifest, with a description of automated unpacking of component tag libraries (TLD) files, and automated unpacking of "Additional Files".

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 and tutorials delivered in Acrobat Reader (PDF) format, release notes, online help, and tutorials delivered in HTML format.

Documentation Available Online

The documents described in this section are available from the docs.sun.com^SM web site and from the Documentation link from the Sun Java Studio Enterprise Developers Source portal (http://developers.sun.com/jsenterprise).

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 7 Release Notes - part no. 819-0905-10

Describes last-minute release changes and technical notes.

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

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

Building J2EE Applications - part no. 819-0819-10

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

Web Application Framework documentation (PDF format)

Web Application Framework Component Author's Guide - part no. 819-0724-10

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

Web Application Framework Component Reference Guide - part no. 819-0725-10

Describes the components available in the Web Application Framework Library.

Web Application Framework Overview - part no. 819-0726-10

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

Web Application Framework Tutorial- part no. 819-0727-10

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

Web Application Framework Developer's Guide - part no. 819-0728-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.

Web Application Framework IDE Guide - part no. 819-0729-10

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

Web Application Framework Tag Library Reference - part no. 819-0730-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.

Tutorials

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

All tutorials are available from the Tutorials and Code Camps link off the Developers Source portal, which you can access from within the IDE by choosing Help > Examples and Tutorials.

QuickStart guides provide an introduction to the Sun Java Studio IDE. Start with a QuickStart tutorial if you are either new to the Sun Java Studio IDE or want a quick introduction to a particular feature. These tutorials describe how to develop simple web and J2EE applications, generate web services, and how to get started with UML modeling and Refactoring. QuickStarts take minutes to complete.

Tutorials focus on a single feature of the Sun Java Studio IDE. Try these if you are interested in the details of a particular feature. Some tutorials build an application from the ground up, while others build on provided source files, depending on the focus of the example. You can complete a tutorial in an hour or less.

Narrated Tutorials use video to illustrate a feature or technique. Try a narrated tutorials for a visual overview of the IDE or an in-depth presentation of a particular feature. You can complete a narrated tutorial in a few minutes. You can also start and stop a narrated tutorial at any point you wish.

Online Help

Online help is available in the Sun Java Studio Enterprise 7 IDE. You can open help by pressing the help key (F1 in Microsoft Windows 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`
Tutorials	HTML at the Examples and Code Camps link from the Developers Source portal at `http://developers.sun.com/jsenterprise`
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 book's title (Web Application Framework Component Author's Guide) and its part number (819-0724-10) in the subject line of your email.