web-j2ee-engine.dtd 
Definition
A document type definition (DTD) used for producing XML files for Web Deployment Descriptor objects creation.
Use
Use the XML file based on this DTD to create or configure the web deployment descriptor settings.
Structure
The web-j2ee-engine.dtd defines the following elements:
The usage of each element is explained in detail as follows:
<!--
web-j2ee-engine is the root element for this deployment descriptor. It
contains information about the deployed web applications.
-->
<!ELEMENT web-j2ee-engine (resource-ref*, resource-env-ref*, ejb-ref*, ejb-local-ref*, server-component-ref*, security-role-map*, response-status*, fail-over-alert?, login-module-configuration?, url-session-tracking?, security-policy-domain?, max-sessions?, cookie-config?)>
<!--
The resource-ref element contains additional reference’s settings for
external resources used within the web application.
Used in: web-j2ee-engine
-->
<!ELEMENT resource-ref (res-ref-name, res-link?, non-transactional?)>
<!--
The res-ref-name element identifies the name of the defined resource
reference. It is the same specified in web.xml.
Used in: resource-ref
-->
<!ELEMENT res-ref-name (#PCDATA)>
<!--
The res-link element specifies the JNDI name of the resource. the value of
this tag depends on the type of the referenced resource:
· For resources of type javax.sql.DataSource it is either the value of the <data-source-name>, or the value of the <alias> tag you specified in the data-sources.xml descriptor. Or if you have used the data-source-aliases.xml instead, the value of this tag must be the same as the value of the <alias> tag for the corresponding DataSource.
· For resources of type javax.jms.QueueConnectionFactory and javax.jms.TopicConnectionFactory it is either the value of the <factory-name>, or the value of the <alias> tag you specified in the jms-factories.xml descriptor.
· For resources of type javax.resource.cci.ConnectionFactory it is either the value of the <jndi-name> tag, or the value of the <alias> tag you specified in the connector-j2ee-engine.xml descriptor. Or if you have not used the connector-j2ee-engine.xml descriptor at all (since it is not mandatory), the value of this tag is equivalent to the name of the corresponding RAR file (not including the .rar file extension).
Used in: resource-ref
-->
<!ELEMENT res-link (#PCDATA)>
<!--
The non-transactional element specifies if the resource reference is
transactional. By default, all references are transactional.
Used in: resource-ref
-->
<!ELEMENT non-transactional EMPTY>
<!--
The resource-env-ref element contains a web application’s reference to
an object in the web application’s environment.
Used in: web-j2ee-engine
-->
<!ELEMENT resource-env-ref (resource-env-ref-name, jndi-name)>
<!--
The resource-env-ref-name element identifies the name of the reference to the
web application’s environment resource specified in the web.xml of this
application.
Used in: resource-env-ref
-->
<!ELEMENT resource-env-ref-name (#PCDATA)>
<!--
The jndi-name element specifies the JNDI name of a referenced resource.
Depending on the DTD element where this tag is used, it can have different
possible values. If it is used in:
· resource-env-ref element, then the value of this tag must be the same as the name of the resource environment entry that you have specified in the <destination-name> tag of the jms-destinations.xml descriptor.
· ejb-ref or ejb-local-ref elements, then:
¡ if you have specified a custom JNDI name for your enterprise bean using the <jndi-name> tag of the ejb-j2ee-engine.xml descriptor, the value of this tag must be the same.
¡ if you have not specified a custom JNDI name for your enterprise bean, then the JNDI name of the bean has the following format: <provider name>/<application name>/<enterprise bean name>.
· server-component-ref element, then the value of this tag must be the corresponding server the component is bound to the JNDI tree.
Used in: resource-env-ref, ejb-ref, ejb-local-ref, server-component-ref
-->
<!ELEMENT jndi-name (#PCDATA)>
<!--
The ejb-ref element contains a reference to an enterprise bean in the web
application.
Used in: web-j2ee-engine
-->
<!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>
<!--
The ejb-ref-name element identifies the name of the enterprise bean reference
specified in the web.xml of the particular application.
Used in: ejb-ref
<!ELEMENT ejb-ref-name (#PCDATA)>
<!--
The ejb-local-ref element contains a reference to enterprise bean’s
local home.
Used in: web-j2ee-engine
<!ELEMENT ejb-local-ref (ejb-ref-name, jndi-name)>
<!--
The server-component-ref element contains a reference to a specific server
component.
Used in: web-j2ee-engine
<!ELEMENT server-component-ref (name, type, jndi-name, description?)>
<!--
The name element specifies the name of a component in the web application.
Used in: server-component-ref, option
<!ELEMENT name (#PCDATA)>
<!--
The type element specifies the server component type. It can be Service or
Interface.
Used in: server-component-ref
<!ELEMENT type (#PCDATA)>
<!--
The security-role-map element contains the web application’s security
roles that are mapped to J2EE Engine security roles.
Used in: web-j2ee-engine
<!ELEMENT security-role-map (role-name, ((user-name*, group-name*) | server-role-name))>
<!--
The role-name element specifies the name of the security role.
Used in: security-role-map
<!ELEMENT role-name (#PCDATA)>
<!--
The user-name element specifies the name of the user existing on the server,
to which the security role is mapped.
This tag is deprecated. Do not use it any more.
Used in: security-role-map
<!ELEMENT user-name (#PCDATA)>
<!--
The group-name element specifies the name of a group of users existing on the
server, that are mapped to a specific security role.
This tag is deprecated. Do not use it any more.
Used in: security-role-map
<!ELEMENT group-name (#PCDATA)>
<!--
The server-role-name element specifies the name of the server roles that are
mapped to specific web application’s security roles. This option is
available when you are working offline and online. The server roles are:
administrators, guests, and all.
Used in: security-role-map
Example: <server-role-name> guests </server-role-name>
<!ELEMENT server-role-name (#PCDATA)>
<!--
The response-status element defines codes for http responses.
Used in: web-j2ee-engine
<!ELEMENT response-status (code, description)>
<!--
The code element specifies the codes’ values of http responses. The
value must be an Integer between 100 (exclusive) and 999 (inclusive) as the
following code values are not permitted: 200, 201, 202, 203, 204, 205, 206,
300, 301, 302, 303, 304, 305, 306, 307, 400, 401, 402, 403, 404, 405, 406,
407, 408, 409, 410, 411, 412, 413, 414, 415, 500, 501, 502, 503, 504, 505.
Used in: response-status
<!ELEMENT code (#PCDATA)>
<!--
The description element specifies the short text for each response
code.
Used in: response-status
<!ELEMENT description (#PCDATA)>
<!--
The fail-over-alert element defines an alert message warning you that the
server node, on which the user session is running will be shut
down.
Used in: web-j2ee-engine
Example:
<fail-over-alert>
<message>
Warning! This server node will be shut down.
</message>
<message-timeout>
15
</message-timeout>
</fail-over-alert>
<!ELEMENT fail-over-alert (message?, message-timeout?)>
<!--
The message element specifies the text of alert message warning you that the
server node will be shut down.
Used in: fail-over-alert
<!ELEMENT message (#PCDATA)>
<!--
The message-timeout element specifies the timeout (in minutes) after which the
server node will be shut down. The displayed alert message warns you about the
specified timeout period.
Used in: fail-over-alert
<!ELEMENT message-timeout (#PCDATA)>
<!--
The login-module-configuration element defines login modules and password
changing settings for a particular web application.
Used in: web-j2ee-engine
<!ELEMENT login-module-configuration (login-module-stack?, password-change-config?)>
<!--
The login-module-stack element contains login modules within a web
application.
Used in: login-module-configuration
<!ELEMENT login-module-stack (login-module+)>
<!--
The login-module element contains a particular login module’s settings.
It defines the authentication method and its priority.
Used in: login-module-stack
<!ELEMENT login-module (login-module-name, flag, options?)>
<!--
The login-module-name element specifies the name of the particular login
module.
Used in: login-module
Example:
<login-module-name>
com.sap.engine.services.userstore.jaas.BasicPasswordLoginModule
</login-module-name>
<!ELEMENT login-module-name (#PCDATA)>
<!--
The flag element specifies the priority of the authentication method in the
login module. The options are: optional, required, requisite, and
sufficient.
Used in: login-module
Example:
<flag> required </flag>
<!ELEMENT flag (#PCDATA)>
<!--
The options element contains specific features for the particular login
module.
Used in: login-module
<!ELEMENT options (option+)>
<!--
The option element defines specific login module option. Each option is in
key=value format.
Used in: options
Example:
<option>
<name>
debug
</name>
<value>
true
</value>
</option>
<!ELEMENT option (name, value)>
<!--
The value element specifies the value of the login module specific
option.
Used in: option
<!ELEMENT value (#PCDATA)>
<!--
The password-change-config element defines the login page and the error page
enabling you to change the login password for your web
application.
Used in: login-module-configuration
<!ELEMENT password-change-config (login-page?, error-page?)>
<!--
The login-page element specifies the login page that is displayed when the
login password for the user expires and you have to set a new
one.
Used in: password-change-config
<!ELEMENT login-page (#PCDATA)>
<!--
The error-page element specifies the error page, displayed when the login
fails.
Used in: password-change-config
<!ELEMENT error-page (#PCDATA)>
<!--
The url-session-tracking element specifies if the cookie will associate user
sessions by URL or by application. By default, the value is false; it
associates the sessions by URL.
Used in: web-j2ee-engine
<!ELEMENT url-session-tracking EMPTY>
<!--
The security-policy-domain element defines the security domain for your web
application.
Used in: web-j2ee-engine
<!ELEMENT security-policy-domain (#PCDATA)>
<!--
The max-sessions element specifies the maximum number of user sessions to an
application.
Used in: web-j2ee-engine
<!ELEMENT max-sessions (#PCDATA)>
<!--
The cookie-config element contains
description of session or application cookies.
Used in: web-j2ee-engine
<!ELEMENT cookie-config (cookie+)>
<!--
This element specifies the
attributes that the web container will use when creating session or
application cookies.
Used in: cookie-config
<!ELEMENT cookie (type, path?, domain?, max-age?)>
<!--
This element specifies
the type of the cookie. It must be SESSION or
APPLICATION.
Used in: cookie
<!ELEMENT type (#PCDATA)>
<!--
This element specifies the
path of the cookie. The possible values for this element are:
APPLICATION -
the web container will
set the path value to "/" + <alias-name> +
"/", NONE -
the web container will
not set a path attribute, or unspecified string - the web container will use
this string for path value. If this tag is missing the web container will set
"/" for path attribute
value. By default, it is
APPLICATION.
Used in: cookie
<!ELEMENT path (#PCDATA)>
<!--
This element specifies the
domain of the cookie. It can be SERVER - the web container will
set a domain value as the host name from the request, NONE - the web container will
not set a domain attribute, or unspecified string - the web container will use
this string for domain value. By default, it is SERVER.
Used in: cookie
<!ELEMENT domain (#PCDATA)>
<!--
This element specifies the
life time of the cookie, in seconds. By default, it is –1, that is, the life time
value is not set.
Used in: cookie
<!ELEMENT max-age (#PCDATA)>