application-client_1_3.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES
Copyright 2000-2001 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, CA 94303, U.S.A. All rights reserved.
This product or document is protected by copyright and distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this product or documentation may be reproduced in any form by any means without prior written authorization of Sun and its licensors, if any.
Third party software, including font technology, is copyrighted and licensed from Sun suppliers.
Sun, Sun Microsystems, the Sun Logo, Solaris, Java, JavaServer Pages, Java Naming and Directory Interface, JDBC, JDK, JavaMail and Enterprise JavaBeans, are trademarks or registered trademarks of Sun Microsystems, Inc in the U.S. and other countries.
All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.
PostScript is a registered trademark of Adobe Systems, Inc.
Federal Acquisitions: Commercial Software - Government Users Subject to Standard License Terms and Conditions.
DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
_________________________________________________________________________
Copyright 2000-2001 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303, Etats-Unis. Tous droits re'serve's.
Ce produit ou document est prote'ge' par un copyright et distribue' avec des licences qui en restreignent l'utilisation, la copie, la distribution, et la de'compilation. Aucune partie de ce produit ou de sa documentation associe'e ne peut e^tre reproduite sous aucune forme, par quelque moyen que ce soit, sans l'autorisation pre'alable et e'crite de Sun et de ses bailleurs de licence, s'il y en a.
Le logiciel de'tenu par des tiers, et qui comprend la technologie relative aux polices de caracte`res, est prote'ge' par un copyright et licencie' par des fournisseurs de Sun.
Sun, Sun Microsystems, le logo Sun, Solaris, Java, JavaServer Pages, Java Naming and Directory Interface, JDBC, JDK, JavaMail, et Enterprise JavaBeans, sont des marques de fabrique ou des marques de'pose'es de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays.
Toutes les marques SPARC sont utilise'es sous licence et sont des marques de fabrique ou des marques de'pose'es de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont base's sur une architecture de'veloppe'e par Sun Microsystems, Inc.
Postcript est une marque enregistre'e d'Adobe Systems Inc.
LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON.
| <application-client> | Root element |
The application-client element is the root element of an application client deployment descriptor. The application client deployment descriptor describes the EJB components and external resources referenced by the application client.
Element's model:
<application-client>'s children Name Cardinality callback-handler One or none description One or none display-name Only one ejb-ref Any number env-entry Any number icon One or none resource-env-ref Any number resource-ref Any number
<application-client>'s attributes Name Values Default id Match the ID rules.
(icon?, display-name, description?, env-entry*, ejb-ref*, resource-ref*, resource-env-ref*, callback-handler?)
| <callback-handler> | Child of application-client |
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
<callback-handler>'s attributes Name Values Default id Match the ID rules.
| <description> | Child of ejb-ref, application-client, env-entry, resource-ref, resource-env-ref |
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
<description>'s attributes Name Values Default id Match the ID rules.
| <display-name> | Child of application-client |
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>
<display-name>'s attributes Name Values Default id Match the ID rules.
| <ejb-link> | Child of ejb-ref |
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>
<ejb-link>'s attributes Name Values Default id Match the ID rules.
| <ejb-ref> | Child of application-client |
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
Element's model:
<ejb-ref>'s children Name Cardinality description One or none ejb-link One or none ejb-ref-name Only one ejb-ref-type Only one home Only one remote Only one
<ejb-ref>'s attributes Name Values Default id Match the ID rules.
(description?, ejb-ref-name, ejb-ref-type, home, remote, ejb-link?)
| <ejb-ref-name> | Child of ejb-ref |
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>
<ejb-ref-name>'s attributes Name Values Default id Match the ID rules.
| <ejb-ref-type> | Child of ejb-ref |
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
<ejb-ref-type>'s attributes Name Values Default id Match the ID rules.
| <env-entry> | Child of application-client |
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
Element's model:
<env-entry>'s children Name Cardinality description One or none env-entry-name Only one env-entry-type Only one env-entry-value One or none
<env-entry>'s attributes Name Values Default id Match the ID rules.
(description?, env-entry-name, env-entry-type, env-entry-value?)
| <env-entry-name> | Child of env-entry |
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>
<env-entry-name>'s attributes Name Values Default id Match the ID rules.
| <env-entry-type> | Child of env-entry |
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>
<env-entry-type>'s attributes Name Values Default id Match the ID rules.
| <env-entry-value> | Child of env-entry |
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>
<env-entry-value>'s attributes Name Values Default id Match the ID rules.
| <home> | Child of ejb-ref |
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>
<home>'s attributes Name Values Default id Match the ID rules.
| <icon> | Child of application-client |
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
Element's model:
<icon>'s children Name Cardinality large-icon One or none small-icon One or none
<icon>'s attributes Name Values Default id Match the ID rules.
(small-icon?, large-icon?)
| <large-icon> | Child of icon |
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>
<large-icon>'s attributes Name Values Default id Match the ID rules.
| <remote> | Child of ejb-ref |
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>
<remote>'s attributes Name Values Default id Match the ID rules.
| <res-auth> | Child of resource-ref |
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
<res-auth>'s attributes Name Values Default id Match the ID rules.
| <res-ref-name> | Child of resource-ref |
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
<res-ref-name>'s attributes Name Values Default id Match the ID rules.
| <res-sharing-scope> | Child of resource-ref |
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
<res-sharing-scope>'s attributes Name Values Default id Match the ID rules.
| <res-type> | Child of resource-ref |
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
<res-type>'s attributes Name Values Default id Match the ID rules.
| <resource-env-ref> | Child of application-client |
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>
Element's model:
<resource-env-ref>'s children Name Cardinality description One or none resource-env-ref-name Only one resource-env-ref-type Only one
<resource-env-ref>'s attributes Name Values Default id Match the ID rules.
(description?, resource-env-ref-name, resource-env-ref-type)
| <resource-env-ref-name> | Child of resource-env-ref |
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
<resource-env-ref-name>'s attributes Name Values Default id Match the ID rules.
| <resource-env-ref-type> | Child of resource-env-ref |
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
<resource-env-ref-type>'s attributes Name Values Default id Match the ID rules.
| <resource-ref> | Child of application-client |
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>
Element's model:
<resource-ref>'s children Name Cardinality description One or none res-auth Only one res-ref-name Only one res-sharing-scope One or none res-type Only one
<resource-ref>'s attributes Name Values Default id Match the ID rules.
(description?, res-ref-name, res-type, res-auth, res-sharing-scope?)
| <small-icon> | Child of icon |
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>
<small-icon>'s attributes Name Values Default id Match the ID rules.
| @id | Attribute of application-client |
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.
Possible values: Match the ID rules.
| @id | Attribute of callback-handler |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of description |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of display-name |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of ejb-link |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of ejb-ref |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of ejb-ref-name |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of ejb-ref-type |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of env-entry |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of env-entry-name |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of env-entry-type |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of env-entry-value |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of home |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of icon |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of large-icon |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of remote |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of res-auth |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of res-ref-name |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of res-sharing-scope |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of res-type |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of resource-env-ref |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of resource-env-ref-name |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of resource-env-ref-type |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of resource-ref |
Element identifier.
Possible values: Match the ID rules.
| @id | Attribute of small-icon |
Element identifier.
Possible values: Match the ID rules.