axis2/java/core-staging/apidocs/org/apache/axis2/engine/Phase.html - axis-site - Git at Google

 <!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>Phase (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="Phase (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/Phase.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/engine/ObjectSupplier.html" title="interface in org.apache.axis2.engine"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../../org/apache/axis2/engine/Pingable.html" title="interface in org.apache.axis2.engine"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/axis2/engine/Phase.html" target="_top">Frames</a></li>
 <li><a href="Phase.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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.engine</div>
 <h2 title="Class Phase" class="title">Class Phase</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>org.apache.axis2.engine.Phase</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/engine/DispatchPhase.html" title="class in org.apache.axis2.engine">DispatchPhase</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public class <span class="strong">Phase</span>
 extends <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>
 implements <a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></pre>
 <div class="block">A Phase is an ordered collection of Handlers.</div>
 </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&nbsp;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>
 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#ALL_PHASES">ALL_PHASES</a></strong></code>&nbsp;</td>
 </tr>
 </table>
 </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">&nbsp;</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/engine/Phase.html#Phase()">Phase</a></strong>()</code>
 <div class="block">Default constructor</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#Phase(java.lang.String)">Phase</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;phaseName)</code>
 <div class="block">Create a named Phase</div>
 </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">&nbsp;</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>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#addHandler(org.apache.axis2.engine.Handler)">addHandler</a></strong>(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</code>
 <div class="block">Add a handler to the Phase.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#addHandler(org.apache.axis2.description.HandlerDescription)">addHandler</a></strong>(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</code>
 <div class="block">Add a HandlerDescription to the Phase</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#addHandler(org.apache.axis2.engine.Handler, int)">addHandler</a></strong>(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler,
           int&nbsp;index)</code>
 <div class="block">Add a Handler at a particular index within the Phase.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#checkPostConditions(org.apache.axis2.context.MessageContext)">checkPostConditions</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
 <div class="block">Confirm that all post-conditions of this Phase are met.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#checkPreconditions(org.apache.axis2.context.MessageContext)">checkPreconditions</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
 <div class="block">Check the preconditions for a Phase.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
 <div class="block">This method will be called on each registered handler that had its
  invoke(...) method called during the processing of the message, once
  the message processing has completed.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#getHandlerCount()">getHandlerCount</a></strong>()</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#getHandlerDesc()">getHandlerDesc</a></strong>()</code>
 <div class="block">Gets the HandlerDescription of a handler.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&gt;</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#getHandlers()">getHandlers</a></strong>()</code>
 <div class="block">Gets all the handlers in the phase.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#getName()">getName</a></strong>()</code>
 <div class="block">Return the name of this Handler</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#getParameter(java.lang.String)">getParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
 <div class="block">Get a Parameter from this Handler</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#getPhaseName()">getPhaseName</a></strong>()</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#init(org.apache.axis2.description.HandlerDescription)">init</a></strong>(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerdesc)</code>
 <div class="block">Initialize a Handler.</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/engine/Phase.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>&nbsp;msgctx)</code>
 <div class="block">Invoke all the handlers in this Phase</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#removeHandler(org.apache.axis2.description.HandlerDescription)">removeHandler</a></strong>(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</code>
 <div class="block">Remove a given Handler from a phase using a HandlerDescription</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#setName(java.lang.String)">setName</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;phaseName)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#setPhaseFirst(org.apache.axis2.engine.Handler)">setPhaseFirst</a></strong>(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</code>
 <div class="block">Add a Handler to the Phase in the very first position, and ensure no other Handler
  will come before it.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#setPhaseLast(org.apache.axis2.engine.Handler)">setPhaseLast</a></strong>(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</code>
 <div class="block">Add a Handler to the Phase in the very last position, and ensure no other Handler
  will come after it.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Phase.html#toString()">toString</a></strong>()</code>&nbsp;</td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;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">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field_detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="ALL_PHASES">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>ALL_PHASES</h4>
 <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ALL_PHASES</pre>
 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis2.engine.Phase.ALL_PHASES">Constant Field Values</a></dd></dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor_detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="Phase()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>Phase</h4>
 <pre>public&nbsp;Phase()</pre>
 <div class="block">Default constructor</div>
 </li>
 </ul>
 <a name="Phase(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>Phase</h4>
 <pre>public&nbsp;Phase(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;phaseName)</pre>
 <div class="block">Create a named Phase</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>phaseName</code> - the name for this Phase</dd></dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method_detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="addHandler(org.apache.axis2.engine.Handler)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addHandler</h4>
 <pre>public&nbsp;void&nbsp;addHandler(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</pre>
 <div class="block">Add a handler to the Phase.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the Handler to add</dd></dl>
 </li>
 </ul>
 <a name="addHandler(org.apache.axis2.description.HandlerDescription)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addHandler</h4>
 <pre>public&nbsp;void&nbsp;addHandler(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)
                 throws <a href="../../../../org/apache/axis2/phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></pre>
 <div class="block">Add a HandlerDescription to the Phase</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handlerDesc</code> - the HandlerDescription to add</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="../../../../org/apache/axis2/phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></code> - if there is a problem</dd></dl>
 </li>
 </ul>
 <a name="addHandler(org.apache.axis2.engine.Handler, int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addHandler</h4>
 <pre>public&nbsp;void&nbsp;addHandler(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler,
               int&nbsp;index)</pre>
 <div class="block">Add a Handler at a particular index within the Phase.

  If we have a Phase with (H1, H2), calling addHandler(H3, 1) will result in (H1, H3, H2)</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the Handler to add</dd><dd><code>index</code> - the position in the Phase at which to place the Handler</dd></dl>
 </li>
 </ul>
 <a name="checkPostConditions(org.apache.axis2.context.MessageContext)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkPostConditions</h4>
 <pre>public&nbsp;void&nbsp;checkPostConditions(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
                          throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
 <div class="block">Confirm that all post-conditions of this Phase are met.  After all Handlers in a
  Phase are invoke()d, this method will be called.  Subclasses should override it in order
  to confirm that the purpose of the given Phase has been acheived.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the active MessageContext</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 a post-condition has not been met, or other problems occur</dd></dl>
 </li>
 </ul>
 <a name="checkPreconditions(org.apache.axis2.context.MessageContext)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkPreconditions</h4>
 <pre>public&nbsp;void&nbsp;checkPreconditions(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
                         throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
 <div class="block">Check the preconditions for a Phase.  This method will be called when the Phase is
  invoked, BEFORE any Handlers are invoked.  Subclasses should override it in order
  to confirm that necessary preconditions are met before the Phase does its work.  They
  should throw an appropriate AxisFault if not.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the active MessageContext</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 a precondition is not met, or in case of other problem</dd></dl>
 </li>
 </ul>
 <a name="init(org.apache.axis2.description.HandlerDescription)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>init</h4>
 <pre>public&nbsp;void&nbsp;init(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerdesc)</pre>
 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html#init(org.apache.axis2.description.HandlerDescription)">Handler</a></code></strong></div>
 <div class="block">Initialize a Handler.</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/axis2/engine/Handler.html#init(org.apache.axis2.description.HandlerDescription)">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>handlerdesc</code> - the HandlerDescription for this Handler</dd></dl>
 </li>
 </ul>
 <a name="invoke(org.apache.axis2.context.MessageContext)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>invoke</h4>
 <pre>public final&nbsp;<a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a>&nbsp;invoke(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgctx)
                                         throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
 <div class="block">Invoke all the handlers in this Phase</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/axis2/engine/Handler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>msgctx</code> - the current MessageContext</dd>
 <dt><span class="strong">Returns:</span></dt><dd>An InvocationResponse that indicates what
          the next step in the message processing should be.</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></dd></dl>
 </li>
 </ul>
 <a name="flowComplete(org.apache.axis2.context.MessageContext)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>flowComplete</h4>
 <pre>public&nbsp;void&nbsp;flowComplete(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</pre>
 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">Handler</a></code></strong></div>
 <div class="block">This method will be called on each registered handler that had its
  invoke(...) method called during the processing of the message, once
  the message processing has completed.  During execution of the
  flowComplete's, handlers are invoked in the opposite order that they
  were invoked originally.  Note that implementations SHOULD check
  msgContext.getFailureReason() to see if this is an error or a normal
  completion.</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/axis2/engine/Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to process with this
                    <code>Handler</code>.</dd></dl>
 </li>
 </ul>
 <a name="toString()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>toString</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
 <dl>
 <dt><strong>Overrides:</strong></dt>
 <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
 </dl>
 </li>
 </ul>
 <a name="getHandlerCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getHandlerCount</h4>
 <pre>public&nbsp;int&nbsp;getHandlerCount()</pre>
 </li>
 </ul>
 <a name="getHandlerDesc()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getHandlerDesc</h4>
 <pre>public&nbsp;<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;getHandlerDesc()</pre>
 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html#getHandlerDesc()">Handler</a></code></strong></div>
 <div class="block">Gets the HandlerDescription of a handler.</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/axis2/engine/Handler.html#getHandlerDesc()">getHandlerDesc</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
 <dt><span class="strong">Returns:</span></dt><dd>Returns HandlerDescription.</dd></dl>
 </li>
 </ul>
 <a name="getHandlers()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getHandlers</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&gt;&nbsp;getHandlers()</pre>
 <div class="block">Gets all the handlers in the phase.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>Returns an ArrayList of Handlers</dd></dl>
 </li>
 </ul>
 <a name="getName()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getName</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html#getName()">Handler</a></code></strong></div>
 <div class="block">Return the name of this Handler</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/axis2/engine/Handler.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
 <dt><span class="strong">Returns:</span></dt><dd>the handler's name as a String</dd></dl>
 </li>
 </ul>
 <a name="getParameter(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getParameter</h4>
 <pre>public&nbsp;<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;getParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html#getParameter(java.lang.String)">Handler</a></code></strong></div>
 <div class="block">Get a Parameter from this Handler</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/axis2/engine/Handler.html#getParameter(java.lang.String)">getParameter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the desired value</dd>
 <dt><span class="strong">Returns:</span></dt><dd>the Parameter, or null.</dd></dl>
 </li>
 </ul>
 <a name="getPhaseName()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPhaseName</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPhaseName()</pre>
 <dl><dt><span class="strong">Returns:</span></dt><dd>Returns the name.</dd></dl>
 </li>
 </ul>
 <a name="setName(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setName</h4>
 <pre>public&nbsp;void&nbsp;setName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;phaseName)</pre>
 </li>
 </ul>
 <a name="setPhaseFirst(org.apache.axis2.engine.Handler)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setPhaseFirst</h4>
 <pre>public&nbsp;void&nbsp;setPhaseFirst(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)
                    throws <a href="../../../../org/apache/axis2/phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></pre>
 <div class="block">Add a Handler to the Phase in the very first position, and ensure no other Handler
  will come before it.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the Handler to add</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="../../../../org/apache/axis2/phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></code> - if another Handler is already set as phaseFirst</dd></dl>
 </li>
 </ul>
 <a name="setPhaseLast(org.apache.axis2.engine.Handler)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setPhaseLast</h4>
 <pre>public&nbsp;void&nbsp;setPhaseLast(<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)
                   throws <a href="../../../../org/apache/axis2/phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></pre>
 <div class="block">Add a Handler to the Phase in the very last position, and ensure no other Handler
  will come after it.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the Handler to add</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="../../../../org/apache/axis2/phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></code> - if another Handler is already set as phaseLast</dd></dl>
 </li>
 </ul>
 <a name="removeHandler(org.apache.axis2.description.HandlerDescription)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>removeHandler</h4>
 <pre>public&nbsp;void&nbsp;removeHandler(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</pre>
 <div class="block">Remove a given Handler from a phase using a HandlerDescription</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handlerDesc</code> - the HandlerDescription to remove</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/Phase.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/engine/ObjectSupplier.html" title="interface in org.apache.axis2.engine"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../../org/apache/axis2/engine/Pingable.html" title="interface in org.apache.axis2.engine"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/axis2/engine/Phase.html" target="_top">Frames</a></li>
 <li><a href="Phase.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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
 </body>
 </html>