PageRenderTime 35ms CodeModel.GetById 30ms app.highlight 3ms RepoModel.GetById 0ms app.codeStats 0ms

/ejb3/src/main/resources/schema/jboss-ejb-client_1_3.xsd

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