Jakarta SOAP with Attachments Jakarta SOAP with Attachments Team, https://projects.eclipse.org/projects/ee4j.jaxws 2.0, August 27, 2020: Table of Contents Eclipse Foundation Specification License . 1 Disclaimers. 2 Scope . 3 1. Introduction . 4 1.1. Acknowledgements. 4 1.2. Terminology . 4 2. Preface. 6 2.1. Audience . 6 2.2. Abstract . 6 3. Typographic Conventions. 7 4. Package Overview . 8 4.1. MessageFactory & SOAPMessage Objects . 8 4.2. SOAPPart & AttachmentPart. 8 4.3. MimeHeader(s) Objects . 9 4.4. SOAP Element . 9 4.5. SOAPEnvelope & SOAPBody objects . 9 4.6. SOAPBodyElement & SOAPFault . 10 4.7. SOAPFaultElement & Detail . 10 4.8. SOAPHeader & SOAPHeaderElement. 10 4.9. SOAPConnection & SOAPConnectionFactory . 10 4.10. SOAPException object . 11 4.11. Node & Text objects . 11 4.12. Name . 11 4.13. SOAPFactory & SOAPElementFactory . 11 4.14. SAAJMetaFactory . 11 4.15. SAAJResult . 12 5. Package: jakarta.xml.soap . 13 5.1. Description . 13 5.2. Discovery of Jakarta SOAP Attachments implementation . 14 Appendix A: References . 15 Appendix B: Change History . 16 Changes in Version 2.0 . 16 Changes in Maintenance Release 4 . 16 Changes in Maintenance Release 3 . 16 Changes in Maintenance Release 2 . 17 Eclipse Foundation Specification License Specification: Jakarta SOAP with Attachments Version: 2.0 Status: Final Release Release: August 27, 2020 Copyright (c) 2019, 2020 Eclipse Foundation. Eclipse Foundation Specification License By using and/or copying this document, or the Eclipse Foundation document from which this statement is linked, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions: Permission to copy, and distribute the contents of this document, or the Eclipse Foundation document from which this statement is linked, in any medium for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the document, or portions thereof, that you use: • link or URL to the original Eclipse Foundation document. • All existing copyright notices, or if one does not exist, a notice (hypertext is preferred, but a textual representation is permitted) of the form: "Copyright (c) [$date-of-document] Eclipse Foundation, Inc. [url to this license]" Inclusion of the full text of this NOTICE must be provided. We request that authorship attribution be provided in any software, documents, or other items or products that you create pursuant to the implementation of the contents of this document, or any portion thereof. No right to create modifications or derivatives of Eclipse Foundation documents is granted pursuant to this license, except anyone may prepare and distribute derivative works and portions of this document in software that implements the specification, in supporting materials accompanying such software, and in documentation of such software, PROVIDED that all such works include the notice below. HOWEVER, the publication of derivative works of this document for use as a technical specification is expressly prohibited. The notice is: "Copyright (c) 2018 Eclipse Foundation. This software or document includes material copied from or derived from [title and URI of the Eclipse Foundation specification document]." Jakarta SOAP with Attachments 1 Eclipse Foundation Specification License Disclaimers THIS DOCUMENT IS PROVIDED "AS IS," AND THE COPYRIGHT HOLDERS AND THE ECLIPSE FOUNDATION MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. THE COPYRIGHT HOLDERS AND THE ECLIPSE FOUNDATION WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE CONTENTS THEREOF. The name and trademarks of the copyright holders or the Eclipse Foundation may NOT be used in advertising or publicity pertaining to this document or its contents without specific, written prior permission. Title to copyright in this document will at all times remain with copyright holders. 2 Jakarta SOAP with Attachments Scope Scope Jakarta SOAP with Attachments defines an API enabling developers to produce and consume messages conforming to the SOAP 1.1, SOAP 1.2, and SOAP Attachments Feature. Jakarta SOAP with Attachments 3 1.1. Acknowledgements Chapter 1. Introduction This specification was developed following the Java™ Community Process (JCP2.10). Comments from experts, participants, and the broader developer community were reviewed and incorporated into this specification. The SOAP with Attachments API for Java Specification, version 1.1 was a maintenance release of the Java™ API for XML Messaging (JAXM) 1.0 specification. JAXM 1.0 was the final deliverable of JSR067 Expert Group (EG). The proposed changes specified in the JSR067 changelog and accepted on 15 April 2002, have been incorporated into this document. The proposed changes specified in the second JSR067 changelog and accepted on 23 April 2003, have been incorporated into this document as SOAP with Attachments API for Java Specification, version 1.2. The proposed changes specified in the third JSR067 changelog have been incorporated into this document as SOAP with Attachments API for Java Specification, version 1.3. The proposed changes specified in the fourth JSR067 changelog have been incorporated into this document as SOAP with Attachments API for Java Specification, version 1.4. Starting with Jakarta SOAP Attachments Specification, Version 2.0, this document is developed under Jakarta EE Specification Process 1.1. Acknowledgements This maintenance release is the product of collaborative work within the Java community. 1.2. Terminology References in this document to SAAJ refer to the Jakarta SOAP with Attachments API unless otherwise noted. The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL, when they appear in this document, are to be interpreted as described in RFC 2119 as quoted here: MUST: This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification. MUST NOT: This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification. SHOULD: This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and 4 Jakarta SOAP with Attachments 1.2. Terminology carefully weighed before choosing a different course. SHOULD NOT: This phrase, or the phrase "NOT RECOMMENDED", mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label. MAY: This word, or the adjective "OPTIONAL", mean that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides. Jakarta SOAP with Attachments 5 2.1. Audience Chapter 2. Preface 2.1. Audience This document is intended for developers using the Java™ programming language who wish to produce and consume messages conforming to the SOAP 1.1, and SOAP 1.2 specification and the SOAP Attachments Feature. Familiarity with the SOAP specifications (including the associated processing model), MIME standards, and XML is assumed. 2.2. Abstract Jakarta SOAP with Attachments defines an API enabling developers to produce and consume messages conforming to the SOAP 1.1, SOAP 1.2.