XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://gtan.azurewebsites.net/schema/resource
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.

Declared Namespaces

Prefix Namespace
Default namespace http://gtan.azurewebsites.net/schema/resource
xs http://www.w3.org/2001/XMLSchema
xhtml http://www.w3.org/1999/xhtml
xml http://www.w3.org/XML/1998/namespace
Schema Component Representation
<xs:schema targetNamespace="http://gtan.azurewebsites.net/schema/resource" elementFormDefault="qualified">
...
</xs:schema>
top

Global Declarations

Element: acl

Name acl
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Defines an access control list (ACL) for a resource. This is the root element.
XML Instance Representation
<acl>
Start Choice [0..*]
Start Choice [1]
<group> ... </group> [1]
<acl> aclElement </acl> [1]
End Choice
End Choice
</acl>
Schema Component Representation
<xs:element name="acl">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:group ref=" aclElements "/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: group

Name group
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Specifies a group of objects and links the group to one or multiple ACL.
XML Instance Representation
<group
name=" groupNameType [1]">
Start Choice [0..*]
<acl
name=" aclNameType [1]"/> [1]
<object> ... </object> [1]
End Choice
</group>
Schema Component Representation
<xs:element name="group">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="acl">
<xs:complexType>
<xs:attribute name="name" type=" aclNameType " use="required"/>
</xs:complexType>
</xs:element>
<xs:element ref=" object "/>
</xs:choice>
<xs:attribute name="name" type=" groupNameType " use="required"/>
</xs:complexType>
</xs:element>
top

Element: object

Name object
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Specify an object which is assigned to this group. An object could for example be a resource or it could be an user. It might have a password.
XML Instance Representation
<object
name=" objectNameType [1]"
password=" passwordType [0..1]"/>
Schema Component Representation
<xs:element name="object">
<xs:complexType>
<xs:attribute name="name" type=" objectNameType " use="required"/>
<xs:attribute name="password" type=" passwordType "/>
</xs:complexType>
</xs:element>
top

Element: right

Name right
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Rights inside an ACL. Rights must have a name as an identifier and it must define an access level for this ACL. The access level can be true or false.
XML Instance Representation
<right
name=" rightNameType [1]"
access=" xs:boolean [1]"/>
Schema Component Representation
<xs:element name="right">
<xs:complexType>
<xs:attribute name="name" type=" rightNameType " use="required"/>
<xs:attribute name="access" type=" xs:boolean " use="required"/>
</xs:complexType>
</xs:element>
top

Global Definitions

Complex Type: aclElement

Super-types: None
Sub-types: None
Name aclElement
Abstract no
Documentation Specifies an ACL consisting of rights.
XML Instance Representation
<...
name=" aclNameType [1]">
Start Sequence [0..*]
<right> ... </right> [1]
End Sequence
</...>
Schema Component Representation
<xs:complexType name="aclElement">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref=" right "/>
</xs:sequence>
<xs:attribute name="name" type=" aclNameType " use="required"/>
</xs:complexType>
top

Model Group: aclElements

Name aclElements
XML Instance Representation
Start Choice [1]
<group> ... </group> [1]
<acl> aclElement </acl> [1]
End Choice
Schema Component Representation
<xs:group name="aclElements">
<xs:choice>
<xs:element ref=" group "/>
<xs:element name="acl" type=" aclElement "/>
</xs:choice>
</xs:group>
top

Simple Type: aclNameType

Super-types: xs:token < classTokenType (by restriction) < aclNameType (by restriction)
Sub-types: None
Name aclNameType
Content
  • Base XSD Type: token
  • pattern = ([a-zA-Z_](\.?[a-zA-Z0-9_])*)
Documentation Name of an ACL can be any class token.
Schema Component Representation
<xs:simpleType name="aclNameType">
<xs:restriction base=" classTokenType "/>
</xs:simpleType>
top

Simple Type: classTokenType

Super-types: xs:token < classTokenType (by restriction)
Sub-types:
Name classTokenType
Content
  • Base XSD Type: token
  • pattern = ([a-zA-Z_](\.?[a-zA-Z0-9_])*)
Documentation A class token consists of a class name and possibly an unlimited amount of members. It must begin with a letter or an underscore and must not contain any special characters apart from underscore.
Examples for valid values: {Default, command.kick, _command.server.kick}
Schema Component Representation
<xs:simpleType name="classTokenType">
<xs:restriction base=" xs:token ">
<xs:pattern value="([a-zA-Z_](\.?[a-zA-Z0-9_])*)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: groupNameType

Super-types: xs:token < classTokenType (by restriction) < groupNameType (by restriction)
Sub-types: None
Name groupNameType
Content
  • Base XSD Type: token
  • pattern = ([a-zA-Z_](\.?[a-zA-Z0-9_])*)
Documentation Name of a group can be any class token.
Schema Component Representation
<xs:simpleType name="groupNameType">
<xs:restriction base=" classTokenType "/>
</xs:simpleType>
top

Simple Type: objectNameType

Super-types: xs:token < objectNameType (by restriction)
Sub-types: None
Name objectNameType
Content
  • Base XSD Type: token
  • pattern = ([a-zA-Z_](\.?[a-zA-Z0-9_])*(\.\*)?)
Documentation An object name is a token similar to class token but it can additionally have a * at the end.
Examples for valid values: {user.Test, user._Test, user.*}
Schema Component Representation
<xs:simpleType name="objectNameType">
<xs:restriction base=" xs:token ">
<-- Similar to classTokenType, but can have an .* at the end -->
<xs:pattern value="([a-zA-Z_](\.?[a-zA-Z0-9_])*(\.\*)?)"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: passwordType

Super-types: xs:token < passwordType (by restriction)
Sub-types: None
Name passwordType
Content
  • Base XSD Type: token
  • pattern = \S*
Documentation A password might contain any characters other than whitespaces.
Schema Component Representation
<xs:simpleType name="passwordType">
<xs:restriction base=" xs:token ">
<xs:pattern value="\S*"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: rightNameType

Super-types: xs:token < classTokenType (by restriction) < rightNameType (by restriction)
Sub-types: None
Name rightNameType
Content
  • Base XSD Type: token
  • pattern = ([a-zA-Z_](\.?[a-zA-Z0-9_])*)
Documentation Name of a right element can be any class token.
Schema Component Representation
<xs:simpleType name="rightNameType">
<xs:restriction base=" classTokenType "/>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top