XML DTD - application-client_1_3.dtd
Schema has:
 25 element definitions and 50 element attribute definitions.
Possible root elements: < application-client >

Element list

Element application-client
diagram element image
attributes id 
uses icon  display-name  description  env-entry  ejb-ref  resource-ref  resource-env-ref  callback-handler 
content a sequence of elements
occurrence required (default)
Attribute Datatype Required Values Default Comments
id ID no (default)     The ID mechanism is to allow tools that produce additional deployment information (i.e., information beyond the standard deployment descriptor information) to store the non-standard information in a separate file, and easily refer from these tool-specific files to the information in the standard deployment descriptor. Tools are not allowed to add the non-standard information into the standard deployment descriptor.  

Element callback-handler
diagram element image
description The callback-handler element names a class provided by the application. The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface. The class will be instantiated by the application client container and used by the container to collect authentication information from the user.

Used in: application-client

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element description
diagram element image
description The description element is used to provide text describing the parent element. The description element should include any information that the application client jar file producer wants to provide to the consumer of the application client jar file (i.e., to the Deployer). Typically, the tools used by the application client jar file consumer will display the description when processing the parent element that contains the description.

Used in: application-client, ejb-ref, env-entry, resource-env-ref, resource-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element display-name
diagram element image
description The display-name element contains a short name that is intended to be displayed by tools. The display name need not be unique.

Used in: application-client

Example:
<display-name>Employee Self Service</display-name>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element ejb-link
diagram element image
description The ejb-link element is used in the ejb-ref element to specify that an EJB reference is linked to an enterprise bean. The name in the ejb-link element is composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by "#". The path name is relative to the jar file containing the application client that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Used in: ejb-ref Examples: <ejb-link>EmployeeRecord</ejb-link> <ejb-link>../products/product.jar#ProductEJB</ejb-link>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element ejb-ref
diagram element image
description The ejb-ref element is used for the declaration of a reference to an enterprise bean's home. The declaration consists of: - an optional description - the EJB reference name used in the code of the application client that's referencing the enterprise bean - the expected type of the referenced enterprise bean - the expected home and remote interfaces of the referenced enterprise bean - optional ejb-link information, used to specify the referenced enterprise bean

Used in: application-client

attributes id 
uses description  ejb-ref-name  ejb-ref-type  home  remote  ejb-link 
content a sequence of elements
occurrence required (default)
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element ejb-ref-name
diagram element image
description The ejb-ref-name element contains the name of an EJB reference. The EJB reference is an entry in the application client's environment and is relative to the java:comp/env context. The name must be unique within the application client. It is recommended that name is prefixed with "ejb/".

Used in: ejb-ref

Example:
<ejb-ref-name>ejb/Payroll</ejb-ref-name>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element ejb-ref-type
diagram element image
description The ejb-ref-type element contains the expected type of the referenced enterprise bean. The ejb-ref-type element must be one of the following: <ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

Used in: ejb-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element env-entry
diagram element image
description The env-entry element contains the declaration of an application client's environment entry. The declaration consists of an optional description, the name of the environment entry, and an optional value. If a value is not specified, one must be supplied during deployment.

Used in: application-client

attributes id 
uses description  env-entry-name  env-entry-type  env-entry-value 
content a sequence of elements
occurrence required (default)
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element env-entry-name
diagram element image
description The env-entry-name element contains the name of an application client's environment entry. The name is a JNDI name relative to the java:comp/env context. The name must be unique within an application client.

Used in: env-entry

Example:
<env-entry-name>minAmount</env-entry-name>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element env-entry-type
diagram element image
description The env-entry-type element contains the fully-qualified Java type of the environment entry value that is expected by the application client's code. The following are the legal values of env-entry-type: java.lang.Boolean java.lang.Byte java.lang.Character java.lang.String java.lang.Short java.lang.Integer java.lang.Long java.lang.Float java.lang.Double

Used in: env-entry

Example:
<env-entry-type>java.lang.Boolean</env-entry-type>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element env-entry-value
diagram element image
description The env-entry-value element contains the value of an application client's environment entry. The value must be a String that is valid for the constructor of the specified type that takes a single String parameter, or for java.lang.Character, a single character.

Used in: env-entry

Example:
<env-entry-value>100.00</env-entry-value>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element home
diagram element image
description The home element contains the fully-qualified name of the enterprise bean's home interface.

Used in: ejb-ref

Example:
<home>com.aardvark.payroll.PayrollHome</home>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element icon
diagram element image
description The icon element contains small-icon and large-icon elements that specify the file names for small and a large GIF or JPEG icon images used to represent the parent element in a GUI tool.

Used in: application-client

attributes id 
uses small-icon  large-icon 
content a sequence of elements
occurrence required (default)
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element large-icon
diagram element image
description The large-icon element contains the name of a file containing a large (32 x 32) icon image. The file name is a relative path within the application client's jar file. The image may be either in the JPEG or GIF format. The icon can be used by tools.

Used in: icon

Example:
<large-icon>employee-service-icon32x32.jpg</large-icon>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element remote
diagram element image
description The remote element contains the fully-qualified name of the enterprise bean's remote interface.

Used in: ejb-ref

Example:
<remote>com.wombat.empl.EmployeeService</remote>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element res-auth
diagram element image
description The res-auth element specifies whether the application client code signs on programmatically to the resource manager, or whether the Container will sign on to the resource manager on behalf of the application client. In the latter case, the Container uses information that is supplied by the Deployer. The value of this element must be one of the two following: <res-auth>Application</res-auth> <res-auth>Container</res-auth>

Used in: resource-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element res-ref-name
diagram element image
description The res-ref-name element specifies the name of a resource manager connection factory reference. The name is a JNDI name relative to the java:comp/env context. The name must be unique within an application client.

Used in: resource-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element res-sharing-scope
diagram element image
description The res-sharing-scope element specifies whether connections obtained through the given resource manager connection factory reference can be shared. The value of this element, if specified, must be one of the two following: <res-sharing-scope>Shareable</res-sharing-scope> <res-sharing-scope>Unshareable</res-sharing-scope> The default value is Shareable.

Used in: resource-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element res-type
diagram element image
description The res-type element specifies the type of the data source. The type is specified by the fully qualified Java language class or interface expected to be implemented by the data source.

Used in: resource-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element resource-env-ref
diagram element image
description The resource-env-ref element contains a declaration of an application client's reference to an administered object associated with a resource in the application client's environment. It consists of an optional description, the resource environment reference name, and an indication of the resource environment reference type expected by the application client code.

Used in: application-client

Example:
<resource-env-ref> <resource-env-ref-name>jms/StockQueue</resource-env-ref-name> <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type> </resource-env-ref>

attributes id 
uses description  resource-env-ref-name  resource-env-ref-type 
content a sequence of elements
occurrence required (default)
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element resource-env-ref-name
diagram element image
description The resource-env-ref-name element specifies the name of a resource environment reference; its value is the environment entry name used in the application client code. The name is a JNDI name relative to the java:comp/env context and must be unique within an application client.

Used in: resource-env-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element resource-env-ref-type
diagram element image
description The resource-env-ref-type element specifies the type of a resource environment reference. It is the fully qualified name of a Java language class or interface.

Used in: resource-env-ref

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element resource-ref
diagram element image
description The resource-ref element contains a declaration of an application client's reference to an external resource. It consists of an optional description, the resource manager connection factory reference name, the indication of the resource manager connection factory type expected by the application client code, the type of authentication (Application or Container), and an optional specification of the shareability of connections obtained from the resource (Shareable or Unshareable).

Used in: application-client

Example:
<resource-ref> <res-ref-name>jdbc/EmployeeAppDB</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref>

attributes id 
uses description  res-ref-name  res-type  res-auth  res-sharing-scope 
content a sequence of elements
occurrence required (default)
Attribute Datatype Required Values Default Comments
id ID no (default)      

Element small-icon
diagram element image
description The small-icon element contains the name of a file containing a small (16 x 16) icon image. The file name is a relative path within the application client's jar file. The image may be either in the JPEG or GIF format. The icon can be used by tools.

Used in: icon

Example:
<small-icon>employee-service-icon16x16.jpg</small-icon>

attributes id 
uses
content character data
occurrence
Attribute Datatype Required Values Default Comments
id ID no (default)