uTools-Manuals/docs/java/javax/xml/ws/handler/soap/SOAPMessageContext.html

234 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
javax.xml.ws.handler.soap
</div>
<h2 class="title" title="Interface SOAPMessageContext">Interface SOAPMessageContext</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Superinterfaces:
</dt>
<dd>
<span><a href="../../../../../java/util/Map.html" title="java.util中的接口">Map</a> &lt; <a href="../../../../../java/lang/String.html" title="java.lang中的类">String</a> <a href="../../../../../java/lang/Object.html" title="java.lang中的类">Object</a> &gt; <a href="../../../../../javax/xml/ws/handler/MessageContext.html" title="javax.xml.ws.handler中的接口">MessageContext</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public interface <span class="typeNameLabel">SOAPMessageContext</span>
extends <a href="../../../../../javax/xml/ws/handler/MessageContext.html" title="interface in javax.xml.ws.handler">MessageContext</a></pre>
<div class="block">
<span>接口<code>SOAPMessageContext</code>提供对RPC请求或响应的SOAP消息的访问。</span>
<span><code>javax.xml.soap.SOAPMessage</code>指定用于表示具有附件的SOAP 1.1消息的标准Java API。</span>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
JAX-WS 2.0
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../../../../javax/xml/soap/SOAPMessage.html" title="javax.xml.soap中的类"><code>SOAPMessage</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- --> </a> <h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.javax.xml.ws.handler.MessageContext">
<!-- --> </a> <h3>Nested classes/interfaces inherited from interface javax.xml.ws.handler.<a href="../../../../../javax/xml/ws/handler/MessageContext.html" title="interface in javax.xml.ws.handler">MessageContext</a></h3> <code><a href="../../../../../javax/xml/ws/handler/MessageContext.Scope.html" title="enum in javax.xml.ws.handler">MessageContext.Scope</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map">
<!-- --> </a> <h3>Nested classes/interfaces inherited from interface java.util.<a href="../../../../../java/util/Map.html" title="interface in java.util">Map</a></h3> <code><a href="../../../../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../../../../java/util/Map.Entry.html" title="type parameter in Map.Entry">K</a>,<a href="../../../../../java/util/Map.Entry.html" title="type parameter in Map.Entry">V</a>&gt;</code></li>
</ul> </li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.javax.xml.ws.handler.MessageContext">
<!-- --> </a> <h3>Fields inherited from interface javax.xml.ws.handler.<a href="../../../../../javax/xml/ws/handler/MessageContext.html" title="interface in javax.xml.ws.handler">MessageContext</a></h3> <code><a href="../../../../../javax/xml/ws/handler/MessageContext.html#HTTP_REQUEST_HEADERS">HTTP_REQUEST_HEADERS</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#HTTP_REQUEST_METHOD">HTTP_REQUEST_METHOD</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#HTTP_RESPONSE_CODE">HTTP_RESPONSE_CODE</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#HTTP_RESPONSE_HEADERS">HTTP_RESPONSE_HEADERS</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#INBOUND_MESSAGE_ATTACHMENTS">INBOUND_MESSAGE_ATTACHMENTS</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#MESSAGE_OUTBOUND_PROPERTY">MESSAGE_OUTBOUND_PROPERTY</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#OUTBOUND_MESSAGE_ATTACHMENTS">OUTBOUND_MESSAGE_ATTACHMENTS</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#PATH_INFO">PATH_INFO</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#QUERY_STRING">QUERY_STRING</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#REFERENCE_PARAMETERS">REFERENCE_PARAMETERS</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#SERVLET_CONTEXT">SERVLET_CONTEXT</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#SERVLET_REQUEST">SERVLET_REQUEST</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#SERVLET_RESPONSE">SERVLET_RESPONSE</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#WSDL_DESCRIPTION">WSDL_DESCRIPTION</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#WSDL_INTERFACE">WSDL_INTERFACE</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#WSDL_OPERATION">WSDL_OPERATION</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#WSDL_PORT">WSDL_PORT</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#WSDL_SERVICE">WSDL_SERVICE</a></code></li>
</ul> </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>
</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><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/ws/handler/soap/SOAPMessageContext.html#getHeaders-javax.xml.namespace.QName-javax.xml.bind.JAXBContext-boolean-">getHeaders</a></span>(<a href="../../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a> header, <a href="../../../../../javax/xml/bind/JAXBContext.html" title="class in javax.xml.bind">JAXBContext</a> context, boolean allRoles)</code>
<div class="block">
从消息上下文中的消息获取具有特定限定名称的头文件。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/xml/ws/handler/soap/SOAPMessageContext.html#getMessage--">getMessage</a></span>()</code>
<div class="block">
从此消息上下文获取
<code>SOAPMessage</code>
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../../../java/util/Set.html" title="interface in java.util">Set</a>&lt;<a href="../../../../../java/lang/String.html" title="class in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/xml/ws/handler/soap/SOAPMessageContext.html#getRoles--">getRoles</a></span>()</code>
<div class="block">
获取与执行处理程序链相关联的SOAP actor角色。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/xml/ws/handler/soap/SOAPMessageContext.html#setMessage-javax.xml.soap.SOAPMessage-">setMessage</a></span>(<a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a> message)</code>
<div class="block">
在此消息上下文中设置SOAPMessage
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.xml.ws.handler.MessageContext">
<!-- --> </a> <h3>Methods inherited from interface javax.xml.ws.handler.<a href="../../../../../javax/xml/ws/handler/MessageContext.html" title="interface in javax.xml.ws.handler">MessageContext</a></h3> <code><a href="../../../../../javax/xml/ws/handler/MessageContext.html#getScope-java.lang.String-">getScope</a>, <a href="../../../../../javax/xml/ws/handler/MessageContext.html#setScope-java.lang.String-javax.xml.ws.handler.MessageContext.Scope-">setScope</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Map">
<!-- --> </a> <h3>Methods inherited from interface java.util.<a href="../../../../../java/util/Map.html" title="interface in java.util">Map</a></h3> <code><a href="../../../../../java/util/Map.html#clear--">clear</a>, <a href="../../../../../java/util/Map.html#compute-K-java.util.function.BiFunction-">compute</a>, <a href="../../../../../java/util/Map.html#computeIfAbsent-K-java.util.function.Function-">computeIfAbsent</a>, <a href="../../../../../java/util/Map.html#computeIfPresent-K-java.util.function.BiFunction-">computeIfPresent</a>, <a href="../../../../../java/util/Map.html#containsKey-java.lang.Object-">containsKey</a>, <a href="../../../../../java/util/Map.html#containsValue-java.lang.Object-">containsValue</a>, <a href="../../../../../java/util/Map.html#entrySet--">entrySet</a>, <a href="../../../../../java/util/Map.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../java/util/Map.html#forEach-java.util.function.BiConsumer-">forEach</a>, <a href="../../../../../java/util/Map.html#get-java.lang.Object-">get</a>, <a href="../../../../../java/util/Map.html#getOrDefault-java.lang.Object-V-">getOrDefault</a>, <a href="../../../../../java/util/Map.html#hashCode--">hashCode</a>, <a href="../../../../../java/util/Map.html#isEmpty--">isEmpty</a>, <a href="../../../../../java/util/Map.html#keySet--">keySet</a>, <a href="../../../../../java/util/Map.html#merge-K-V-java.util.function.BiFunction-">merge</a>, <a href="../../../../../java/util/Map.html#put-K-V-">put</a>, <a href="../../../../../java/util/Map.html#putAll-java.util.Map-">putAll</a>, <a href="../../../../../java/util/Map.html#putIfAbsent-K-V-">putIfAbsent</a>, <a href="../../../../../java/util/Map.html#remove-java.lang.Object-">remove</a>, <a href="../../../../../java/util/Map.html#remove-java.lang.Object-java.lang.Object-">remove</a>, <a href="../../../../../java/util/Map.html#replace-K-V-">replace</a>, <a href="../../../../../java/util/Map.html#replace-K-V-V-">replace</a>, <a href="../../../../../java/util/Map.html#replaceAll-java.util.function.BiFunction-">replaceAll</a>, <a href="../../../../../java/util/Map.html#size--">size</a>, <a href="../../../../../java/util/Map.html#values--">values</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getMessage--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getMessage</h4> <pre><a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a> getMessage()</pre>
<div class="block">
<span>从此消息上下文获取<code>SOAPMessage</code></span>
<span>修改返回的<code>SOAPMessage</code>更改消息就地,没有必要随后调用<code>setMessage</code></span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>返回<code>SOAPMessage</code> ;</span>
<span>如果此消息上下文中没有<code>SOAPMessage</code>则返回<code>null</code></span>
</dd>
</dl> </li>
</ul> <a name="setMessage-javax.xml.soap.SOAPMessage-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setMessage</h4> <pre>void setMessage(<a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a> message)</pre>
<div class="block">
在此消息上下文中设置SOAPMessage
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>message</code> - SOAP消息
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code>WebServiceException</code> - 如果在此消息上下文中设置
<code>SOAPMessage</code>时有任何错误
</dd>
<dd>
<code><a href="../../../../../java/lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - 如果不支持此操作
</dd>
</dl> </li>
</ul> <a name="getHeaders-javax.xml.namespace.QName-javax.xml.bind.JAXBContext-boolean-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getHeaders</h4> <pre><a href="../../../../../java/lang/Object.html" title="class in java.lang">Object</a>[] getHeaders(<a href="../../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a> header,
<a href="../../../../../javax/xml/bind/JAXBContext.html" title="class in javax.xml.bind">JAXBContext</a> context,
boolean allRoles)</pre>
<div class="block">
<span>从消息上下文中的消息获取具有特定限定名称的头文件。</span>
<span>请注意SOAP消息可以包含具有相同限定名称的多个头文件。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>header</code> - SOAP标头的XML限定名称。
</dd>
<dd>
<code>context</code> - 应用于解组头的JAXBContext
</dd>
<dd>
<code>allRoles</code> - 如果
<code>true</code>返回所有SOAP角色的头文件如果
<code>false</code>只返回目标在此SOAP节点正在播放的角色的头文件请参阅
<code>getRoles</code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>一组未编组的标题;</span>
<span>如果此消息上下文中没有消息,或者没有标头与提供的限定名称匹配,则返回一个空数组。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<span><code>WebServiceException</code> - 如果使用提供的<code>JAXBContext</code>进行解组时发生错误。</span>
<span><code>WebServiceException</code>的原因是原来的<code>JAXBException</code></span>
</dd>
</dl> </li>
</ul> <a name="getRoles--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getRoles</h4> <pre><a href="../../../../../java/util/Set.html" title="interface in java.util">Set</a>&lt;<a href="../../../../../java/lang/String.html" title="class in java.lang">String</a>&gt; getRoles()</pre>
<div class="block">
<span>获取与执行处理程序链相关联的SOAP actor角色。</span>
<span>请注意SOAP actor角色适用于SOAP节点并使用<a href="../../../../../javax/xml/ws/soap/SOAPBinding.html#setRoles-java.util.Set-"><code>SOAPBinding.setRoles(java.util.Set&lt;java.lang.String&gt;)</code></a><a href="../../../../../javax/xml/ws/soap/SOAPBinding.html#getRoles--"><code>SOAPBinding.getRoles()</code></a>进行管理。</span>
<span>处理程序链中的<code>Handler</code>实例使用有关SOAP actor角色的此信息来处理SOAP标头块。</span>
<span>请注意在通过处理程序链处理SOAP消息期间SOAP actor角色是不变的。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
数组为
<code>String</code> 用于SOAP演员角色
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>