Blame view
framework/service/dtd/services.xsd
24 KB
c16038356
first commit
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:include schemaLocation="http://ofbiz.apache.org/dtds/service-group.xsd"/>
<xs:element name="services">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="description"/>
<xs:element minOccurs="0" ref="vendor"/>
<xs:element minOccurs="0" ref="version"/>
<xs:element minOccurs="0" ref="created"/>
<xs:element maxOccurs="unbounded" ref="service"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="description" type="xs:string"/>
<xs:element name="vendor" type="xs:string"/>
<xs:element name="version" type="xs:string"/>
<xs:element name="created" type="xs:string"/>
<xs:element name="namespace" type="xs:string"/>
<xs:element name="service">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="description"/>
<xs:element minOccurs="0" ref="namespace"/>
<xs:element minOccurs="0" maxOccurs="1" ref="permission-service"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="required-permissions"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="implements"/>
<xs:element minOccurs="0" ref="metric"/>
<xs:choice maxOccurs="1" minOccurs="0">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="auto-attributes"/>
<xs:element ref="attribute"/>
</xs:choice>
<xs:element ref="group"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="override"/>
</xs:sequence>
<xs:attributeGroup ref="attlist.service"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.service">
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="engine" type="xs:string" use="required"/>
<xs:attribute name="location" type="xs:string"/>
<xs:attribute name="invoke" type="xs:string"/>
<xs:attribute name="auth" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="export" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="validate" default="true">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="default-entity-name" type="xs:string"/>
<xs:attribute name="use-transaction" default="true">
<xs:annotation>
<xs:documentation>
If set to true and there is no transaction already in place the Service Engine will begin one.
If set to false or there is a transaction already in place the Service Engine will do nothing (this also means that if set to false and a transaction is already in place it will do nothing).
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="require-new-transaction" default="false">
<xs:annotation>
<xs:documentation>
If set to true and there is a transaction already in place the Service Engine will suspend that transaction, begin a new one just for this service, commit or rollback the local transaction when the service is complete, and will resume the original transaction.
If set to true and there is no transaction already in place it will just begin a transaction and manage it as would be done for a normal user-transaction=true.
If use-transaction=false this setting is ignored.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="hideResultInLog" default="false">
<xs:annotation>
<xs:documentation>
If set to true the result will be hidden from possible exposition in LocalDispatcher.runSync()
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="transaction-timeout" type="xs:int" default="0">
<xs:annotation>
<xs:documentation>
Defines the timeout for the transaction, in seconds.
Defaults to the value set in the TransactionFactory being used (typically 60 seconds).
This value is only used if this service begins a transaction (either require-new-transaction=true, or use-transaction=true and there is no other transaction already in place).
If use-transaction=false this setting is ignored.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="max-retry" type="xs:int" default="-1"/>
<xs:attribute name="debug" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="semaphore" default="none">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="none"/>
<xs:enumeration value="fail"/>
<xs:enumeration value="wait"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="semaphore-wait-seconds" type="xs:int" default="300"/>
<xs:attribute name="semaphore-sleep" type="xs:int" default="500"/>
</xs:attributeGroup>
<xs:element name="notification">
<xs:complexType>
<xs:attributeGroup ref="attlist.notification"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.notification">
<xs:attribute name="event" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="success"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fail"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="group" type="xs:string" use="required"/>
</xs:attributeGroup>
<xs:element name="permission-service">
<xs:complexType>
<xs:attributeGroup ref="attlist.permission-service"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.permission-service">
<xs:attribute name="service-name" type="xs:string" use="required"/>
<xs:attribute name="resource-description" type="xs:string" use="optional">
<xs:annotation><xs:documentation>This will be used in error messages, et cetera. If not specified will default to a service name.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute name="main-action" use="optional">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="CREATE"/>
<xs:enumeration value="UPDATE"/>
<xs:enumeration value="DELETE"/>
<xs:enumeration value="VIEW"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="required-permissions">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="check-permission"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="check-role-member"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="permission-service"/>
</xs:sequence>
<xs:attributeGroup ref="attlist.required-permissions"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.required-permissions">
<xs:attribute name="join-type" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="AND"/>
<xs:enumeration value="OR"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="check-permission">
<xs:complexType>
<xs:attributeGroup ref="attlist.check-permission"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.check-permission">
<xs:attribute name="permission" type="xs:string" use="required"/>
<xs:attribute name="action" type="xs:string"/>
</xs:attributeGroup>
<xs:element name="check-role-member">
<xs:complexType>
<xs:attributeGroup ref="attlist.check-role-member"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.check-role-member">
<xs:attribute name="role-type" type="xs:string" use="required"/>
</xs:attributeGroup>
<xs:element name="service-security">
<xs:complexType>
<xs:attributeGroup ref="attlist.service-security"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.service-security">
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="class" type="xs:string" use="required"/>
</xs:attributeGroup>
<xs:element name="implements">
<xs:complexType>
<xs:attributeGroup ref="attlist.implements"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.implements">
<xs:attribute name="service" type="xs:string" use="required"/>
<xs:attribute name="optional" default="false">
<xs:annotation><xs:documentation>If set to true all attributes inherited will have be optional whether or not they were in the implemented service definition.</xs:documentation></xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="metric">
<xs:annotation>
<xs:documentation>
Calculate and maintain an average response time for this service. Service metrics can be used
for monitoring and reporting.
The metric works by gathering statistics until a configurable maximum is reached (number of
requests or elapsed time), then the average is calculated. A smoothing factor is used to
smooth differences between calculations.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Each metric must have a unique name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="estimation-size" type="xs:string">
<xs:annotation>
<xs:documentation>
Positive integer number of requests to include in the metrics calculation. Defaults to "100".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="estimation-time" type="xs:string">
<xs:annotation>
<xs:documentation>
Positive integer number of milliseconds to include in the metrics calculation. Defaults to "1000".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="smoothing" type="xs:string">
<xs:annotation>
<xs:documentation>
Positive decimal smoothing factor - used to smooth the differences between calculations. A value of "1" disables smoothing. Defaults to "0.7".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="auto-attributes">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="exclude"/>
</xs:sequence>
<xs:attributeGroup ref="attlist.auto-attributes"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.auto-attributes">
<xs:attribute name="entity-name" type="xs:string"/>
<xs:attribute name="include" default="all">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="pk"/>
<xs:enumeration value="nonpk"/>
<xs:enumeration value="all"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="mode" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="IN"/>
<xs:enumeration value="OUT"/>
<xs:enumeration value="INOUT"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="optional" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="form-display" default="true">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="allow-html" use="optional" default="none">
<xs:annotation><xs:documentation>See the documentation on the allow-html attribute of the "attribute" element.</xs:documentation></xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="any"/>
<xs:enumeration value="safe"/>
<xs:enumeration value="none"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="exclude">
<xs:complexType>
<xs:attributeGroup ref="attlist.exclude"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exclude">
<xs:attribute name="field-name" type="xs:string" use="required"/>
</xs:attributeGroup>
<xs:element name="attribute">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="type-validate"/>
<xs:element minOccurs="0" ref="description" />
</xs:sequence>
<xs:attributeGroup ref="attlist.attribute"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.attribute">
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="type" type="xs:string" use="required"/>
<xs:attribute name="mode" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="IN"/>
<xs:enumeration value="OUT"/>
<xs:enumeration value="INOUT"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="optional" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="default-value" type="xs:string">
<xs:annotation><xs:documentation>The value specified will be used for the attribute if no value is passed in. This will only happen if it is okay to not pass a value in, so if this is set then optional will be set to true. If optional=false and this is set then the value will be overridden and with a value in default-value is will set optional=true anyway.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute name="form-label" type="xs:string"/>
<xs:attribute name="entity-name" type="xs:string"/>
<xs:attribute name="field-name" type="xs:string"/>
<xs:attribute name="request-attribute-name" type="xs:string"/>
<xs:attribute name="session-attribute-name" type="xs:string"/>
<xs:attribute name="string-map-prefix" type="xs:string"/>
<xs:attribute name="string-list-suffix" type="xs:string"/>
<xs:attribute name="form-display" default="true">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="allow-html" use="optional" default="none">
<xs:annotation><xs:documentation>
Applies only to String fields.
Only checked for incoming parameters/attributes (could change in the future, but this is meant for validating input from users, other systems, etc).
Defualts to "none" meaning no HTML is allowed (will result in an error message).
If some HTML is desired then use "safe" which will follow the rules in the antisamy-esapi.xml file. This should be safe for both internal and public users.
In rare cases when users are trusted or it is not a sensitive field the "any" option may be used to not check the HTML content at all.
</xs:documentation></xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="any"/>
<xs:enumeration value="safe"/>
<xs:enumeration value="none"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="override">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="type-validate"/>
</xs:sequence>
<xs:attributeGroup ref="attlist.override"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.override">
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="type" type="xs:string"/>
<xs:attribute name="entity-name" type="xs:string"/>
<xs:attribute name="field-name" type="xs:string"/>
<xs:attribute name="mode">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="IN"/>
<xs:enumeration value="OUT"/>
<xs:enumeration value="INOUT"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="optional">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="default-value" type="xs:string"/>
<xs:attribute name="form-label" type="xs:string"/>
<xs:attribute name="form-display">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="allow-html" use="optional">
<xs:annotation><xs:documentation>See the documentation on the allow-html attribute of the "attribute" element. Note that it is slightly different here as there is no defualt.</xs:documentation></xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="any"/>
<xs:enumeration value="safe"/>
<xs:enumeration value="none"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="type-validate">
<xs:complexType>
<xs:choice>
<xs:element ref="fail-message"/>
<xs:element ref="fail-property"/>
</xs:choice>
<xs:attributeGroup ref="attlist.type-validate"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.type-validate">
<xs:attribute name="method" type="xs:string"/>
<xs:attribute name="class" type="xs:string" default="org.ofbiz.base.util.UtilValidate"/>
</xs:attributeGroup>
<xs:element name="fail-message">
<xs:complexType>
<xs:attributeGroup ref="attlist.fail-message"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.fail-message">
<xs:attribute name="message" type="xs:string" use="required"/>
</xs:attributeGroup>
<xs:element name="fail-property">
<xs:complexType>
<xs:attributeGroup ref="attlist.fail-property"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.fail-property">
<xs:attribute name="resource" type="xs:string" use="required"/>
<xs:attribute name="property" type="xs:string" use="required"/>
</xs:attributeGroup>
</xs:schema>
|