git-svn-id: https://svn.apache.org/repos/asf/ofbiz/trunk@981018 13f79535-47bb-0310-9956-ffa450edef68
457 lines
21 KiB
XML
457 lines
21 KiB
XML
<?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: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="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="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="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>
|