Directory structure for factory Web applications

Directory structure for factory Web applications

Related Topics ...

Overview: Configuring a Development Environment
Referencing Servable Resources
About Generated File Names

The Factory's directory structure is similar to any other Web application in that it has a document root where all its static HTML and other servable resources reside. Depending on the application server, the Factory's document root, also known as the servable content root directory, is similar to one of the following locations:

Tomcat -- c:\tomcat\webapps\<ear>\<war>
WebSphere -- c:\WebSphere\AppServer\installedApps\<ear>\<war>

Where domainName is the domain name you specified during installation and factory is the name of the directory in which you installed the WebSphere Portlet Factory.
Web applications generated by the Factory adhere to the architecture for all J2EE applications. HTML pages, images, and other "servable" resources reside somewhere below the Factory's servable content root directory. Java classes, profile sets, models, and other "non-servable" content resides in the Factory's WEB-INF directory.
The following table lists and describes the directories relevant to Web application development with the Factory.

Directory

Description

project

Factory's servable content root directory. All HTML pages, images, and other resources that are "servable" to the user are stored in this directory or in one of its sub-directories.

factory

All the servable resources pertaining to Factory reside in this directory. HTML pages for the applications that comprise the Factory and images are all in this directory.

genjsp

All the JSPs from your models get stored in this directory according to the directory path and model name to which the page belongs. For example, com/acme/insurance_portal/UserRegistration_RegistrationPage.jsp.

WEB-INF

Factory's non-servable content root, containing all the Java classes, profile sets, and other non-servable resources for Factory itself as well as all of the Web applications you create.

WEB-INF/builders

Contains all of the builder definition files used in the Factory.

WEB-INF/classes

Part of Factory's class path. Contains the deployable Java classes used by your Web applcations.

WEB-INF/clientLibs

Part of Factory's class path. Store the deployable JAR files used by your Web applications.

WEB-INF/config

Contains the property files used by the Factory.

WEB-INF/factory/generated

Contains the genjava directory, which contains all of the Java classes that the Automation Engine generates for the methods in your models.

WEB-INF/lib

Part of the Factory's class path. Contains all the JAR files used by the Factory.

WEB-INF/logs

Contains log files from the Factory.

WEB-INF/models

Contains all the models installed as part of the Factory as well as the models you create.

WEB-INF/temp

IBM WebSphere Studio or Rational Development Environments compile Java source files to this directory and then uses Ant to copy the class files to the WEB-INF/work/classes directory.

WEB-INF/work

Contains sample Java source files and classes.

WEB-INF/work/classes

The work/classes directory is also part of Factory's class path. All classes in this directory get dynamically loaded by the Factory.

WEB-INF/work/source

Contains sample code and serves as a convenient place to store Java source files for your Web applications.

Directory	Description
project	Factory's servable content root directory. All HTML pages, images, and other resources that are "servable" to the user are stored in this directory or in one of its sub-directories.
factory	All the servable resources pertaining to Factory reside in this directory. HTML pages for the applications that comprise the Factory and images are all in this directory.
genjsp	All the JSPs from your models get stored in this directory according to the directory path and model name to which the page belongs. For example, com/acme/insurance_portal/UserRegistration_RegistrationPage.jsp.
WEB-INF	Factory's non-servable content root, containing all the Java classes, profile sets, and other non-servable resources for Factory itself as well as all of the Web applications you create.
WEB-INF/builders	Contains all of the builder definition files used in the Factory.
WEB-INF/classes	Part of Factory's class path. Contains the deployable Java classes used by your Web applcations.
WEB-INF/clientLibs	Part of Factory's class path. Store the deployable JAR files used by your Web applications.
WEB-INF/config	Contains the property files used by the Factory.
WEB-INF/factory/generated	Contains the genjava directory, which contains all of the Java classes that the Automation Engine generates for the methods in your models.
WEB-INF/lib	Part of the Factory's class path. Contains all the JAR files used by the Factory.
WEB-INF/logs	Contains log files from the Factory.
WEB-INF/models	Contains all the models installed as part of the Factory as well as the models you create.
WEB-INF/temp	IBM WebSphere Studio or Rational Development Environments compile Java source files to this directory and then uses Ant to copy the class files to the WEB-INF/work/classes directory.
WEB-INF/work	Contains sample Java source files and classes.
WEB-INF/work/classes	The work/classes directory is also part of Factory's class path. All classes in this directory get dynamically loaded by the Factory.
WEB-INF/work/source	Contains sample code and serves as a convenient place to store Java source files for your Web applications.