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:
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::
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE application-client PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application Client 1.3//EN" "http://java.sun.com/dtd/application-client_1_3.dtd"> <application-client> <display-name>Client of the earsample</display-name> <description>client of the earsample</description> <env-entry> <env-entry-name>envEntryString</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>Test of envEntry of application-client.xml file</env-entry-value> </env-entry> <ejb-ref> <ejb-ref-name>ejb/Op</ejb-ref-name> <ejb-ref-type>Session</ejb-ref-type> <home>org.objectweb.earsample.beans.secusb.OpHome</home> <remote>org.objectweb.earsample.beans.secusb.Op</remote> <ejb-link>secusb.jar#EarOp</ejb-link> </ejb-ref> <resource-ref> <res-ref-name>url/jonas</res-ref-name> <res-type>java.net.URL</res-type> <res-auth>Container</res-auth> </resource-ref> <callback-handler>org.objectweb.jonas.security.auth.callback.LoginCallbackHandler</callback-handler> </application-client>
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE jonas-client PUBLIC "-//ObjectWeb//DTD JOnAS Client 3.2//EN" "http://www.objectweb.org/jonas/dtds/jonas-client_3_2.dtd"> <jonas-client> <jonas-resource> <res-ref-name>url/jonas</res-ref-name> <jndi-name>http://jonas.objectweb.org</jndi-name> </jonas-resource> <jonas-security> <jaasfile>jaas.config</jaasfile> <jaasentry>earsample</jaasentry> <username>jonas</username> <password>jonas</password> </jonas-security> </jonas-client>
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:
< | < | less than |
> | > | greater than |
& | & | ampersand |
' | ' | apostrophe |
" | " | quotation mark |