jboss-ejb-client_1_1.xsd 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  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.1"
  25. xmlns="urn:jboss:ejb-client:1.1"
  26. elementFormDefault="unqualified"
  27. attributeFormDefault="unqualified"
  28. version="1.1">
  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:complexType>
  72. <xsd:complexType name="ejb-receiversType">
  73. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  74. <xsd:element name="remoting-ejb-receiver" type="remoting-ejb-receiverType">
  75. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  76. <documentation>
  77. Configures a remoting based EJB receiver
  78. </documentation>
  79. </annotation>
  80. </xsd:element>
  81. </xsd:choice>
  82. <xsd:attribute name="exclude-local-receiver" type="xsd:boolean" use="optional" default="false">
  83. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  84. <documentation>
  85. Set to true if the local receiver which gets added to the EJB client context by default, has to be
  86. excluded from the context
  87. </documentation>
  88. </annotation>
  89. </xsd:attribute>
  90. <xsd:attribute name="local-receiver-pass-by-value" type="xsd:boolean" use="optional" default="true">
  91. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  92. <documentation>
  93. Set to false if the local receiver that's available in the EJB client context, should use
  94. pass-by-reference (instead of pass-by-value) semantics for the EJB invocations.
  95. </documentation>
  96. </annotation>
  97. </xsd:attribute>
  98. </xsd:complexType>
  99. <xsd:complexType name="remoting-ejb-receiverType">
  100. <xsd:attribute name="outbound-connection-ref" type="xsd:string" use="required">
  101. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  102. <documentation>
  103. Reference to an outbound connection configured in the remoting subsytem
  104. </documentation>
  105. </annotation>
  106. </xsd:attribute>
  107. </xsd:complexType>
  108. <xsd:complexType name="clustersType">
  109. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  110. <xsd:element name="cluster" type="clusterType">
  111. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  112. <documentation>
  113. Configures a cluster in the client context
  114. </documentation>
  115. </annotation>
  116. </xsd:element>
  117. </xsd:choice>
  118. </xsd:complexType>
  119. <xsd:complexType name="clusterType">
  120. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  121. <xsd:element name="channel-creation-options" type="channel-creation-optionsType" maxOccurs="1">
  122. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  123. <documentation>
  124. Configures the channel creation options for the nodes in this cluster
  125. </documentation>
  126. </annotation>
  127. </xsd:element>
  128. <xsd:element name="connection-creation-options" type="connection-creation-optionsType" maxOccurs="1">
  129. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  130. <documentation>
  131. Configures the connection creation options for the nodes in this cluster
  132. </documentation>
  133. </annotation>
  134. </xsd:element>
  135. <xsd:element name="node" type="clusterNodeType" maxOccurs="unbounded">
  136. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  137. <documentation>
  138. Configures the channel creation options for the nodes in this cluster
  139. </documentation>
  140. </annotation>
  141. </xsd:element>
  142. </xsd:choice>
  143. <xsd:attribute name="name" type="xsd:string" use="required">
  144. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  145. <documentation>
  146. The name of the cluster
  147. </documentation>
  148. </annotation>
  149. </xsd:attribute>
  150. <xsd:attribute name="connect-timeout" type="xsd:long" use="optional">
  151. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  152. <documentation>
  153. The timeout in milliseconds while creating a connection for the nodes in the cluster
  154. </documentation>
  155. </annotation>
  156. </xsd:attribute>
  157. <xsd:attribute name="max-allowed-connected-nodes" type="xsd:long" use="optional">
  158. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  159. <documentation>
  160. The maximum number of nodes to which the connection will be established in the cluster
  161. </documentation>
  162. </annotation>
  163. </xsd:attribute>
  164. <xsd:attribute name="cluster-node-selector" type="xsd:string" use="optional">
  165. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  166. <documentation>
  167. The fully qualified classname of the class which implements the
  168. org.jboss.ejb.client.ClusterNodeSelector
  169. interface. The instance of this class will be used for selecting nodes, within the cluster, for
  170. handling
  171. invocations
  172. </documentation>
  173. </annotation>
  174. </xsd:attribute>
  175. <xsd:attribute name="username" type="xsd:string" use="optional">
  176. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  177. <documentation>
  178. The username that will be used for authentication during connection creation for nodes in the
  179. cluster
  180. </documentation>
  181. </annotation>
  182. </xsd:attribute>
  183. <xsd:attribute name="security-realm" type="xsd:string" use="optional">
  184. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  185. <documentation>
  186. The security-realm that will be used for authentication during connection creation for nodes in the
  187. cluster
  188. </documentation>
  189. </annotation>
  190. </xsd:attribute>
  191. </xsd:complexType>
  192. <xsd:complexType name="clusterNodeType">
  193. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  194. <xsd:element name="channel-creation-options" type="channel-creation-optionsType" maxOccurs="1">
  195. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  196. <documentation>
  197. Configures the channel creation options for the node
  198. </documentation>
  199. </annotation>
  200. </xsd:element>
  201. <xsd:element name="connection-creation-options" type="connection-creation-optionsType" maxOccurs="1">
  202. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  203. <documentation>
  204. Configures the connection creation options for the node
  205. </documentation>
  206. </annotation>
  207. </xsd:element>
  208. </xsd:choice>
  209. <xsd:attribute name="name" type="xsd:string" use="required">
  210. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  211. <documentation>
  212. The name of the cluster node
  213. </documentation>
  214. </annotation>
  215. </xsd:attribute>
  216. <xsd:attribute name="connect-timeout" type="xsd:long" use="optional">
  217. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  218. <documentation>
  219. The timeout in milliseconds while creating a connection for the node
  220. </documentation>
  221. </annotation>
  222. </xsd:attribute>
  223. <xsd:attribute name="username" type="xsd:string" use="optional">
  224. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  225. <documentation>
  226. The username that will be used for authentication during connection creation for the node
  227. </documentation>
  228. </annotation>
  229. </xsd:attribute>
  230. <xsd:attribute name="security-realm" type="xsd:string" use="optional">
  231. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  232. <documentation>
  233. The security-realm that will be used for authentication during connection creation for the node
  234. cluster
  235. </documentation>
  236. </annotation>
  237. </xsd:attribute>
  238. </xsd:complexType>
  239. <xsd:complexType name="channel-creation-optionsType">
  240. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  241. <xsd:element name="property" type="propertyType"/>
  242. </xsd:choice>
  243. </xsd:complexType>
  244. <xsd:complexType name="connection-creation-optionsType">
  245. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  246. <xsd:element name="property" type="propertyType"/>
  247. </xsd:choice>
  248. </xsd:complexType>
  249. <xsd:complexType name="propertyType">
  250. <xsd:attribute name="name" type="xsd:string" use="required">
  251. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  252. <documentation>
  253. The name of the property. Example org.xnio.Options.SASL_POLICY_NOANONYMOUS
  254. </documentation>
  255. </annotation>
  256. </xsd:attribute>
  257. <xsd:attribute name="value" type="xsd:string" use="required">
  258. <annotation xmlns="http://www.w3.org/2001/XMLSchema">
  259. <documentation>
  260. The value of the property.
  261. </documentation>
  262. </annotation>
  263. </xsd:attribute>
  264. </xsd:complexType>
  265. </xsd:schema>