uTools-Manuals/docs/java/javax/xml/ws/WebServiceContext.html

<div class="header">
<div class="subTitle">
     javax.xml.ws 
   </div>
<h2 class="title" title="Interface WebServiceContext">Interface WebServiceContext</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr/> <br/> <pre>public interface <span class="typeNameLabel">WebServiceContext</span></pre>
<div class="block">
<span>A <code>WebServiceContext</code>使Web服务端点实现类可以相对于正在服务的请求访问消息上下文和安全信息。</span>
<span>通常， <code>WebServiceContext</code>注入到使用端点实现类<code>Resource</code>注解。</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/annotation/Resource.html" title="javax.annotation中的注释"><code>Resource</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>&lt;T extends <a href="../../../javax/xml/ws/EndpointReference.html" title="class in javax.xml.ws">EndpointReference</a>&gt;<br/>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/WebServiceContext.html#getEndpointReference-java.lang.Class-org.w3c.dom.Element...-">getEndpointReference</a></span>(<a href="../../../java/lang/Class.html" title="class in java.lang">类</a>&lt;T&gt; clazz, <a href="../../../org/w3c/dom/Element.html" title="interface in org.w3c.dom">Element</a>... referenceParameters)</code>
<div class="block">
              返回与此端点相关 
             <code>EndpointReference</code> EndpointReference。 
            </div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../javax/xml/ws/EndpointReference.html" title="class in javax.xml.ws">EndpointReference</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/WebServiceContext.html#getEndpointReference-org.w3c.dom.Element...-">getEndpointReference</a></span>(<a href="../../../org/w3c/dom/Element.html" title="interface in org.w3c.dom">Element</a>... referenceParameters)</code>
<div class="block">
              返回此端点的 
             <code>EndpointReference</code> 。 
            </div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../javax/xml/ws/handler/MessageContext.html" title="interface in javax.xml.ws.handler">MessageContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/WebServiceContext.html#getMessageContext--">getMessageContext</a></span>()</code>
<div class="block">
              返回在 
             <code>MessageContext</code>此方法时提供的请求的 
             <code>MessageContext</code> 。 
            </div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../java/security/Principal.html" title="interface in java.security">Principal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/WebServiceContext.html#getUserPrincipal--">getUserPrincipal</a></span>()</code>
<div class="block">
              返回标识当前正在处理的请求的发件人的Principal。 
            </div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/WebServiceContext.html#isUserInRole-java.lang.String-">isUserInRole</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> role)</code>
<div class="block">
              返回一个布尔值，指示经过身份验证的用户是否包含在指定的逻辑角色中。 
            </div> </td>
</tr>
</tbody>
</table> </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="getMessageContext--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getMessageContext</h4> <pre><a href="../../../javax/xml/ws/handler/MessageContext.html" title="interface in javax.xml.ws.handler">MessageContext</a> getMessageContext()</pre>
<div class="block">
<span>返回在<code>MessageContext</code>此方法时提供的请求的<code>MessageContext</code> 。</span>
<span>只有具有APPLICATION范围的属性才能对应用程序可见。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             MessageContext消息上下文。 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果在没有请求服务的情况下调用该方法，则抛出此异常。 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../javax/xml/ws/handler/MessageContext.html" title="javax.xml.ws.handler中的接口"><code>MessageContext</code></a> ， <a href="../../../javax/xml/ws/handler/MessageContext.Scope.html" title="javax.xml.ws.handler中的枚举"><code>MessageContext.Scope</code></a> ， <a href="../../../java/lang/IllegalStateException.html" title="java.lang中的类"><code>IllegalStateException</code></a></span>
</dd>
</dl> </li>
</ul> <a name="getUserPrincipal--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getUserPrincipal</h4> <pre><a href="../../../java/security/Principal.html" title="interface in java.security">Principal</a> getUserPrincipal()</pre>
<div class="block">
<span>返回标识当前正在处理的请求的发件人的Principal。</span>
<span>如果发件人尚未认证，则该方法返回<code>null</code> 。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             校长主要对象。 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果在没有请求服务的情况下调用该方法，则抛出此异常。 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../java/security/Principal.html" title="java.security中的接口"><code>Principal</code></a> ， <a href="../../../java/lang/IllegalStateException.html" title="java.lang中的类"><code>IllegalStateException</code></a></span>
</dd>
</dl> </li>
</ul> <a name="isUserInRole-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>isUserInRole</h4> <pre>boolean isUserInRole(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> role)</pre>
<div class="block">
<span>返回一个布尔值，指示经过身份验证的用户是否包含在指定的逻辑角色中。</span>
<span>如果用户尚未认证，该方法返回<code>false</code> 。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>role</code> - A 
            <code>String</code>指定角色的名称 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             一个 
            <code>boolean</code>指示请求的发送者是否属于给定的角色 
           </dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果在没有请求服务的情况下调用该方法，则抛出此异常。 
           </dd>
</dl> </li>
</ul> <a name="getEndpointReference-org.w3c.dom.Element...-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getEndpointReference</h4> <pre><a href="../../../javax/xml/ws/EndpointReference.html" title="class in javax.xml.ws">EndpointReference</a> getEndpointReference(<a href="../../../org/w3c/dom/Element.html" title="interface in org.w3c.dom">Element</a>... referenceParameters)</pre>
<div class="block">
<span>返回此端点的<code>EndpointReference</code> 。</span>
<p> <span>如果这个<a href="../../../javax/xml/ws/Binding.html" title="javax.xml.ws中的接口">bindingProvider</a>的<code>bindingProvider</code>是SOAP1.1 / HTTP或SOAP1.2 / HTTP，则必须返回一个<code>W3CEndpointReference</code> 。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>referenceParameters</code> - 与返回的 
            <code>EndpointReference</code>实例相关联的 
            <code>EndpointReference</code>参数。 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>与此<code>WebServiceContext</code>的端点的<code>WebServiceContext</code> 。</span>
<span>如果返回的<code>EndpointReference</code>是<code>W3CEndpointReference</code>那么它必须包含指定的<code>referenceParameters</code> 。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果在没有请求服务的情况下调用该方法，则抛出此异常。 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             JAX-WS 2.1 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="javax.xml.ws.wsaddressing中的类"><code>W3CEndpointReference</code></a></span>
</dd>
</dl> </li>
</ul> <a name="getEndpointReference-java.lang.Class-org.w3c.dom.Element...-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getEndpointReference</h4> <pre>&lt;T extends <a href="../../../javax/xml/ws/EndpointReference.html" title="class in javax.xml.ws">EndpointReference</a>&gt; T getEndpointReference(<a href="../../../java/lang/Class.html" title="class in java.lang">类</a>&lt;T&gt; clazz,
                                                     <a href="../../../org/w3c/dom/Element.html" title="interface in org.w3c.dom">Element</a>... referenceParameters)</pre>
<div class="block">
            返回与此端点 
           <code>EndpointReference</code> EndpointReference。 
          </div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>clazz</code> - 必须返回的类型 
            <code>EndpointReference</code> 。 
           </dd>
<dd>
<code>referenceParameters</code> - 与返回的 
            <code>EndpointReference</code>实例相关联的 
            <code>EndpointReference</code>参数。 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>与此<code>WebServiceContext</code>实例<code>clazz</code>的端点类型为<code>clazz</code>的<code>WebServiceContext</code> 。</span>
<span>如果返回的<code>EndpointReference</code>是<code>W3CEndpointReference</code>那么它必须包含指定的<code>referenceParameters</code> 。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果在没有请求服务的情况下调用该方法，则抛出此异常。 
           </dd>
<dd>
<code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> -如果 
            <code>clazz</code>型 
            <code>EndpointReference</code>不支持。 
           </dd>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
             JAX-WS 2.1 
           </dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>