1 2 ebXML Messaging Services 3 Specification 2.1 4 Working Draft 04, 25 March 2004 5 Document identifier: 6 wd-ebMS-2_1-04 7 Location: 8 http://www.oasis-open.org/committees/download.php/5591/wd-ebMS-2_1-01.pdf 9 Editor: 10 Matthew MacKenzie, Adobe Systems Incorporated, [email protected] 11 Contributors: 12 Dale Moberg Cyclone Commerce [email protected] Doug Bunting Sun Microsystems [email protected] Ian Jones Individual [email protected] Jacques Durand Fujitsu [email protected] Jeff Turpin Cyclone Commerce [email protected] Martin Sachs Cyclone Commerce [email protected] Mike Dillon Drummond Group [email protected] Pete Wenzel SeeBeyond [email protected] 13 14 Abstract: 15 [TODO] 16 Status: 17 This document specifies an ebXML Message Specification for the eBusiness community. 18 Distribution of this document is unlimited. 19 Note: Implementers of this specification should consult the OASIS ebXML Messaging Services 20 Technical Committee web site for current status and revisions to the specification 21 (http://www.oasis-open.org/committees/ebxml-msg/ ). 22 Previous version (2.0) 23 http://www.oasis-open.org/committees/ebxml-msg/documents/ebMS_v2_0.pdf 24 Errata to this version 25 http://TODO Copyright (C) .2004 OASIS Open, Inc. All Rights Reserved. OASIS ebXML Messaging Services March 2004 26 27 28 Table of Contents 29 1 Introduction 8 30 2 Summary of Contents of this Document 9 31 2.1.1 Document Conventions 9 32 2.1.2 Audience 10 33 2.1.3 Caveats and Assumptions 10 34 2.1.4 Related Documents 10 35 2.2 Concept of Operation 10 36 2.2.1 Scope 10 37 2.2.2 Background and Objectives 11 38 2.2.3 Operational Policies and Constraints 12 39 2.2.4 Modes of Operation 12 40 2.3 Minimal Requirements for Conformance 13 41 3 ebXML with SOAP 16 42 3.1 Packaging Specification 16 43 3.1.1 SOAP Structural Conformance 17 44 3.1.2 Message Package 17 45 3.1.3 Header Container 17 46 3.1.3.1 Content-Type 17 47 3.1.3.2 charset attribute 17 48 3.1.3.3 Header Container Example 18 49 3.1.4 Payload Container 18 50 3.1.4.1 Example of a Payload Container 18 51 3.1.5 Additional MIME Parameters 19 52 3.1.6 Reporting MIME Errors 19 53 3.2 XML Prolog 19 54 3.2.1 XML Declaration 19 55 3.2.2 Encoding Declaration 19 56 3.3 ebXML SOAP Envelope extensions 20 57 3.3.1 Namespace pseudo attribute 20 58 3.3.2 xsi:schemaLocation attribute 20 59 3.3.3 SOAP Header Element 21 60 3.3.4 SOAP Body Element 21 61 3.3.5 ebXML SOAP Extensions 21 62 3.3.5.1 SOAP Header extensions: 21 63 3.3.5.2 SOAP Body extension: 21 64 3.3.5.3 Core ebXML Modules: 21 65 3.3.6 #wildcard Element Content 22 66 3.3.7 id attribute 22 67 3.3.8 version attribute 22 68 3.3.9 SOAP mustUnderstand attribute 22 Message Service Specification 2.1 Page 2 of 87 Copyright © 2002 OASIS Open, Inc. All Rights Reserved. OASIS ebXML Messaging Services March 2004 69 3.3.10 ebXML "Next MSH" actor URI 23 70 3.3.11 ebXML "To Party MSH" actor URI 23 71 4 Core Extension Elements 24 72 4.1 MessageHeader Element 24 73 4.1.1 From and To Elements 24 74 4.1.1.1 PartyId Element 24 75 4.1.1.2 Role Element 25 76 4.1.2 CPAId Element 25 77 4.1.3 ConversationId Element 25 78 4.1.4 Service Element 26 79 4.1.4.1 type attribute 26 80 4.1.5 Action Element 26 81 4.1.6 MessageData Element 26 82 4.1.6.1 MessageId Element 27 83 4.1.6.2 Timestamp Element 27 84 4.1.6.3 RefToMessageId Element 27 85 4.1.6.4 TimeToLive Element 27 86 4.1.7 DuplicateElimination Element 27 87 4.1.8 Description Element 28 88 4.1.9 MessageHeader Sample 28 89 4.2 Manifest Element 28 90 4.2.1 Reference Element 29 91 4.2.1.1 Schema Element 29 92 4.2.1.2 Description Element 29 93 4.2.2 Manifest Validation 29 94 4.2.3 Manifest Sample 30 95 5 Core Modules 31 96 5.1 Security Module 31 97 5.1.1 Signature Element 31 98 5.1.2 Security and Management 31 99 5.1.2.1 Collaboration Protocol Agreement 31 100 5.1.3 Signature Generation 32 101 5.1.4 Countermeasure Technologies 34 102 5.1.4.1 Persistent Digital Signature 34 103 5.1.4.2 Persistent Signed Receipt 34 104 5.1.4.3 Non-persistent Authentication 35 105 5.1.4.4 Non-persistent Integrity 35 106 5.1.4.5 Persistent Confidentiality 35 107 5.1.4.6 Non-persistent Confidentiality 35 108 5.1.4.7 Persistent Authorization 35 109 5.1.4.8 Non-persistent Authorization 35 110 5.1.4.9 Trusted Timestamp 35 111 5.1.5 Security Considerations 36 112 5.2 Error Handling Module 37 113 5.2.1.1 Definitions: 37 114 5.2.2 Types of Errors 37 Message Service Specification 2.1 Page 3 of 87 Copyright © 2002 OASIS Open, Inc. All Rights Reserved. OASIS ebXML Messaging Services March 2004 115 5.2.3 ErrorList Element 37 116 5.2.3.1 highestSeverity attribute 38 117 5.2.3.2 Error Element 38 118 5.2.3.3 ErrorList Sample 39 119 5.2.3.4 errorCode values 39 120 5.2.4 Implementing Error Reporting and Handling 40 121 5.2.4.1 When to Generate Error Messages 40 122 5.2.4.2 Identifying the Error Reporting Location 40 123 5.2.4.3 Service and Action Element Values 40 124 5.3 SyncReply Module 41 125 5.3.1 SyncReply Element 41 126 6 Combining ebXML SOAP Extension Elements 42 127 6.1.1 MessageHeader Element Interaction 42 128 6.1.2 Manifest Element Interaction 42 129 6.1.3 Signature Element Interaction 42 130 6.1.4 ErrorList Element Interaction 42 131 6.1.5 SyncReply Element Interaction 42 132 7 Reliable Messaging Module 44 133 7.1 Persistent Storage and System Failure 44 134 7.2 Methods of Implementing Reliable Messaging 44 135 7.3 Reliable Messaging SOAP Header Extensions 45 136 7.3.1 AckRequested Element 45 137 7.3.1.1 SOAP actor attribute 45 138 7.3.1.2 signed attribute 45 139 7.3.1.3 AckRequested Sample 46 140 7.3.1.4 AckRequested Element Interaction 46 141 7.3.2 Acknowledgment Element 46 142 7.3.2.1 SOAP actor attribute 46 143 7.3.2.2 Timestamp Element 46 144 7.3.2.3 RefToMessageId Element 46 145 7.3.2.4 From Element 47 146 7.3.2.5 [XMLDSIG] Reference Element 47 147 7.3.2.6 Acknowledgment Sample 47 148 7.3.2.7 Sending an Acknowledgment Message by Itself 47 149 7.3.2.8 Acknowledgment Element Interaction 48 150 7.4 Reliable Messaging Parameters 48 151 7.4.1 DuplicateElimination 48 152 7.4.2 AckRequested 48 153 7.4.3 Retries 48 154 7.4.4 RetryInterval 48 155 7.4.5 TimeToLive 48 156 7.4.6 PersistDuration 49 157 7.4.7 syncReplyMode 49 158 7.5 ebXML Reliable Messaging Protocol 49 159 7.5.1 Sending Message Behavior 50 160 7.5.2 Receiving Message Behavior 50 Message Service Specification 2.1 Page 4 of 87 Copyright © 2002 OASIS Open, Inc. All Rights Reserved. OASIS ebXML Messaging Services March 2004 161 7.5.3 Generating an Acknowledgment Message 51 162 7.5.4 Resending Lost Application Messages 51 163 7.5.5 Resending Acknowledgments 52 164 7.5.6 Duplicate Message Handling 52 165 7.5.7 Failed Message Delivery 53 166 7.6 Reliable Messaging Combinations 53 167 8 Message Status Service 55 168 8.1 Message Status Messages 55 169 8.1.1 Message Status Request Message 55 170 8.1.2 Message Status Response Message 55 171 8.1.3 Security Considerations 56 172 8.2 StatusRequest Element 56 173 8.2.1 RefToMessageId Element 56 174 8.2.2 StatusRequest Sample 56 175 8.2.3 StatusRequest Element Interaction 56 176 8.3 StatusResponse Element 56 177 8.3.1 RefToMessageId Element 57 178 8.3.2 Timestamp Element 57 179 8.3.3 messageStatus attribute 57 180 8.3.4 StatusResponse Sample 57 181 8.3.5 StatusResponse Element Interaction 57 182 9 Message Service Handler Ping Service 58 183 9.1 Message Service Handler Ping Message 58 184 9.2 Message Service Handler Pong Message 59 185 9.3 Security Considerations 60 186 10 MessageOrder Module 61 187 10.1 MessageOrder Element 61 188 10.1.1 SequenceNumber Element 61 189 10.1.2 MessageOrder Sample 62 190 10.2 MessageOrder Element Interaction 62 191 11 Multi-Hop Module 63 192 11.1 Multi-hop Reliable Messaging 63 193 11.1.1 AckRequested Sample 63 194 11.1.2 Acknowledgment Sample 64 195 11.1.3 Multi-Hop Acknowledgments 64 196 11.1.4 Signing Multi-Hop Acknowledgments 64 197 11.1.5 Multi-Hop Security Considerations 65 198 11.2 Message Ordering and Multi-Hop 65 199 Appendix A.