ear-generator.dtd 

Use

This XML file is a specific J2EE Engine file, to be used by the eargenerator script file. It defines the J2EE components to be included in an EAR file.

Structure

The ear-generator.dtd defines the following elements:

 

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

<!--
Ear-generator element is the root element.
This element is obligatory and the name must be ear-generator.
An element that appears only once in the XML file.
-->
<!ELEMENT ear-generator (ear)+>

 

<!--
The ear element describes the EAR file to be generated by the eargenerator script file. The jar/war/client/file or rar element specifies the type of the file to be added to the EAR.
An element that appears only once in the XML file.
Used in: ear-generator
-->
<!ELEMENT ear (project-dir?, pathname, displayname, small-icon?, large-icon?, description?, (jar|war|client|file|rar)+)>

 

<!--
Project-dir element specifies the project directory where project files are located. This is a main element for the application components that are described with 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 ear element.
Used in: ear
-->
<!ELEMENT project-dir (#PCDATA)>

 

<!--
The pathname element specifies the full or relative file path.
An element that can appear more than once in the element.
Used in: ear, jar, war, client, file, rar, altdd
-->
<!ELEMENT pathname (#PCDATA)>

 

<!--
The displayname element specifies the name by which the server looks for the EAR file
An element that appears only once in the ear element.
Used in: ear
-->
<!ELEMENT displayname (#PCDATA)>

 

<!--
The small-icon element specifies the file name for small images used to represent EAR file with tools. The image must be (16 x 16 pixel) GIF or JPEG image file.
An element that appears only once in the element.
Used in: ear
-->
<!ELEMENT small-icon (#PCDATA)>

 

<!--
The large-icon element specifies the file name for large images used to represent the EAR with tools. The image must be (32 x 32 pixel) GIF or JPEG image file.
An element that appears only once in the element.
Used in: ear
-->
<!ELEMENT large-icon (#PCDATA)>

 

<!--
The description element provides descriptive text about the EAR file.
An element that appears only once in the element.
Used in: ear
-->
<!ELEMENT description (#PCDATA)>

 

<!--
Jar element describes a JAR file in the EAR file.
An element that can appear more than once in the XML file.
Used in: ear
-->
<!ELEMENT jar (pathname, entryname, is-loaded, altdd*)>

 

<!--
War element describes the WAR files in the EAR.
An element that can appear more than once in the element.
Used in: ear
-->
<!ELEMENT war (pathname, entryname, contextroot, is-loaded, altdd*)>

 

<!--
Client element describes the client archive file in the EAR.
An element that can appear more than once in the XML file.
Used in: ear
-->
<!ELEMENT client (pathname, entryname, is-loaded, altdd*)>

 

<!--
File element specifies the additional file(s) to be added to the EAR.
An element that can appear more than once in the ear element.
Used in: ear
-->
<!ELEMENT file (pathname, entryname)>

 

<!--
The rar element specifies the RAR files (s) to be added to the EAR.
An element that can appear more than once in the ear element.
Used in: ear
-->
<!ELEMENT rar (pathname, entryname, is-loaded, altdd*)>

 

<!--
The entryname element specifies the name the file uses in the EAR. The name the file uses in the local file system may differ from its name in the EAR file.
An element that can appear more than once in the element.
Used in: jar, client, file, war
-->
<!ELEMENT entryname (#PCDATA)>

 

<!--
The contextroot element specifies the WAR context root, by which the HTTP Service accesses the WAR.
An element that appears only once in the war element.
Used in: war
-->
<!ELEMENT contextroot (#PCDATA)>

 

<!--
The elname element specifies the name of the component for which an alternative deployment descriptor is to be used. For example, the name of a Bean.
An element that appears only once in the altdd element.
Used in: altdd
-->
<!ELEMENT elname (#PCDATA)>

 

<!--
The altdd element specifies an alternative application component deployment descriptor to replace the original application component deployment descriptor. Altdd element specifies the component level deployment descriptor – JAR descriptor, WAR descriptor and client JAR descriptor. There is no limit on the number of the altdd elements. Use the element to make changes at deployment descriptor of the element.
An element that can appear more than once in the element.
Used in: war, client, jar
-->
<!ELEMENT altdd (pathname, elname)>

 

<!--
Altdd attribute specifies whether the alternative deployment descriptor, to be used. Possible values are yes or no. If you set “no”, do not specify the pathname and elname for altdd element.
-->
<!ATTLIST altdd use-alternative (yes|no) #REQUIRED>

 

<!--

Internal element for the Deploy Tool GUI. Set this element to false when using this xml outside of Deploy Tool GUI.

-->

<!ELEMENT is-loaded (#PCDATA)>

 

Example

For an example of ear-generator.dtd, see ear-generator.xml.