application-j2ee-engine.dtd 

Definition

A document type definition (DTD) that describes how to specify additional, SAP J2EE Engine-specific information about a J2EE application.

Structure

The application-j2ee-engine.dtd defines the following elements:

The usage of each element is explained below:

 

<!--
The root element for this deployment descriptor. It contains information about the different components of a particular application along with the references of the application to other components.
-->
<!ELEMENT application-j2ee-engine (reference*, classpath?, provider-name?, modules-additional?, fail-over-enable?, start-up?)>

 

<!--
Specifies an application reference to another application, library, service, or interface.
-->
<!ELEMENT reference (reference-target)>

 

<!--
Specifies the type of the reference.
-->
<!ATTLIST reference reference-type (strong|weak) #REQUIRED>

 

<!--
The name of the component, which is referenced by the application.
Example:
<reference-target target-type="application" provider-name="sap">
Application_Name
</reference-target>
-->
<!ELEMENT reference-target (#PCDATA)>

 

<!--
Describes the type of the component, which is referenced by the application.
-->
<!ATTLIST reference-target target-type (application|library|service|interface) #REQUIRED>

 

<!--
The name of the component provider.
-->
<!ATTLIST reference-target provider-name CDATA #IMPLIED>

 

<!--
Contains the classpaths to different resources (JAR or class files) that your application uses, but which are not necessary to be available when you deploy your application. If you call these resources from your application at runtime and they are still not available, you will receive an exception.
The classpath you specify can be either relative to the SAP J2EE Engine root directory, or absolute.
-->
<!ELEMENT classpath (#PCDATA)>

 

<!--
The name of the application provider.
-->
<!ELEMENT provider-name (#PCDATA)>

 

<!--
Specifies application modules, which must be distributed to containers that are not standard J2EE containers, such as WebDynpro, Web Services, JMSConnector, and so on.
-->
<!ELEMENT modules-additional (module+)>

 

<!--
Specifies a particular application component and the non-J2EE container to which this component must be distributed.
Example:
<module>
   <entry-name>jms/SonicDestination.xml</entry-name>
   <container-type>JMSConnector</container-type>
</module>
-->
<!ELEMENT module (entry-name, container-type+)>

 

<!--
The name of the application component. This name must be the exact entry name of the component in the EAR. For example if your component is located in a directory named xyz in the EAR, then the entry-name of the component must be xyz/component_name.
-->
<!ELEMENT entry-name (#PCDATA)>

 

<!--
The name of the container, to which this component is distributed. To view the containers that are available on the J2EE Engine, execute the CONTAINER_INFO -a shell command from the DEPLOY group of shell commands.
-->
<!ELEMENT container-type (#PCDATA)>

 

<!--
Enables failover for the application.
-->
<!ELEMENT fail-over-enable EMPTY>

 

<!--
Specifies the failover mode. The possible values are: disable (failover is disabled); on_request (the HTTP session is serialized after completing each HTTP request); and on_attribute (the HTTP session is serialized every time an attribute is added, changed, or removed from the HTTP session).
-->
<!ATTLIST fail-over-enable mode (disable|on_request|on_attribute) #REQUIRED>

 

<!--
Specifies the start-up time of the application.
-->
<!ELEMENT start-up EMPTY>

 

<!--
The values this attribute can take are: manual (application start is disabled); lazy (the application is started when there is a request to it); and always (the application is started when the server is started).
This element can be specified only for applications that use start-on-demand-enabled containers only.
-->
<!ATTLIST start-up mode CDATA #IMPLIED>