Show TOC

appclient-j2ee-engine.dtdLocate this document in the navigation structure

Definition

A document type definition (DTD) used for creating XML documents in order to customize an application client at deploy time.

Use

This XML is not required for the proper deployment of the application client. You can use it to specify the resources that the application client accesses.

Structure

The appclient-j2ee-engine.dtd has the following structure:

The use of each tag is explained in detail as follows:

<!--

Appclient-j2ee-engine is the root element for this deployment descriptor. It contains declarations of resource references, resource environment references, enterprise bean references, and server component references.

-->

->

<!ELEMENT appclient-j2ee-engine (resource-ref*, resource-env-ref*,ejb-ref*,server-component-ref*)>

<!--

Resource-ref element contains information about a reference to a resource that the application client uses. This information enables the client to look up the resource reference and therefore access the necessary resource associated to the reference.

Used in: appclient-j2ee-engine

Example:

<resource-ref>

<res-ref-name>

myResReference

</res-ref-name>

<res-link>

myDataSource

</res-link>

</resource-ref>

-->

<!ELEMENT resource-ref (res-ref-name, res-link)>

<!--

Res-ref-name element defines the name of the resource reference. The client looks up the reference by its name.

Used in: resource-ref

-->

<!ELEMENT res-ref-name (#PCDATA)>

<!--

Res-link element specifies the JNDI name of the resource that is linked to the resource reference. 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. 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)>

<!--

Resource-env-ref encapsulates information about the references from the application client to administered objects - for example, JMS Destination or ConnectionFactory objects.

Used in: appclient-j2ee-engine

Example:

<resource-env-ref>

<resource-env-ref-name>

myResEnvReference

</resource-env-ref-name>

<jndi-name>

myJMSDestination

</jndi-name>

</resource-env-ref>

-->

<!ELEMENT resource-env-ref (resource-env-ref-name, jndi-name)>

<!--

Resource-env-ref-name element defines the name of the resource environment reference entry.

Used in: resource-env-ref

sed in: resource-env-ref

-->

<!ELEMENT resource-env-ref-name (#PCDATA)>

<!--

Jndi-name element specifies the JNDI name of a referenced resource. Depending on the DTD element this tag is used in, it can have different possible values. If 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 specified in the <destination-name> tag of the jms-destinations.xml descriptor.
  • ejb-ref element, 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 name used to bind the corresponding server component in the JNDI tree.

Used in: resource-env-ref, ejb-ref, server-component-ref

-->

<!ELEMENT jndi-name (#PCDATA)>

<!--

Ejb-ref element contains information about an EJB that is referenced by the application client. This information is used for lookup operations.

Used in: appclient-j2ee-engine

Example:

<ejb-ref>

<ejb-ref-name>

myEJBReference

</ejb-ref-name>

<jndi-name>

mySessionBean

</jndi-name>

</ejb-ref>

-->

<!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>

<!--

Ejb-ref-name element specifies the name of the EJB reference.

Used in: ejb-ref

-->

<!ELEMENT ejb-ref-name (#PCDATA)>

<!--

Server-component-ref element contains information about the server component referenced by the application client.

Used in: appclient-j2ee-engine

Example:

<server-component-ref>

<name>

myInterface

</name>

<type>

interface

</type>

<jndi-name>

myInterface

</jndi-name>

</server-component-ref >

-->

<!ELEMENT server-component-ref (name, type, jndi-name, description?)>

<!--

Name element specifies the name of the referenced server component.

Used in: server-component-ref

-->

<!ELEMENT name (#PCDATA)>

<!--

Type element specifies the type of the referenced server component. The values of this tag can be:

  • Service
  • Interface

Used in: server-component-ref

-->

<!ELEMENT type (#PCDATA)>

<!--

Description element provides descriptive text about the server component that is referenced. This element is optional.

Used in: server-component-ref

-->

<!ELEMENT description (#PCDATA)>