quick intro to xml schemas & soap - world wide web ... · quick intro to xml schemas & soap...

Quick Intro to Quick Intro to XML Schemas & SOAPXML Schemas & SOAP

Noah MendelsohnNoah MendelsohnLotus Development Corp.Lotus Development Corp.Oct. 12, 2000Oct. 12, 2000

How SOAP uses SchemasHow SOAP uses Schemas

To define SOAP's XML vocabularyTo define SOAP's XML vocabulary

Optionally: to define your msg. vocabularyOptionally: to define your msg. vocabulary

SOAP encoding uses schema "types"SOAP encoding uses schema "types"Schema builtin datatypes: integer, float, date, etc.Schema builtin datatypes: integer, float, date, etc.SOAP builtins for arrays & structsSOAP builtins for arrays & structsTypes you define in schemaTypes you define in schemaYou can indicate types:You can indicate types:

Directly in your message using xsi:typeDirectly in your message using xsi:typeOptionally: in an external schema documentOptionally: in an external schema document

Schema WG StatusSchema WG Status

Hope for candidate recommendation soonHope for candidate recommendation soon

Three documentsThree documentsStructures: the overall languageStructures: the overall languageDatatypes: integer, float, date, etc.Datatypes: integer, float, date, etc.Primer: start with this!Primer: start with this!

Public working drafts availablePublic working drafts available

A SchemaA Schema

<xsd:schema xmlns:xsd="..." targetNamespace="yourURI"> <xsd:element name="purchaseOrder" type="POType"/> <xsd:element name="comment" type="xsd:string"/>

<xsd:complexType name="POType"> <xsd:sequence> <xsd:element name="shipTo" type="USAddress"/> <xsd:element name="billTo" type="USAddress"/> <xsd:element ref="comment" minOccurs="0"/> <xsd:element name="items" type="Items"/> </xsd:sequence> <xsd:attribute name="orderDate" type="xsd:date"/> </xsd:complexType>

........</xsd:schema>

Namespaces and Schema Documents

One Schema Doc per NamespaceOne Schema Doc per Namespace




Validates:

<po:purchaseOrder xmlns:po="yourURI">....

</po:purchaseOrder>

A SOAP MessageA SOAP Message

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://{soaporg}/envelope/" SOAP-ENV:encodingStyle= "http://{soaporg}/encoding/"> <SOAP-ENV:Body> <m:GetLastTradePrice xmlns:m="Some-URI"> <symbol>DIS</symbol> </m:GetLastTradePrice> </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

SOAP SchemaSOAP Schema



soapenv.xsd: validates SOAP's vocabulary

SOAP Schema & User SchemaSOAP Schema & User Schema



soapenv.xsd stockquote.xsd

Declaring Elements and Attributes

A Sample InstanceA Sample Instance<?xml version="1.0"?><purchaseOrder orderDate="1999-10-20"> <shipTo country="US"> <name>Alice Smith</name> <street>123 Maple Street</street> <city>Mill Valley</city> <state>CA</state> <zip>90952</zip> </shipTo> <billTo country="US">...</billTo> <comment>Hurry, my lawn is going wild!</comment> <items> <item partNum="872-AA">...</item> <item partNum="926-AA">...</item> </items></purchaseOrder>

A SchemaA Schema




Elements have TypesElements have Types








Built in types





User-defined Types

Global elementsGlobal elements




Global elements useable

anywhere

Locally scoped elementsLocally scoped elements




Locally scoped

elements useable only

in parent type

Attributes have TypesAttributes have Types




Simple and Complex Types

Attributes

width="10"

Simple typesSimple types

height="20"

Attributes

width="10"


height="20"

Same restriction on content = "type"

(xsd:integer)

Attributes

width="10"


height="20"

<width> 10</width>

Elements

<height> 20</height>

Simple type captures what's common:It's an integerType has a name (xsd:integer)Simple types work on attrs and elements

Types for ElementsTypes for Elements

<width> 10</width>

Simple type

<height> 20</height>

<width unit="cm"> 10</width>

Complex type<height unit="cm"> 20</height>

Type(s) capture what's common:It's an integer + attributeType has a name (yourns:measure)

More Complex Types for ElementsMore Complex Types for Elements

<ShipTo> <street>1 Main St.</street> <city state="NY">Albany</city></ShipTo>

Element

<BillTo> <street>13 Market St.</street> <city state="CA">San Jose</city></BillTo>

Complex types are for elements:Sharing content models, attr lists.Type has a name (somens:address)

Self-describing SOAP MsgsSelf-describing SOAP Msgs

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://{soaporg}/envelope/" SOAP-ENV:encodingStyle= "http://{soaporg}/encoding/"> <SOAP-ENV:Body> <m:GetLastTradePrice xmlns:m="Some-URI"> <symbol xsi:type="xsd:string"> DIS </symbol>

<quoteDate xsi:type="xsd:date"> 1999-05-21

</quoteDate> </m:GetLastTradePrice> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Summary: Summary: How SOAP uses SchemasHow SOAP uses Schemas

To define SOAP's XML vocabularyTo define SOAP's XML vocabulary

Optionally: to define your msg. vocabularyOptionally: to define your msg. vocabulary

SOAP encoding uses schema "types"SOAP encoding uses schema "types"Schema builtin datatypes: integer, float, date, etc.Schema builtin datatypes: integer, float, date, etc.SOAP builtins for arrays & structsSOAP builtins for arrays & structsTypes you define in schemaTypes you define in schemaYou can indicate types:You can indicate types:

Directly in your message using xsi:typeDirectly in your message using xsi:typeOptionally: in an external schema documentOptionally: in an external schema document