deploy-manager-config.dtd 

Use

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

Structure

The deploy-manager-config.dtd defines the following elements:

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

<!--
The deploy-manager-config element is the root element.
This element is obligatory.
An element that appears only once in the XML file.
-->
<!ELEMENT deploy-manager-config (version-id, project-dir?, deployable-object, element*, login-info, user-role-mapping?, server-components-xml?, library-info?, supports, deployment-properties?, repl-var-properties?, log-file?)>

 

<!--
The version-id element specifies the version number of SAP J2EE Engine that deploys the application.
An element that appears only once in the Deploy-manager-config element.
Used in: deploy-manager-config.
-->
<!ELEMENT version-id (#PCDATA)>

 

<!--
The project-dir element specifies the project directory where project files are located. This is a main element for the application components described with the relative file path. If this element is not specified, the location of the application components have to be specified by their full file path.
Used in: Deploy-manager-config.
-->
<!ELEMENT project-dir (#PCDATA)>

 

<!—
The deployable-object element specifies the type of the deployable element. You can deploy EAR application files, as well J2EE modules (for example JAR and WAR).
An element that appears only once in the Deploy-manager-config element.
Used in: deploy-manager-config.
-->
<!ELEMENT deployable-object (ear-file|j2ee-module)>

 

<!--
The action-type attribute specifies a type of deployment action. Possible values are deploy and update. Use deploy to deploy a new application. Use update to update an existing application. During the update procedure, if the application contains new components, they are added to the deployed application.
An attribute that appears only once in the XML file.
Used in: xml-ear-path.
-->
<!ATTLIST deployable-object action-type (deploy|update) #REQUIRED>

 

<!--
The ear-file element specifies the EAR application file by path, display name and alternative descriptor. This element is critical for execution of the deploymanager script file.
An element that appears only once in the XML file.
Used in: deployable-object.
-->
<!ELEMENT ear-file (ear-path, display-name?, altdd*)>

 

<!--
The ear-path element specifies the file path to the application EAR file used for deployment. The file path can be the full or relative path. If the project-dir element is not specified, use the full file path. This element is obligatory and critical for the execution of the deploymanager script file.
An element that appears only once in the XML file.
Used in: ear-file.
-->
<!ELEMENT ear-path (#PCDATA)>

 

<!--
The display-name element specifies the name that is to be used for the application. This element is obligatory.
An element that appears only once in the XML file.
Used in: ear-file.
-->
<!ELEMENT display-name (#PCDATA)>

 

<!--
The j2ee-module element specifies the archive that is to be deployed on the SAP J2EE Engine. This element is critical for execution of the deploymanager script file.
An element that appears only once in the XML file.
Used in: deployable-object.
-->
<!ELEMENT j2ee-module (archive-path, altdd*)>

 

<!--
The archive-path element specifies the file path to the J2EE module used for deployment. The file path can be full or relative path. If the project-dir element is not specified, use the full file path. This element is obligatory and critical for the execution of the deploymanager script file.
An element that appears only once in the XML file.
Used in: j2ee-module.
-->
<!ELEMENT archive-path (#PCDATA)>

 

<!--
The container attribute specifies the type of container to be used for the deployed J2EE application module.
Used in: j2ee-module
-->
<!ATTLIST j2ee-module container (appclient|connector|EJB_Container|servlet_jsp) #REQUIRED>

 

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

 

<!--
The altdd element specifies an alternative deployment descriptor of an element.
An element that can appear more than once in the element.
Used in: element
-->
<!ELEMENT altdd (pathname, entry-name)>

 

<!--
The 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 entry-name for the altdd element.
Used in: altdd
-->
<!ATTLIST altdd use-alternative (yes|no) #REQUIRED>

 

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

 

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

 

<!--
The login-info element sets the information required to accomplish the connection to the server and the lookup of the server’s deploy services. This element is critical for deployment procedure.
An element that appears only once in the deploy-manager-config element.
Used in: deploy-manager-config.
-->
<!ELEMENT login-info (host, port, transport-protocol*, user-name, user-password)>

 

<!--
The host element specifies the dispatcher host name to connect to the SAP J2EE Engine.
An element that appears only once in the login-info element.
Used in: login-info.
-->
<!ELEMENT host (#PCDATA)>

 

<!--
The port element specifies the port for connection to the SAP J2EE Engine.
An element that appears only once in the login-info element.
Used in: login-info.
-->
<!ELEMENT port (#PCDATA)>

 

<!--
The transport-protocol element specifies the protocol name by which the connection is realized.
Deploymanager uses SSL and Http Tunneling protocols. If you set SSL, make sure that the SSL service already is running on the SAP J2EE Engine. Possible values are SSL and httptunneling.
An element that appears only once in the login-info element.
Used in: login-info.
-->
<!ELEMENT transport-protocol (#PCDATA)>

 

<!—

The user-name element specifies the name of a registered user that has administrator rights.

An element that appears only once in the login-info element.

Used in: login-info.

-->

<!ELEMENT user-name (#PCDATA)>

 

<!--
The user-password specifies the password of a registered user. This element appears only once in the login-info element.

psw-file is the name of the file with the encrypted password. If you specify more than one element, the first element will be taken. If you specify zero elements, the password will be an empty String.

The user-password can contain PCDATA for backward compatibility.

Used in: login-info.

-->

<!ELEMENT user-password (#PCDATA|psw-file)>

 

<!—

The psw-file specifies the full path to the file with an encrypted password inside. This file is generated by the Deploy Tool GUI.

-->

<!ELEMENT psw-file (#PCDATA)>

 

<!--
The user-role-mapping element describes a list of security roles.
An element that appears only once in the XML file.
Used in: deploy-manager-config.
-->
<!ELEMENT user-role-mapping (role-name+)>

 

<!--
The role-name element defines the role name that is stored in the deployment descriptor’s XML, to be mapped to the real users.
An element that can appear more than once in the user-role-mapping element.
Used in: user-role-mapping.
-->
<!ELEMENT role-name (#PCDATA | mapping)*>

 

<!--
The mapping element defines mappings to users or groups (or both), defined in the server User Management System.
An element that can appears more than once in the user-role-mapping.
Used in: user-role-mapping.
-->
<!ELEMENT mapping (name, type)>

 

<!--
The name element specifies the name of a user or group.
An element that appears only once in the mapping element.
Used in: mapping.
-->
<!ELEMENT name (#PCDATA)>

 

<!--
The type element defines the type of the security user. Possible values are user or group.
An element that appears only once in the mapping element.
Used in: mapping.
-->
<!ELEMENT type (#PCDATA)>

 

<!--
The server-components-xml specifies the usage of server_component_management.xml file. It is used as an alternative way of deploying services, interfaces and libraries.
An element that is not obligatory and that can appear only once in the deploy-manager-config element.
Used in: deploy-manager-config
-->
<!ELEMENT server-components-xml (#PCDATA)>

 

<!--
The library-info specifies the information about the deployment of a library.
Used in: deploy-manager-config
-->
<!ELEMENT library-info (library*, reference*)>

 

<!--
The library element specifies the name and archive file for a library.
Used in: library-info
-->
<!ELEMENT library (lib-name, lib-jar+)>

 

<!--
The lib-name element specifies the display name of a library.
It is an obligatory element for the library element.
Used in: lib-name
-->
<!ELEMENT lib-name (#PCDATA)>

 

<!--
The lib-jar element specifies a file path to the archive file of a library.
It is an obligatory element for the library element.
Used in: library
-->
<!ELEMENT lib-jar (#PCDATA)>

 

<!--
The reference element supplements a reference from an application, library or service to another application, library or service. This element is not obligatory. For example, use this element if you deploy an application that uses a library, but this library uses another library, service or application.
An element that can appear more than once in the library-info element.
Used in: library-info.
-->
<!ELEMENT reference (from-loader, to-loader+)>

 

<!--
The from-loader element specifies the library, application or service that uses the reference. The possible values are: application: <application_name>, library: <library_name>, service: <service_name>.
This element is obligatory for the reference element.
An element that appears only once in a reference element.
Used in: reference.
-->
<!ELEMENT from-loader (#PCDATA)>

 

<!--
The to-loader element specifies the library, application or service that is used by the reference. The possible values are: application: <application_name>, library: <library_name>, service: <service_name>.
This element is obligatory for the reference element.
An element that can appear more than once in the reference element.
Used in: reference.
-->
<!ELEMENT to-loader (#PCDATA)>

 

<!--
The support element specifies a list of remote support types to be generated.
An element that appears only once in the XML file.
Used in: deploy-manager-config.

-->
<!ELEMENT supports (support+)>

 

<!--
The support element specifies the support type.
The available support is p4. If no support is set, the application will be deployed with p4 support. There is an RMI/IIOP support for deployment of EJBs, but in order to use this functionality you must make sure that the IIOP service is running on both the dispatcher and server nodes.
An element that can appear more than once in the XML file.
Used in: supports.
-->
<!ELEMENT support (#PCDATA)>

 

<!--
The repl-var-properties element is important for SDM. It specifies the replaceable variables of the application. If your project contains such types of variables and you do not specify them, the application will not be deployed.
-->
<!ELEMENT repl-var-properties (property*)>

 

<!--
The deployment-properties element specifies the properties, such as J2EE™ specification, root lookup, container type.
Used in: deploy-manager-config.
-->
<!ELEMENT deployment-properties (property*)>

 

<!--
The property element must be specified as “key=value.” Use one of the following: container_type = B or container_type = A; root_lookup = false or root_lookup = true; specification = J2EE_1_2 or specification = J2EE_1_3;
Used in: deployment-properties.
-->
<!ELEMENT property (#PCDATA)>

 

<!--
The log-file element specifies the file in which all log messages are to be stored.
Used in: deploy-manager-config.
-->
<!ELEMENT log-file (#PCDATA)>

Example

For an example of deploy-manager-config.dtd, see deploy-manager-config.xml.