uTools-Manuals/docs/java/javax/xml/soap/SOAPMessage.html

<div class="header">
<div class="subTitle">
     javax.xml.soap 
   </div>
<h2 class="title" title="Class SOAPMessage">Class SOAPMessage</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.xml.soap.SOAPMessage</li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr/> <br/> <pre>public abstract class <span class="typeNameLabel">SOAPMessage</span>
extends <a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></pre>
<div class="block">
<span>所有SOAP消息的根类。</span>
<span>如在“线”上传输的，SOAP消息是XML文档或MIME消息，其第一个主体部分是XML / SOAP文档。</span>
<p> <span><code>SOAPMessage</code>对象由SOAP部分和可选的一个或多个附件部分组成。</span> <span><code>SOAPMessage</code>对象的SOAP部分是一个<code>SOAPPart</code>对象，其中包含用于消息路由和标识的信息，可以包含应用程序特定的内容。</span> <span>消息的SOAP部分中的所有数据必须是XML格式。</span> </p>
<p> <span>新的<code>SOAPMessage</code>对象默认包含以下内容：</span> </p>
<ul>
<li> <span>一个<code>SOAPPart</code>对象</span> </li>
<li> <span>一个<code>SOAPEnvelope</code>对象</span> </li>
<li> <span>一个<code>SOAPBody</code>对象</span> </li>
<li> <span>一个<code>SOAPHeader</code>对象</span> </li>
</ul>
<span>消息的SOAP部分可以通过调用方法<code>SOAPMessage.getSOAPPart()</code> 。</span>
<span>所述<code>SOAPEnvelope</code>对象从检索<code>SOAPPart</code>对象，并且<code>SOAPEnvelope</code>对象用于检索<code>SOAPBody</code>个<code>SOAPHeader</code>对象。</span>
<pre>  <span>SOAPPart sp = message.getSOAPPart();
     SOAPEnvelope se = sp.getEnvelope();
     SOAPBody sb = se.getBody();
     SOAPHeader sh = se.getHeader();</span> </pre>
<p> <span>除了强制性的<code>SOAPPart</code>对象外， <code>SOAPMessage</code>对象可能包含零个或多个<code>AttachmentPart</code>对象，每个对象包含应用程序特定的数据。</span> <span><code>SOAPMessage</code>接口提供了创建<code>AttachmentPart</code>对象以及将其添加到<code>SOAPMessage</code>对象的方法。</span> <span>收到一个<code>SOAPMessage</code>对象的一方可以通过检索各个附件部分来检查其内容。</span> </p>
<p> <span>与SOAP消息的其余部分不同，附件不需要是XML格式，因此可以是从简单文本到图像文件的任何内容。</span> <span>因此，任何不是XML格式的邮件内容都必须在<code>AttachmentPart</code>对象中。</span> </p>
<p> <span><code>MessageFactory</code>对象可以创建<code>SOAPMessage</code>对象，该对象具有专门针对SAAJ的特定实现或应用程序的行为。</span> <span>例如， <code>MessageFactory</code>对象可能产生符合特定配置文件（如ebXML）的<code>SOAPMessage</code>对象。</span> <span>在这种情况下， <code>MessageFactory</code>对象可能会产生使用ebXML头部<code>SOAPMessage</code>对象。</span> </p>
<p> <span>为了确保向后的源兼容性，在SAAJ规范版本1.1之后添加到此类的方法都是具体而不是抽象的，它们都具有默认实现。</span> <span>除非在JavaDocs中为这些方法另有说明，默认实现只需抛出一个<code>UnsupportedOperationException</code> ，并且SAAJ实现代码必须用提供指定行为的方法覆盖它们。</span> <span>然而，传统的客户端代码没有这种限制，只要没有声明符合规范的某些更新版本，而不是最初编写的。</span> <span>扩展SOAPMessage类的遗留类可以编译和/或针对后续版本的SAAJ API进行运行，而无需修改。</span> <span>如果这样的一个类被正确地实现，那么它将继续正确地相对于它被编写的规范版本而正确地运行。</span> </p>
</div>
<dl>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../javax/xml/soap/MessageFactory.html" title="javax.xml.soap中的类"><code>MessageFactory</code></a> ， <a href="../../../javax/xml/soap/AttachmentPart.html" title="javax.xml.soap中的类"><code>AttachmentPart</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption>
<span>Fields</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#CHARACTER_SET_ENCODING">CHARACTER_SET_ENCODING</a></span></code>
<div class="block">
              指定SOAP消息的字符类型编码。 
            </div> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#WRITE_XML_DECLARATION">WRITE_XML_DECLARATION</a></span></code>
<div class="block">
              指定SOAP消息发送时是否包含XML声明。 
            </div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#SOAPMessage--">SOAPMessage</a></span>()</code> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t3"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#addAttachmentPart-javax.xml.soap.AttachmentPart-">addAttachmentPart</a></span>(<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> AttachmentPart)</code>
<div class="block">
              将给定的 
             <code>AttachmentPart</code>对象添加到此 
             <code>SOAPMessage</code>对象。 
            </div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#countAttachments--">countAttachments</a></span>()</code>
<div class="block">
              获取此消息中附件数量的计数。 
            </div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart--">createAttachmentPart</a></span>()</code>
<div class="block">
              创建一个新的空 
             <code>AttachmentPart</code>对象。 
            </div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart-javax.activation.DataHandler-">createAttachmentPart</a></span>(<a href="../../../javax/activation/DataHandler.html" title="class in javax.activation">DataHandler</a> dataHandler)</code>
<div class="block">
              创建一个 
             <code>AttachmentPart</code>对象，并使用给定的 
             <code>DataHandler</code>对象进行 
             <code>DataHandler</code> 。 
            </div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart-java.lang.Object-java.lang.String-">createAttachmentPart</a></span>(<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a> content, <a href="../../../java/lang/String.html" title="class in java.lang">String</a> contentType)</code>
<div class="block">
              创建一个 
             <code>AttachmentPart</code>对象，并使用指定的内容类型的指定数据填充它。 
            </div> </td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachment-javax.xml.soap.SOAPElement-">getAttachment</a></span>(<a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a> element)</code>
<div class="block">
              返回与 
             <code>AttachmentPart</code>对象，该 
             <code>SOAPElement</code>或 
             <code>null</code>如果不存在此类附件。 
            </div> </td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>abstract <a href="../../../java/util/Iterator.html" title="interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments--">getAttachments</a></span>()</code>
<div class="block">
              检索所有 
             <code>AttachmentPart</code>对象是这部分 
             <code>SOAPMessage</code>对象。 
            </div> </td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>abstract <a href="../../../java/util/Iterator.html" title="interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments-javax.xml.soap.MimeHeaders-">getAttachments</a></span>(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</code>
<div class="block">
              检索具有与指定标题匹配的标题条目的所有 
             <code>AttachmentPart</code>对象。 
            </div> </td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>abstract <a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription--">getContentDescription</a></span>()</code>
<div class="block">
              检索此 
             <code>SOAPMessage</code>对象内容的描述。 
            </div> </td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getMimeHeaders--">getMimeHeaders</a></span>()</code>
<div class="block">
              以传输独立的方式返回此 
             <code>SOAPMessage</code>对象的所有传输特定MIME标头。 
            </div> </td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code><a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getProperty-java.lang.String-">getProperty</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> property)</code>
<div class="block">
              检索指定属性的值。 
            </div> </td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPBody--">getSOAPBody</a></span>()</code>
<div class="block">
              获取此 
             <code>SOAPMessage</code>对象中包含的SOAP Body。 
            </div> </td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPHeader--">getSOAPHeader</a></span>()</code>
<div class="block">
              获取此 
             <code>SOAPMessage</code>对象中包含的SOAP头。 
            </div> </td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPPart--">getSOAPPart</a></span>()</code>
<div class="block">
              获取此 
             <code>SOAPMessage</code>对象的SOAP部分。 
            </div> </td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#removeAllAttachments--">removeAllAttachments</a></span>()</code>
<div class="block">
              删除所有 
             <code>AttachmentPart</code>已经加入到这一对象 
             <code>SOAPMessage</code>对象。 
            </div> </td>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#removeAttachments-javax.xml.soap.MimeHeaders-">removeAttachments</a></span>(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</code>
<div class="block">
              删除所有具有与指定标题匹配的标题条目的 
             <code>AttachmentPart</code>对象。 
            </div> </td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#saveChanges--">saveChanges</a></span>()</code>
<div class="block">
              更新此 
             <code>SOAPMessage</code>对象，并对其进行了所有更改。 
            </div> </td>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#saveRequired--">saveRequired</a></span>()</code>
<div class="block">
              指示这个 
             <code>SOAPMessage</code>对象是否需要调用方法 
             <code>saveChanges</code> 。 
            </div> </td>
</tr>
<tr class="altColor" id="i18">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription-java.lang.String-">setContentDescription</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> description)</code>
<div class="block">
              使用给定的说明设置此 
             <code>SOAPMessage</code>对象的内容的描述。 
            </div> </td>
</tr>
<tr class="rowColor" id="i19">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> property, <a href="../../../java/lang/Object.html" title="class in java.lang">Object</a> value)</code>
<div class="block">
              将指定的值与指定的属性相关联。 
            </div> </td>
</tr>
<tr class="altColor" id="i20">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#writeTo-java.io.OutputStream-">writeTo</a></span>(<a href="../../../java/io/OutputStream.html" title="class in java.io">OutputStream</a> out)</code>
<div class="block">
              将此 
             <code>SOAPMessage</code>对象写入给定的输出流。 
            </div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../../java/lang/Object.html#clone--">clone</a>, <a href="../../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../../java/lang/Object.html#notify--">notify</a>, <a href="../../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../../java/lang/Object.html#toString--">toString</a>, <a href="../../../java/lang/Object.html#wait--">wait</a>, <a href="../../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- --> </a> <h3>字段详细信息</h3> <a name="CHARACTER_SET_ENCODING">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>CHARACTER_SET_ENCODING</h4> <pre>public static final <a href="../../../java/lang/String.html" title="class in java.lang">String</a> CHARACTER_SET_ENCODING</pre>
<div class="block">
<span>指定SOAP消息的字符类型编码。</span>
<span>有效值包括“utf-8”和“utf-16”。</span>
<span>有关其他支持的值，请参阅供应商文档。</span>
<span>默认值为“utf-8”。</span>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.2 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<a href="../../../javax/xml/soap/SOAPMessage.html#setProperty-java.lang.String-java.lang.Object-"><code>SOAPMessage.setProperty</code></a> ， 
            <a href="../../../constant-values.html#javax.xml.soap.SOAPMessage.CHARACTER_SET_ENCODING">Constant Field Values</a>
</dd>
</dl> </li>
</ul> <a name="WRITE_XML_DECLARATION">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>WRITE_XML_DECLARATION</h4> <pre>public static final <a href="../../../java/lang/String.html" title="class in java.lang">String</a> WRITE_XML_DECLARATION</pre>
<div class="block">
<span>指定SOAP消息发送时是否包含XML声明。</span>
<span>唯一有效的值是“true”和“false”。</span>
<span>默认值为“false”。</span>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.2 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<a href="../../../javax/xml/soap/SOAPMessage.html#setProperty-java.lang.String-java.lang.Object-"><code>SOAPMessage.setProperty</code></a> ， 
            <a href="../../../constant-values.html#javax.xml.soap.SOAPMessage.WRITE_XML_DECLARATION">Constant Field Values</a>
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="SOAPMessage--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>SOAPMessage</h4> <pre>public SOAPMessage()</pre> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="setContentDescription-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setContentDescription</h4> <pre>public abstract void setContentDescription(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> description)</pre>
<div class="block">
            使用给定的说明设置此 
           <code>SOAPMessage</code>对象的内容的描述。 
          </div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>description</code> - 
            <code>String</code>此消息内容的String 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription--"><code>getContentDescription()</code></a>
</dd>
</dl> </li>
</ul> <a name="getContentDescription--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getContentDescription</h4> <pre>public abstract <a href="../../../java/lang/String.html" title="class in java.lang">String</a> getContentDescription()</pre>
<div class="block">
            检索此 
           <code>SOAPMessage</code>对象内容的描述。 
          </div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             一个 
            <code>String</code>此消息内容的 
            <code>null</code>或 
            <code>null</code>如果没有设置描述） 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription-java.lang.String-"><code>setContentDescription(java.lang.String)</code></a>
</dd>
</dl> </li>
</ul> <a name="getSOAPPart--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getSOAPPart</h4> <pre>public abstract <a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a> getSOAPPart()</pre>
<div class="block">
<span>获取此<code>SOAPMessage</code>对象的SOAP部分。</span>
<p> <span><code>SOAPMessage</code>对象包含一个或多个附件，SOAP部分必须是消息中的第一个MIME主体部分。</span> </p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             该 
            <code>SOAPPart</code>对象为此 
            <code>SOAPMessage</code>对象 
           </dd>
</dl> </li>
</ul> <a name="getSOAPBody--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getSOAPBody</h4> <pre>public <a href="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</a> getSOAPBody()
                     throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">
            获取此 
           <code>SOAPMessage</code>对象中包含的SOAP Body。 
           <p></p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             这个 
            <code>SOAPBody</code>对象包含的 
            <code>SOAPMessage</code>对象 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - 如果SOAP主体不存在或无法检索 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.2 
           </dd>
</dl> </li>
</ul> <a name="getSOAPHeader--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getSOAPHeader</h4> <pre>public <a href="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</a> getSOAPHeader()
                         throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">
            获取此 
           <code>SOAPMessage</code>对象中包含的SOAP头。 
           <p></p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             该 
            <code>SOAPHeader</code>对象包含此 
            <code>SOAPMessage</code>对象 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - 如果SOAP头不存在或无法检索 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.2 
           </dd>
</dl> </li>
</ul> <a name="removeAllAttachments--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>removeAllAttachments</h4> <pre>public abstract void removeAllAttachments()</pre>
<div class="block">
<span>删除所有<code>AttachmentPart</code>已经加入到这一对象<code>SOAPMessage</code>对象。</span>
<p> <span>此方法不接触SOAP部分。</span> </p>
</div> </li>
</ul> <a name="countAttachments--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>countAttachments</h4> <pre>public abstract int countAttachments()</pre>
<div class="block">
<span>获取此消息中附件数量的计数。</span>
<span>此计数不包括SOAP部分。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<code>AttachmentPart</code>对象的数量是这个 
            <code>SOAPMessage</code>对象的一部分 
           </dd>
</dl> </li>
</ul> <a name="getAttachments--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getAttachments</h4> <pre>public abstract <a href="../../../java/util/Iterator.html" title="interface in java.util">Iterator</a> getAttachments()</pre>
<div class="block">
            检索所有 
           <code>AttachmentPart</code>对象是这部分 
           <code>SOAPMessage</code>对象。 
          </div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             在该消息中的所有附件上的迭代器 
           </dd>
</dl> </li>
</ul> <a name="getAttachments-javax.xml.soap.MimeHeaders-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getAttachments</h4> <pre>public abstract <a href="../../../java/util/Iterator.html" title="interface in java.util">Iterator</a> getAttachments(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</pre>
<div class="block">
<span>检索具有与指定标题匹配的标题条目的所有<code>AttachmentPart</code>对象。</span>
<span>请注意，返回的附件除了指定的附件之外还可能包含标题。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>headers</code> - 一个 
            <code>MimeHeaders</code>要搜索的MIME标题的 
            <code>MimeHeaders</code>对象 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             在所有附件上都有一个迭代器，它们具有与给定标题之一匹配的标题 
           </dd>
</dl> </li>
</ul> <a name="removeAttachments-javax.xml.soap.MimeHeaders-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>removeAttachments</h4> <pre>public abstract void removeAttachments(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</pre>
<div class="block">
<span>删除所有具有与指定标题匹配的标题条目的<code>AttachmentPart</code>对象。</span>
<span>请注意，删除的附件除了指定的附件之外还可能有标题。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>headers</code> - 一个 
            <code>MimeHeaders</code>要搜索的MIME标题的 
            <code>MimeHeaders</code>对象 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.3 
           </dd>
</dl> </li>
</ul> <a name="getAttachment-javax.xml.soap.SOAPElement-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getAttachment</h4> <pre>public abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> getAttachment(<a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a> element)
                                      throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">
<span>返回一个<code>AttachmentPart</code>对象，该对象与由此<code>SOAPElement</code>或<code>null</code>如果不存在此类附件。</span>
<span>引用可以通过进行<code>href</code>属性中所描述<a href="http://www.w3.org/TR/SOAP-attachments#SOAPReferenceToAttachements">SOAP Messages with Attachments</a>经由单个，或<code>Text</code>含有URI作为WS-I附件描述简介1.0模式类型的元素的子节点<a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html">ref:swaRef</a> 。</span>
<span>必须支持这两个机制。</span>
<span>通过<code>href</code>引用支持也意味着这个方法也应该是一个元素，它是一个<i>xop：Include</i>元素（ <a href="http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html">XOP</a> ）。</span>
<span>其他参考机制可以由该标准的各个实现来支持。</span>
<span>有关详细信息，请联系您的供应商。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>element</code> - 包含 
            <code>SOAPElement</code>附件的引用的SOAPElement 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             引用 
            <code>AttachmentPart</code>或如果没有这样的 
            <code>AttachmentPart</code>存在null或在此 
            <code>SOAPElement</code>没有 
            <code>SOAPElement</code> 。 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - 如果尝试访问附件时出现错误 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.3 
           </dd>
</dl> </li>
</ul> <a name="addAttachmentPart-javax.xml.soap.AttachmentPart-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>addAttachmentPart</h4> <pre>public abstract void addAttachmentPart(<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> AttachmentPart)</pre>
<div class="block">
<span>将给定的<code>AttachmentPart</code>对象添加到此<code>SOAPMessage</code>对象。</span>
<span>必须创建一个<code>AttachmentPart</code>对象，然后才能将其添加到消息中。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>AttachmentPart</code> -一个 
            <code>AttachmentPart</code>对象，它是成为本的一部分 
            <code>SOAPMessage</code>对象 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code>
</dd>
</dl> </li>
</ul> <a name="createAttachmentPart--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>createAttachmentPart</h4> <pre>public abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> createAttachmentPart()</pre>
<div class="block">
<span>创建一个新的空的<code>AttachmentPart</code>对象。</span>
<span>请注意，必须使用此新的<code>AttachmentPart</code>对象作为参数调用方法<code>addAttachmentPart</code> ，以使其成为此<code>SOAPMessage</code>对象的<code>SOAPMessage</code> 。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             一个新的 
            <code>AttachmentPart</code>对象，可以填充并添加到此 
            <code>SOAPMessage</code>对象 
           </dd>
</dl> </li>
</ul> <a name="createAttachmentPart-javax.activation.DataHandler-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>createAttachmentPart</h4> <pre>public <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> createAttachmentPart(<a href="../../../javax/activation/DataHandler.html" title="class in javax.activation">DataHandler</a> dataHandler)</pre>
<div class="block">
            创建一个 
           <code>AttachmentPart</code>对象，并使用给定的 
           <code>DataHandler</code>对象进行 
           <code>DataHandler</code> 。 
          </div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>dataHandler</code> -在 
            <code>javax.activation.DataHandler</code>对象将生成此内容 
            <code>SOAPMessage</code>对象 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             一个新的 
            <code>AttachmentPart</code>对象，其中包含由给定的 
            <code>DataHandler</code>对象 
            <code>DataHandler</code>数据 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果指定的 
            <code>DataHandler</code>对象有问题 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../javax/activation/DataHandler.html" title="javax.activation中的类"><code>DataHandler</code></a> ， <a href="../../../javax/activation/DataContentHandler.html" title="javax.activation中的接口"><code>DataContentHandler</code></a></span>
</dd>
</dl> </li>
</ul> <a name="getMimeHeaders--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getMimeHeaders</h4> <pre>public abstract <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> getMimeHeaders()</pre>
<div class="block">
            以传输独立的方式返回此 
           <code>SOAPMessage</code>对象的所有传输特定MIME标头。 
          </div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             一个 
            <code>MimeHeaders</code>对象的 
            <code>MimeHeader</code>对象 
           </dd>
</dl> </li>
</ul> <a name="createAttachmentPart-java.lang.Object-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>createAttachmentPart</h4> <pre>public <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> createAttachmentPart(<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a> content,
                                           <a href="../../../java/lang/String.html" title="class in java.lang">String</a> contentType)</pre>
<div class="block">
<span>创建一个<code>AttachmentPart</code>对象，并使用指定的内容类型的指定数据<code>AttachmentPart</code>对象。</span>
<span>的类型的<code>Object</code>应该对应于用于给定的值<code>Content-Type</code> 。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>content</code> -一个 
            <code>Object</code>包含内容为 
            <code>AttachmentPart</code>被创建的对象 
           </dd>
<dd>
<span><code>contentType</code> - 提供内容类型的<code>String</code>对象;</span>
<span>示例是“text / xml”，“text / plain”和“image / jpeg”</span>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             包含给定数据的新的 
            <code>AttachmentPart</code>对象 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果contentType与内容对象的类型不匹配，或者如果给定的内容对象没有 
            <code>DataContentHandler</code>对象，则可能会抛出 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../javax/activation/DataHandler.html" title="javax.activation中的类"><code>DataHandler</code></a> ， <a href="../../../javax/activation/DataContentHandler.html" title="javax.activation中的接口"><code>DataContentHandler</code></a></span>
</dd>
</dl> </li>
</ul> <a name="saveChanges--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>saveChanges</h4> <pre>public abstract void saveChanges()
                          throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">
<span>更新此<code>SOAPMessage</code>对象，并对其进行了所有更改。</span>
<span>当调用<code>writeTo(OutputStream)</code>时，会<a href="../../../javax/xml/soap/SOAPMessage.html#writeTo-java.io.OutputStream-">自动</a>调用此方法。</span>
<span>但是，如果对已收到的消息或已发送的消息进行更改，则需要显式调用方法<code>saveChanges</code>以保存更改。</span>
<span>方法<code>saveChanges</code>还生成可以回读的任何更改（例如，支持消息标识的配置文件中的MessageId）。</span>
<span>为发送目的创建的消息中的所有MIME标头只有在<code>saveChanges</code>之后<code>saveChanges</code> 。</span>
<p> <span>此外，该方法标记了将所有<code>AttachmentPart</code>对象的数据拉入消息的点。</span> </p>
<p></p>
</div>
<dl>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><code>SOAPException</code></code> - 如果在保存对此消息的更改时出现问题。 
           </dd>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code>
</dd>
</dl> </li>
</ul> <a name="saveRequired--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>saveRequired</h4> <pre>public abstract boolean saveRequired()</pre>
<div class="block">
            指示这个 
           <code>SOAPMessage</code>对象是否需要调用方法 
           <code>saveChanges</code> 。 
          </div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span><code>true</code>如果<code>saveChanges</code>需要调用;</span>
<span><code>false</code>否则。</span>
</dd>
</dl> </li>
</ul> <a name="writeTo-java.io.OutputStream-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>writeTo</h4> <pre>public abstract void writeTo(<a href="../../../java/io/OutputStream.html" title="class in java.io">OutputStream</a> out)
                      throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a>,
                             <a href="../../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
<span>将此<code>SOAPMessage</code>对象写入给定的输出流。</span>
<span>外部化格式由具有附件规范的SOAP 1.1定义。</span>
<p> <span>如果没有附件，只会写出一个XML流。</span> <span>对于那些有附件的邮件， <code>writeTo</code>写入MIME编码的字节流。</span> </p>
<p> <span>请注意，此方法不会写入消息的传输特定MIME标头</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>out</code> -在 
            <code>OutputStream</code>到该对象 
            <code>SOAPMessage</code>对象将被写入 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果发生I / O错误 
           </dd>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - 如果在外部化此SOAP消息时出现问题 
           </dd>
</dl> </li>
</ul> <a name="setProperty-java.lang.String-java.lang.Object-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setProperty</h4> <pre>public void setProperty(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> property,
                        <a href="../../../java/lang/Object.html" title="class in java.lang">Object</a> value)
                 throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">
<span>将指定的值与指定的属性相关联。</span>
<span>如果已经有与此属性相关联的值，则替换旧值。</span>
<p> <span>有效的产权名称包括<a href="../../../javax/xml/soap/SOAPMessage.html#WRITE_XML_DECLARATION"><code>WRITE_XML_DECLARATION</code></a>和<a href="../../../javax/xml/soap/SOAPMessage.html#CHARACTER_SET_ENCODING"><code>CHARACTER_SET_ENCODING</code></a> 。</span> <span>所有这些标准SAAJ属性都以“javax.xml.soap”为前缀。</span> <span>供应商还可以添加实现特定属性。</span> <span>这些属性必须以供应商唯一的包名称作为前缀。</span> </p>
<p> <span>将属性<code>WRITE_XML_DECLARATION</code>设置为<code>"true"</code>将导致在SOAP消息开始时写出XML声明。</span> <span>默认值“false”禁止此声明。</span> </p>
<p> <span>属性<code>CHARACTER_SET_ENCODING</code>默认为值<code>"utf-8"</code> ，这将导致SOAP消息使用UTF-8进行编码。</span> <span>将<code>CHARACTER_SET_ENCODING</code>设置为<code>"utf-16"</code>导致SOAP消息使用UTF-16进行编码。</span> </p>
<p> <span>除了UTF-8和UTF-16之外，一些实现可能允许编码。</span> <span>有关详细信息，请参阅供应商的文档。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>property</code> - 指定值 
            <code>property</code>的属性。 
           </dd>
<dd>
<code>value</code> - 与指定属性相关联的值 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - 如果属性名称无法识别。 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.2 
           </dd>
</dl> </li>
</ul> <a name="getProperty-java.lang.String-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getProperty</h4> <pre>public <a href="../../../java/lang/Object.html" title="class in java.lang">Object</a> getProperty(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> property)
                   throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">
            检索指定属性的值。 
          </div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>property</code> - 要检索的属性的名称 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             与命名属性相关 
            <code>null</code>的值或如果没有此类属性， 
            <code>null</code> 。 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - 如果属性名称不被识别。 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             SAAJ 1.2 
           </dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>