src/share/jaxws_classes/javax/xml/soap/package.html

Sat, 07 Nov 2020 10:30:02 +0800

author
aoqi
date
Sat, 07 Nov 2020 10:30:02 +0800
changeset 1921
7166269ef0f1
parent 0
373ffda63c9a
permissions
-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset fdbe50121f48

aoqi@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
aoqi@0 2 <!--
aoqi@0 3 Copyright (c) 1993, 2002, Oracle and/or its affiliates. All rights reserved.
aoqi@0 4 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 5
aoqi@0 6 This code is free software; you can redistribute it and/or modify it
aoqi@0 7 under the terms of the GNU General Public License version 2 only, as
aoqi@0 8 published by the Free Software Foundation. Oracle designates this
aoqi@0 9 particular file as subject to the "Classpath" exception as provided
aoqi@0 10 by Oracle in the LICENSE file that accompanied this code.
aoqi@0 11
aoqi@0 12 This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 15 version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 16 accompanied this code).
aoqi@0 17
aoqi@0 18 You should have received a copy of the GNU General Public License version
aoqi@0 19 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 20 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 21
aoqi@0 22 Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 23 or visit www.oracle.com if you need additional information or have any
aoqi@0 24 questions.
aoqi@0 25 -->
aoqi@0 26
aoqi@0 27 <html>
aoqi@0 28 <head>
aoqi@0 29
aoqi@0 30 <title></title>
aoqi@0 31
aoqi@0 32 </head>
aoqi@0 33 <body bgcolor="white">
aoqi@0 34 Provides the API for creating and building SOAP messages. This package
aoqi@0 35 is defined in the <i>SOAP with Attachments API for Java<sup><font
aoqi@0 36 size="-2">TM</font></sup> (SAAJ) 1.3</i> specification.
aoqi@0 37 <p> The API in the <code>javax.xml.soap</code> package allows you to do the
aoqi@0 38 following: </p>
aoqi@0 39
aoqi@0 40 <ul>
aoqi@0 41 <li>create a point-to-point connection to a specified endpoint </li>
aoqi@0 42 <li>create a SOAP message </li>
aoqi@0 43 <li>create an XML fragment </li>
aoqi@0 44 <li>add content to the header of a SOAP message </li>
aoqi@0 45 <li>add content to the body of a SOAP message </li>
aoqi@0 46 <li>create attachment parts and add content to them </li>
aoqi@0 47 <li>access/add/modify parts of a SOAP message </li>
aoqi@0 48 <li>create/add/modify SOAP fault information </li>
aoqi@0 49 <li>extract content from a SOAP message </li>
aoqi@0 50 <li>send a SOAP request-response message </li>
aoqi@0 51
aoqi@0 52 </ul>
aoqi@0 53
aoqi@0 54 <p> <!-- <h2>Package Specification</h2> --> <!-- The SAAJ 1.1 specification gives an overview of the -->
aoqi@0 55 <!-- <code>javax.xml.soap</code> package and --> <!-- explains how its classes and interfaces work. -->
aoqi@0 56 <!-- <ul> --> <!-- <li><a href="http://java.sun.com/xml/downloads/jaxm.html"> -->
aoqi@0 57 <!-- SAAJ 1.1 Specification</a> --> <!-- </ul> --> <!-- <h2>Related Documentation</h2> -->
aoqi@0 58 <!-- For overviews, tutorials, examples, guides, and tool documentation, please see: -->
aoqi@0 59 <!-- <ul> --> <!-- <li><a href="../../../../tutorial/doc/JAXM.html">JAXM Tutorial</a> -->
aoqi@0 60 <!-- <li><a href="../../../../jaxm/index.html">JAXM Reference Implementation (RI) -->
aoqi@0 61 <!-- Documentation</a> --> <!-- </ul> --> </p>
aoqi@0 62 In addition the APIs in the <code>javax.xml.soap</code> package extend
aoqi@0 63 their counterparts in the <code>org.w3c.dom</code> package. This means that
aoqi@0 64 the <code>SOAPPart</code> of a <code>SOAPMessage</code> is also a DOM Level
aoqi@0 65 2 <code>Document</code>, and can be manipulated as such by applications,
aoqi@0 66 tools and libraries that use DOM (see http://www.w3.org/DOM/ for more information).
aoqi@0 67 It is important to note that, while it is possible to use DOM APIs to add
aoqi@0 68 ordinary DOM nodes to a SAAJ tree, the SAAJ APIs are still required to return
aoqi@0 69 SAAJ types when examining or manipulating the tree. In order to accomplish
aoqi@0 70 this the SAAJ APIs (specifically {@link javax.xml.soap.SOAPElement#getChildElements()})
aoqi@0 71 are allowed to silently replace objects that are incorrectly typed relative
aoqi@0 72 to SAAJ requirements with equivalent objects of the required type. These
aoqi@0 73 replacements must never cause the logical structure of the tree to change,
aoqi@0 74 so from the perspective of the DOM APIs the tree will remain unchanged. However,
aoqi@0 75 the physical composition of the tree will have changed so that references
aoqi@0 76 to the nodes that were replaced will refer to nodes that are no longer a
aoqi@0 77 part of the tree. The SAAJ APIs are not allowed to make these replacements
aoqi@0 78 if they are not required so the replacement objects will never subsequently
aoqi@0 79 be silently replaced by future calls to the SAAJ API.
aoqi@0 80 <p>
aoqi@0 81 What this means in
aoqi@0 82 practical terms is that an application that starts to use SAAJ APIs on a
aoqi@0 83 tree after manipulating it using DOM APIs must assume that the tree has been
aoqi@0 84 translated into an all SAAJ tree and that any references to objects within
aoqi@0 85 the tree that were obtained using DOM APIs are no longer valid. Switching
aoqi@0 86 from SAAJ APIs to DOM APIs is not allowed to cause invalid references and
aoqi@0 87 neither is using SAAJ APIs exclusively. It is only switching from using DOM
aoqi@0 88 APIs on a particular SAAJ tree to using SAAJ APIs that causes the risk of
aoqi@0 89 invalid references.<br>
aoqi@0 90
aoqi@0 91 </body>
aoqi@0 92 </html>

mercurial