| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>HandlerChain</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="HandlerChain"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html" title="class in javax.xml.rpc.handler"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/rpc/handler/HandlerChain.html" target="_top">Frames</a></li> |
| <li><a href="HandlerChain.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.handler</div> |
| <h2 title="Interface HandlerChain" class="title">Interface HandlerChain</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.util.Collection, java.lang.Iterable, java.util.List</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openejb/server/axis/HandlerChainImpl.html" title="class in org.apache.openejb.server.axis">HandlerChainImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">HandlerChain</span> |
| extends java.util.List</pre> |
| <div class="block">The <code>javax.xml.rpc.handler.HandlerChain</code> represents |
| a list of handlers. All elements in the HandlerChain are of |
| the type <code>javax.xml.rpc.handler.Handler</code>. |
| |
| <p>An implementation class for the <code>HandlerChain</code> |
| interface abstracts the policy and mechanism for the invocation |
| of the registered handlers.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/rpc/handler/HandlerChain.html" title="interface in javax.xml.rpc.handler"><code>HandlerChain</code></a></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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#destroy--">destroy</a></span>()</code> |
| <div class="block">Indicates the end of lifecycle for a HandlerChain.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#getRoles--">getRoles</a></span>()</code> |
| <div class="block">Gets SOAP actor roles registered for this HandlerChain at |
| this SOAP node.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#handleFault-javax.xml.rpc.handler.MessageContext-">handleFault</a></span>(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> context)</code> |
| <div class="block">The <code>handleFault</code> method initiates the SOAP |
| fault processing for this handler chain.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#handleRequest-javax.xml.rpc.handler.MessageContext-">handleRequest</a></span>(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> context)</code> |
| <div class="block">The <code>handleRequest</code> method initiates the request |
| processing for this handler chain.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#handleResponse-javax.xml.rpc.handler.MessageContext-">handleResponse</a></span>(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> context)</code> |
| <div class="block">The <code>handleResponse</code> method initiates the response |
| processing for this handler chain.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#init-java.util.Map-">init</a></span>(java.util.Map config)</code> |
| <div class="block">Initializes the configuration for a HandlerChain.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerChain.html#setRoles-java.lang.String:A-">setRoles</a></span>(java.lang.String[] soapActorNames)</code> |
| <div class="block">Sets SOAP Actor roles for this <code>HandlerChain</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.List"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.List</h3> |
| <code>add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.Collection"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.Collection</h3> |
| <code>parallelStream, removeIf, stream</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.Iterable</h3> |
| <code>forEach</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>Method Detail</h3> |
| <a name="handleRequest-javax.xml.rpc.handler.MessageContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRequest</h4> |
| <pre>boolean handleRequest(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> context)</pre> |
| <div class="block">The <code>handleRequest</code> method initiates the request |
| processing for this handler chain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - MessageContext parameter provides access to |
| the request SOAP message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean Returns <code>true</code> if all handlers in |
| chain have been processed. Returns <code>false</code> |
| if a handler in the chain returned |
| <code>false</code> from its handleRequest |
| method.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>JAXRPCException</code> - if any processing error happens</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/rpc/handler/Handler.html#handleRequest-javax.xml.rpc.handler.MessageContext-"><code>Handler.handleRequest(javax.xml.rpc.handler.MessageContext)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleResponse-javax.xml.rpc.handler.MessageContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleResponse</h4> |
| <pre>boolean handleResponse(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> context)</pre> |
| <div class="block">The <code>handleResponse</code> method initiates the response |
| processing for this handler chain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - MessageContext parameter provides access to |
| the response SOAP message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean Returns <code>true</code> if all handlers in |
| chain have been processed. Returns <code>false</code> |
| if a handler in the chain returned |
| <code>false</code> from its handleResponse method.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>JAXRPCException</code> - if any processing error happens</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/rpc/handler/Handler.html#handleResponse-javax.xml.rpc.handler.MessageContext-"><code>Handler.handleResponse(javax.xml.rpc.handler.MessageContext)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleFault-javax.xml.rpc.handler.MessageContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleFault</h4> |
| <pre>boolean handleFault(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a> context)</pre> |
| <div class="block">The <code>handleFault</code> method initiates the SOAP |
| fault processing for this handler chain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - MessageContext parameter provides access |
| to the SOAP message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean Returns <code>true</code> if all handlers in |
| chain have been processed. Returns <code>false</code> |
| if a handler in the chain returned |
| <code>false</code> from its handleFault method.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>JAXRPCException</code> - if any processing error happens</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/rpc/handler/Handler.html#handleFault-javax.xml.rpc.handler.MessageContext-"><code>Handler.handleFault(javax.xml.rpc.handler.MessageContext)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>void init(java.util.Map config)</pre> |
| <div class="block">Initializes the configuration for a HandlerChain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - Configuration for the initialization of |
| this handler chain</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>JAXRPCException</code> - If any error during initialization</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>void destroy()</pre> |
| <div class="block">Indicates the end of lifecycle for a HandlerChain.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>JAXRPCException</code> - If any error during destroy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRoles-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRoles</h4> |
| <pre>void setRoles(java.lang.String[] soapActorNames)</pre> |
| <div class="block">Sets SOAP Actor roles for this <code>HandlerChain</code>. This |
| specifies the set of roles in which this HandlerChain is to act |
| for the SOAP message processing at this SOAP node. These roles |
| assumed by a HandlerChain must be invariant during the |
| processing of an individual SOAP message through the HandlerChain. |
| |
| <p>A <code>HandlerChain</code> always acts in the role of the |
| special SOAP actor <code>next</code>. Refer to the SOAP |
| specification for the URI name for this special SOAP actor. |
| There is no need to set this special role using this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>soapActorNames</code> - URIs for SOAP actor name</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/rpc/NamespaceConstants.html" title="class in javax.xml.rpc"><code>NamespaceConstants</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRoles--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRoles</h4> |
| <pre>java.lang.String[] getRoles()</pre> |
| <div class="block">Gets SOAP actor roles registered for this HandlerChain at |
| this SOAP node. The returned array includes the special |
| SOAP actor <code>next</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String[] SOAP Actor roles as URIs</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/rpc/NamespaceConstants.html" title="class in javax.xml.rpc"><code>NamespaceConstants</code></a></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="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html" title="class in javax.xml.rpc.handler"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/rpc/handler/HandlerChain.html" target="_top">Frames</a></li> |
| <li><a href="HandlerChain.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> |
