The Example JSP Pages - The J2EE 1.4 Tutorial

The Example JSP Pages

This chapter describes the tasks involved in defining simple tags. We illustrate the tasks using excerpts from the JSP version of the Duke's Bookstore application discussed in The Example JSP Pages, rewritten here to take advantage of several custom tags:

A catalog tag for rendering the book catalog
A shipDate tag for rendering the ship date of an order
A template library for ensuring a common look and feel among all screens and composing screens out of content chunks

The last section in the chapter, Examples, describes several tags in detail: a simple iteration tag and the set of tags in the tutorial-template tag library.

The tutorial-template tag library defines a set of tags for creating an application template. The template is a JSP page that has placeholders for the parts that need to change with each screen. Each of these placeholders is referred to as a parameter of the template. For example, a simple template might include a title parameter for the top of the generated screen and a body parameter to refer to a JSP page for the custom content of the screen. The template is created using a set of nested tags--definition, screen, and parameter--that are used to build a table of screen definitions for Duke's Bookstore. An insert tag to insert parameters from the table into the screen.

Figure 15-1 shows the flow of a request through the following Duke's Bookstore web components:

template.jsp, which determines the structure of each screen. It uses the insert tag to compose a screen from subcomponents.
screendefinitions.jsp, which defines the subcomponents used by each screen. All screens have the same banner but different title and body content (specified by the JSP Pages column in Table 12-1).
Dispatcher, a servlet, which processes requests and forwards to template.jsp.

Figure 15-1 Request Flow through Duke's Bookstore Components

The source code for the Duke's Bookstore application is located in the <INSTALL>/j2eetutorial14/examples/web/bookstore3/ directory created when you unzip the tutorial bundle (see About the Examples). A sample bookstore3.war is provided in <INSTALL>/j2eetutorial14/examples/web/provided-wars/. To build the example, follow these steps:

Build and package the bookstore common files as described in Duke's Bookstore Examples.
In a terminal window, go to <INSTALL>/j2eetutorial14/examples/bookstore3/.
Run asant build. This target will spawn any necessary compilations and will copy files to the <INSTALL>/j2eetutorial14/examples/web/bookstore3/build/ directory.
Start the Application Server.
Perform all the operations described in Accessing Databases from Web Applications.

To package and deploy the example using asant, follow these steps:

Run asant create-bookstore-war.
Run asant deploy-war.

To learn how to configure the example, use deploytool to package and deploy it:

Start deploytool.
Create a web application called bookstore3. Select FileNewWeb Component.
In the New Web Component wizard:
Select the Create New Stand-Alone WAR Module radio button.
In the WAR File field, enter <INSTALL>/j2eetutorial14/examples/web/bookstore3/bookstore3.war. The WAR Display Name field will show bookstore3.
In the Context Root field, enter /bookstore3.
Click Edit Contents.
In the Edit Contents dialog box, navigate to <INSTALL>/j2eetutorial14/examples/web/bookstore3/build/. Select the JSP pages bookstore.jsp, bookdetails.jsp, bookcatalog.jsp, bookshowcart.jsp, bookcashier.jsp, bookreceipt.jsp, and bookordererror.jsp, the tag files catalog.tag and shipDate.tag, the custom TLD, tutorial-template.tld, and the dispatcher, database, listeners, and template directories and click Add. Click OK.
Add the shared bookstore library. Navigate to <INSTALL>/j2eetutorial14/examples/web/bookstore/dist/. Select bookstore.jar, and click Add. Click OK.
Click Next.
Select the Servlet radio button, then .
Click Next.
Select dispatcher.Dispatcher from the Servlet class combo box.
Click Finish.
Add the listener class listeners.ContextListener (described in Handling Servlet Life-Cycle Events).
Select the Event Listeners tab.
Click Add.
Select the listeners.ContextListener class from drop-down field in the Event Listener Classes pane.
Add the aliases.
Select Dispatcher.
Select the Aliases tab.
Click Add and then type /bookstore in the Aliases field. Repeat to add the aliases /bookcatalog, /bookdetails, /bookshowcart, /bookcashier, /bookordererror, and /bookreceipt.
Add the context parameter that specifies the JSTL resource bundle base name.
Select the web module.
Select the Context tab.
Click Add.
Enter javax.servlet.jsp.jstl.fmt.localizationContext in the Coded Parameter field.
Enter messages.BookstoreMessages in the Value field.
Set the prelude for all JSP pages.
Select the JSP Properties tab.
Click the Add button next to the Name list.
Enter bookstore3.
Click the Add URL button.
Enter *.jsp.
Click the Edit Preludes button.
Click Add.
Enter /template/prelude.jspf.
Click OK.
Add a resource reference for the database.
Select the Resource Ref's tab.
Click Add.
Enter jdbc/BookDB in the Coded Name field.
Accept the default type javax.sql.DataSource.
Accept the default authorization Container.
Accept the default selected Shareable.
Enter jdbc/BookDB in the JNDI name field of the Sun-specific Settings frame.
Deploy the application.
Select ToolsDeploy.
Click OK.
A pop-up dialog box will display the results of the deployment. Click Close.

To run the example, open the bookstore URL http://localhost:8080/bookstore3/bookstore.

See Troubleshooting for help with diagnosing common problems.

All of the material in The J2EE(TM) 1.4 Tutorial is copyright-protected and may not be published in other works without express written permission from Sun Microsystems.