david_williams | e073de1 | 2007-04-28 04:01:44 +0000 | [diff] [blame] | 1 | <!-- |
| 2 | Copyright 1999 Sun Microsystems, Inc. 901 San Antonio Road, |
| 3 | Palo Alto, CA 94303, U.S.A. All rights reserved. |
| 4 | |
| 5 | This product or document is protected by copyright and distributed |
| 6 | under licenses restricting its use, copying, distribution, and |
| 7 | decompilation. No part of this product or documentation may be |
| 8 | reproduced in any form by any means without prior written authorization |
| 9 | of Sun and its licensors, if any. |
| 10 | |
| 11 | Third party software, including font technology, is copyrighted and |
| 12 | licensed from Sun suppliers. |
| 13 | |
| 14 | Sun, Sun Microsystems, the Sun Logo, Solaris, Java, JavaServer Pages, Java |
| 15 | Naming and Directory Interface, JDBC, JDK, JavaMail and Enterprise JavaBeans, |
| 16 | are trademarks or registered trademarks of Sun Microsystems, Inc in the U.S. |
| 17 | and other countries. |
| 18 | |
| 19 | All SPARC trademarks are used under license and are trademarks |
| 20 | or registered trademarks of SPARC International, Inc. |
| 21 | in the U.S. and other countries. Products bearing SPARC |
| 22 | trademarks are based upon an architecture developed by Sun Microsystems, Inc. |
| 23 | |
| 24 | PostScript is a registered trademark of Adobe Systems, Inc. |
| 25 | |
| 26 | |
| 27 | Federal Acquisitions: Commercial Software - Government Users Subject to |
| 28 | Standard License Terms and Conditions. |
| 29 | |
| 30 | |
| 31 | |
| 32 | DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED |
| 33 | CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY |
| 34 | IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
| 35 | PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT |
| 36 | TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY |
| 37 | INVALID. |
| 38 | |
| 39 | _________________________________________________________________________ |
| 40 | Copyright 1999 Sun Microsystems, Inc., |
| 41 | 901 San Antonio Road, Palo Alto, CA 94303, Etats-Unis. |
| 42 | Tous droits re'serve's. |
| 43 | |
| 44 | |
| 45 | Ce produit ou document est prote'ge' par un copyright et distribue' avec |
| 46 | des licences qui en restreignent l'utilisation, la copie, la distribution, |
| 47 | et la de'compilation. Aucune partie de ce produit ou de sa documentation |
| 48 | associe'e ne peut e^tre reproduite sous aucune forme, par quelque moyen |
| 49 | que ce soit, sans l'autorisation pre'alable et e'crite de Sun et de ses |
| 50 | bailleurs de licence, s'il y en a. |
| 51 | |
| 52 | Le logiciel de'tenu par des tiers, et qui comprend la technologie |
| 53 | relative aux polices de caracte`res, est prote'ge' par un copyright |
| 54 | et licencie' par des fournisseurs de Sun. |
| 55 | |
| 56 | Sun, Sun Microsystems, le logo Sun, Solaris, Java, JavaServer Pages, Java |
| 57 | Naming and Directory Interface, JDBC, JDK, JavaMail, et Enterprise JavaBeans, |
| 58 | sont des marques de fabrique ou des marques de'pose'es de Sun |
| 59 | Microsystems, Inc. aux Etats-Unis et dans d'autres pays. |
| 60 | |
| 61 | Toutes les marques SPARC sont utilise'es sous licence et sont |
| 62 | des marques de fabrique ou des marques de'pose'es de SPARC |
| 63 | International, Inc. aux Etats-Unis et dans |
| 64 | d'autres pays. Les produits portant les marques SPARC sont |
| 65 | base's sur une architecture de'veloppe'e par Sun Microsystems, Inc. |
| 66 | |
| 67 | Postcript est une marque enregistre'e d'Adobe Systems Inc. |
| 68 | |
| 69 | LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS, |
| 70 | DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES, |
| 71 | DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT |
| 72 | TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE |
| 73 | A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON. |
| 74 | --> |
| 75 | |
| 76 | <!-- |
| 77 | The application-client element is the root element of an application client |
| 78 | deployment descriptor. |
| 79 | The application client deployment descriptor describes the EJB components and |
| 80 | external resources referenced by the application client. |
| 81 | --> |
| 82 | <!ELEMENT application-client (icon?, display-name, description?, env-entry*, |
| 83 | ejb-ref*, resource-ref*)> |
| 84 | |
| 85 | <!-- |
| 86 | The description element is used to provide text describing the parent element. |
| 87 | The description element should include any information that the |
| 88 | application-client file producer wants to provide to the consumer of the |
| 89 | application-client file (i.e., to the Deployer). Typically, the tools used by |
| 90 | the application-client file consumer will display the description when |
| 91 | processing the parent element that contains the description. |
| 92 | --> |
| 93 | <!ELEMENT description (#PCDATA)> |
| 94 | |
| 95 | <!-- |
| 96 | The display-name element contains a short name that is intended to be displayed |
| 97 | by tools. |
| 98 | --> |
| 99 | <!ELEMENT display-name (#PCDATA)> |
| 100 | |
| 101 | <!-- |
| 102 | The ejb-link element is used in the ejb-ref element to specify that an EJB |
| 103 | reference is linked to an enterprise bean in the encompassing J2EE Application |
| 104 | package. The value of the ejb-link element must be the ejb-name of an enterprise |
| 105 | bean in the same J2EE Application package. Used in: ejb-ref |
| 106 | Example: <ejb-link>EmployeeRecord</ejb-link> |
| 107 | --> |
| 108 | <!ELEMENT ejb-link (#PCDATA)> |
| 109 | |
| 110 | <!-- |
| 111 | The ejb-ref element is used for the declaration of a reference to an enterprise |
| 112 | bean's home. The declaration consists of an optional description; the EJB |
| 113 | reference name used in the code of the referencing application client; the |
| 114 | expected type of the referenced enterprise bean; the expected home and remote |
| 115 | interfaces of the referenced enterprise bean; and an optional ejb-link |
| 116 | information. The optional ejb-link element is used to specify the referenced |
| 117 | enterprise bean. |
| 118 | --> |
| 119 | <!ELEMENT ejb-ref (description?, ejb-ref-name, ejb-ref-type, home, remote, |
| 120 | ejb-link?)> |
| 121 | |
| 122 | <!-- |
| 123 | The ejb-ref-name element contains the name of an EJB reference. The EJB |
| 124 | reference is an entry in the application client's environment. It is recommended |
| 125 | that name is prefixed with "ejb/". Used in: ejb-ref |
| 126 | Example: <ejb-ref-name>ejb/Payroll</ejb-ref-name> |
| 127 | --> |
| 128 | <!ELEMENT ejb-ref-name (#PCDATA)> |
| 129 | |
| 130 | <!-- |
| 131 | The ejb-ref-type element contains the expected type of the referenced enterprise |
| 132 | bean. The ejb-ref-type element must be one of the following: |
| 133 | <ejb-ref-type>Entity</ejb-ref-type> |
| 134 | <ejb-ref-type>Session</ejb-ref-type> |
| 135 | Used in: ejb-ref |
| 136 | --> |
| 137 | <!ELEMENT ejb-ref-type (#PCDATA)> |
| 138 | |
| 139 | <!-- |
| 140 | The env-entry element contains the declaration of an application client's |
| 141 | environment entries. The declaration consists of an optional description, the |
| 142 | name of the environment entry, and an optional value. |
| 143 | --> |
| 144 | <!ELEMENT env-entry (description?, env-entry-name, env-entry-type, |
| 145 | env-entry-value?)> |
| 146 | |
| 147 | <!-- |
| 148 | The env-entry-name element contains the name of an application client's |
| 149 | environment entry. Used in: env-entry |
| 150 | Example: <env-entry-name>EmployeeAppDB</env-entry-name> |
| 151 | --> |
| 152 | <!ELEMENT env-entry-name (#PCDATA)> |
| 153 | |
| 154 | <!-- |
| 155 | The env-entry-type element contains the fully-qualified Java type of the |
| 156 | environment entry value that is expected by the application client's code. The |
| 157 | following are the legal values of env-entry-type: java.lang.Boolean, |
| 158 | java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, |
| 159 | java.lang.Short, java.lang.Long, and java.lang.Float. |
| 160 | |
| 161 | Used in: env-entry |
| 162 | |
| 163 | Example: |
| 164 | <env-entry-type>java.lang.Boolean</env-entry-type> |
| 165 | --> |
| 166 | <!ELEMENT env-entry-type (#PCDATA)> |
| 167 | |
| 168 | <!-- |
| 169 | The env-entry-value element contains the value of an application client's |
| 170 | environment entry. The value must be a String that is valid for the constructor |
| 171 | of the specified type that takes a single String parameter. |
| 172 | |
| 173 | Used in: env-entry |
| 174 | |
| 175 | Example: |
| 176 | <env-entry-value>/datasources/MyDatabase</env-entry-value> |
| 177 | --> |
| 178 | <!ELEMENT env-entry-value (#PCDATA)> |
| 179 | |
| 180 | <!-- |
| 181 | The home element contains the fully-qualified name of the enterprise bean's home |
| 182 | interface. |
| 183 | Used in: ejb-ref |
| 184 | Example: <home>com.aardvark.payroll.PayrollHome</home> |
| 185 | --> |
| 186 | <!ELEMENT home (#PCDATA)> |
| 187 | |
| 188 | <!-- |
| 189 | The icon element contains a small-icon and large-icon element which specify the |
| 190 | URIs for a small and a large GIF or JPEG icon image used to represent the |
| 191 | application client in a GUI tool. |
| 192 | --> |
| 193 | <!ELEMENT icon (small-icon?, large-icon?)> |
| 194 | |
| 195 | <!-- |
| 196 | The large-icon element contains the name of a file containing a large (32 x 32) |
| 197 | icon image. The file name is a relative path within the application-client jar |
| 198 | file. The image must be either in the JPEG or GIF format, and the file name must |
| 199 | end with the suffix ".jpg" or ".gif" respectively. The icon can be used by |
| 200 | tools. |
| 201 | Example: |
| 202 | <large-icon>lib/images/employee-service-icon32x32.jpg</large-icon> |
| 203 | --> |
| 204 | <!ELEMENT large-icon (#PCDATA)> |
| 205 | |
| 206 | <!-- |
| 207 | The remote element contains the fully-qualified name of the enterprise bean's |
| 208 | remote interface. |
| 209 | Used in: ejb-ref |
| 210 | Example: |
| 211 | <remote>com.wombat.empl.EmployeeService</remote> |
| 212 | --> |
| 213 | <!ELEMENT remote (#PCDATA)> |
| 214 | |
| 215 | <!-- |
| 216 | The res-auth element specifies whether the enterprise bean code signs on |
| 217 | programmatically to the resource manager, or whether the Container will sign on |
| 218 | to the resource manager on behalf of the bean. In the latter case, the Container |
| 219 | uses information that is supplied by the Deployer. |
| 220 | The value of this element must be one of the two following: |
| 221 | <res-auth>Application</res-auth> |
| 222 | <res-auth>Container</res-auth> |
| 223 | --> |
| 224 | <!ELEMENT res-auth (#PCDATA)> |
| 225 | |
| 226 | <!-- |
| 227 | The res-ref-name element specifies the name of the resource factory reference |
| 228 | name. The resource factory reference name is the name of the application |
| 229 | client's environment entry whose value contains the JNDI name of the data |
| 230 | source. |
| 231 | Used in: resource-ref |
| 232 | --> |
| 233 | <!ELEMENT res-ref-name (#PCDATA)> |
| 234 | |
| 235 | <!-- |
| 236 | The res-type element specifies the type of the data source. The type is |
| 237 | specified by the Java interface (or class) expected to be implemented by the |
| 238 | data source. |
| 239 | Used in: resource-ref |
| 240 | --> |
| 241 | <!ELEMENT res-type (#PCDATA)> |
| 242 | |
| 243 | <!-- |
| 244 | The resource-ref element contains a declaration of application clients's |
| 245 | reference to an external resource. It consists of an optional description, the |
| 246 | resource factory reference name, the indication of the resource factory type |
| 247 | expected by the application client's code, and the type of authentication (bean |
| 248 | or container). |
| 249 | |
| 250 | Example: |
| 251 | <resource-ref> |
| 252 | <res-ref-name>EmployeeAppDB</res-ref-name> |
| 253 | <res-type>javax.sql.DataSource</res-type> |
| 254 | <res-auth>Container</res-auth> |
| 255 | </resource-ref> |
| 256 | --> |
| 257 | <!ELEMENT resource-ref (description?, res-ref-name, res-type, res-auth)> |
| 258 | <!-- |
| 259 | The small-icon element contains the name of a file containing a small (16 x 16) |
| 260 | icon image. The file name is a relative path within the application-client jar |
| 261 | file. The image must be either in the JPEG or GIF format, and the file name must |
| 262 | end with the suffix ".jpg" or ".gif" respectively. The icon can be used by |
| 263 | tools. |
| 264 | Example: |
| 265 | <small-icon>lib/images/employee-service-icon16x16.jpg</small-icon> |
| 266 | --> |
| 267 | <!ELEMENT small-icon (#PCDATA)> |
| 268 | |
| 269 | <!-- |
| 270 | The ID mechanism is to allow tools to easily make tool-specific references to |
| 271 | the elements of the deployment descriptor. |
| 272 | --> |
| 273 | <!ATTLIST application-client id ID #IMPLIED> |
| 274 | <!ATTLIST description id ID #IMPLIED> |
| 275 | <!ATTLIST display-name id ID #IMPLIED> |
| 276 | <!ATTLIST ejb-link id ID #IMPLIED> |
| 277 | <!ATTLIST ejb-ref id ID #IMPLIED> |
| 278 | <!ATTLIST ejb-ref-name id ID #IMPLIED> |
| 279 | <!ATTLIST ejb-ref-type id ID #IMPLIED> |
| 280 | <!ATTLIST env-entry id ID #IMPLIED> |
| 281 | <!ATTLIST env-entry-name id ID #IMPLIED> |
| 282 | <!ATTLIST env-entry-type id ID #IMPLIED> |
| 283 | <!ATTLIST env-entry-value id ID #IMPLIED> |
| 284 | <!ATTLIST home id ID #IMPLIED> |
| 285 | <!ATTLIST icon id ID #IMPLIED> |
| 286 | <!ATTLIST large-icon id ID #IMPLIED> |
| 287 | <!ATTLIST remote id ID #IMPLIED> |
| 288 | <!ATTLIST res-auth id ID #IMPLIED> |
| 289 | <!ATTLIST res-ref-name id ID #IMPLIED> |
| 290 | <!ATTLIST res-type id ID #IMPLIED> |
| 291 | <!ATTLIST resource-ref id ID #IMPLIED> |
| 292 | <!ATTLIST small-icon id ID #IMPLIED> |