User's Manual

50 Chapter 8. WAF Application Development Tutorial

The standard layout of ﬁles in the build environment of a WAF application follows the guidelines

set out in the Tomcat Application Developer’s Guide (http://jakarta.apache.org/tomcat/tomcat-4.1-

doc/appdev/index.html), which are based on the Servlet speciﬁcation.

binder/

The name of the directory you choose to hold your application source and build ﬁles. Our exam-

ple application is a note binder, so we call our directory binder.

binder/pdl/

The PDL code for this application. As is common with Java code, it is organized into packages.

binder/pdl/com/example/binder/Binder.pdl

binder/pdl/com/example/binder/Note.pdl

binder/sql/

Custom SQL for your application. Ordinarily developers will autogenerate their SQL from PDL,

but if a custom schema is required, SQL ﬁles may be placed here to override automatic SQL

generation. See Chapter 9 Persistence Tutorial for more information. Files in this directory are

organized by relational database.

binder/src/

The source code and resources of your application reside here. As with library code, the source

is organized in packages. For example:

binder/src/com/example/binder/Binder.java

binder/src/com/example/binder/Note.java

binder/src/com/example/binder/NoteCollection.java

binder/src/com/example/binder/BinderServlet.java

binder/web/

The place for ﬁles that will become part of your webapp’s document root, such as JSPs, images,

and XSL templates. Once deployed, these ﬁles will be directly addressable via HTTP.

binder/web/logo.png

binder/web/note.jsp

binder/web/WEB-INF/

These are other resources such as compiled Java classes, property ﬁles, and resource bundles that

are used internally by your application code. Such ﬁles are not addressable.

binder/web/WEB-INF/classes

binder/web/WEB-INF/lib

Classes and jars that your application code uses go in classes/ and lib/, respectively. When

you compile and produce your webapp, these jars and classes will go with it.

8.4. Build Tools

If you choose to use the WAF build tools, you will start out with commands to build and deploy your

webapp from these directories. You can also use your own tools as long as you use this basic ﬁle layout

and follow the guidelines set out in the Jakarta webapp developer’s document speciﬁed in Section 8.3

Directories in the Work Area.