javaee_6.xsd 79 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xsd:schema targetNamespace="http://java.sun.com/xml/ns/javaee"
  3. xmlns:javaee="http://java.sun.com/xml/ns/javaee"
  4. xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  5. elementFormDefault="qualified"
  6. attributeFormDefault="unqualified"
  7. version="6">
  8. <xsd:annotation>
  9. <xsd:documentation>
  10. $Id$
  11. </xsd:documentation>
  12. </xsd:annotation>
  13. <xsd:annotation>
  14. <xsd:documentation>
  15. DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  16. Copyright 2003-2009 Sun Microsystems, Inc. All rights reserved.
  17. The contents of this file are subject to the terms of either the
  18. GNU General Public License Version 2 only ("GPL") or the Common
  19. Development and Distribution License("CDDL") (collectively, the
  20. "License"). You may not use this file except in compliance with
  21. the License. You can obtain a copy of the License at
  22. https://glassfish.dev.java.net/public/CDDL+GPL.html or
  23. glassfish/bootstrap/legal/LICENSE.txt. See the License for the
  24. specific language governing permissions and limitations under the
  25. License.
  26. When distributing the software, include this License Header
  27. Notice in each file and include the License file at
  28. glassfish/bootstrap/legal/LICENSE.txt. Sun designates this
  29. particular file as subject to the "Classpath" exception as
  30. provided by Sun in the GPL Version 2 section of the License file
  31. that accompanied this code. If applicable, add the following
  32. below the License Header, with the fields enclosed by brackets []
  33. replaced by your own identifying information:
  34. "Portions Copyrighted [year] [name of copyright owner]"
  35. Contributor(s):
  36. If you wish your version of this file to be governed by only the
  37. CDDL or only the GPL Version 2, indicate your decision by adding
  38. "[Contributor] elects to include this software in this
  39. distribution under the [CDDL or GPL Version 2] license." If you
  40. don't indicate a single choice of license, a recipient has the
  41. option to distribute your version of this file under either the
  42. CDDL, the GPL Version 2 or to extend the choice of license to its
  43. licensees as provided above. However, if you add GPL Version 2
  44. code and therefore, elected the GPL Version 2 license, then the
  45. option applies only if the new code is made subject to such
  46. option by the copyright holder.
  47. </xsd:documentation>
  48. </xsd:annotation>
  49. <xsd:annotation>
  50. <xsd:documentation>
  51. The following definitions that appear in the common
  52. shareable schema(s) of Java EE deployment descriptors should be
  53. interpreted with respect to the context they are included:
  54. Deployment Component may indicate one of the following:
  55. java ee application;
  56. application client;
  57. web application;
  58. enterprise bean;
  59. resource adapter;
  60. Deployment File may indicate one of the following:
  61. ear file;
  62. war file;
  63. jar file;
  64. rar file;
  65. </xsd:documentation>
  66. </xsd:annotation>
  67. <xsd:import namespace="http://www.w3.org/XML/1998/namespace"
  68. schemaLocation="http://www.w3.org/2001/xml.xsd"/>
  69. <xsd:include schemaLocation="javaee_web_services_client_1_3.xsd"/>
  70. <xsd:group name="descriptionGroup">
  71. <xsd:annotation>
  72. <xsd:documentation>
  73. This group keeps the usage of the contained description related
  74. elements consistent across Java EE deployment descriptors.
  75. All elements may occur multiple times with different languages,
  76. to support localization of the content.
  77. </xsd:documentation>
  78. </xsd:annotation>
  79. <xsd:sequence>
  80. <xsd:element name="description"
  81. type="javaee:descriptionType"
  82. minOccurs="0"
  83. maxOccurs="unbounded"/>
  84. <xsd:element name="display-name"
  85. type="javaee:display-nameType"
  86. minOccurs="0"
  87. maxOccurs="unbounded"/>
  88. <xsd:element name="icon"
  89. type="javaee:iconType"
  90. minOccurs="0"
  91. maxOccurs="unbounded"/>
  92. </xsd:sequence>
  93. </xsd:group>
  94. <xsd:group name="jndiEnvironmentRefsGroup">
  95. <xsd:annotation>
  96. <xsd:documentation>
  97. This group keeps the usage of the contained JNDI environment
  98. reference elements consistent across Java EE deployment descriptors.
  99. </xsd:documentation>
  100. </xsd:annotation>
  101. <xsd:sequence>
  102. <xsd:element name="env-entry"
  103. type="javaee:env-entryType"
  104. minOccurs="0"
  105. maxOccurs="unbounded"/>
  106. <xsd:element name="ejb-ref"
  107. type="javaee:ejb-refType"
  108. minOccurs="0"
  109. maxOccurs="unbounded"/>
  110. <xsd:element name="ejb-local-ref"
  111. type="javaee:ejb-local-refType"
  112. minOccurs="0"
  113. maxOccurs="unbounded"/>
  114. <xsd:group ref="javaee:service-refGroup"/>
  115. <xsd:element name="resource-ref"
  116. type="javaee:resource-refType"
  117. minOccurs="0"
  118. maxOccurs="unbounded"/>
  119. <xsd:element name="resource-env-ref"
  120. type="javaee:resource-env-refType"
  121. minOccurs="0"
  122. maxOccurs="unbounded"/>
  123. <xsd:element name="message-destination-ref"
  124. type="javaee:message-destination-refType"
  125. minOccurs="0"
  126. maxOccurs="unbounded"/>
  127. <xsd:element name="persistence-context-ref"
  128. type="javaee:persistence-context-refType"
  129. minOccurs="0"
  130. maxOccurs="unbounded"/>
  131. <xsd:element name="persistence-unit-ref"
  132. type="javaee:persistence-unit-refType"
  133. minOccurs="0"
  134. maxOccurs="unbounded"/>
  135. <xsd:element name="post-construct"
  136. type="javaee:lifecycle-callbackType"
  137. minOccurs="0"
  138. maxOccurs="unbounded"/>
  139. <xsd:element name="pre-destroy"
  140. type="javaee:lifecycle-callbackType"
  141. minOccurs="0"
  142. maxOccurs="unbounded"/>
  143. <xsd:element name="data-source"
  144. type="javaee:data-sourceType"
  145. minOccurs="0"
  146. maxOccurs="unbounded"/>
  147. </xsd:sequence>
  148. </xsd:group>
  149. <xsd:group name="resourceGroup">
  150. <xsd:annotation>
  151. <xsd:documentation>
  152. This group collects elements that are common to most
  153. JNDI resource elements.
  154. </xsd:documentation>
  155. </xsd:annotation>
  156. <xsd:sequence>
  157. <xsd:group ref="javaee:resourceBaseGroup"/>
  158. <xsd:element name="lookup-name"
  159. type="javaee:xsdStringType"
  160. minOccurs="0">
  161. <xsd:annotation>
  162. <xsd:documentation>
  163. The JNDI name to be looked up to resolve a resource reference.
  164. </xsd:documentation>
  165. </xsd:annotation>
  166. </xsd:element>
  167. </xsd:sequence>
  168. </xsd:group>
  169. <xsd:group name="resourceBaseGroup">
  170. <xsd:annotation>
  171. <xsd:documentation>
  172. This group collects elements that are common to all the
  173. JNDI resource elements. It does not include the lookup-name
  174. element, that is only applicable to some resource elements.
  175. </xsd:documentation>
  176. </xsd:annotation>
  177. <xsd:sequence>
  178. <xsd:element name="mapped-name"
  179. type="javaee:xsdStringType"
  180. minOccurs="0">
  181. <xsd:annotation>
  182. <xsd:documentation>
  183. A product specific name that this resource should be
  184. mapped to. The name of this resource, as defined by the
  185. resource's name element or defaulted, is a name that is
  186. local to the application component using the resource.
  187. (It's a name in the JNDI java:comp/env namespace.) Many
  188. application servers provide a way to map these local
  189. names to names of resources known to the application
  190. server. This mapped name is often a global JNDI name,
  191. but may be a name of any form.
  192. Application servers are not required to support any
  193. particular form or type of mapped name, nor the ability
  194. to use mapped names. The mapped name is
  195. product-dependent and often installation-dependent. No
  196. use of a mapped name is portable.
  197. </xsd:documentation>
  198. </xsd:annotation>
  199. </xsd:element>
  200. <xsd:element name="injection-target"
  201. type="javaee:injection-targetType"
  202. minOccurs="0"
  203. maxOccurs="unbounded"/>
  204. </xsd:sequence>
  205. </xsd:group>
  206. <!-- **************************************************** -->
  207. <xsd:complexType name="data-sourceType">
  208. <xsd:annotation>
  209. <xsd:documentation>
  210. Configuration of a DataSource.
  211. </xsd:documentation>
  212. </xsd:annotation>
  213. <xsd:sequence>
  214. <xsd:element name="description"
  215. type="javaee:descriptionType"
  216. minOccurs="0">
  217. <xsd:annotation>
  218. <xsd:documentation>
  219. Description of this DataSource.
  220. </xsd:documentation>
  221. </xsd:annotation>
  222. </xsd:element>
  223. <xsd:element name="name"
  224. type="javaee:jndi-nameType">
  225. <xsd:annotation>
  226. <xsd:documentation>
  227. The name element specifies the JNDI name of the
  228. data source being defined.
  229. </xsd:documentation>
  230. </xsd:annotation>
  231. </xsd:element>
  232. <xsd:element name="class-name"
  233. type="javaee:fully-qualified-classType"
  234. minOccurs="0">
  235. <xsd:annotation>
  236. <xsd:documentation>
  237. DataSource, XADataSource or ConnectionPoolDataSource
  238. implementation class.
  239. </xsd:documentation>
  240. </xsd:annotation>
  241. </xsd:element>
  242. <xsd:element name="server-name"
  243. type="javaee:string"
  244. minOccurs="0">
  245. <xsd:annotation>
  246. <xsd:documentation>
  247. Database server name.
  248. </xsd:documentation>
  249. </xsd:annotation>
  250. </xsd:element>
  251. <xsd:element name="port-number"
  252. type="javaee:xsdIntegerType"
  253. minOccurs="0">
  254. <xsd:annotation>
  255. <xsd:documentation>
  256. Port number where a server is listening for requests.
  257. </xsd:documentation>
  258. </xsd:annotation>
  259. </xsd:element>
  260. <xsd:element name="database-name"
  261. type="javaee:string"
  262. minOccurs="0">
  263. <xsd:annotation>
  264. <xsd:documentation>
  265. Name of a database on a server.
  266. </xsd:documentation>
  267. </xsd:annotation>
  268. </xsd:element>
  269. <xsd:element name="url"
  270. type="javaee:jdbc-urlType"
  271. minOccurs="0">
  272. <xsd:annotation>
  273. <xsd:documentation>
  274. <![CDATA[[
  275. A JDBC URL. If the <code>url</code> property is specified
  276. along with other standard <code>DataSource</code> properties
  277. such as <code>serverName</code>, <code>databaseName</code>
  278. and <code>portNumber</code>, the more specific properties will
  279. take precedence and <code>url</code> will be ignored.
  280. ]]>
  281. </xsd:documentation>
  282. </xsd:annotation>
  283. </xsd:element>
  284. <xsd:element name="user"
  285. type="javaee:string"
  286. minOccurs="0">
  287. <xsd:annotation>
  288. <xsd:documentation>
  289. User name to use for connection authentication.
  290. </xsd:documentation>
  291. </xsd:annotation>
  292. </xsd:element>
  293. <xsd:element name="password"
  294. type="javaee:string"
  295. minOccurs="0">
  296. <xsd:annotation>
  297. <xsd:documentation>
  298. Password to use for connection authentication.
  299. </xsd:documentation>
  300. </xsd:annotation>
  301. </xsd:element>
  302. <xsd:element name="property"
  303. type="javaee:propertyType"
  304. minOccurs="0"
  305. maxOccurs="unbounded">
  306. <xsd:annotation>
  307. <xsd:documentation>
  308. JDBC DataSource property. This may be a vendor-specific
  309. property or a less commonly used DataSource property.
  310. </xsd:documentation>
  311. </xsd:annotation>
  312. </xsd:element>
  313. <xsd:element name="login-timeout"
  314. type="javaee:xsdIntegerType"
  315. minOccurs="0">
  316. <xsd:annotation>
  317. <xsd:documentation>
  318. Sets the maximum time in seconds that this data source
  319. will wait while attempting to connect to a database.
  320. </xsd:documentation>
  321. </xsd:annotation>
  322. </xsd:element>
  323. <xsd:element name="transactional"
  324. type="javaee:xsdBooleanType"
  325. minOccurs="0">
  326. <xsd:annotation>
  327. <xsd:documentation>
  328. Set to false if connections should not participate in
  329. transactions.
  330. </xsd:documentation>
  331. </xsd:annotation>
  332. </xsd:element>
  333. <xsd:element name="isolation-level"
  334. type="javaee:isolation-levelType"
  335. minOccurs="0">
  336. <xsd:annotation>
  337. <xsd:documentation>
  338. Isolation level for connections.
  339. </xsd:documentation>
  340. </xsd:annotation>
  341. </xsd:element>
  342. <xsd:element name="initial-pool-size"
  343. type="javaee:xsdIntegerType"
  344. minOccurs="0">
  345. <xsd:annotation>
  346. <xsd:documentation>
  347. Number of connections that should be created when a
  348. connection pool is initialized.
  349. </xsd:documentation>
  350. </xsd:annotation>
  351. </xsd:element>
  352. <xsd:element name="max-pool-size"
  353. type="javaee:xsdIntegerType"
  354. minOccurs="0">
  355. <xsd:annotation>
  356. <xsd:documentation>
  357. Maximum number of connections that should be concurrently
  358. allocated for a connection pool.
  359. </xsd:documentation>
  360. </xsd:annotation>
  361. </xsd:element>
  362. <xsd:element name="min-pool-size"
  363. type="javaee:xsdIntegerType"
  364. minOccurs="0">
  365. <xsd:annotation>
  366. <xsd:documentation>
  367. Minimum number of connections that should be concurrently
  368. allocated for a connection pool.
  369. </xsd:documentation>
  370. </xsd:annotation>
  371. </xsd:element>
  372. <xsd:element name="max-idle-time"
  373. type="javaee:xsdIntegerType"
  374. minOccurs="0">
  375. <xsd:annotation>
  376. <xsd:documentation>
  377. The number of seconds that a physical connection should
  378. remain unused in the pool before the connection is
  379. closed for a connection pool.
  380. </xsd:documentation>
  381. </xsd:annotation>
  382. </xsd:element>
  383. <xsd:element name="max-statements"
  384. type="javaee:xsdIntegerType"
  385. minOccurs="0">
  386. <xsd:annotation>
  387. <xsd:documentation>
  388. The total number of statements that a connection pool
  389. should keep open.
  390. </xsd:documentation>
  391. </xsd:annotation>
  392. </xsd:element>
  393. </xsd:sequence>
  394. <xsd:attribute name="id"
  395. type="xsd:ID"/>
  396. </xsd:complexType>
  397. <!-- **************************************************** -->
  398. <xsd:complexType name="descriptionType">
  399. <xsd:annotation>
  400. <xsd:documentation>
  401. The description type is used by a description element to
  402. provide text describing the parent element. The elements
  403. that use this type should include any information that the
  404. Deployment Component's Deployment File file producer wants
  405. to provide to the consumer of the Deployment Component's
  406. Deployment File (i.e., to the Deployer). Typically, the
  407. tools used by such a Deployment File consumer will display
  408. the description when processing the parent element that
  409. contains the description.
  410. The lang attribute defines the language that the
  411. description is provided in. The default value is "en" (English).
  412. </xsd:documentation>
  413. </xsd:annotation>
  414. <xsd:simpleContent>
  415. <xsd:extension base="javaee:xsdStringType">
  416. <xsd:attribute ref="xml:lang"/>
  417. </xsd:extension>
  418. </xsd:simpleContent>
  419. </xsd:complexType>
  420. <xsd:simpleType name="dewey-versionType">
  421. <xsd:annotation>
  422. <xsd:documentation>
  423. This type defines a dewey decimal that is used
  424. to describe versions of documents.
  425. </xsd:documentation>
  426. </xsd:annotation>
  427. <xsd:restriction base="xsd:token">
  428. <xsd:pattern value="\.?[0-9]+(\.[0-9]+)*"/>
  429. </xsd:restriction>
  430. </xsd:simpleType>
  431. <!-- **************************************************** -->
  432. <xsd:complexType name="display-nameType">
  433. <xsd:annotation>
  434. <xsd:documentation>
  435. <![CDATA[[
  436. The display-name type contains a short name that is intended
  437. to be displayed by tools. It is used by display-name
  438. elements. The display name need not be unique.
  439. Example:
  440. ...
  441. <display-name xml:lang="en">
  442. Employee Self Service
  443. </display-name>
  444. The value of the xml:lang attribute is "en" (English) by default.
  445. ]]>
  446. </xsd:documentation>
  447. </xsd:annotation>
  448. <xsd:simpleContent>
  449. <xsd:extension base="javaee:string">
  450. <xsd:attribute ref="xml:lang"/>
  451. </xsd:extension>
  452. </xsd:simpleContent>
  453. </xsd:complexType>
  454. <!-- **************************************************** -->
  455. <xsd:complexType name="ejb-linkType">
  456. <xsd:annotation>
  457. <xsd:documentation>
  458. <![CDATA[[
  459. The ejb-linkType is used by ejb-link
  460. elements in the ejb-ref or ejb-local-ref elements to specify
  461. that an EJB reference is linked to enterprise bean.
  462. The value of the ejb-link element must be the ejb-name of an
  463. enterprise bean in the same ejb-jar file or in another ejb-jar
  464. file in the same Java EE application unit.
  465. Alternatively, the name in the ejb-link element may be
  466. composed of a path name specifying the ejb-jar containing the
  467. referenced enterprise bean with the ejb-name of the target
  468. bean appended and separated from the path name by "#". The
  469. path name is relative to the Deployment File containing
  470. Deployment Component that is referencing the enterprise
  471. bean. This allows multiple enterprise beans with the same
  472. ejb-name to be uniquely identified.
  473. Examples:
  474. <ejb-link>EmployeeRecord</ejb-link>
  475. <ejb-link>../products/product.jar#ProductEJB</ejb-link>
  476. ]]>
  477. </xsd:documentation>
  478. </xsd:annotation>
  479. <xsd:simpleContent>
  480. <xsd:restriction base="javaee:string"/>
  481. </xsd:simpleContent>
  482. </xsd:complexType>
  483. <!-- **************************************************** -->
  484. <xsd:complexType name="ejb-local-refType">
  485. <xsd:annotation>
  486. <xsd:documentation>
  487. The ejb-local-refType is used by ejb-local-ref elements for
  488. the declaration of a reference to an enterprise bean's local
  489. home or to the local business interface of a 3.0 bean.
  490. The declaration consists of:
  491. - an optional description
  492. - the EJB reference name used in the code of the Deployment
  493. Component that's referencing the enterprise bean.
  494. - the optional expected type of the referenced enterprise bean
  495. - the optional expected local interface of the referenced
  496. enterprise bean or the local business interface of the
  497. referenced enterprise bean.
  498. - the optional expected local home interface of the referenced
  499. enterprise bean. Not applicable if this ejb-local-ref refers
  500. to the local business interface of a 3.0 bean.
  501. - optional ejb-link information, used to specify the
  502. referenced enterprise bean
  503. - optional elements to define injection of the named enterprise
  504. bean into a component field or property.
  505. </xsd:documentation>
  506. </xsd:annotation>
  507. <xsd:sequence>
  508. <xsd:element name="description"
  509. type="javaee:descriptionType"
  510. minOccurs="0"
  511. maxOccurs="unbounded"/>
  512. <xsd:element name="ejb-ref-name"
  513. type="javaee:ejb-ref-nameType"/>
  514. <xsd:element name="ejb-ref-type"
  515. type="javaee:ejb-ref-typeType"
  516. minOccurs="0"/>
  517. <xsd:element name="local-home"
  518. type="javaee:local-homeType"
  519. minOccurs="0"/>
  520. <xsd:element name="local"
  521. type="javaee:localType"
  522. minOccurs="0"/>
  523. <xsd:element name="ejb-link"
  524. type="javaee:ejb-linkType"
  525. minOccurs="0"/>
  526. <xsd:group ref="javaee:resourceGroup"/>
  527. </xsd:sequence>
  528. <xsd:attribute name="id"
  529. type="xsd:ID"/>
  530. </xsd:complexType>
  531. <!-- **************************************************** -->
  532. <xsd:complexType name="ejb-ref-nameType">
  533. <xsd:annotation>
  534. <xsd:documentation>
  535. <![CDATA[[
  536. The ejb-ref-name element contains the name of an EJB
  537. reference. The EJB reference is an entry in the
  538. Deployment Component's environment and is relative to the
  539. java:comp/env context. The name must be unique within the
  540. Deployment Component.
  541. It is recommended that name is prefixed with "ejb/".
  542. Example:
  543. <ejb-ref-name>ejb/Payroll</ejb-ref-name>
  544. ]]>
  545. </xsd:documentation>
  546. </xsd:annotation>
  547. <xsd:simpleContent>
  548. <xsd:restriction base="javaee:jndi-nameType"/>
  549. </xsd:simpleContent>
  550. </xsd:complexType>
  551. <!-- **************************************************** -->
  552. <xsd:complexType name="ejb-refType">
  553. <xsd:annotation>
  554. <xsd:documentation>
  555. The ejb-refType is used by ejb-ref elements for the
  556. declaration of a reference to an enterprise bean's home or
  557. to the remote business interface of a 3.0 bean.
  558. The declaration consists of:
  559. - an optional description
  560. - the EJB reference name used in the code of
  561. the Deployment Component that's referencing the enterprise
  562. bean.
  563. - the optional expected type of the referenced enterprise bean
  564. - the optional remote interface of the referenced enterprise bean
  565. or the remote business interface of the referenced enterprise
  566. bean
  567. - the optional expected home interface of the referenced
  568. enterprise bean. Not applicable if this ejb-ref
  569. refers to the remote business interface of a 3.0 bean.
  570. - optional ejb-link information, used to specify the
  571. referenced enterprise bean
  572. - optional elements to define injection of the named enterprise
  573. bean into a component field or property
  574. </xsd:documentation>
  575. </xsd:annotation>
  576. <xsd:sequence>
  577. <xsd:element name="description"
  578. type="javaee:descriptionType"
  579. minOccurs="0"
  580. maxOccurs="unbounded"/>
  581. <xsd:element name="ejb-ref-name"
  582. type="javaee:ejb-ref-nameType"/>
  583. <xsd:element name="ejb-ref-type"
  584. type="javaee:ejb-ref-typeType"
  585. minOccurs="0"/>
  586. <xsd:element name="home"
  587. type="javaee:homeType"
  588. minOccurs="0"/>
  589. <xsd:element name="remote"
  590. type="javaee:remoteType"
  591. minOccurs="0"/>
  592. <xsd:element name="ejb-link"
  593. type="javaee:ejb-linkType"
  594. minOccurs="0"/>
  595. <xsd:group ref="javaee:resourceGroup"/>
  596. </xsd:sequence>
  597. <xsd:attribute name="id"
  598. type="xsd:ID"/>
  599. </xsd:complexType>
  600. <!-- **************************************************** -->
  601. <xsd:complexType name="ejb-ref-typeType">
  602. <xsd:annotation>
  603. <xsd:documentation>
  604. The ejb-ref-typeType contains the expected type of the
  605. referenced enterprise bean.
  606. The ejb-ref-type designates a value
  607. that must be one of the following:
  608. Entity
  609. Session
  610. </xsd:documentation>
  611. </xsd:annotation>
  612. <xsd:simpleContent>
  613. <xsd:restriction base="javaee:string">
  614. <xsd:enumeration value="Entity"/>
  615. <xsd:enumeration value="Session"/>
  616. </xsd:restriction>
  617. </xsd:simpleContent>
  618. </xsd:complexType>
  619. <!-- **************************************************** -->
  620. <xsd:complexType name="emptyType">
  621. <xsd:annotation>
  622. <xsd:documentation>
  623. This type is used to designate an empty
  624. element when used.
  625. </xsd:documentation>
  626. </xsd:annotation>
  627. <xsd:attribute name="id"
  628. type="xsd:ID"/>
  629. </xsd:complexType>
  630. <!-- **************************************************** -->
  631. <xsd:complexType name="env-entryType">
  632. <xsd:annotation>
  633. <xsd:documentation>
  634. The env-entryType is used to declare an application's
  635. environment entry. The declaration consists of an optional
  636. description, the name of the environment entry, a type
  637. (optional if the value is injected, otherwise required), and
  638. an optional value.
  639. It also includes optional elements to define injection of
  640. the named resource into fields or JavaBeans properties.
  641. If a value is not specified and injection is requested,
  642. no injection will occur and no entry of the specified name
  643. will be created. This allows an initial value to be
  644. specified in the source code without being incorrectly
  645. changed when no override has been specified.
  646. If a value is not specified and no injection is requested,
  647. a value must be supplied during deployment.
  648. This type is used by env-entry elements.
  649. </xsd:documentation>
  650. </xsd:annotation>
  651. <xsd:sequence>
  652. <xsd:element name="description"
  653. type="javaee:descriptionType"
  654. minOccurs="0"
  655. maxOccurs="unbounded"/>
  656. <xsd:element name="env-entry-name"
  657. type="javaee:jndi-nameType">
  658. <xsd:annotation>
  659. <xsd:documentation>
  660. <![CDATA[[
  661. The env-entry-name element contains the name of a
  662. Deployment Component's environment entry. The name
  663. is a JNDI name relative to the java:comp/env
  664. context. The name must be unique within a
  665. Deployment Component. The uniqueness
  666. constraints must be defined within the declared
  667. context.
  668. Example:
  669. <env-entry-name>minAmount</env-entry-name>
  670. ]]>
  671. </xsd:documentation>
  672. </xsd:annotation>
  673. </xsd:element>
  674. <xsd:element name="env-entry-type"
  675. type="javaee:env-entry-type-valuesType"
  676. minOccurs="0">
  677. <xsd:annotation>
  678. <xsd:documentation>
  679. <![CDATA[[
  680. The env-entry-type element contains the Java language
  681. type of the environment entry. If an injection target
  682. is specified for the environment entry, the type may
  683. be omitted, or must match the type of the injection
  684. target. If no injection target is specified, the type
  685. is required.
  686. Example:
  687. <env-entry-type>java.lang.Integer</env-entry-type>
  688. ]]>
  689. </xsd:documentation>
  690. </xsd:annotation>
  691. </xsd:element>
  692. <xsd:element name="env-entry-value"
  693. type="javaee:xsdStringType"
  694. minOccurs="0">
  695. <xsd:annotation>
  696. <xsd:documentation>
  697. <![CDATA[[
  698. The env-entry-value designates the value of a
  699. Deployment Component's environment entry. The value
  700. must be a String that is valid for the
  701. constructor of the specified type that takes a
  702. single String parameter, or for java.lang.Character,
  703. a single character.
  704. Example:
  705. <env-entry-value>100.00</env-entry-value>
  706. ]]>
  707. </xsd:documentation>
  708. </xsd:annotation>
  709. </xsd:element>
  710. <xsd:group ref="javaee:resourceGroup"/>
  711. </xsd:sequence>
  712. <xsd:attribute name="id"
  713. type="xsd:ID"/>
  714. </xsd:complexType>
  715. <!-- **************************************************** -->
  716. <xsd:complexType name="env-entry-type-valuesType">
  717. <xsd:annotation>
  718. <xsd:documentation>
  719. <![CDATA[[
  720. This type contains the fully-qualified Java type of the
  721. environment entry value that is expected by the
  722. application's code.
  723. The following are the legal values of env-entry-type-valuesType:
  724. java.lang.Boolean
  725. java.lang.Byte
  726. java.lang.Character
  727. java.lang.String
  728. java.lang.Short
  729. java.lang.Integer
  730. java.lang.Long
  731. java.lang.Float
  732. java.lang.Double
  733. java.lang.Class
  734. any enumeration type (i.e. a subclass of java.lang.Enum)
  735. Examples:
  736. <env-entry-type>java.lang.Boolean</env-entry-type>
  737. <env-entry-type>java.lang.Class</env-entry-type>
  738. <env-entry-type>com.example.Color</env-entry-type>
  739. ]]>
  740. </xsd:documentation>
  741. </xsd:annotation>
  742. <xsd:simpleContent>
  743. <xsd:restriction base="javaee:fully-qualified-classType"/>
  744. </xsd:simpleContent>
  745. </xsd:complexType>
  746. <!-- **************************************************** -->
  747. <xsd:complexType name="fully-qualified-classType">
  748. <xsd:annotation>
  749. <xsd:documentation>
  750. The elements that use this type designate the name of a
  751. Java class or interface. The name is in the form of a
  752. "binary name", as defined in the JLS. This is the form
  753. of name used in Class.forName(). Tools that need the
  754. canonical name (the name used in source code) will need
  755. to convert this binary name to the canonical name.
  756. </xsd:documentation>
  757. </xsd:annotation>
  758. <xsd:simpleContent>
  759. <xsd:restriction base="javaee:string"/>
  760. </xsd:simpleContent>
  761. </xsd:complexType>
  762. <!-- **************************************************** -->
  763. <xsd:complexType name="generic-booleanType">
  764. <xsd:annotation>
  765. <xsd:documentation>
  766. This type defines four different values which can designate
  767. boolean values. This includes values yes and no which are
  768. not designated by xsd:boolean
  769. </xsd:documentation>
  770. </xsd:annotation>
  771. <xsd:simpleContent>
  772. <xsd:restriction base="javaee:string">
  773. <xsd:enumeration value="true"/>
  774. <xsd:enumeration value="false"/>
  775. <xsd:enumeration value="yes"/>
  776. <xsd:enumeration value="no"/>
  777. </xsd:restriction>
  778. </xsd:simpleContent>
  779. </xsd:complexType>
  780. <!-- **************************************************** -->
  781. <xsd:complexType name="iconType">
  782. <xsd:annotation>
  783. <xsd:documentation>
  784. The icon type contains small-icon and large-icon elements
  785. that specify the file names for small and large GIF, JPEG,
  786. or PNG icon images used to represent the parent element in a
  787. GUI tool.
  788. The xml:lang attribute defines the language that the
  789. icon file names are provided in. Its value is "en" (English)
  790. by default.
  791. </xsd:documentation>
  792. </xsd:annotation>
  793. <xsd:sequence>
  794. <xsd:element name="small-icon"
  795. type="javaee:pathType"
  796. minOccurs="0">
  797. <xsd:annotation>
  798. <xsd:documentation>
  799. <![CDATA[[
  800. The small-icon element contains the name of a file
  801. containing a small (16 x 16) icon image. The file
  802. name is a relative path within the Deployment
  803. Component's Deployment File.
  804. The image may be in the GIF, JPEG, or PNG format.
  805. The icon can be used by tools.
  806. Example:
  807. <small-icon>employee-service-icon16x16.jpg</small-icon>
  808. ]]>
  809. </xsd:documentation>
  810. </xsd:annotation>
  811. </xsd:element>
  812. <xsd:element name="large-icon"
  813. type="javaee:pathType"
  814. minOccurs="0">
  815. <xsd:annotation>
  816. <xsd:documentation>
  817. <![CDATA[[
  818. The large-icon element contains the name of a file
  819. containing a large
  820. (32 x 32) icon image. The file name is a relative
  821. path within the Deployment Component's Deployment
  822. File.
  823. The image may be in the GIF, JPEG, or PNG format.
  824. The icon can be used by tools.
  825. Example:
  826. <large-icon>employee-service-icon32x32.jpg</large-icon>
  827. ]]>
  828. </xsd:documentation>
  829. </xsd:annotation>
  830. </xsd:element>
  831. </xsd:sequence>
  832. <xsd:attribute ref="xml:lang"/>
  833. <xsd:attribute name="id"
  834. type="xsd:ID"/>
  835. </xsd:complexType>
  836. <!-- **************************************************** -->
  837. <xsd:complexType name="injection-targetType">
  838. <xsd:annotation>
  839. <xsd:documentation>
  840. An injection target specifies a class and a name within
  841. that class into which a resource should be injected.
  842. The injection target class specifies the fully qualified
  843. class name that is the target of the injection. The
  844. Java EE specifications describe which classes can be an
  845. injection target.
  846. The injection target name specifies the target within
  847. the specified class. The target is first looked for as a
  848. JavaBeans property name. If not found, the target is
  849. looked for as a field name.
  850. The specified resource will be injected into the target
  851. during initialization of the class by either calling the
  852. set method for the target property or by setting a value
  853. into the named field.
  854. </xsd:documentation>
  855. </xsd:annotation>
  856. <xsd:sequence>
  857. <xsd:element name="injection-target-class"
  858. type="javaee:fully-qualified-classType"/>
  859. <xsd:element name="injection-target-name"
  860. type="javaee:java-identifierType"/>
  861. </xsd:sequence>
  862. </xsd:complexType>
  863. <xsd:simpleType name="isolation-levelType">
  864. <xsd:annotation>
  865. <xsd:documentation>
  866. The following transaction isolation levels are allowed
  867. (see documentation for the java.sql.Connection interface):
  868. TRANSACTION_READ_UNCOMMITTED
  869. TRANSACTION_READ_COMMITTED
  870. TRANSACTION_REPEATABLE_READ
  871. TRANSACTION_SERIALIZABLE
  872. </xsd:documentation>
  873. </xsd:annotation>
  874. <xsd:restriction base="xsd:string">
  875. <xsd:enumeration value="TRANSACTION_READ_UNCOMMITTED"/>
  876. <xsd:enumeration value="TRANSACTION_READ_COMMITTED"/>
  877. <xsd:enumeration value="TRANSACTION_REPEATABLE_READ"/>
  878. <xsd:enumeration value="TRANSACTION_SERIALIZABLE"/>
  879. </xsd:restriction>
  880. </xsd:simpleType>
  881. <!-- **************************************************** -->
  882. <xsd:complexType name="java-identifierType">
  883. <xsd:annotation>
  884. <xsd:documentation>
  885. The java-identifierType defines a Java identifier.
  886. The users of this type should further verify that
  887. the content does not contain Java reserved keywords.
  888. </xsd:documentation>
  889. </xsd:annotation>
  890. <xsd:simpleContent>
  891. <xsd:restriction base="javaee:string">
  892. <xsd:pattern value="($|_|\p{L})(\p{L}|\p{Nd}|_|$)*"/>
  893. </xsd:restriction>
  894. </xsd:simpleContent>
  895. </xsd:complexType>
  896. <!-- **************************************************** -->
  897. <xsd:complexType name="java-typeType">
  898. <xsd:annotation>
  899. <xsd:documentation>
  900. This is a generic type that designates a Java primitive
  901. type or a fully qualified name of a Java interface/type,
  902. or an array of such types.
  903. </xsd:documentation>
  904. </xsd:annotation>
  905. <xsd:simpleContent>
  906. <xsd:restriction base="javaee:string">
  907. <xsd:pattern value="[^\p{Z}]*"/>
  908. </xsd:restriction>
  909. </xsd:simpleContent>
  910. </xsd:complexType>
  911. <!-- **************************************************** -->
  912. <xsd:complexType name="jdbc-urlType">
  913. <xsd:annotation>
  914. <xsd:documentation>
  915. <![CDATA[[
  916. The jdbc-urlType contains the url pattern of the mapping.
  917. It must follow the rules specified in Section 9.3 of the
  918. JDBC Specification where the format is:
  919. jdbc:<subprotocol>:<subname>
  920. Example:
  921. <url>jdbc:mysql://localhost:3307/testdb</url>
  922. ]]>
  923. </xsd:documentation>
  924. </xsd:annotation>
  925. <xsd:simpleContent>
  926. <xsd:restriction base="javaee:string">
  927. <xsd:pattern value="jdbc:(.*):(.*)"/>
  928. </xsd:restriction>
  929. </xsd:simpleContent>
  930. </xsd:complexType>
  931. <!-- **************************************************** -->
  932. <xsd:complexType name="jndi-nameType">
  933. <xsd:annotation>
  934. <xsd:documentation>
  935. The jndi-nameType type designates a JNDI name in the
  936. Deployment Component's environment and is relative to the
  937. java:comp/env context. A JNDI name must be unique within the
  938. Deployment Component.
  939. </xsd:documentation>
  940. </xsd:annotation>
  941. <xsd:simpleContent>
  942. <xsd:restriction base="javaee:string"/>
  943. </xsd:simpleContent>
  944. </xsd:complexType>
  945. <!-- **************************************************** -->
  946. <xsd:complexType name="homeType">
  947. <xsd:annotation>
  948. <xsd:documentation>
  949. <![CDATA[[
  950. The homeType defines the fully-qualified name of
  951. an enterprise bean's home interface.
  952. Example:
  953. <home>com.aardvark.payroll.PayrollHome</home>
  954. ]]>
  955. </xsd:documentation>
  956. </xsd:annotation>
  957. <xsd:simpleContent>
  958. <xsd:restriction base="javaee:fully-qualified-classType"/>
  959. </xsd:simpleContent>
  960. </xsd:complexType>
  961. <!-- **************************************************** -->
  962. <xsd:complexType name="lifecycle-callbackType">
  963. <xsd:annotation>
  964. <xsd:documentation>
  965. The lifecycle-callback type specifies a method on a
  966. class to be called when a lifecycle event occurs.
  967. Note that each class may have only one lifecycle callback
  968. method for any given event and that the method may not
  969. be overloaded.
  970. If the lifefycle-callback-class element is missing then
  971. the class defining the callback is assumed to be the
  972. component class in scope at the place in the descriptor
  973. in which the callback definition appears.
  974. </xsd:documentation>
  975. </xsd:annotation>
  976. <xsd:sequence>
  977. <xsd:element name="lifecycle-callback-class"
  978. type="javaee:fully-qualified-classType"
  979. minOccurs="0"/>
  980. <xsd:element name="lifecycle-callback-method"
  981. type="javaee:java-identifierType"/>
  982. </xsd:sequence>
  983. </xsd:complexType>
  984. <!-- **************************************************** -->
  985. <xsd:complexType name="listenerType">
  986. <xsd:annotation>
  987. <xsd:documentation>
  988. The listenerType indicates the deployment properties for a web
  989. application listener bean.
  990. </xsd:documentation>
  991. </xsd:annotation>
  992. <xsd:sequence>
  993. <xsd:group ref="javaee:descriptionGroup"/>
  994. <xsd:element name="listener-class"
  995. type="javaee:fully-qualified-classType">
  996. <xsd:annotation>
  997. <xsd:documentation>
  998. The listener-class element declares a class in the
  999. application must be registered as a web
  1000. application listener bean. The value is the fully
  1001. qualified classname of the listener class.
  1002. </xsd:documentation>
  1003. </xsd:annotation>
  1004. </xsd:element>
  1005. </xsd:sequence>
  1006. <xsd:attribute name="id"
  1007. type="xsd:ID"/>
  1008. </xsd:complexType>
  1009. <!-- **************************************************** -->
  1010. <xsd:complexType name="localType">
  1011. <xsd:annotation>
  1012. <xsd:documentation>
  1013. The localType defines the fully-qualified name of an
  1014. enterprise bean's local interface.
  1015. </xsd:documentation>
  1016. </xsd:annotation>
  1017. <xsd:simpleContent>
  1018. <xsd:restriction base="javaee:fully-qualified-classType"/>
  1019. </xsd:simpleContent>
  1020. </xsd:complexType>
  1021. <!-- **************************************************** -->
  1022. <xsd:complexType name="local-homeType">
  1023. <xsd:annotation>
  1024. <xsd:documentation>
  1025. The local-homeType defines the fully-qualified
  1026. name of an enterprise bean's local home interface.
  1027. </xsd:documentation>
  1028. </xsd:annotation>
  1029. <xsd:simpleContent>
  1030. <xsd:restriction base="javaee:fully-qualified-classType"/>
  1031. </xsd:simpleContent>
  1032. </xsd:complexType>
  1033. <!-- **************************************************** -->
  1034. <xsd:complexType name="param-valueType">
  1035. <xsd:annotation>
  1036. <xsd:documentation>
  1037. This type is a general type that can be used to declare
  1038. parameter/value lists.
  1039. </xsd:documentation>
  1040. </xsd:annotation>
  1041. <xsd:sequence>
  1042. <xsd:element name="description"
  1043. type="javaee:descriptionType"
  1044. minOccurs="0"
  1045. maxOccurs="unbounded"/>
  1046. <xsd:element name="param-name"
  1047. type="javaee:string">
  1048. <xsd:annotation>
  1049. <xsd:documentation>
  1050. The param-name element contains the name of a
  1051. parameter.
  1052. </xsd:documentation>
  1053. </xsd:annotation>
  1054. </xsd:element>
  1055. <xsd:element name="param-value"
  1056. type="javaee:xsdStringType">
  1057. <xsd:annotation>
  1058. <xsd:documentation>
  1059. The param-value element contains the value of a
  1060. parameter.
  1061. </xsd:documentation>
  1062. </xsd:annotation>
  1063. </xsd:element>
  1064. </xsd:sequence>
  1065. <xsd:attribute name="id"
  1066. type="xsd:ID"/>
  1067. </xsd:complexType>
  1068. <!-- **************************************************** -->
  1069. <xsd:complexType name="pathType">
  1070. <xsd:annotation>
  1071. <xsd:documentation>
  1072. The elements that use this type designate either a relative
  1073. path or an absolute path starting with a "/".
  1074. In elements that specify a pathname to a file within the
  1075. same Deployment File, relative filenames (i.e., those not
  1076. starting with "/") are considered relative to the root of
  1077. the Deployment File's namespace. Absolute filenames (i.e.,
  1078. those starting with "/") also specify names in the root of
  1079. the Deployment File's namespace. In general, relative names
  1080. are preferred. The exception is .war files where absolute
  1081. names are preferred for consistency with the Servlet API.
  1082. </xsd:documentation>
  1083. </xsd:annotation>
  1084. <xsd:simpleContent>
  1085. <xsd:restriction base="javaee:string"/>
  1086. </xsd:simpleContent>
  1087. </xsd:complexType>
  1088. <!-- **************************************************** -->
  1089. <xsd:complexType name="persistence-context-refType">
  1090. <xsd:annotation>
  1091. <xsd:documentation>
  1092. <![CDATA[[
  1093. The persistence-context-ref element contains a declaration
  1094. of Deployment Component's reference to a persistence context
  1095. associated within a Deployment Component's
  1096. environment. It consists of:
  1097. - an optional description
  1098. - the persistence context reference name
  1099. - an optional persistence unit name. If not specified,
  1100. the default persistence unit is assumed.
  1101. - an optional specification as to whether
  1102. the persistence context type is Transaction or
  1103. Extended. If not specified, Transaction is assumed.
  1104. - an optional list of persistence properties
  1105. - optional injection targets
  1106. Examples:
  1107. <persistence-context-ref>
  1108. <persistence-context-ref-name>myPersistenceContext
  1109. </persistence-context-ref-name>
  1110. </persistence-context-ref>
  1111. <persistence-context-ref>
  1112. <persistence-context-ref-name>myPersistenceContext
  1113. </persistence-context-ref-name>
  1114. <persistence-unit-name>PersistenceUnit1
  1115. </persistence-unit-name>
  1116. <persistence-context-type>Extended</persistence-context-type>
  1117. </persistence-context-ref>
  1118. ]]>
  1119. </xsd:documentation>
  1120. </xsd:annotation>
  1121. <xsd:sequence>
  1122. <xsd:element name="description"
  1123. type="javaee:descriptionType"
  1124. minOccurs="0"
  1125. maxOccurs="unbounded"/>
  1126. <xsd:element name="persistence-context-ref-name"
  1127. type="javaee:jndi-nameType">
  1128. <xsd:annotation>
  1129. <xsd:documentation>
  1130. The persistence-context-ref-name element specifies
  1131. the name of a persistence context reference; its
  1132. value is the environment entry name used in
  1133. Deployment Component code. The name is a JNDI name
  1134. relative to the java:comp/env context.
  1135. </xsd:documentation>
  1136. </xsd:annotation>
  1137. </xsd:element>
  1138. <xsd:element name="persistence-unit-name"
  1139. type="javaee:string"
  1140. minOccurs="0">
  1141. <xsd:annotation>
  1142. <xsd:documentation>
  1143. The Application Assembler(or BeanProvider) may use the
  1144. following syntax to avoid the need to rename persistence
  1145. units to have unique names within a Java EE application.
  1146. The Application Assembler specifies the pathname of the
  1147. root of the persistence.xml file for the referenced
  1148. persistence unit and appends the name of the persistence
  1149. unit separated from the pathname by #. The pathname is
  1150. relative to the referencing application component jar file.
  1151. In this manner, multiple persistence units with the same
  1152. persistence unit name may be uniquely identified when the
  1153. Application Assembler cannot change persistence unit names.
  1154. </xsd:documentation>
  1155. </xsd:annotation>
  1156. </xsd:element>
  1157. <xsd:element name="persistence-context-type"
  1158. type="javaee:persistence-context-typeType"
  1159. minOccurs="0"/>
  1160. <xsd:element name="persistence-property"
  1161. type="javaee:propertyType"
  1162. minOccurs="0"
  1163. maxOccurs="unbounded">
  1164. <xsd:annotation>
  1165. <xsd:documentation>
  1166. Used to specify properties for the container or persistence
  1167. provider. Vendor-specific properties may be included in
  1168. the set of properties. Properties that are not recognized
  1169. by a vendor must be ignored. Entries that make use of the
  1170. namespace javax.persistence and its subnamespaces must not
  1171. be used for vendor-specific properties. The namespace
  1172. javax.persistence is reserved for use by the specification.
  1173. </xsd:documentation>
  1174. </xsd:annotation>
  1175. </xsd:element>
  1176. <xsd:group ref="javaee:resourceBaseGroup"/>
  1177. </xsd:sequence>
  1178. <xsd:attribute name="id"
  1179. type="xsd:ID"/>
  1180. </xsd:complexType>
  1181. <!-- **************************************************** -->
  1182. <xsd:complexType name="persistence-context-typeType">
  1183. <xsd:annotation>
  1184. <xsd:documentation>
  1185. The persistence-context-typeType specifies the transactional
  1186. nature of a persistence context reference.
  1187. The value of the persistence-context-type element must be
  1188. one of the following:
  1189. Transaction
  1190. Extended
  1191. </xsd:documentation>
  1192. </xsd:annotation>
  1193. <xsd:simpleContent>
  1194. <xsd:restriction base="javaee:string">
  1195. <xsd:enumeration value="Transaction"/>
  1196. <xsd:enumeration value="Extended"/>
  1197. </xsd:restriction>
  1198. </xsd:simpleContent>
  1199. </xsd:complexType>
  1200. <!-- **************************************************** -->
  1201. <xsd:complexType name="propertyType">
  1202. <xsd:annotation>
  1203. <xsd:documentation>
  1204. Specifies a name/value pair.
  1205. </xsd:documentation>
  1206. </xsd:annotation>
  1207. <xsd:sequence>
  1208. <xsd:element name="name"
  1209. type="javaee:xsdStringType">
  1210. </xsd:element>
  1211. <xsd:element name="value"
  1212. type="javaee:xsdStringType">
  1213. </xsd:element>
  1214. </xsd:sequence>
  1215. <xsd:attribute name="id"
  1216. type="xsd:ID"/>
  1217. </xsd:complexType>
  1218. <!-- **************************************************** -->
  1219. <xsd:complexType name="persistence-unit-refType">
  1220. <xsd:annotation>
  1221. <xsd:documentation>
  1222. <![CDATA[[
  1223. The persistence-unit-ref element contains a declaration
  1224. of Deployment Component's reference to a persistence unit
  1225. associated within a Deployment Component's
  1226. environment. It consists of:
  1227. - an optional description
  1228. - the persistence unit reference name
  1229. - an optional persistence unit name. If not specified,
  1230. the default persistence unit is assumed.
  1231. - optional injection targets
  1232. Examples:
  1233. <persistence-unit-ref>
  1234. <persistence-unit-ref-name>myPersistenceUnit
  1235. </persistence-unit-ref-name>
  1236. </persistence-unit-ref>
  1237. <persistence-unit-ref>
  1238. <persistence-unit-ref-name>myPersistenceUnit
  1239. </persistence-unit-ref-name>
  1240. <persistence-unit-name>PersistenceUnit1
  1241. </persistence-unit-name>
  1242. </persistence-unit-ref>
  1243. ]]>
  1244. </xsd:documentation>
  1245. </xsd:annotation>
  1246. <xsd:sequence>
  1247. <xsd:element name="description"
  1248. type="javaee:descriptionType"
  1249. minOccurs="0"
  1250. maxOccurs="unbounded"/>
  1251. <xsd:element name="persistence-unit-ref-name"
  1252. type="javaee:jndi-nameType">
  1253. <xsd:annotation>
  1254. <xsd:documentation>
  1255. The persistence-unit-ref-name element specifies
  1256. the name of a persistence unit reference; its
  1257. value is the environment entry name used in
  1258. Deployment Component code. The name is a JNDI name
  1259. relative to the java:comp/env context.
  1260. </xsd:documentation>
  1261. </xsd:annotation>
  1262. </xsd:element>
  1263. <xsd:element name="persistence-unit-name"
  1264. type="javaee:string"
  1265. minOccurs="0">
  1266. <xsd:annotation>
  1267. <xsd:documentation>
  1268. The Application Assembler(or BeanProvider) may use the
  1269. following syntax to avoid the need to rename persistence
  1270. units to have unique names within a Java EE application.
  1271. The Application Assembler specifies the pathname of the
  1272. root of the persistence.xml file for the referenced
  1273. persistence unit and appends the name of the persistence
  1274. unit separated from the pathname by #. The pathname is
  1275. relative to the referencing application component jar file.
  1276. In this manner, multiple persistence units with the same
  1277. persistence unit name may be uniquely identified when the
  1278. Application Assembler cannot change persistence unit names.
  1279. </xsd:documentation>
  1280. </xsd:annotation>
  1281. </xsd:element>
  1282. <xsd:group ref="javaee:resourceBaseGroup"/>
  1283. </xsd:sequence>
  1284. <xsd:attribute name="id"
  1285. type="xsd:ID"/>
  1286. </xsd:complexType>
  1287. <!-- **************************************************** -->
  1288. <xsd:complexType name="remoteType">
  1289. <xsd:annotation>
  1290. <xsd:documentation>
  1291. <![CDATA[[
  1292. The remote element contains the fully-qualified name
  1293. of the enterprise bean's remote interface.
  1294. Example:
  1295. <remote>com.wombat.empl.EmployeeService</remote>
  1296. ]]>
  1297. </xsd:documentation>
  1298. </xsd:annotation>
  1299. <xsd:simpleContent>
  1300. <xsd:restriction base="javaee:fully-qualified-classType"/>
  1301. </xsd:simpleContent>
  1302. </xsd:complexType>
  1303. <!-- **************************************************** -->
  1304. <xsd:complexType name="resource-env-refType">
  1305. <xsd:annotation>
  1306. <xsd:documentation>
  1307. <![CDATA[[
  1308. The resource-env-refType is used to define
  1309. resource-env-ref elements. It contains a declaration of a
  1310. Deployment Component's reference to an administered object
  1311. associated with a resource in the Deployment Component's
  1312. environment. It consists of an optional description, the
  1313. resource environment reference name, and an optional
  1314. indication of the resource environment reference type
  1315. expected by the Deployment Component code.
  1316. It also includes optional elements to define injection of
  1317. the named resource into fields or JavaBeans properties.
  1318. The resource environment type must be supplied unless an
  1319. injection target is specified, in which case the type
  1320. of the target is used. If both are specified, the type
  1321. must be assignment compatible with the type of the injection
  1322. target.
  1323. Example:
  1324. <resource-env-ref>
  1325. <resource-env-ref-name>jms/StockQueue
  1326. </resource-env-ref-name>
  1327. <resource-env-ref-type>javax.jms.Queue
  1328. </resource-env-ref-type>
  1329. </resource-env-ref>
  1330. ]]>
  1331. </xsd:documentation>
  1332. </xsd:annotation>
  1333. <xsd:sequence>
  1334. <xsd:element name="description"
  1335. type="javaee:descriptionType"
  1336. minOccurs="0"
  1337. maxOccurs="unbounded"/>
  1338. <xsd:element name="resource-env-ref-name"
  1339. type="javaee:jndi-nameType">
  1340. <xsd:annotation>
  1341. <xsd:documentation>
  1342. The resource-env-ref-name element specifies the name
  1343. of a resource environment reference; its value is
  1344. the environment entry name used in
  1345. the Deployment Component code. The name is a JNDI
  1346. name relative to the java:comp/env context and must
  1347. be unique within a Deployment Component.
  1348. </xsd:documentation>
  1349. </xsd:annotation>
  1350. </xsd:element>
  1351. <xsd:element name="resource-env-ref-type"
  1352. type="javaee:fully-qualified-classType"
  1353. minOccurs="0">
  1354. <xsd:annotation>
  1355. <xsd:documentation>
  1356. The resource-env-ref-type element specifies the type
  1357. of a resource environment reference. It is the
  1358. fully qualified name of a Java language class or
  1359. interface.
  1360. </xsd:documentation>
  1361. </xsd:annotation>
  1362. </xsd:element>
  1363. <xsd:group ref="javaee:resourceGroup"/>
  1364. </xsd:sequence>
  1365. <xsd:attribute name="id"
  1366. type="xsd:ID"/>
  1367. </xsd:complexType>
  1368. <!-- **************************************************** -->
  1369. <xsd:complexType name="resource-refType">
  1370. <xsd:annotation>
  1371. <xsd:documentation>
  1372. <![CDATA[[
  1373. The resource-refType contains a declaration of a
  1374. Deployment Component's reference to an external resource. It
  1375. consists of an optional description, the resource manager
  1376. connection factory reference name, an optional indication of
  1377. the resource manager connection factory type expected by the
  1378. Deployment Component code, an optional type of authentication
  1379. (Application or Container), and an optional specification of
  1380. the shareability of connections obtained from the resource
  1381. (Shareable or Unshareable).
  1382. It also includes optional elements to define injection of
  1383. the named resource into fields or JavaBeans properties.
  1384. The connection factory type must be supplied unless an
  1385. injection target is specified, in which case the type
  1386. of the target is used. If both are specified, the type
  1387. must be assignment compatible with the type of the injection
  1388. target.
  1389. Example:
  1390. <resource-ref>
  1391. <res-ref-name>jdbc/EmployeeAppDB</res-ref-name>
  1392. <res-type>javax.sql.DataSource</res-type>
  1393. <res-auth>Container</res-auth>
  1394. <res-sharing-scope>Shareable</res-sharing-scope>
  1395. </resource-ref>
  1396. ]]>
  1397. </xsd:documentation>
  1398. </xsd:annotation>
  1399. <xsd:sequence>
  1400. <xsd:element name="description"
  1401. type="javaee:descriptionType"
  1402. minOccurs="0"
  1403. maxOccurs="unbounded"/>
  1404. <xsd:element name="res-ref-name"
  1405. type="javaee:jndi-nameType">
  1406. <xsd:annotation>
  1407. <xsd:documentation>
  1408. The res-ref-name element specifies the name of a
  1409. resource manager connection factory reference.
  1410. The name is a JNDI name relative to the
  1411. java:comp/env context.
  1412. The name must be unique within a Deployment File.
  1413. </xsd:documentation>
  1414. </xsd:annotation>
  1415. </xsd:element>
  1416. <xsd:element name="res-type"
  1417. type="javaee:fully-qualified-classType"
  1418. minOccurs="0">
  1419. <xsd:annotation>
  1420. <xsd:documentation>
  1421. The res-type element specifies the type of the data
  1422. source. The type is specified by the fully qualified
  1423. Java language class or interface
  1424. expected to be implemented by the data source.
  1425. </xsd:documentation>
  1426. </xsd:annotation>
  1427. </xsd:element>
  1428. <xsd:element name="res-auth"
  1429. type="javaee:res-authType"
  1430. minOccurs="0"/>
  1431. <xsd:element name="res-sharing-scope"
  1432. type="javaee:res-sharing-scopeType"
  1433. minOccurs="0"/>
  1434. <xsd:group ref="javaee:resourceGroup"/>
  1435. </xsd:sequence>
  1436. <xsd:attribute name="id"
  1437. type="xsd:ID"/>
  1438. </xsd:complexType>
  1439. <!-- **************************************************** -->
  1440. <xsd:complexType name="res-authType">
  1441. <xsd:annotation>
  1442. <xsd:documentation>
  1443. The res-authType specifies whether the Deployment Component
  1444. code signs on programmatically to the resource manager, or
  1445. whether the Container will sign on to the resource manager
  1446. on behalf of the Deployment Component. In the latter case,
  1447. the Container uses information that is supplied by the
  1448. Deployer.
  1449. The value must be one of the two following:
  1450. Application
  1451. Container
  1452. </xsd:documentation>
  1453. </xsd:annotation>
  1454. <xsd:simpleContent>
  1455. <xsd:restriction base="javaee:string">
  1456. <xsd:enumeration value="Application"/>
  1457. <xsd:enumeration value="Container"/>
  1458. </xsd:restriction>
  1459. </xsd:simpleContent>
  1460. </xsd:complexType>
  1461. <!-- **************************************************** -->
  1462. <xsd:complexType name="res-sharing-scopeType">
  1463. <xsd:annotation>
  1464. <xsd:documentation>
  1465. The res-sharing-scope type specifies whether connections
  1466. obtained through the given resource manager connection
  1467. factory reference can be shared. The value, if specified,
  1468. must be one of the two following:
  1469. Shareable
  1470. Unshareable
  1471. The default value is Shareable.
  1472. </xsd:documentation>
  1473. </xsd:annotation>
  1474. <xsd:simpleContent>
  1475. <xsd:restriction base="javaee:string">
  1476. <xsd:enumeration value="Shareable"/>
  1477. <xsd:enumeration value="Unshareable"/>
  1478. </xsd:restriction>
  1479. </xsd:simpleContent>
  1480. </xsd:complexType>
  1481. <!-- **************************************************** -->
  1482. <xsd:complexType name="run-asType">
  1483. <xsd:annotation>
  1484. <xsd:documentation>
  1485. The run-asType specifies the run-as identity to be
  1486. used for the execution of a component. It contains an
  1487. optional description, and the name of a security role.
  1488. </xsd:documentation>
  1489. </xsd:annotation>
  1490. <xsd:sequence>
  1491. <xsd:element name="description"
  1492. type="javaee:descriptionType"
  1493. minOccurs="0"
  1494. maxOccurs="unbounded"/>
  1495. <xsd:element name="role-name"
  1496. type="javaee:role-nameType"/>
  1497. </xsd:sequence>
  1498. <xsd:attribute name="id"
  1499. type="xsd:ID"/>
  1500. </xsd:complexType>
  1501. <!-- **************************************************** -->
  1502. <xsd:complexType name="role-nameType">
  1503. <xsd:annotation>
  1504. <xsd:documentation>
  1505. The role-nameType designates the name of a security role.
  1506. The name must conform to the lexical rules for a token.
  1507. </xsd:documentation>
  1508. </xsd:annotation>
  1509. <xsd:simpleContent>
  1510. <xsd:restriction base="javaee:string"/>
  1511. </xsd:simpleContent>
  1512. </xsd:complexType>
  1513. <!-- **************************************************** -->
  1514. <xsd:complexType name="security-roleType">
  1515. <xsd:annotation>
  1516. <xsd:documentation>
  1517. <![CDATA[[
  1518. The security-roleType contains the definition of a security
  1519. role. The definition consists of an optional description of
  1520. the security role, and the security role name.
  1521. Example:
  1522. <security-role>
  1523. <description>
  1524. This role includes all employees who are authorized
  1525. to access the employee service application.
  1526. </description>
  1527. <role-name>employee</role-name>
  1528. </security-role>
  1529. ]]>
  1530. </xsd:documentation>
  1531. </xsd:annotation>
  1532. <xsd:sequence>
  1533. <xsd:element name="description"
  1534. type="javaee:descriptionType"
  1535. minOccurs="0"
  1536. maxOccurs="unbounded"/>
  1537. <xsd:element name="role-name"
  1538. type="javaee:role-nameType"/>
  1539. </xsd:sequence>
  1540. <xsd:attribute name="id"
  1541. type="xsd:ID"/>
  1542. </xsd:complexType>
  1543. <!-- **************************************************** -->
  1544. <xsd:complexType name="security-role-refType">
  1545. <xsd:annotation>
  1546. <xsd:documentation>
  1547. The security-role-refType contains the declaration of a
  1548. security role reference in a component's or a
  1549. Deployment Component's code. The declaration consists of an
  1550. optional description, the security role name used in the
  1551. code, and an optional link to a security role. If the
  1552. security role is not specified, the Deployer must choose an
  1553. appropriate security role.
  1554. </xsd:documentation>
  1555. </xsd:annotation>
  1556. <xsd:sequence>
  1557. <xsd:element name="description"
  1558. type="javaee:descriptionType"
  1559. minOccurs="0"
  1560. maxOccurs="unbounded"/>
  1561. <xsd:element name="role-name"
  1562. type="javaee:role-nameType">
  1563. <xsd:annotation>
  1564. <xsd:documentation>
  1565. The value of the role-name element must be the String used
  1566. as the parameter to the
  1567. EJBContext.isCallerInRole(String roleName) method or the
  1568. HttpServletRequest.isUserInRole(String role) method.
  1569. </xsd:documentation>
  1570. </xsd:annotation>
  1571. </xsd:element>
  1572. <xsd:element name="role-link"
  1573. type="javaee:role-nameType"
  1574. minOccurs="0">
  1575. <xsd:annotation>
  1576. <xsd:documentation>
  1577. The role-link element is a reference to a defined
  1578. security role. The role-link element must contain
  1579. the name of one of the security roles defined in the
  1580. security-role elements.
  1581. </xsd:documentation>
  1582. </xsd:annotation>
  1583. </xsd:element>
  1584. </xsd:sequence>
  1585. <xsd:attribute name="id"
  1586. type="xsd:ID"/>
  1587. </xsd:complexType>
  1588. <!-- **************************************************** -->
  1589. <xsd:complexType name="xsdQNameType">
  1590. <xsd:annotation>
  1591. <xsd:documentation>
  1592. This type adds an "id" attribute to xsd:QName.
  1593. </xsd:documentation>
  1594. </xsd:annotation>
  1595. <xsd:simpleContent>
  1596. <xsd:extension base="xsd:QName">
  1597. <xsd:attribute name="id"
  1598. type="xsd:ID"/>
  1599. </xsd:extension>
  1600. </xsd:simpleContent>
  1601. </xsd:complexType>
  1602. <!-- **************************************************** -->
  1603. <xsd:complexType name="xsdBooleanType">
  1604. <xsd:annotation>
  1605. <xsd:documentation>
  1606. This type adds an "id" attribute to xsd:boolean.
  1607. </xsd:documentation>
  1608. </xsd:annotation>
  1609. <xsd:simpleContent>
  1610. <xsd:extension base="xsd:boolean">
  1611. <xsd:attribute name="id"
  1612. type="xsd:ID"/>
  1613. </xsd:extension>
  1614. </xsd:simpleContent>
  1615. </xsd:complexType>
  1616. <!-- **************************************************** -->
  1617. <xsd:complexType name="xsdNMTOKENType">
  1618. <xsd:annotation>
  1619. <xsd:documentation>
  1620. This type adds an "id" attribute to xsd:NMTOKEN.
  1621. </xsd:documentation>
  1622. </xsd:annotation>
  1623. <xsd:simpleContent>
  1624. <xsd:extension base="xsd:NMTOKEN">
  1625. <xsd:attribute name="id"
  1626. type="xsd:ID"/>
  1627. </xsd:extension>
  1628. </xsd:simpleContent>
  1629. </xsd:complexType>
  1630. <!-- **************************************************** -->
  1631. <xsd:complexType name="xsdAnyURIType">
  1632. <xsd:annotation>
  1633. <xsd:documentation>
  1634. This type adds an "id" attribute to xsd:anyURI.
  1635. </xsd:documentation>
  1636. </xsd:annotation>
  1637. <xsd:simpleContent>
  1638. <xsd:extension base="xsd:anyURI">
  1639. <xsd:attribute name="id"
  1640. type="xsd:ID"/>
  1641. </xsd:extension>
  1642. </xsd:simpleContent>
  1643. </xsd:complexType>
  1644. <!-- **************************************************** -->
  1645. <xsd:complexType name="xsdIntegerType">
  1646. <xsd:annotation>
  1647. <xsd:documentation>
  1648. This type adds an "id" attribute to xsd:integer.
  1649. </xsd:documentation>
  1650. </xsd:annotation>
  1651. <xsd:simpleContent>
  1652. <xsd:extension base="xsd:integer">
  1653. <xsd:attribute name="id"
  1654. type="xsd:ID"/>
  1655. </xsd:extension>
  1656. </xsd:simpleContent>
  1657. </xsd:complexType>
  1658. <!-- **************************************************** -->
  1659. <xsd:complexType name="xsdPositiveIntegerType">
  1660. <xsd:annotation>
  1661. <xsd:documentation>
  1662. This type adds an "id" attribute to xsd:positiveInteger.
  1663. </xsd:documentation>
  1664. </xsd:annotation>
  1665. <xsd:simpleContent>
  1666. <xsd:extension base="xsd:positiveInteger">
  1667. <xsd:attribute name="id"
  1668. type="xsd:ID"/>
  1669. </xsd:extension>
  1670. </xsd:simpleContent>
  1671. </xsd:complexType>
  1672. <!-- **************************************************** -->
  1673. <xsd:complexType name="xsdNonNegativeIntegerType">
  1674. <xsd:annotation>
  1675. <xsd:documentation>
  1676. This type adds an "id" attribute to xsd:nonNegativeInteger.
  1677. </xsd:documentation>
  1678. </xsd:annotation>
  1679. <xsd:simpleContent>
  1680. <xsd:extension base="xsd:nonNegativeInteger">
  1681. <xsd:attribute name="id"
  1682. type="xsd:ID"/>
  1683. </xsd:extension>
  1684. </xsd:simpleContent>
  1685. </xsd:complexType>
  1686. <!-- **************************************************** -->
  1687. <xsd:complexType name="xsdStringType">
  1688. <xsd:annotation>
  1689. <xsd:documentation>
  1690. This type adds an "id" attribute to xsd:string.
  1691. </xsd:documentation>
  1692. </xsd:annotation>
  1693. <xsd:simpleContent>
  1694. <xsd:extension base="xsd:string">
  1695. <xsd:attribute name="id"
  1696. type="xsd:ID"/>
  1697. </xsd:extension>
  1698. </xsd:simpleContent>
  1699. </xsd:complexType>
  1700. <!-- **************************************************** -->
  1701. <xsd:complexType name="string">
  1702. <xsd:annotation>
  1703. <xsd:documentation>
  1704. This is a special string datatype that is defined by Java EE as
  1705. a base type for defining collapsed strings. When schemas
  1706. require trailing/leading space elimination as well as
  1707. collapsing the existing whitespace, this base type may be
  1708. used.
  1709. </xsd:documentation>
  1710. </xsd:annotation>
  1711. <xsd:simpleContent>
  1712. <xsd:extension base="xsd:token">
  1713. <xsd:attribute name="id"
  1714. type="xsd:ID"/>
  1715. </xsd:extension>
  1716. </xsd:simpleContent>
  1717. </xsd:complexType>
  1718. <!-- **************************************************** -->
  1719. <xsd:complexType name="true-falseType">
  1720. <xsd:annotation>
  1721. <xsd:documentation>
  1722. This simple type designates a boolean with only two
  1723. permissible values
  1724. - true
  1725. - false
  1726. </xsd:documentation>
  1727. </xsd:annotation>
  1728. <xsd:simpleContent>
  1729. <xsd:restriction base="javaee:xsdBooleanType">
  1730. <xsd:pattern value="(true|false)"/>
  1731. </xsd:restriction>
  1732. </xsd:simpleContent>
  1733. </xsd:complexType>
  1734. <!-- **************************************************** -->
  1735. <xsd:complexType name="url-patternType">
  1736. <xsd:annotation>
  1737. <xsd:documentation>
  1738. The url-patternType contains the url pattern of the mapping.
  1739. It must follow the rules specified in Section 11.2 of the
  1740. Servlet API Specification. This pattern is assumed to be in
  1741. URL-decoded form and must not contain CR(#xD) or LF(#xA).
  1742. If it contains those characters, the container must inform
  1743. the developer with a descriptive error message.
  1744. The container must preserve all characters including whitespaces.
  1745. </xsd:documentation>
  1746. </xsd:annotation>
  1747. <xsd:simpleContent>
  1748. <xsd:extension base="xsd:string"/>
  1749. </xsd:simpleContent>
  1750. </xsd:complexType>
  1751. <!-- **************************************************** -->
  1752. <xsd:complexType name="message-destinationType">
  1753. <xsd:annotation>
  1754. <xsd:documentation>
  1755. <![CDATA[[
  1756. The message-destinationType specifies a message
  1757. destination. The logical destination described by this
  1758. element is mapped to a physical destination by the Deployer.
  1759. The message destination element contains:
  1760. - an optional description
  1761. - an optional display-name
  1762. - an optional icon
  1763. - a message destination name which must be unique
  1764. among message destination names within the same
  1765. Deployment File.
  1766. - an optional mapped name
  1767. - an optional lookup name
  1768. Example:
  1769. <message-destination>
  1770. <message-destination-name>CorporateStocks
  1771. </message-destination-name>
  1772. </message-destination>
  1773. ]]>
  1774. </xsd:documentation>
  1775. </xsd:annotation>
  1776. <xsd:sequence>
  1777. <xsd:group ref="javaee:descriptionGroup"/>
  1778. <xsd:element name="message-destination-name"
  1779. type="javaee:string">
  1780. <xsd:annotation>
  1781. <xsd:documentation>
  1782. The message-destination-name element specifies a
  1783. name for a message destination. This name must be
  1784. unique among the names of message destinations
  1785. within the Deployment File.
  1786. </xsd:documentation>
  1787. </xsd:annotation>
  1788. </xsd:element>
  1789. <xsd:element name="mapped-name"
  1790. type="javaee:xsdStringType"
  1791. minOccurs="0">
  1792. <xsd:annotation>
  1793. <xsd:documentation>
  1794. A product specific name that this message destination
  1795. should be mapped to. Each message-destination-ref
  1796. element that references this message destination will
  1797. define a name in the namespace of the referencing
  1798. component or in one of the other predefined namespaces.
  1799. Many application servers provide a way to map these
  1800. local names to names of resources known to the
  1801. application server. This mapped name is often a global
  1802. JNDI name, but may be a name of any form. Each of the
  1803. local names should be mapped to this same global name.
  1804. Application servers are not required to support any
  1805. particular form or type of mapped name, nor the ability
  1806. to use mapped names. The mapped name is
  1807. product-dependent and often installation-dependent. No
  1808. use of a mapped name is portable.
  1809. </xsd:documentation>
  1810. </xsd:annotation>
  1811. </xsd:element>
  1812. <xsd:element name="lookup-name"
  1813. type="javaee:xsdStringType"
  1814. minOccurs="0">
  1815. <xsd:annotation>
  1816. <xsd:documentation>
  1817. The JNDI name to be looked up to resolve the message destination.
  1818. </xsd:documentation>
  1819. </xsd:annotation>
  1820. </xsd:element>
  1821. </xsd:sequence>
  1822. <xsd:attribute name="id"
  1823. type="xsd:ID"/>
  1824. </xsd:complexType>
  1825. <!-- **************************************************** -->
  1826. <xsd:complexType name="message-destination-refType">
  1827. <xsd:annotation>
  1828. <xsd:documentation>
  1829. <![CDATA[[
  1830. The message-destination-ref element contains a declaration
  1831. of Deployment Component's reference to a message destination
  1832. associated with a resource in Deployment Component's
  1833. environment. It consists of:
  1834. - an optional description
  1835. - the message destination reference name
  1836. - an optional message destination type
  1837. - an optional specification as to whether
  1838. the destination is used for
  1839. consuming or producing messages, or both.
  1840. if not specified, "both" is assumed.
  1841. - an optional link to the message destination
  1842. - optional injection targets
  1843. The message destination type must be supplied unless an
  1844. injection target is specified, in which case the type
  1845. of the target is used. If both are specified, the type
  1846. must be assignment compatible with the type of the injection
  1847. target.
  1848. Examples:
  1849. <message-destination-ref>
  1850. <message-destination-ref-name>jms/StockQueue
  1851. </message-destination-ref-name>
  1852. <message-destination-type>javax.jms.Queue
  1853. </message-destination-type>
  1854. <message-destination-usage>Consumes
  1855. </message-destination-usage>
  1856. <message-destination-link>CorporateStocks
  1857. </message-destination-link>
  1858. </message-destination-ref>
  1859. ]]>
  1860. </xsd:documentation>
  1861. </xsd:annotation>
  1862. <xsd:sequence>
  1863. <xsd:element name="description"
  1864. type="javaee:descriptionType"
  1865. minOccurs="0"
  1866. maxOccurs="unbounded"/>
  1867. <xsd:element name="message-destination-ref-name"
  1868. type="javaee:jndi-nameType">
  1869. <xsd:annotation>
  1870. <xsd:documentation>
  1871. The message-destination-ref-name element specifies
  1872. the name of a message destination reference; its
  1873. value is the environment entry name used in
  1874. Deployment Component code.
  1875. </xsd:documentation>
  1876. </xsd:annotation>
  1877. </xsd:element>
  1878. <xsd:element name="message-destination-type"
  1879. type="javaee:message-destination-typeType"
  1880. minOccurs="0"/>
  1881. <xsd:element name="message-destination-usage"
  1882. type="javaee:message-destination-usageType"
  1883. minOccurs="0"/>
  1884. <xsd:element name="message-destination-link"
  1885. type="javaee:message-destination-linkType"
  1886. minOccurs="0"/>
  1887. <xsd:group ref="javaee:resourceGroup"/>
  1888. </xsd:sequence>
  1889. <xsd:attribute name="id"
  1890. type="xsd:ID"/>
  1891. </xsd:complexType>
  1892. <!-- **************************************************** -->
  1893. <xsd:complexType name="message-destination-usageType">
  1894. <xsd:annotation>
  1895. <xsd:documentation>
  1896. The message-destination-usageType specifies the use of the
  1897. message destination indicated by the reference. The value
  1898. indicates whether messages are consumed from the message
  1899. destination, produced for the destination, or both. The
  1900. Assembler makes use of this information in linking producers
  1901. of a destination with its consumers.
  1902. The value of the message-destination-usage element must be
  1903. one of the following:
  1904. Consumes
  1905. Produces
  1906. ConsumesProduces
  1907. </xsd:documentation>
  1908. </xsd:annotation>
  1909. <xsd:simpleContent>
  1910. <xsd:restriction base="javaee:string">
  1911. <xsd:enumeration value="Consumes"/>
  1912. <xsd:enumeration value="Produces"/>
  1913. <xsd:enumeration value="ConsumesProduces"/>
  1914. </xsd:restriction>
  1915. </xsd:simpleContent>
  1916. </xsd:complexType>
  1917. <!-- **************************************************** -->
  1918. <xsd:complexType name="message-destination-typeType">
  1919. <xsd:annotation>
  1920. <xsd:documentation>
  1921. <![CDATA[[
  1922. The message-destination-typeType specifies the type of
  1923. the destination. The type is specified by the Java interface
  1924. expected to be implemented by the destination.
  1925. Example:
  1926. <message-destination-type>javax.jms.Queue
  1927. </message-destination-type>
  1928. ]]>
  1929. </xsd:documentation>
  1930. </xsd:annotation>
  1931. <xsd:simpleContent>
  1932. <xsd:restriction base="javaee:fully-qualified-classType"/>
  1933. </xsd:simpleContent>
  1934. </xsd:complexType>
  1935. <!-- **************************************************** -->
  1936. <xsd:complexType name="message-destination-linkType">
  1937. <xsd:annotation>
  1938. <xsd:documentation>
  1939. The message-destination-linkType is used to link a message
  1940. destination reference or message-driven bean to a message
  1941. destination.
  1942. The Assembler sets the value to reflect the flow of messages
  1943. between producers and consumers in the application.
  1944. The value must be the message-destination-name of a message
  1945. destination in the same Deployment File or in another
  1946. Deployment File in the same Java EE application unit.
  1947. Alternatively, the value may be composed of a path name
  1948. specifying a Deployment File containing the referenced
  1949. message destination with the message-destination-name of the
  1950. destination appended and separated from the path name by
  1951. "#". The path name is relative to the Deployment File
  1952. containing Deployment Component that is referencing the
  1953. message destination. This allows multiple message
  1954. destinations with the same name to be uniquely identified.
  1955. </xsd:documentation>
  1956. </xsd:annotation>
  1957. <xsd:simpleContent>
  1958. <xsd:restriction base="javaee:string"/>
  1959. </xsd:simpleContent>
  1960. </xsd:complexType>
  1961. </xsd:schema>