jboss-ejb-client_1_2.xsd 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. ~ JBoss, Home of Professional Open Source.
  4. ~ Copyright 2012, Red Hat, Inc., and individual contributors
  5. ~ as indicated by the @author tags. See the copyright.txt file in the
  6. ~ distribution for a full listing of individual contributors.
  7. ~
  8. ~ This is free software; you can redistribute it and/or modify it
  9. ~ under the terms of the GNU Lesser General Public License as
  10. ~ published by the Free Software Foundation; either version 2.1 of
  11. ~ the License, or (at your option) any later version.
  12. ~
  13. ~ This software is distributed in the hope that it will be useful,
  14. ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16. ~ Lesser General Public License for more details.
  17. ~
  18. ~ You should have received a copy of the GNU Lesser General Public
  19. ~ License along with this software; if not, write to the Free
  20. ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21. ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  22. -->
  23. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  24. targetNamespace="urn:jboss:ejb-client:1.2"
  25. xmlns="urn:jboss:ejb-client:1.2"
  26. elementFormDefault="unqualified"
  27. attributeFormDefault="unqualified"
  28. version="1.2">
  29. <!-- Root element -->
  30. <xsd:element name="jboss-ejb-client" type="jboss-ejb-clientType">
  31. <xsd:annotation>
  32. <xsd:documentation>
  33. Root element for a jboss-ejb-client.xml file
  34. </xsd:documentation>
  35. </xsd:annotation>
  36. </xsd:element>
  37. <xsd:complexType name="jboss-ejb-clientType">
  38. <xsd:annotation>
  39. <xsd:documentation>
  40. The EJB client configurations
  41. </xsd:documentation>
  42. </xsd:annotation>
  43. <xsd:all>
  44. <xsd:element name="client-context" type="client-contextType">
  45. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  46. <documentation>
  47. Configurations that will be used to setup an EJB client context for the
  48. deployment.
  49. </documentation>
  50. </annotation>
  51. </xsd:element>
  52. </xsd:all>
  53. </xsd:complexType>
  54. <xsd:complexType name="client-contextType">
  55. <xsd:all>
  56. <xsd:element name="ejb-receivers" type="ejb-receiversType">
  57. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  58. <documentation>
  59. Configures EJB receivers for the client context
  60. </documentation>
  61. </annotation>
  62. </xsd:element>
  63. <xsd:element name="clusters" type="clustersType">
  64. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  65. <documentation>
  66. Cluster configurations applicable for this client context
  67. </documentation>
  68. </annotation>
  69. </xsd:element>
  70. </xsd:all>
  71. <xsd:attribute name="invocation-timeout" type="xsd:long" use="optional">
  72. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  73. <documentation>
  74. A timeout, in milliseconds, that will be used for EJB invocations. A value of zero
  75. or a negative value will imply a "wait forever" semantic where the invocation will never timeout
  76. and the client will wait for the invocation result indefinitely.
  77. </documentation>
  78. </annotation>
  79. </xsd:attribute>
  80. <xsd:attribute name="deployment-node-selector" type="xsd:string" use="optional">
  81. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  82. <documentation>
  83. The fully qualified classname of the class which implements the
  84. org.jboss.ejb.client.DeploymentNodeSelector
  85. interface. The instance of this class will be used for selecting nodes, from among multiple eligible
  86. nodes within a EJB client context, which can handle a particular deployment
  87. </documentation>
  88. </annotation>
  89. </xsd:attribute>
  90. </xsd:complexType>
  91. <xsd:complexType name="ejb-receiversType">
  92. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  93. <xsd:element name="remoting-ejb-receiver" type="remoting-ejb-receiverType">
  94. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  95. <documentation>
  96. Configures a remoting based EJB receiver
  97. </documentation>
  98. </annotation>
  99. </xsd:element>
  100. </xsd:choice>
  101. <xsd:attribute name="exclude-local-receiver" type="xsd:boolean" use="optional" default="false">
  102. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  103. <documentation>
  104. Set to true if the local receiver which gets added to the EJB client context by default, has to be
  105. excluded from the context
  106. </documentation>
  107. </annotation>
  108. </xsd:attribute>
  109. <xsd:attribute name="local-receiver-pass-by-value" type="xsd:boolean" use="optional" default="true">
  110. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  111. <documentation>
  112. Set to false if the local receiver that's available in the EJB client context, should use
  113. pass-by-reference (instead of pass-by-value) semantics for the EJB invocations.
  114. </documentation>
  115. </annotation>
  116. </xsd:attribute>
  117. </xsd:complexType>
  118. <xsd:complexType name="remoting-ejb-receiverType">
  119. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  120. <xsd:element name="channel-creation-options" type="channel-creation-optionsType" maxOccurs="1">
  121. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  122. <documentation>
  123. Configures the channel creation options for this remoting EJB receiver
  124. </documentation>
  125. </annotation>
  126. </xsd:element>
  127. </xsd:choice>
  128. <xsd:attribute name="outbound-connection-ref" type="xsd:string" use="required">
  129. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  130. <documentation>
  131. Reference to an outbound connection configured in the remoting subsytem
  132. </documentation>
  133. </annotation>
  134. </xsd:attribute>
  135. <xsd:attribute name="connect-timeout" type="xsd:long" use="optional">
  136. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  137. <documentation>
  138. The timeout, in milliseconds, to be used while creating a connection
  139. </documentation>
  140. </annotation>
  141. </xsd:attribute>
  142. </xsd:complexType>
  143. <xsd:complexType name="clustersType">
  144. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  145. <xsd:element name="cluster" type="clusterType">
  146. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  147. <documentation>
  148. Configures a cluster in the client context
  149. </documentation>
  150. </annotation>
  151. </xsd:element>
  152. </xsd:choice>
  153. </xsd:complexType>
  154. <xsd:complexType name="clusterType">
  155. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  156. <xsd:element name="channel-creation-options" type="channel-creation-optionsType" maxOccurs="1">
  157. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  158. <documentation>
  159. Configures the channel creation options for the nodes in this cluster
  160. </documentation>
  161. </annotation>
  162. </xsd:element>
  163. <xsd:element name="connection-creation-options" type="connection-creation-optionsType" maxOccurs="1">
  164. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  165. <documentation>
  166. Configures the connection creation options for the nodes in this cluster
  167. </documentation>
  168. </annotation>
  169. </xsd:element>
  170. <xsd:element name="node" type="clusterNodeType" maxOccurs="unbounded">
  171. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  172. <documentation>
  173. Configures the channel creation options for the nodes in this cluster
  174. </documentation>
  175. </annotation>
  176. </xsd:element>
  177. </xsd:choice>
  178. <xsd:attribute name="name" type="xsd:string" use="required">
  179. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  180. <documentation>
  181. The name of the cluster
  182. </documentation>
  183. </annotation>
  184. </xsd:attribute>
  185. <xsd:attribute name="connect-timeout" type="xsd:long" use="optional">
  186. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  187. <documentation>
  188. The timeout in milliseconds while creating a connection for the nodes in the cluster
  189. </documentation>
  190. </annotation>
  191. </xsd:attribute>
  192. <xsd:attribute name="max-allowed-connected-nodes" type="xsd:long" use="optional">
  193. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  194. <documentation>
  195. The maximum number of nodes to which the connection will be established in the cluster
  196. </documentation>
  197. </annotation>
  198. </xsd:attribute>
  199. <xsd:attribute name="cluster-node-selector" type="xsd:string" use="optional">
  200. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  201. <documentation>
  202. The fully qualified classname of the class which implements the
  203. org.jboss.ejb.client.ClusterNodeSelector
  204. interface. The instance of this class will be used for selecting nodes, within the cluster, for
  205. handling
  206. invocations
  207. </documentation>
  208. </annotation>
  209. </xsd:attribute>
  210. <xsd:attribute name="username" type="xsd:string" use="optional">
  211. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  212. <documentation>
  213. The username that will be used for authentication during connection creation for nodes in the
  214. cluster
  215. </documentation>
  216. </annotation>
  217. </xsd:attribute>
  218. <xsd:attribute name="security-realm" type="xsd:string" use="optional">
  219. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  220. <documentation>
  221. The security-realm that will be used for authentication during connection creation for nodes in the
  222. cluster
  223. </documentation>
  224. </annotation>
  225. </xsd:attribute>
  226. </xsd:complexType>
  227. <xsd:complexType name="clusterNodeType">
  228. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  229. <xsd:element name="channel-creation-options" type="channel-creation-optionsType" maxOccurs="1">
  230. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  231. <documentation>
  232. Configures the channel creation options for the node
  233. </documentation>
  234. </annotation>
  235. </xsd:element>
  236. <xsd:element name="connection-creation-options" type="connection-creation-optionsType" maxOccurs="1">
  237. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  238. <documentation>
  239. Configures the connection creation options for the node
  240. </documentation>
  241. </annotation>
  242. </xsd:element>
  243. </xsd:choice>
  244. <xsd:attribute name="name" type="xsd:string" use="required">
  245. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  246. <documentation>
  247. The name of the cluster node
  248. </documentation>
  249. </annotation>
  250. </xsd:attribute>
  251. <xsd:attribute name="connect-timeout" type="xsd:long" use="optional">
  252. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  253. <documentation>
  254. The timeout in milliseconds while creating a connection for the node
  255. </documentation>
  256. </annotation>
  257. </xsd:attribute>
  258. <xsd:attribute name="username" type="xsd:string" use="optional">
  259. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  260. <documentation>
  261. The username that will be used for authentication during connection creation for the node
  262. </documentation>
  263. </annotation>
  264. </xsd:attribute>
  265. <xsd:attribute name="security-realm" type="xsd:string" use="optional">
  266. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  267. <documentation>
  268. The security-realm that will be used for authentication during connection creation for the node
  269. cluster
  270. </documentation>
  271. </annotation>
  272. </xsd:attribute>
  273. </xsd:complexType>
  274. <xsd:complexType name="channel-creation-optionsType">
  275. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  276. <xsd:element name="property" type="propertyType"/>
  277. </xsd:choice>
  278. </xsd:complexType>
  279. <xsd:complexType name="connection-creation-optionsType">
  280. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  281. <xsd:element name="property" type="propertyType"/>
  282. </xsd:choice>
  283. </xsd:complexType>
  284. <xsd:complexType name="propertyType">
  285. <xsd:attribute name="name" type="xsd:string" use="required">
  286. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  287. <documentation>
  288. The name of the property. Example org.xnio.Options.SASL_POLICY_NOANONYMOUS
  289. </documentation>
  290. </annotation>
  291. </xsd:attribute>
  292. <xsd:attribute name="value" type="xsd:string" use="required">
  293. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  294. <documentation>
  295. The value of the property.
  296. </documentation>
  297. </annotation>
  298. </xsd:attribute>
  299. </xsd:complexType>
  300. </xsd:schema>