1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/javax/xml/soap/package.html Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,92 @@
1.4 +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
1.5 +<!--
1.6 + Copyright (c) 1993, 2002, Oracle and/or its affiliates. All rights reserved.
1.7 + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.8 +
1.9 + This code is free software; you can redistribute it and/or modify it
1.10 + under the terms of the GNU General Public License version 2 only, as
1.11 + published by the Free Software Foundation. Oracle designates this
1.12 + particular file as subject to the "Classpath" exception as provided
1.13 + by Oracle in the LICENSE file that accompanied this code.
1.14 +
1.15 + This code is distributed in the hope that it will be useful, but WITHOUT
1.16 + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.17 + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.18 + version 2 for more details (a copy is included in the LICENSE file that
1.19 + accompanied this code).
1.20 +
1.21 + You should have received a copy of the GNU General Public License version
1.22 + 2 along with this work; if not, write to the Free Software Foundation,
1.23 + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.24 +
1.25 + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.26 + or visit www.oracle.com if you need additional information or have any
1.27 + questions.
1.28 +-->
1.29 +
1.30 +<html>
1.31 +<head>
1.32 +
1.33 + <title></title>
1.34 +
1.35 +</head>
1.36 + <body bgcolor="white">
1.37 + Provides the API for creating and building SOAP messages. This package
1.38 + is defined in the <i>SOAP with Attachments API for Java<sup><font
1.39 + size="-2">TM</font></sup> (SAAJ) 1.3</i> specification.
1.40 +<p> The API in the <code>javax.xml.soap</code> package allows you to do the
1.41 + following: </p>
1.42 +
1.43 +<ul>
1.44 + <li>create a point-to-point connection to a specified endpoint </li>
1.45 + <li>create a SOAP message </li>
1.46 + <li>create an XML fragment </li>
1.47 + <li>add content to the header of a SOAP message </li>
1.48 + <li>add content to the body of a SOAP message </li>
1.49 + <li>create attachment parts and add content to them </li>
1.50 + <li>access/add/modify parts of a SOAP message </li>
1.51 + <li>create/add/modify SOAP fault information </li>
1.52 + <li>extract content from a SOAP message </li>
1.53 + <li>send a SOAP request-response message </li>
1.54 +
1.55 +</ul>
1.56 +
1.57 +<p> <!-- <h2>Package Specification</h2> --> <!-- The SAAJ 1.1 specification gives an overview of the -->
1.58 + <!-- <code>javax.xml.soap</code> package and --> <!-- explains how its classes and interfaces work. -->
1.59 + <!-- <ul> --> <!-- <li><a href="http://java.sun.com/xml/downloads/jaxm.html"> -->
1.60 + <!-- SAAJ 1.1 Specification</a> --> <!-- </ul> --> <!-- <h2>Related Documentation</h2> -->
1.61 + <!-- For overviews, tutorials, examples, guides, and tool documentation, please see: -->
1.62 + <!-- <ul> --> <!-- <li><a href="../../../../tutorial/doc/JAXM.html">JAXM Tutorial</a> -->
1.63 + <!-- <li><a href="../../../../jaxm/index.html">JAXM Reference Implementation (RI) -->
1.64 + <!-- Documentation</a> --> <!-- </ul> --> </p>
1.65 +In addition the APIs in the <code>javax.xml.soap</code> package extend
1.66 +their counterparts in the <code>org.w3c.dom</code> package. This means that
1.67 +the <code>SOAPPart</code> of a <code>SOAPMessage</code> is also a DOM Level
1.68 +2 <code>Document</code>, and can be manipulated as such by applications,
1.69 +tools and libraries that use DOM (see http://www.w3.org/DOM/ for more information).
1.70 +It is important to note that, while it is possible to use DOM APIs to add
1.71 +ordinary DOM nodes to a SAAJ tree, the SAAJ APIs are still required to return
1.72 +SAAJ types when examining or manipulating the tree. In order to accomplish
1.73 +this the SAAJ APIs (specifically {@link javax.xml.soap.SOAPElement#getChildElements()})
1.74 +are allowed to silently replace objects that are incorrectly typed relative
1.75 +to SAAJ requirements with equivalent objects of the required type. These
1.76 +replacements must never cause the logical structure of the tree to change,
1.77 +so from the perspective of the DOM APIs the tree will remain unchanged. However,
1.78 +the physical composition of the tree will have changed so that references
1.79 +to the nodes that were replaced will refer to nodes that are no longer a
1.80 +part of the tree. The SAAJ APIs are not allowed to make these replacements
1.81 +if they are not required so the replacement objects will never subsequently
1.82 +be silently replaced by future calls to the SAAJ API.
1.83 +<p>
1.84 +What this means in
1.85 +practical terms is that an application that starts to use SAAJ APIs on a
1.86 +tree after manipulating it using DOM APIs must assume that the tree has been
1.87 +translated into an all SAAJ tree and that any references to objects within
1.88 +the tree that were obtained using DOM APIs are no longer valid. Switching
1.89 +from SAAJ APIs to DOM APIs is not allowed to cause invalid references and
1.90 +neither is using SAAJ APIs exclusively. It is only switching from using DOM
1.91 +APIs on a particular SAAJ tree to using SAAJ APIs that causes the risk of
1.92 +invalid references.<br>
1.93 +
1.94 +</body>
1.95 +</html>
