j2ee-components-generator.dtd 

Use

This XML file is a specific J2EE Engine file, to be used by J2EEgenerator script file.

Structure

The j2ee-components-generator.dtd defines the following elements:

The usage of each element is explained in detail as follows:

<!--
The j2ee-components-generator element is the root element. This element is obligatory and the name must be j2ee-components-generator.
An element that appears only once in the XML file.
-->
<!ELEMENT j2ee-components-generator (project-dir?, archive*)>

 

<!--
The project-dir element specifies the project directory where project files are located. This is a main element for the application components described with a relative file path. If this element is not specified, the location of the application components must be specified by its full file path.
An element that appears only once in the XML file.
Used in: j2ee-components-generator
-->
<!ELEMENT project-dir (#PCDATA)>

 

<!--
The archive element describes the archive to be created.
An element that can appear more than once in the XML file.
Used in: j2ee-components-generator
-->
<!ELEMENT archive (file-name, archive-descriptor, files*, directories*, additional-classpath)>

 

<!--
The file-name element specifies the relative or full path to the output archive file to be created by the J2Eegenerator script file.
An element that appears only once in the archive element.
Used in: archive
-->
<!ELEMENT file-name (#PCDATA)>

 

<!--
The archive-descriptor element specifies the relative or full path to the archive deployment descriptor.
An element that appears only once in the archive element.
Used in: archive
-->
<!ELEMENT archive-descriptor (file-location)>

 

<!--
The archive-descriptor attribute specifies the type of the J2EE archive element that deployment descriptor describes – enterprise bean, JAR, WAR or client JAR files. Possible values are “EJB,” “WEB” or “JAVA” respectively.
-->
<!ATTLIST archive-descriptor type CDATA #REQUIRED>

 

<!--
The file-location element specifies the relative or full path to the XML file, describing the archive.
An element that appears only once in the archive-descriptor element.
Used in: archive-descriptor
-->
<!ELEMENT file-location (#PCDATA)>

 

<!--
The files element specifies the entry name and the relative or full path to the additional archive files. This tag is required if helper classes or other additional files (or both) exist in the project. The tag is not used to specify enterprise bean classes in a JAR, as they are described in the deployment descriptor. The Servlet classes and JSP files in a WAR must be specified. The Manifest.mf files of the components must also be specified.
An element that can appear more than once in the archive element.
Used in: archive
-->
<!ELEMENT files (entry-name, file-path)>

 

<!--
The entry-name element specifies the entry name of the additional file(s) in the archive. This element can be used with mapping purposes. For example, Manifest.mf files must be added with entry-name meta-inf\Manifest.mf.
An element that appears only once in the files element.
Used in: files
-->
<!ELEMENT entry-name (#PCDATA)>

 

<!--
The file-path element specifies the relative or full path to the additional file(s).
An element that appears only once in the files element.
Used in: files
-->
<!ELEMENT file-path (#PCDATA)>

 

<!--
The directories element specifies a directory and its sub directories to be added to the archive.
An element that can appear more than once in the archive element.
Used in: archive
-->
<!ELEMENT directories (dir-path, extension-mapping*, included, excluded-files?)>

 

<!--
The dir-path element specifies the path to the directories, that will be added to the archive.
An element that appears only once in the directories element.
Used in: directories
-->
<!ELEMENT dir-path (#PCDATA)>

 

<!--
The included element specifies whether the directory is added to the archive. The possible values are YES or NO. This element is obligatory for a directory to be added.
An element that appears only once in the directories element.
Used in: directories
-->
<!ELEMENT included (#PCDATA)>

 

<!--
The extension-mapping element describes a list of all mappings and filters defined for the files in the directory.
An element that appears only once in the directories element.
Used in: directories
-->
<!ELEMENT extension-mapping (ext, mapping)>

 

<!--
The ext element specifies the extension by which all files are filtered, from the directory to be added. The possible values are mark with a full stop at the beginning. For example .class or .txt.
An element that can appear more than once in the extension-mapping element.
Used in: extension-mapping
-->
<!ELEMENT ext (#PCDATA)>

 

<!--
The mapping element specifies the directory where the filtered files are added to the archive. For example WEB-INF.
An element that can appear more than once in the extension-mapping element.
Used in: extension-mapping
-->
<!ELEMENT mapping (#PCDATA)>

 

<!--
The exclude-files element specifies a list of extensions of files to be excluded from the directories to be added to the archive. For example, .xml;.mf;.
An element that appears only once in the directories element.
Used in: directories
-->
<!ELEMENT excluded-files (#PCDATA)>

 

<!--
The additional-classpath element specifies a list of additional classpaths used for loading of the enterprise bean files. The different classpaths are divided by a semicolon (;).
An element that appears only once in the archive element.
Used in: archive
-->
<!ELEMENT additional-classpath (#PCDATA)>

Example

For an example of j2ee-components-generator.dtd, which can be used to create a few JAR files and a WAR file, see j2ee-components-generator.xml.