DOC

ebXML Message Service Specification

By Jesse Woods,2014-11-24 08:40
8 views 0
ebXML Message Service Specification

    Message Service Specification

    v1.0

    Transport, Routing & Packaging Team

    11 May 2001

    (This document is the non-normative version formatted for printing, July 2001)

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

Transport, Routing & Packaging Team May 2001

Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved

    This document and translations of it MAY be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation MAY be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself MAY not be modified in any way, such as by removing the copyright notice or references to the ebXML, UN/CEFACT, or OASIS, except as required to translate it into languages other than English.

    The limited permissions granted above are perpetual and will not be revoked by ebXML or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and ebXML disclaims all warranties, express or implied, including but not limited to any warranty that the use of the information herein will not infringe any rights or any implied warranties of merchantability or fitness for a particular purpose. Message Service Specification Page 2 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

    Transport, Routing & Packaging Team May 2001

    Table of Contents 1 Status of this Document .....................................................................................................9 2 ebXML Participants ........................................................................................................ 10 3 Introduction ..................................................................................................................... 12 3.1 Summary of contents of document .............................................................................. 12 3.2 Document conventions ............................................................................................... 13 3.3 Audience .................................................................................................................... 14 3.4 Caveats and assumptions ........................................................................................... 14 3.5 Related documents ..................................................................................................... 14 4 Design Objectives ............................................................................................................ 15 5 System Overview ............................................................................................................. 16 5.1 Message service purpose ........................................................................................... 16 5.2 Message service overview .......................................................................................... 16 5.3 Use of version attribute .............................................................................................. 18 6 Packaging Specification ................................................................................................... 19 6.1 Introduction ............................................................................................................... 19

    6.1.1 SOAP structural conformance ........................................................................................................ 20 6.2 Message package ....................................................................................................... 20 6.3 Header container ....................................................................................................... 21

    6.3.1 Content-type .................................................................................................................................. 21

    6.3.1.1 charset attribute .............................................................................................. 21

    6.3.2 Header container example .............................................................................................................. 22 6.4 Payload container...................................................................................................... 22

    6.4.1 Example of a payload container ..................................................................................................... 22 6.5 Additional MIME parameters .................................................................................... 23 6.6 Reporting MIME errors ............................................................................................. 23 7 ebXML SOAP Extensions ............................................................................................... 24 Message Service Specification Page 3 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

Transport, Routing & Packaging Team May 2001

    7.1 XML prolog ............................................................................................................... 24

    7.1.1 XML declaration ........................................................................................................................... 24

    7.1.2 Encoding declaration ..................................................................................................................... 24

    7.2 ebXML SOAP Envelope extensions ............................................................................ 25

    7.2.1 Namespace pseudo attribute ........................................................................................................... 25

     xsi:schemaLocation attribute .......................................................................................................... 25 7.2.2

    7.2.3 ebXML SOAP Extensions ............................................................................................................. 26

    7.2.4 #wildcard element content ............................................................................................................. 27

    7.2.5 id attributes.................................................................................................................................... 28

    7.3 SOAP Header element ............................................................................................... 28

    7.4 MessageHeader element ............................................................................................ 28

    7.4.1 From and To elements ................................................................................................................... 29

    4.1.1 PartyID element ............................................................................................. 29 7.

    7.4.2 CPAId element .............................................................................................................................. 30

    7.4.3 ConversationId element ................................................................................................................. 30

    7.4.4 Service element ............................................................................................................................. 31

    7.4.4.1 type attribute .................................................................................................. 31 7.4.5 Action element .............................................................................................................................. 31

    7.4.6 MessageData element .................................................................................................................... 32

    7.4.6.1 MessageId element ......................................................................................... 32

    7.4.6.2 Timestamp element ........................................................................................ 32

    7.4.6.3 RefToMessageId element ............................................................................... 32

     7.4.6.4 TimeToLive element ...................................................................................... 337.4.7 QualityOfServiceInfo element........................................................................................................ 33

    7.4.7.1 deliveryReceiptRequested attribute ................................................................ 33

    7.4.7.2 messageOrderSemantics attribute ................................................................... 34 7.4.8 SequenceNumber element .............................................................................................................. 35

    7.4.9 Description element ....................................................................................................................... 36

    7.4.10 version attribute ........................................................................................................................ 36

    7.4.11 SOAP mustUnderstand attribute ................................................................................................ 36

    7.4.12 MessageHeader sample ............................................................................................................. 37

    7.5 TraceHeaderList element ........................................................................................... 37

    7.5.1 SOAP actor attribute ...................................................................................................................... 37

    7.5.2 TraceHeader element ..................................................................................................................... 38

    7.5.2.1 Sender element ............................................................................................... 38

    7.5.2.2 Receiver element ............................................................................................ 39

    7.5.2.3 Timestamp element ........................................................................................ 39

    7.5.2.4 #wildcard element .......................................................................................... 39 Message Service Specification Page 4 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

Transport, Routing & Packaging Team May 2001

    7.5.3 Single hop TraceHeader sample ..................................................................................................... 39

    7.5.4 Multi-hop TraceHeader sample ...................................................................................................... 40

    7.6 Acknowledgment element ........................................................................................... 42

    7.6.1 Timestamp element........................................................................................................................ 43

    7.6.2 From element ................................................................................................................................ 43

    7.6.3 ds:Reference element ..................................................................................................................... 43

    7.6.4 SOAP actor attribute ...................................................................................................................... 43

    7.6.5 Acknowledgement sample ............................................................................................................. 43

    7.7 Via element ................................................................................................................ 43

    7.7.1 SOAP mustUnderstand attribute..................................................................................................... 44

    7.7.2 SOAP actor attribute ...................................................................................................................... 44

     syncReply attribute ........................................................................................................................ 45 7.7.3

    7.7.4 reliableMessagingMethod attribute ................................................................................................ 45

    7.7.5 ackRequested attribute ................................................................................................................... 45

    7.7.6 CPAId element .............................................................................................................................. 45

    7.7.7 Service and action elements ........................................................................................................... 46

    7.7.8 Via element sample ....................................................................................................................... 46

    7.8 ErrorList element ....................................................................................................... 46

    7.8.1 id attribute ..................................................................................................................................... 46

    7.8.2 highestSeverity attribute ................................................................................................................ 47

    7.8.3 Error element ................................................................................................................................. 47

    7.8.3.1 codeContext attribute ..................................................................................... 47

    7.8.3.2 errorCode attribute ......................................................................................... 47

    7.8.3.3 severity attribute ............................................................................................. 47

    7.8.3.4 location attribute ............................................................................................ 48

    7.8.3.5 Error element content ..................................................................................... 48 7.8.4 ErrorList sample ............................................................................................................................ 48

    7.8.5 errorCode values............................................................................................................................ 48

    7.8.5.1 Reporting errors in the ebXML elements ........................................................ 49

    7.8.5.2 Non-XML document errors ............................................................................ 49 7.9 ds:Signature element.................................................................................................. 50

    7.10 SOAP Body extensions ............................................................................................... 50

    7.11 Manifest element ........................................................................................................ 51

    7.11.1 id attribute ................................................................................................................................ 51

    7.11.2 #wildcard element ..................................................................................................................... 51

    7.11.3 Reference element ..................................................................................................................... 51

    7.11.3.1 Schema element ......................................................................................... 52 Message Service Specification Page 5 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

    Transport, Routing & Packaging Team May 2001

    7.11.3.2 Description element .................................................................................... 52

    7.11.3.3 #wildcard element ...................................................................................... 53 7.11.4 References included in a manifest .............................................................................................. 53 7.11.5 Manifest validation ................................................................................................................... 53

     Manifest sample ........................................................................................................................ 53 7.11.6

    7.12 StatusRequest element ................................................................................................ 53 7.12.1 StatusRequest sample ................................................................................................................ 54 7.13 StatusResponse element ............................................................................................. 54 7.13.1 RefToMessageId element .......................................................................................................... 54 7.13.2 Timestamp element ................................................................................................................... 54 7.13.3 messageStatus attribute ............................................................................................................. 54 7.13.4 StatusResponse sample.............................................................................................................. 55 7.14 DeliveryReceipt element ............................................................................................ 55 7.14.1 Timestamp element ................................................................................................................... 55 7.14.2 ds:Reference element ................................................................................................................ 56 7.14.3 DeliveryReceipt sample............................................................................................................. 56 7.15 Combining ebXML SOAP extension elements ............................................................ 56 7.15.1 Manifest element ....................................................................................................................... 56 7.15.2 MessageHeader element ............................................................................................................ 56 7.15.3 TraceHeaderList element ........................................................................................................... 56 7.15.4 StatusRequest element ............................................................................................................... 56 7.15.5 StatusResponse element ............................................................................................................ 57 7.15.6 ErrorList element ...................................................................................................................... 57 7.15.7 Acknowledgment element ......................................................................................................... 57 7.15.8 Delivery receipt element............................................................................................................ 57 7.15.9 Signature element...................................................................................................................... 57 7.15.10 Via element ............................................................................................................................... 57 8 Message Service Handler Services .................................................................................. 58 8.1 Message status request service................................................................................... 58 8.1.1 Message status request message ..................................................................................................... 58 8.1.2 Message status response message ................................................................................................... 59 8.1.3 Security considerations .................................................................................................................. 60 8.2 Message service handler ping service ........................................................................ 60 8.2.1 Message service handler ping message ........................................................................................... 60 8.2.2 Message service handler pong message .......................................................................................... 61 Message Service Specification Page 6 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

    Transport, Routing & Packaging Team May 2001

    8.2.3 Security considerations .................................................................................................................. 62 9 Reliable Messaging .......................................................................................................... 63

    9.1.1 Persistent storage and system failure .............................................................................................. 63

     Methods of implementing reliable messaging ................................................................................. 63 9.1.2

    9.2 Reliable messaging parameters .................................................................................. 64

    9.2.1 Delivery semantics ........................................................................................................................ 64

    9.2.2 mshTimeAccuracy ......................................................................................................................... 64

    9.2.3 TimeToLive .................................................................................................................................. 65

    9.2.4 reliableMessagingMethod .............................................................................................................. 65

     ackRequested................................................................................................................................. 65 9.2.5

    9.2.6 retries ............................................................................................................................................ 66

     retryInterval ................................................................................................................................... 66 9.2.7

    9.2.8 persistDuration .............................................................................................................................. 66 9.3 ebXML reliable messaging protocol ........................................................................... 66

    9.3.1 Sending message behavior ............................................................................................................. 67

    9.3.2 Receiving message behavior .......................................................................................................... 67

    9.3.3 Generating an acknowledgement message ...................................................................................... 68

    9.3.4 Resending lost messages and duplicate filtering ............................................................................. 69

    9.3.5 Duplicate message handling ........................................................................................................... 71 9.4 Failed message delivery ............................................................................................. 72 10 Error Reporting and Handling ................................................................................... 73 10.1 Definitions ................................................................................................................. 73 10.2 Types of errors ........................................................................................................... 73 10.3 When to generate error messages .............................................................................. 74

    10.3.1 Security considerations.............................................................................................................. 74 10.4 Identifying the error reporting location ...................................................................... 74 10.5 Service and action element values .............................................................................. 75 11 Security ........................................................................................................................ 76 11.1 Security and management .......................................................................................... 76 11.2 Collaboration protocol agreement ............................................................................. 76 11.3 Countermeasure technologies .................................................................................... 77

    11.3.1 Persistent digital signature ......................................................................................................... 77

    11.3.1.1 Signature generation ................................................................................... 77

    Message Service Specification Page 7 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

    Transport, Routing & Packaging Team May 2001

    11.3.2 Persistent signed receipt ............................................................................................................ 79

    11.3.3 Non-persistent authentication .................................................................................................... 80

    11.3.4 Non-persistent Integrity ............................................................................................................. 80

    11.3.5 Persistent confidentiality ........................................................................................................... 80

    11.3.6 Non-persistent confidentiality .................................................................................................... 80

    11.3.7 Persistent authorization ............................................................................................................. 80

    11.3.8 Non-persistent authorization ...................................................................................................... 81

    11.3.9 Trusted timestamp ..................................................................................................................... 81

    11.3.10 Supported security services ....................................................................................................... 81 12 References .................................................................................................................... 84 12.1 Normative references ................................................................................................. 84 12.2 Non-normative references .......................................................................................... 85 13 Contact Information .................................................................................................... 87 14 Disclaimer .................................................................................................................... 92 Appendix A ebXML SOAP Extension Elements Schema ............................................... 93 Appendix B Communication Protocol Bindings .............................................................. 99 Introduction .......................................................................................................................... 99 HTTP .................................................................................................................................... 99

    Minimum level of HTTP protocol ................................................................................................................ 99

    Sending ebXML service messages over HTTP ............................................................................................. 99

    HTTP response codes ................................................................................................................................ 101

    SOAP error conditions and synchronous exchanges ................................................................................... 101

    Synchronous vs. asynchronous .................................................................................................................. 102

    Access control ........................................................................................................................................... 102

    Confidentiality and communication protocol level security ......................................................................... 102 SMTP .................................................................................................................................. 103

    Minimum level of supported protocols ....................................................................................................... 104

    Sending ebXML messages over SMTP ...................................................................................................... 104

    Response messages.................................................................................................................................... 106

    Access control ........................................................................................................................................... 106

    Confidentiality and communication protocol level security ......................................................................... 106

    SMTP model ............................................................................................................................................. 107 Communication errors during reliable messaging ............................................................... 107 Message Service Specification Page 8 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

    Transport, Routing & Packaging Team May 2001 1 Status of this Document This document specifies an ebXML Technical Specification for the eBusiness community.

    Distribution of this document is unlimited. The document formatting is based on the Internet Society‟s Standard RFC format.

    This version

    http://www.ebxml.org/specs/ebMS.pdf

    Latest version

    http://www.ebxml.org/specs/ebMS.pdf

    Message Service Specification Page 9 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

    Transport, Routing & Packaging Team May 2001 2 ebXML Participants

    The authors wish to acknowledge the support of the members of the Transport, Routing and

    Packaging Project Team who contributed ideas to this specification by the group‟s discussion

    eMail list, on conference calls and during face-to-face meeting.

    Ralph Berwanger bTrade.com

    Jonathan Borden Author of XMTP

    Jon Bosak Sun Microsystems

    Marc Breissinger webMethods

    Dick Brooks Group 8760

    Doug Bunting Ariba

    David Burdett Commerce One

    David Craft VerticalNet

    Philippe De Smedt Viquity

    Lawrence Ding WorldSpan

    Rik Drummond Drummond Group

    Andrew Eisenberg Progress Software

    Colleen Evans Progress / Sonic Software

    David Fischer Drummond Group

    Christopher Ferris Sun Microsystems

    Robert Fox Softshare

    Brian Gibb Sterling Commerce

    Maryann Hondo IBM

    Jim Hughes Fujitsu

    Message Service Specification Page 10 of 107

     Copyright ? UN/CEFACT and OASIS, 2001. All Rights Reserved.

Report this document

For any questions or suggestions please email
cust-service@docsford.com