WS-I Usage Scenarios for the WS-I Attachments Profile 1.0

Transcription

1 WS-I Usage Scenaris fr Attachments WS-I Usage Scenaris fr the WS-I Attachments Prfile 1.0 Dcument Status: Member Review Draft Versin: 1.02 Date: 2 September, 2004 Editrs: Marc Gdner, SAP Barbara McKee, IBM 2 September, 2004 Page 1 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

2 WS-I Usage Scenaris fr Attachments Table f Cntents 1 Intrductin Hw t use this dcument Usage Scenari Taxnmy Web Service Stack Activities Data Layer Activities SOAP Message Layer Activities MIME Layer Activities Transprt Layer Activities Web Service Actrs Usage Scenaris Explicitly bund attachments Descriptin Flw Flw Cnstraints Descriptin Cnstraints UDDI Security Referenced attachments Descriptin Flw Flw Cnstraints Descriptin Cnstraints UDDI Security Appendix 1 Cnstraints Write MIME Header Prcess MIME Header Write MIME entity bdy Prcess MIME entity bdy Write attachment data Prcess attachment data Send HTTP Receive HTTP Cnstraints n WSDL parts September, 2004 Page 2 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

3 WS-I Usage Scenaris fr Attachments 4.10 Cnstraints n WSDL bindings References Acknwledgements Table f Figures Figure 2-1 Web services stack September, 2004 Page 3 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

4 WS-I Usage Scenaris fr Attachments Revisin Histry Nvember 24, 2003 Initial versin January 16, 2004 January 21, 2004 January 22, 2004 January 27, 2004 January 30, 2004 February 18, 2004 February 25, 2004 March 31, 2004 April 20, 2004 April 26, 2004 April 28, 2004 June 10, 2004 July 9, 2004 August 19, 2004 Cpyright First review sessin Results f Jan. 16 th call First pass mapping AI frm 1/23 call incrprated Updated frm call discussin Changes accepted at F2F Pst F2F update Editrial changes fr Wrk Grup Draft Mappings t AP 4/19 ED Updates frm BP feedback Editrial changes fr Wrk Grup Apprval Draft Editrial changes fr Bard Apprval Draft Updated per feedback during BdAD, changes tracked in Sample Apps WG Issue List Updated with revisins prpsed t Bard and edits discussed in Sample Apps WG Cpyright 2003, 2004 WS-I Organizatin. N part f this dcument may be reprduced withut the permissin f WS-I Organizatin. Cnfidentiality This dcument cntains prprietary infrmatin that is cnfidential and shall nt be made available t unauthrized persns. 2 September, 2004 Page 4 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

5 WS-I Usage Scenaris fr Attachments 1 Intrductin 1.1 WS-I Usage Scenaris fr the Attachments Prfile 1.0 define hw Web services that have attachments can be used, identifying basic interperability requirements fr such interactins, and mapping the scenari t the requirements f the WS-I Attachments Prfile 1.0 (hereafter, Attachments Prfile) [3]Referenced attachments. The scenaris in this dcument represent nly the mst cmmn usage patterns f SOAP with Attachments. There are ther uses f SOAP with Attachments nt cvered here, such as the use f unslicited attachments. Scenaris are independent f any applicatin dmain. WS-I Use Cases emply Scenaris t mdel high-level definitins f specific applicatins. The scenaris presented here can be cmpsed r extended. That is, they describe Web service design patterns fr attachments that can be cmbined and built upn like building blcks, and with the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4]. Fr example, the Explicitly Bund Attachments scenari in this dcument describes an attachment pattern which can apply t the Synchrnus Request/Respnse scenari r Basic Callback scenari frm the Usage Scenaris fr Basic Prfile Hw t use this dcument This dcument describes the mst cmmn usage patterns assciated with the WS-I Attachments Prfile. The Attachments Prfile cnstraints and requirements are referenced directly and the reader is expected t use the Attachments Prfile in cnjunctin with this dcument t interpret the referenced infrmatin. The tw scenaris presented in this dcument are intended t prvide sufficient infrmatin s that a user f this dcument can create Web services that are cnfrmant with the Attachment Prfile using ne r mre f the scenaris. All applicable guidelines and restrictins fr the messages and service descriptin instances fr each scenari are prvided. 2 Usage Scenari Taxnmy The Usage Scenari taxnmy defined fr the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4] is used here as well, fr applying the Attachment Prfile cnstraints. The taxnmy cnsists f a Web services stack and a set f activities, gruped by the layers f the stack that a Web service instance executes as part f the Web service Usage Scenari. Sme f these layers and activities map t the Usage Scenaris fr the Basic Prfile and are nt relevant t the Attachment scenaris per se. These are included because the Attachment scenaris augment the Basic Prfile scenaris. The cnstraints f the Attachments Prfile are applied t each activity as well as t the ptinal cmpnents f the scenari, e.g., the WSDL fr the descriptin f the Web service instance. There are tw types f cnstraints n scenaris: Flw Cnstraints applying t each activity that takes part in the flw f the Web service. These include: expressing the Web service data mdel in XML, creating and cnsuming messages using SOAP, transprting messages using HTTP Descriptin Cnstraints applying t the descriptin f the Scenari. Operatinally, the descriptin f a Web service instance ccurs in WSDL and pssibly UDDI; therefre, these cnstraints are applied t the WSDL and UDDI describing the Scenari. The fllwing are attributes f WS-I Usage Scenaris fr Attachments (nte that there are ther attributes f using SOAP with Attachments that are nt reflected by the cmmn patterns chsen fr this dcument; unslicited attachments, fr example, are nt described with a WSDL descriptin): They include a flw descriptin, linking tgether the set f activities specific t the scenari, 2 September, 2004 Page 5 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

6 WS-I Usage Scenaris fr Attachments They include ptinal cmpnents, such as SOAP headers r security, They are described with a WSDL dcument, Each activity within a scenari has cnstraints applied t it by the Attachments Prfile, and They represent a real-wrld Web service implementatin. 2.1 Web Service Stack The Usage Scenari taxnmy is based n a Web services stack. Each layer f the stack represents ne f the fundamental functinal areas f a Web service instance. Nt all pssible functinal areas are represented (e.g., security r crdinatin), nly the mst basic. This dcument will nly address new additins t this stack t facilitate attachments in Web services. Please see the Usage Scenaris 1.0 [4] fr infrmatin n underlying layers. These layers are depicted in the fllwing diagram. Web Service Stack Data SOAP Message MIME Transprt XML, Attchs SOAP MIME HTTP Web Service Stack Data SOAP Message MIME Transprt Message Figure 2-1 Web services stack A Web service applicatin may include several lgical layers incrprating functins such as the Web service instance and applicatin business lgic. The Prfiles and Usage Scenaris d nt address applicatin business lgic except where the functinality f any part f the Web services stack is implemented within the business lgic. The details f each layer f the Web service stack are: Data Layer The data layer translates the applicatin specific data int the mdel chsen fr the specific Web service. The data layer includes the functins necessary t supprt flexible data typing. This layer maps t the wsdl:types and wsdl:message definitins within a WSDL dcument. It als handles attachment data as indicated in wsdl:binding definitins. SOAP Message Layer The SOAP message layer is the infrastructure that prcesses SOAP messages, dispatches them, and may ptinally fulfill Quality f Service requirements. On the sending side the message layer writes SOAP messages, based n the data mdel defined in prttypes and bindings. On the receiving side the message layer prcesses the SOAP messages and dispatches requests t the crrect applicatin r methd. When attachment parts are present the SOAP Message Layer may be called upn t create r reslve references t attachments. MIME Layer 2 September, 2004 Page 6 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

7 WS-I Usage Scenaris fr Attachments The MIME layer is the infrastructure that prcesses MIME headers, and MIME entity bdies fr the rt part and attachments. On the sending side the MIME Layer writes a MIME header fr each part, including the SOAP Message (rt) part, and the attachment parts themselves. In sme cases the MIME Layer interacts with the SOAP Message Layer t insert references t attachment parts. On the receiving side the MIME Layer prcesses the MIME parts (MIME headers and MIME entity bdies), reslves references t attachment parts, and ensures that all MIME cntent is dispatched prperly t the SOAP message layer. The MIME layer handles attachments that are expected thrugh explicit declaratin in a WSDL dcument, and thse that are unslicited. Transprt Layer The transprt layer sends and receives messages. Fr the Basic Prfile, this includes nly HTTP client and server platfrms. This layer maps t the wsdl:binding and wsdl:prt definitins within the WSDL dcument. 2.2 Activities A set f activities is defined fr each layer f the Web service stack. Activities are the fundamental peratins that cmprise a Web service. A single activity may have several cnstraints applied t it frm the Basic Prfile, and may als have cnstraints that apply frm the Attachments Prfile. Fr example, ne activity might be Send HTTP and the specificatins and guidelines fr hw t fulfill that activity cme frm the Use f SOAP in HTTP sectin f the Basic Prfile and MIME sectin f the Attachments Prfile. The fllwing table summarizes these activities. Layer Data Layer SOAP Message Layer MIME Layer Transprt Layer Activity Write XML Write attachment data Prcess XML Prcess attachment data Write SOAP envelpe Prcess SOAP envelpe Write SOAP bdy Prcess SOAP bdy Write SOAP header Prcess SOAP header Write MIME header Prcess MIME header Write MIME entity bdy Prcess MIME entity bdy Send HTTP Receive HTTP Table 1 - Activities gruped by Web services stack layer 2 September, 2004 Page 7 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

8 WS-I Usage Scenaris fr Attachments Data Layer Activities In additin t the activities related t handling XML data that were previusly described in the Usage Scenaris fr the Basic Prfile 1.0 fr activities, tw additinal activities have been added t the Data Layer fr Usage Scenaris fr the Attachments Prfile. These are: Write attachment data Prcess attachment data SOAP Message Layer Activities There are n additinal activities fr the SOAP Message Layer required fr Usage Scenaris fr the Attachments Prfile. The Usage Scenaris fr the Basic Prfile 1.0 [4] cntain descriptins fr activities that are executed within the SOAP Message Layer. One caveat is that the SOAP Message Layer may be required t recrd and reslve references t attachments in the SOAP bdy, header, r fault activities MIME Layer Activities The fllwing activities ccur within the MIME Layer t deal with MIME parts that are either described with a mime:multipartrelated WSDL binding, r t deal with unslicited MIME parts: MIME header A MIME header precedes each MIME entity bdy in a multipart/related SOAP message. Write MIME header Prcess MIME header. MIME entity bdy When using MIME bindings in a WSDL descriptin, the assciated message may cntain ne r mre MIME parts. When this ccurs, the SOAP envelpe is cntained within the rt MIME part. Other MIME parts cntain MIME cntent. Write MIME entity bdy Prcess MIME entity bdy Transprt Layer Activities There are n additinal activities fr the Transprt Layer required fr Usage Scenaris fr the Attachments Prfile. The Usage Scenaris fr the Basic Prfile 1.0 [4] cntain descriptins fr activities that are executed within this Layer. Because attachment activities affect the HTTP header, additinal cnstraints ver and abve thse recrded in the Usage Scenaris fr the Basic Prfile 1.0 are impsed upn this layer by the Attachments Prfile Web Service Actrs In WS-I Web services scenaris fr attachments there are n additinal actrs frm what was described in Usage Scenaris fr BP 1.0 [4], Cnsumer and Prvider. These are nt related t SOAP Actrs as defined in SOAP Usage Scenaris This sectin defines the tw Usage Scenaris develped t cmplement the Attachment Prfile [3]: Explicitly bund attachments Referenced attachments 2 September, 2004 Page 8 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

9 WS-I Usage Scenaris fr Attachments 3.1 Explicitly bund attachments Descriptin An attachment is bund t a mime:part in the wsdl:sap:binding fr a request r a respnse. One r mre mime:cntent elements are specified fr the attachment. N elements that prvide references t the attachment, i.e. swaref, are allwed in either the descriptin r within the SOAP envelpe. This Scenari applies t situatins where there are a finite number f knwn attachments. There is at least ne attachment described in the mime:cntent f the wsdl:binding. wsdl:parts that are explicitly bund t mime:cntent are required. Attachment rder is nt guaranteed, s when multiple attachments f the same cntent type appear in a message their rder cannt be used t distinguish them. Assumptins: This scenari describes a runtime set f events; it des nt describe the design r deplyment activities. Order f the events is nt significant. The data mdel, the applicatin semantics, and the transprt bindings are all agreed upn and implemented a priri t this scenari. All parts f this scenari are defined in cnfrmance with the guidelines and recmmendatins f the Attachments Prfile [3] and Basic Prfile 1.1 [2]. This scenari is cmpsable, that is, it may be cmbined with ne f the Basic Prfile Usage Scenaris 1.0 [4] Flw The detailed flw fr this scenari, using the activities defined in Sectin 2.2, is described belw. Each bulleted item represents the activities perfrmed within ne layer f the stack required t cmplete the flw. Each activity may have cnstraints impsed upn it frm the Attachments Prfile. Which actr is invlved in the interactin is nt significant (e.g., the Message Exchange pattern is nt significant in the flw). The rder f activities within an actr is nt significant. 2 September, 2004 Page 9 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

10 WS-I Usage Scenaris fr Attachments Attachment Sender Attachment Receiver Write XML Write Attachment data Write SOAP Envelpe Write SOAP Bdy Write MIME header Write MIME entity bdy Send HTTP Receive HTTP Prcess MIME header Prcess MIME entity bdy Prcess SOAP Envelpe Prcess SOAP Bdy Prcess Attachment data Prcess XML Write MIME part An actr initiates a MIME message: Data Layer Write XML. The paylad is created accrding t the data mdel. Write attachment data (ptinal) 2 September, 2004 Page 10 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

11 WS-I Usage Scenaris fr Attachments SOAP Message Layer MIME Layer Transprt Layer Write SOAP envelpe Write SOAP bdy (may include references t attachments) Write MIME header Write MIME entity bdy Send HTTP A receiving actr receives the MIME message: Transprt Layer MIME Layer Receive HTTP Prcess MIME header Prcess MIME entity bdy SOAP Message Layer Data Layer Prcess SOAP envelpe Prcess SOAP bdy Flw Cnstraints Prcess XML. The data paylad is prcessed accrding t the data mdel and dispatched t the applicatin. Prcess attachment data (ptinal) The fllwing are the flw cnstraints upn this Usage Scenari. Write XML, as defined in Basic Prfile 1.1 [2]; see Usage Scenaris fr the Basic Prfile 1.0 [4] Write attachment data, as defined in Appendix 1, Sectin 4.5 Write SOAP envelpe, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Write SOAP bdy, as define in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Write MIME header, as defined in Appendix 1, Sectin 4.1 Write MIME entity bdy, as defined in Appendix 1, Sectin 4.3 Send HTTP, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Receive HTTP, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Prcess MIME header, as defined in Appendix 1, Sectin 4.2 Prcess MIME entity bdy, as defined in Appendix 1, Sectin 4.4 Prcess SOAP envelpe, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile September, 2004 Page 11 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

12 WS-I Usage Scenaris fr Attachments Prcess SOAP bdy, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Prcess XML, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Prcess attachment data, as defined in Appendix 1, Sectin Errr cnditins and SOAP Fault A SOAP Fault can be returned as defined in Basic Prfile 1.1 [2], and is further cnstrained by the Attachments Prfile 1.0. If the wsdl:utput element is defined using the WSDL MIME binding, faults can be sent using the SOAP HTTP binding r the MIME binding. If a fault is sent using the MIME binding, it can include attachments. Hwever, faults explicitly defined in the WSDL definitin cannt be defined using the WSDL MIME binding SOAP Headers Use f a SOAP header is ptinal fr this scenari. If ne is used, it must fllw the cnstraints fr the Write SOAP Header and Prcess SOAP Header activities, as defined in Sectin 5.7 and 5.8, respectively f WS-I Usage Scenaris fr the Basic Prfile 1.0 [4] Descriptin Cnstraints The WSDL shuld fllw the patterns fr ne f the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4]. Only additinal cnstraints related t definitins that have explicitly bund attachments are listed here types A descriptin f a Web service that has an explicitly bund attachment must nt include a swaref reference t that attachment. Type cnstraints fr attachments that have references defined are cvered by the Referenced Attachments Usage Scenari in Sectin 3.2. Any ther type is permissible fr describing an attachment part, but the actual type f the attachment is determined by the cntent type specified in the mime:cntent binding. There are n further cnstraints n the types required by this Usage Scenari. See the WS-I Usage Scenaris fr the Basic Prfile 1.0. Cnstraints n WSDL types are listed in Sectin 5.12 f that dcument messages All explicitly bund attachments must be defined with a wsdl:part in the input r utput message, alng with any part infrmatin fr the sap:bdy, sap:header, sap:fault, and sap:headerfault. Message frmat depends upn the data mdel (dc/literal r rpc/literal) Dcument messages Dcument message sap:bdy parts are cmpsed frm Schema element definitins. Parts fr attachments can be cmpsed frm Schema element definitins r Schema type declaratins (R2910). Attachment parts described using a glbal schema element definitin are serialized t an XML Infset whse rt element is described by the part s referenced element (R2942). <wsdl:message > <wsdl:part name= Bdy element=.. > <wsdl:part name= Attachment1 type=.. > <wsdl:part name= Attachment2 element=.. > 2 September, 2004 Page 12 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

13 WS-I Usage Scenaris fr Attachments </wsdl:message> <wsdl:part name= Attachmentn type=.. > RPC messages RPC message sap:bdy parts are cmpsed frm Schema type definitins. Parts fr attachments can be cmpsed frm Schema element definitins r Schema type declaratins (R2910). Attachment parts described using a glbal schema element definitin are serialized t an XML Infset whse rt element is described by the part s referenced element (R2942). <wsdl:message > <wsdl:part name= Bdy1 type=.. /> <wsdl:part name= Bdy2 type=.. /> <wsdl:part name= Attachment1 type=.. /> <wsdl:part name= Attachment2 element=.. /> </wsdl:message> <wsdl:part name= Attachmentn type=.. /> prttypes There are n unique cnstraints fr prttypes impsed by the Attachments Prfile. See the WS-I Usage Scenaris fr the Basic Prfile 1.0, Sectin 5.14, fr cnstraints n WSDL prttypes binding The wsdl:binding sectin is extended by this scenari t explicitly bind attachment parts t mime cntent. Defined faults cannt be bund t mime:mutlipartrelated (R2930). Cnstraints in the Attachment Prfile as well as Basic Prfile 1.1 affect the Web service descriptin fr this scenari. The cnstraints listed in Sectin 5.15 f the WS-I Usage Scenaris fr the Basic Prfile 1.0 als apply. <wsdl:binding > <sap:binding style= rpc dcument transprt= > <wsdl:xxput > <mime:multipartrelated> <mime:part> </mime:part> <mime:part> </mime:part> <mime:part> </mime:part> <mime:part> <sap:bdy parts= Bdy /> <mime:cntent part= Attachment1 type= /> <mime:cntent part= Attachment2 type= text/xml /> 2 September, 2004 Page 13 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

14 WS-I Usage Scenaris fr Attachments <mime:cntent part= Attachmentn type= /> </mime:part> </mime:multipartrelated> </wsdl:xxput> </sap:binding> </wsdl:binding> Other cnstraints are listed in Appendix 1, Sectin prt There are n unique cnstraints fr prts impsed by the Attachments Prfile. See the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4]. Cnstraints n WSDL prts are listed in Sectin 5.16 f that dcument UDDI Advertisement f Web services patterned after this scenari adheres t the Using WSDL in a UDDI Registry, Versin 1.08 Best Practice dcument. A uddi:tmdel representing the Web service type references the file cntaining the wsdl:binding fr the message peratin. The uddi:bindingtemplate captures the service endpint and references the uddi:tmdel(s) fr the Web service type. Advertising Web services in this way enables discvery using the inquiry patterns supprted by the UDDI Inquiry API set (see These include the brwse pattern, the drill-dwn pattern and the invcatin pattern. General UDDI Cnstraints are listed in Sectin 5.17 f the Usage Scenaris fr the Basic Prfile [4] Security As f this writing n specific threat has been identified as being singularly relevant t this Usage Scenari, we encurage yu t read the Basic Security Prfile Security Scenaris [5] t better understand security requirements related t Web services in general. 3.2 Referenced attachments Descriptin An attachment is referenced using the swaref type fr an element within the SOAP bdy r header fr a request r a respnse. N mime:cntent elements are specified fr the attachment. This Scenari is useful when an attachment is ptinal, when the cntent type is unknwn, when an attachment repeats an unknwn number f times with the same r different cntent type, and when an attachment is lgically cnsidered t be a part f a larger data structure that appears within a SOAP envelpe. Nte that it is nt pssible t describe the referenced attachment s cntent type in the WSDL. Assumptins: This scenari describes a runtime set f events; it des nt describe the design r deplyment activities. Order f the events is nt significant. The data mdel, the applicatin semantics, and the transprt bindings are all agreed upn and implemented a priri t this scenari. 2 September, 2004 Page 14 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

15 WS-I Usage Scenaris fr Attachments All parts f this scenari are defined in cnfrmance with the guidelines and recmmendatins f the Attachments Prfile [3] and Basic Prfile 1.1 [2]. This scenari is cmpsable, that is, it may be cmbined with ne f the Basic Prfile Usage Scenaris 1.0 [4] Flw The detailed flw fr this scenari, using the activities defined in Sectin 2.2, is described belw. Each bulleted item represents the activities perfrmed within ne layer f the stack required t cmplete the flw. Each activity may have cnstraints impsed upn it frm the Attachments Prfile. Which actr is invlved in the interactin is nt significant (e.g., the Message Exchange pattern is nt significant in the flw). The rder f activities within an actr is nt significant. 2 September, 2004 Page 15 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

16 WS-I Usage Scenaris fr Attachments Attachment Sender Attachment Receiver Write XML Write Attachment data Write SOAP Envelpe Write SOAP Bdy Write MIME header Write MIME entity bdy Send HTTP Receive HTTP Prcess MIME header Prcess MIME entity bdy Prcess SOAP Envelpe Prcess SOAP Bdy Prcess Attachment data Prcess XML Write MIME part An actr initiates a MIME message: Data Layer Write XML. The paylad is created accrding t the data mdel. Write attachment data (ptinal) 2 September, 2004 Page 16 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

17 WS-I Usage Scenaris fr Attachments SOAP Message Layer MIME Layer Transprt Layer Write SOAP envelpe Write SOAP bdy (will include references t attachments) Write MIME header Write MIME entity bdy Send HTTP A receiving actr receives the MIME message: Transprt Layer MIME Layer Receive HTTP Prcess MIME header Prcess MIME entity bdy SOAP Message Layer Data Layer Prcess SOAP envelpe Prcess SOAP bdy Flw Cnstraints Prcess XML. The data paylad is prcessed accrding t the data mdel and dispatched t the applicatin. Prcess attachment data (ptinal) The fllwing are the flw cnstraints upn this Usage Scenari. Write XML, as defined in Basic Prfile 1.1 [2]; see Usage Scenaris fr the Basic Prfile 1.0 [4] Write attachment data, as defined in Appendix 1, Sectin 4.5 Write SOAP envelpe, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Write SOAP bdy, as define in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Write MIME header, as defined in Appendix 1, Sectin 4.1 Write MIME entity bdy, as defined in Appendix 1, Sectin 4.3 Send HTTP, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Receive HTTP, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Prcess MIME header, as defined in Appendix 1, Sectin 4.2 Prcess MIME entity bdy, as defined in Appendix 1, Sectin 4.4 Prcess SOAP envelpe, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile September, 2004 Page 17 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

18 WS-I Usage Scenaris fr Attachments Prcess SOAP bdy, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Prcess XML, as defined in Basic Prfile 1.1; see Usage Scenaris fr the Basic Prfile 1.0 Prcess attachment data, as defined in Appendix 1, Sectin Errrs and SOAP Faults A SOAP Fault can be returned as defined in Basic Prfile 1.1 [2], and is further cnstrained by the Attachments Prfile 1.0. If the wsdl:utput element is defined using the WSDL MIME binding, faults can be sent using the SOAP HTTP binding r the MIME binding. If a fault is sent using the MIME binding, it can include attachments. Hwever, faults explicitly defined in the WSDL definitin cannt be defined using the WSDL MIME binding SOAP Headers Use f a SOAP header is ptinal fr this scenari. If ne is used, it must fllw the cnstraints fr the Write SOAP Header and Prcess SOAP Header activities, as defined in Sectin 5.7 and 5.8, respectively f WS-I Usage Scenaris fr the Basic Prfile 1.0 [4] Descriptin Cnstraints The WSDL shuld fllw the patterns fr ne f the WS-I Usage Scenaris fr the Basic Prfile 1.0. Only additinal cnstraints related t definitins that have referenced attachments are listed here types A descriptin f a Web service that has a referenced attachment may use the WS-I swaref type t unambiguusly indicate that a reference URI crrespnds t an attachment cntained in the message. When swaref is used t describe an attachment reference it shuld nly be bund t a sap:bdy r sap:header. It shuld nt be bund t mime:cntent. There are n further cnstraints n the types required by this Usage Scenari. See the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4]. Cnstraints n WSDL types are listed in Sectin 5.12 f that dcument messages Parts that are defined with the swaref type r that are cmplex types that cntain the swaref type are included in messages alng with ther part infrmatin bund t the sap:bdy, sap:header, sap:fault, and sap:headerfault. Parts f type swaref shuld nly be bund t sap:bdy r sap:header (rpc style bindings), r swarefs shuld be cntained within a cmplex type assciated with a part that is bund t sap:bdy r sap:header (dcument style binding) (R2940). Parts that are nt bund are ignred. Message frmat depends upn the data mdel (dc/literal r rpc/literal) Dcument messages Dcument message sap:bdy parts are cmpsed frm Schema element definitins. swaref parts are either bund directly t sap:bdy r sap:header, r swarefs are cntained within a structure that is bund t sap:bdy r sap:header (shwn belw). <wsdl:message > </wsdl:message> <wsdl:part name= Bdy element= ref:elementcntaining_swaref.. > 2 September, 2004 Page 18 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

19 WS-I Usage Scenaris fr Attachments RPC messages RPC message sap:bdy parts are cmpsed frm Schema type definitins. swaref parts are either bund directly t sap:bdy r sap:header (shwn belw), r swarefs are cntained within a structure that is bund t sap:bdy r sap:header. <wsdl:message > </wsdl:message> <wsdl:part name= Bdy1 type=.. /> <wsdl:part name= AttchRef type= wsiref:swaref /> prttypes There are n unique cnstraints fr prttypes impsed by the Attachments Prfile [3]. See the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4], Sectin 5.14, fr cnstraints n WSDL prttypes binding The wsdl:binding sectin is extended by this scenari t indicate that there are mime:parts assciated with the peratin. While referenced attachments are nt explicitly bund t mime:cntent, the sap:bdy must still be placed in a multipart:related binding element. Defined faults cannt be bund t mime:mutlipartrelated (R2930). Cnstraints in the Attachment Prfile [3] as well as Basic Prfile 1.1 [2] affect the Web service descriptin fr this scenari. The cnstraints listed in Sectin 5.15 f the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4] als apply. In this example an RPC style binding cntains tw message parts bund t sap:bdy the Bdy1 part and the AttchRef part. <wsdl:binding > <sap:binding style= rpc transprt= > <wsdl:xxput > </wsdl:xxput> </sap:binding> </wsdl:binding> <mime:multipartrelated> <mime:part> </mime:part> </mime:multipartrelated> <sap:bdy parts= Bdy1 AttchRef /> In this example a Dcument style binding cntains a single message part bund t sap:bdy. The part cntains ne r mre attachment reference elements whse type is swaref. The Basic Prfile 1.1 restricts the number f message parts that can be bund t sap:bdy t ne fr dcument style bindings. <wsdl:binding > <sap:binding style= dcument transprt= > <wsdl:xxput > <mime:multipartrelated> <mime:part> <sap:bdy parts= Bdy /> 2 September, 2004 Page 19 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

20 WS-I Usage Scenaris fr Attachments </mime:part> </mime:multipartrelated> </wsdl:xxput> </sap:binding> </wsdl:binding> Other cnstraints are listed in Appendix 1, Sectin prt There are n unique cnstraints fr prts impsed by the Attachments Prfile. See the WS-I Usage Scenaris fr the Basic Prfile 1.0 [4]. Cnstraints n WSDL prts are listed in Sectin 5.16 f that dcument UDDI Advertisement f Web services patterned after this scenari adheres t the Using WSDL in a UDDI Registry, Versin 1.08 Best Practice dcument. A uddi:tmdel representing the Web service type references the file cntaining the wsdl:binding fr the message peratin. The uddi:bindingtemplate captures the service endpint and references the uddi:tmdel(s) fr the Web service type. Advertising Web services in this way enables discvery using the inquiry patterns supprted by the UDDI Inquiry API set (see These include the brwse pattern, the drill-dwn pattern and the invcatin pattern. General UDDI Cnstraints are listed in Sectin 5.17 f the Usage Scenaris fr the Basic Prfile [4] Security As f this writing n specific threat has been identified as being singularly relevant t this Usage Scenari, we encurage yu t read the Basic Security Prfile Security Scenaris [5] t better understand security requirements related t Web services in general. 4 Appendix 1 Cnstraints This sectin prvides a mapping f cnstraints listed in the Basic Prfile 1.1 [2] and Attachments Prfile [3] t each f the flw activities identified in Sectin 2 that are new r changed within ne f these prfiles and within each scenari. In carrying ut each activity, the listed cnstraints shuld be cnsulted in the Basic Prfile t check fr cmpliance with the details f the cnstraint. 4.1 Write MIME Header Use f SOAP with Attachments: R2902, R2933, R Prcess MIME Header R2933, R Write MIME entity bdy Rt part: R2931, R2915, R2927, R2929, R September, 2004 Page 20 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.

21 WS-I Usage Scenaris fr Attachments MIME parts in general: E0001, R2916, R2917, R2919, R2920, R2929, R2923, R2926, R2936, R2942, R2943, R Prcess MIME entity bdy Dereferencing attachments: R2918, R2921, R2929, R2922, R2912, R2928 MIME parts: R Write attachment data Encding: R Prcess attachment data Encding: R Send HTTP HTTP headers: R2925, R2913, R2945, R2932, R Receive HTTP HTTP headers: R Cnstraints n WSDL parts Mime parts: R2910, R2925, R2943, R Cnstraints n WSDL bindings MIME bindings: R2901, R2902, R2903, R2904, R2905, R2906, R2909, R2911, R2930, R2920, R2933, R2941, R2946, R2940, R2943, R2944, R2947 MIME binding schema: R2907, R References [1] WS-I Basic Prfile versin 1.0 frm [2] WS-I Basic Prfile versin 1.1 frm [3] WS-I Attachments Prfile versin 1.0 frm [4] WS-I Usage Scenaris versin 1.01 frm [5] Basic Security Prfile Security Scenaris Wrking Grup Draft frm 6 Acknwledgements This is the wrk f the WS-I Sample Applicatins Wrking Grup, whse members have included: Heidi Buelw (Quvadx), Marc Gdner (SAP), Arun Gupta (Sun), Jasn Hgg (Micrsft), Tim Julien (Oracle ), Barbara McKee (IBM ), Jesse Pangburn (Quvadx), Vijay Rajan (Nvell), Rimas Rekasius (IBM), Bruce Stephens (BEA) 2 September, 2004 Page 21 f 21 Cpyright 2003, 2004 by the Web Services-Interperability Organizatin. All rights reserved.