| <!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>AbstractTemplatedHandler (Apache Axis2)</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="AbstractTemplatedHandler (Apache Axis2)"; |
| } |
| //--> |
| </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/AbstractTemplatedHandler.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="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis2/handlers/AbstractTemplatedHandler.html" target="_top">Frames</a></li> |
| <li><a href="AbstractTemplatedHandler.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><a href="#fields_inherited_from_class_org.apache.axis2.handlers.AbstractHandler">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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">org.apache.axis2.handlers</div> |
| <h2 title="Class AbstractTemplatedHandler" class="title">Class AbstractTemplatedHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">org.apache.axis2.handlers.AbstractHandler</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis2.handlers.AbstractTemplatedHandler</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/axis2/handlers/addressing/AddressingInHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingInHandler</a>, <a href="../../../../org/apache/axis2/handlers/addressing/AddressingOutHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingOutHandler</a>, <a href="../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html" title="class in org.apache.axis2.jaxws.dispatchers">MustUnderstandChecker</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">AbstractTemplatedHandler</span> |
| extends <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></pre> |
| <div class="block">This abstract class differentiates the concern of the conditional check to see whether this |
| particular message needs to be handled by the handler implementation and the actual invocation |
| logic.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers"><code>AbstractHandler</code></a></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_org.apache.axis2.engine.Handler"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.axis2.engine.<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></h3> |
| <code><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></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_org.apache.axis2.handlers.AbstractHandler"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.axis2.handlers.<a href="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></h3> |
| <code><a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#handlerDesc">handlerDesc</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#AbstractTemplatedHandler()">AbstractTemplatedHandler</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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>abstract <a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#doInvoke(org.apache.axis2.context.MessageContext)">doInvoke</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgCtx)</code> |
| <div class="block">This should implement the actual handler invocation logic.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgContext)</code> |
| <div class="block">Implements the separation of the conditional check and the actual logic</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#shouldInvoke(org.apache.axis2.context.MessageContext)">shouldInvoke</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgCtx)</code> |
| <div class="block">This method should implement the conditional check of the handler to decide whether this |
| particular message needs to be handled by me</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.handlers.AbstractHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.axis2.handlers.<a href="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></h3> |
| <code><a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a>, <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#getHandlerDesc()">getHandlerDesc</a>, <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#getName()">getName</a>, <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#getParameter(java.lang.String)">getParameter</a>, <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#init(org.apache.axis2.description.HandlerDescription)">init</a>, <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractTemplatedHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractTemplatedHandler</h4> |
| <pre>public AbstractTemplatedHandler()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="invoke(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre>public final <a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a> invoke(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgContext) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Implements the separation of the conditional check and the actual logic</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to process with this <code>Handler</code>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>CONTINUE if the handler implementation says 'should not be invoked' |
| or the result of the <a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#doInvoke(org.apache.axis2.context.MessageContext)"><code>doInvoke(org.apache.axis2.context.MessageContext)</code></a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if the <a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#doInvoke(org.apache.axis2.context.MessageContext)"><code>doInvoke(org.apache.axis2.context.MessageContext)</code></a> |
| throws the same</dd></dl> |
| </li> |
| </ul> |
| <a name="shouldInvoke(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldInvoke</h4> |
| <pre>public abstract boolean shouldInvoke(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgCtx) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">This method should implement the conditional check of the handler to decide whether this |
| particular message needs to be handled by me</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgCtx</code> - current <code>MessageContext</code> to be evaluated</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>boolean <code>true<code>, if this handler needs to be further invoked, |
| <code>false</code> if this handler has nothing to do with this specific message |
| and want the flow to be continued</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in an error in evaluating the decision</dd></dl> |
| </li> |
| </ul> |
| <a name="doInvoke(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>doInvoke</h4> |
| <pre>public abstract <a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a> doInvoke(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgCtx) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">This should implement the actual handler invocation logic.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgCtx</code> - current message to be handled by this handler</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>flow completion decision, should be one of <code>InvocationResponse#CONTINUE</code>, |
| <code>InvocationResponse#ABORT</code>, <code>InvocationResponse#SUSPEND</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in an error in invoking the handler</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><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/AbstractTemplatedHandler.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="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis2/handlers/AbstractTemplatedHandler.html" target="_top">Frames</a></li> |
| <li><a href="AbstractTemplatedHandler.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><a href="#fields_inherited_from_class_org.apache.axis2.handlers.AbstractHandler">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |