| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ServletEndpointContext (Apache Axis)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ServletEndpointContext (Apache Axis)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/ServletEndpointContext.html">Use</a></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="../../../../javax/xml/rpc/server/ServiceLifecycle.html" title="interface in javax.xml.rpc.server"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/rpc/server/ServletEndpointContext.html" target="_top">Frames</a></li> |
| <li><a href="ServletEndpointContext.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">javax.xml.rpc.server</div> |
| <h2 title="Interface ServletEndpointContext" class="title">Interface ServletEndpointContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/axis/transport/http/ServletEndpointContextImpl.html" title="class in org.apache.axis.transport.http">ServletEndpointContextImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ServletEndpointContext</span></pre> |
| <div class="block">The <code>ServletEndpointContext</code> provides an endpoint |
| context maintained by the underlying servlet container based |
| JAX-RPC runtime system. For service endpoints deployed on a |
| servlet container based JAX-RPC runtime system, the context |
| parameter in the <code>ServiceLifecycle.init</code> method is |
| required to be of the Java type |
| <code>javax.xml.rpc.server.ServletEndpointContext</code>. |
| <p> |
| A servlet container based JAX-RPC runtime system implements |
| the <code>ServletEndpointContext</code> interface. The JAX-RPC |
| runtime system is required to provide appropriate session, |
| message context, servlet context and user principal information |
| per method invocation on the endpoint class.</div> |
| <dl><dt><span class="strong">Version:</span></dt> |
| <dd>1.0</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javaee/1.4/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http">HttpSession</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/server/ServletEndpointContext.html#getHttpSession()">getHttpSession</a></strong>()</code> |
| <div class="block">The <code>getHttpSession</code> method returns the current |
| HTTP session (as a <code>javax.servlet.http.HTTPSession</code>).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/server/ServletEndpointContext.html#getMessageContext()">getMessageContext</a></strong>()</code> |
| <div class="block">The method <code>getMessageContext</code> returns the |
| <code>MessageContext</code> targeted for this endpoint instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javaee/1.4/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet">ServletContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/server/ServletEndpointContext.html#getServletContext()">getServletContext</a></strong>()</code> |
| <div class="block">The method <code>getServletContext</code> returns the |
| <code>ServletContex</code>t associated with the web |
| application that contain this endpoint.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/server/ServletEndpointContext.html#getUserPrincipal()">getUserPrincipal</a></strong>()</code> |
| <div class="block">Returns a <code>java.security.Principal</code> instance that |
| contains the name of the authenticated user for the current |
| method invocation on the endpoint instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/server/ServletEndpointContext.html#isUserInRole(java.lang.String)">isUserInRole</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> </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="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> getMessageContext()</pre> |
| <div class="block">The method <code>getMessageContext</code> returns the |
| <code>MessageContext</code> targeted for this endpoint instance. |
| This enables the service endpoint instance to acccess the |
| <code>MessageContext</code> propagated by request |
| <code>HandlerChain</code> (and its contained <code>Handler</code> |
| instances) to the target endpoint instance and to share any |
| SOAP message processing related context. The endpoint instance |
| can access and manipulate the <code>MessageContext</code> |
| and share the SOAP message processing related context with |
| the response <code>HandlerChain</code>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>MessageContext; If there is no associated |
| <code>MessageContext</code>, this method returns |
| <code>null</code>.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if this method is invoked outside a |
| remote method implementation by a service endpoint instance.</dd></dl> |
| </li> |
| </ul> |
| <a name="getUserPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserPrincipal</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a> getUserPrincipal()</pre> |
| <div class="block">Returns a <code>java.security.Principal</code> instance that |
| contains the name of the authenticated user for the current |
| method invocation on the endpoint instance. This method returns |
| <code>null</code> if there is no associated principal yet. |
| The underlying JAX-RPC runtime system takes the responsibility |
| of providing the appropriate authenticated principal for a |
| remote method invocation on the service endpoint instance.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>A <code>java.security.Principal</code> for the |
| authenticated principal associated with the current |
| invocation on the servlet endpoint instance; |
| Returns <code>null</code> if there no authenticated |
| user associated with a method invocation.</dd></dl> |
| </li> |
| </ul> |
| <a name="getHttpSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpSession</h4> |
| <pre><a href="http://download.oracle.com/javaee/1.4/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http">HttpSession</a> getHttpSession()</pre> |
| <div class="block">The <code>getHttpSession</code> method returns the current |
| HTTP session (as a <code>javax.servlet.http.HTTPSession</code>). |
| When invoked by the service endpoint within a remote method |
| implementation, the <code>getHttpSession</code> returns the |
| HTTP session associated currently with this method invocation. |
| This method returns <code>null</code> if there is no HTTP |
| session currently active and associated with this service |
| endpoint. An endpoint class should not rely on an active |
| HTTP session being always there; the underlying JAX-RPC |
| runtime system is responsible for managing whether or not |
| there is an active HTTP session. |
| <p> |
| The getHttpSession method throws <code>JAXRPCException</code> |
| if invoked by an non HTTP bound endpoint.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The HTTP session associated with the current |
| invocation or <code>null</code> if there is no active session.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - - If this method invoked by a non-HTTP bound |
| endpoints.</dd></dl> |
| </li> |
| </ul> |
| <a name="getServletContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletContext</h4> |
| <pre><a href="http://download.oracle.com/javaee/1.4/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet">ServletContext</a> getServletContext()</pre> |
| <div class="block">The method <code>getServletContext</code> returns the |
| <code>ServletContex</code>t associated with the web |
| application that contain this endpoint. According to |
| the Servlet specification, There is one context per web |
| application (installed as a WAR) per JVM . A servlet |
| based service endpoint is deployed as part of a web |
| application.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the current <code>ServletContext</code></dd></dl> |
| </li> |
| </ul> |
| <a name="isUserInRole(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isUserInRole</h4> |
| <pre>boolean isUserInRole(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/ServletEndpointContext.html">Use</a></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="../../../../javax/xml/rpc/server/ServiceLifecycle.html" title="interface in javax.xml.rpc.server"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/rpc/server/ServletEndpointContext.html" target="_top">Frames</a></li> |
| <li><a href="ServletEndpointContext.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 ======= --> |
| <p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
