Defining the Client Deployment Descriptor

Target Audience and Content

The target audience for this guide is the Client component provider, i.e. the person in charge of developing the Client components on the client side. It describes how the Client component provider should build the deployment descriptors of its Client components.

The content of this guide is the following:

  1. Target Audience and Content
  2. Principles
  3. Examples of Client Deployment Descriptors
  4. Tips

Principles

The Client component programmer is responsible for providing the deployment descriptor associated with the developed client components.

The client component provider's responsibilities and the Application Assembler's responsibilities are to provide an XML deployment descriptor that conforms to the deployment descriptor's XML DTD as defined in the Java TM Application Client Specification Version 1.3. (Refer to $JONAS_ROOT/xml/application-client_1_3.dtd).

To customize the Client components, information not defined in the standard XML deployment descriptor may be needed. Such information might include, for example, the mapping of the name of referenced resources to its JNDI name. This information can be specified during the deployment phase within another XML deployment descriptor that is specific to JOnAS. The JOnAS-specific deployment descriptor's XML DTD is located in $JONAS_ROOT/xml/jonas-client_X_Y.dtd. The file name of the JOnAS-specific XML deployment descriptor must be 'jonas-client.xml'.

JOnAS interprets the <!DOCTYPE> tag at the parsing of the deployment descriptor XML files.
The parser first tries to get the specified DTD via the classpath, then it uses the specified URL (or path).

In the following two examples, the parser gets the jonas-client_3_2.dtd DTD file via the URL or in the /usr/local/jonas/xml/ directory.

    <!DOCTYPE application-client PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application Client 1.3//EN" "http://java.sun.com/dtd/application-client_1_3.dtd">
    <!DOCTYPE application-client SYSTEM "/usr/local/jonas/xml/application-client_1_3.dtd">

    

The standard deployment descriptor (application-client.xml) should contain structural information that includes the following:

The JOnAS-specific deployment descriptor (jonas-client.xml) may contain information that includes the following::

Examples of Client Deployment Descriptors

Tips

Although some characters, such as ">", are legal, it is good practice to replace them with XML entity references.

The following is a list of the predefined entity references for XML:

&lt; < less than
&gt; > greater than
&amp; & ampersand
&apos; ' apostrophe
&quot; " quotation mark