| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>WebServiceContext</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebServiceContext"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/ws/WebServiceClient.html" title="annotation in jakarta.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/ws/WebServiceContext.html" target="_top">Frames</a></li> |
| <li><a href="WebServiceContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.xml.ws</div> |
| <h2 title="Interface WebServiceContext" class="title">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">A <code>WebServiceContext</code> makes it possible for |
| a web service endpoint implementation class to access |
| message context and security information relative to |
| a request being served. |
| |
| Typically a <code>WebServiceContext</code> is injected |
| into an endpoint implementation class using the |
| <code>Resource</code> annotation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd>"javax.annotation.Resource"</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>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws">EndpointReference</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/WebServiceContext.html#getEndpointReference-java.lang.Class-org.w3c.dom.Element...-">getEndpointReference</a></span>(java.lang.Class<T> clazz, |
| org.w3c.dom.Element... referenceParameters)</code> |
| <div class="block">Returns the <code>EndpointReference</code> associated with |
| this endpoint.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws">EndpointReference</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/WebServiceContext.html#getEndpointReference-org.w3c.dom.Element...-">getEndpointReference</a></span>(org.w3c.dom.Element... referenceParameters)</code> |
| <div class="block">Returns the <code>EndpointReference</code> for this |
| endpoint.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/WebServiceContext.html#getMessageContext--">getMessageContext</a></span>()</code> |
| <div class="block">Returns the <code>MessageContext</code> for the request being served |
| at the time this method is called.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.security.Principal</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/WebServiceContext.html#getUserPrincipal--">getUserPrincipal</a></span>()</code> |
| <div class="block">Returns the Principal that identifies the sender |
| of the request currently being serviced.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/WebServiceContext.html#isUserInRole-java.lang.String-">isUserInRole</a></span>(java.lang.String role)</code> |
| <div class="block">Returns a boolean indicating whether the |
| authenticated user is included in the specified |
| logical role.</div> |
| </td> |
| </tr> |
| </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>Method Detail</h3> |
| <a name="getMessageContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageContext</h4> |
| <pre><a href="../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a> getMessageContext()</pre> |
| <div class="block">Returns the <code>MessageContext</code> for the request being served |
| at the time this method is called. Only properties with |
| APPLICATION scope will be visible to the application.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>MessageContext The message context.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - This exception is thrown |
| if the method is called while no request is |
| being serviced.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler"><code>MessageContext</code></a>, |
| <a href="../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler"><code>MessageContext.Scope</code></a>, |
| <code>IllegalStateException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUserPrincipal--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserPrincipal</h4> |
| <pre>java.security.Principal getUserPrincipal()</pre> |
| <div class="block">Returns the Principal that identifies the sender |
| of the request currently being serviced. If the |
| sender has not been authenticated, the method |
| returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Principal The principal object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - This exception is thrown |
| if the method is called while no request is |
| being serviced.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Principal</code>, |
| <code>IllegalStateException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isUserInRole-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUserInRole</h4> |
| <pre>boolean isUserInRole(java.lang.String role)</pre> |
| <div class="block">Returns a boolean indicating whether the |
| authenticated user is included in the specified |
| logical role. If the user has not been |
| authenticated, the method returns <code>false</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>role</code> - A <code>String</code> specifying the name of the role</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>boolean</code> indicating whether |
| the sender of the request belongs to a given role</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - This exception is thrown |
| if the method is called while no request is |
| being serviced.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndpointReference-org.w3c.dom.Element...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointReference</h4> |
| <pre><a href="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws">EndpointReference</a> getEndpointReference(org.w3c.dom.Element... referenceParameters)</pre> |
| <div class="block">Returns the <code>EndpointReference</code> for this |
| endpoint. |
| <p> |
| If the <a href="../../../jakarta/xml/ws/Binding.html" title="interface in jakarta.xml.ws"><code>Binding</code></a> for this <code>bindingProvider</code> is |
| either SOAP1.1/HTTP or SOAP1.2/HTTP, then a |
| <code>W3CEndpointReference</code> MUST be returned.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>referenceParameters</code> - Reference parameters to be associated with the |
| returned <code>EndpointReference</code> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EndpointReference of the endpoint associated with this |
| <code>WebServiceContext</code>. |
| If the returned <code>EndpointReference</code> is of type |
| <code>W3CEndpointReference</code> then it MUST contain the |
| the specified <code>referenceParameters</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - This exception is thrown |
| if the method is called while no request is |
| being serviced.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in jakarta.xml.ws.wsaddressing"><code>W3CEndpointReference</code></a></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><T extends <a href="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws">EndpointReference</a>> T getEndpointReference(java.lang.Class<T> clazz, |
| org.w3c.dom.Element... referenceParameters)</pre> |
| <div class="block">Returns the <code>EndpointReference</code> associated with |
| this endpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of <code>EndpointReference</code>.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - The type of <code>EndpointReference</code> that |
| MUST be returned.</dd> |
| <dd><code>referenceParameters</code> - Reference parameters to be associated with the |
| returned <code>EndpointReference</code> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EndpointReference of type <code>clazz</code> of the endpoint |
| associated with this <code>WebServiceContext</code> instance. |
| If the returned <code>EndpointReference</code> is of type |
| <code>W3CEndpointReference</code> then it MUST contain the |
| the specified <code>referenceParameters</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - This exception is thrown |
| if the method is called while no request is |
| being serviced.</dd> |
| <dd><code><a href="../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws">WebServiceException</a></code> - If the <code>clazz</code> type of |
| <code>EndpointReference</code> is not supported.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/ws/WebServiceClient.html" title="annotation in jakarta.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/ws/WebServiceContext.html" target="_top">Frames</a></li> |
| <li><a href="WebServiceContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
