Google Git
Sign in
apache / axis-site / 2ab3d496f1b4574a7e5677efcc4511d2c8e4807c / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / engine / Phase.html
blob: 150131217eac3ba47ca725c1921421a7a1df3e04 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Phase (Apache Axis2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Phase (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.axis2.engine</a></div>
<h2 title="Class Phase" class="title">Class Phase</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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><code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="DispatchPhase.html" title="class in org.apache.axis2.engine">DispatchPhase</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Phase</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="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 ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="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="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></h3>
<code><a href="Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ALL_PHASES">ALL_PHASES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Phase</a></span>()</code></th>
<td class="colLast">
<div class="block">Default constructor</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">Phase</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;phaseName)</code></th>
<td class="colLast">
<div class="block">Create a named Phase</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addHandler(org.apache.axis2.description.HandlerDescription)">addHandler</a></span>&#8203;(<a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</code></th>
<td class="colLast">
<div class="block">Add a HandlerDescription to the Phase</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addHandler(org.apache.axis2.engine.Handler)">addHandler</a></span>&#8203;(<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Add a handler to the Phase.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addHandler(org.apache.axis2.engine.Handler,int)">addHandler</a></span>&#8203;(<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Add a Handler at a particular index within the Phase.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkPostConditions(org.apache.axis2.context.MessageContext)">checkPostConditions</a></span>&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code></th>
<td class="colLast">
<div class="block">Confirm that all post-conditions of this Phase are met.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkPreconditions(org.apache.axis2.context.MessageContext)">checkPreconditions</a></span>&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code></th>
<td class="colLast">
<div class="block">Check the preconditions for a Phase.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a></span>&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code></th>
<td class="colLast">
<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 id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHandlerCount()">getHandlerCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHandlerDesc()">getHandlerDesc</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the HandlerDescription of a handler.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHandlers()">getHandlers</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets all the handlers in the phase.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the name of this Handler</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameter(java.lang.String)">getParameter</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get a Parameter from this Handler</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPhaseName()">getPhaseName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.apache.axis2.description.HandlerDescription)">init</a></span>&#8203;(<a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerdesc)</code></th>
<td class="colLast">
<div class="block">Initialize a Handler.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invoke(org.apache.axis2.context.MessageContext)">invoke</a></span>&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgctx)</code></th>
<td class="colLast">
<div class="block">Invoke all the handlers in this Phase</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeHandler(org.apache.axis2.description.HandlerDescription)">removeHandler</a></span>&#8203;(<a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</code></th>
<td class="colLast">
<div class="block">Remove a given Handler from a phase using a HandlerDescription</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setName(java.lang.String)">setName</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;phaseName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPhaseFirst(org.apache.axis2.engine.Handler)">setPhaseFirst</a></span>&#8203;(<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</code></th>
<td class="colLast">
<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 id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPhaseLast(org.apache.axis2.engine.Handler)">setPhaseLast</a></span>&#8203;(<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)</code></th>
<td class="colLast">
<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 id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ALL_PHASES">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ALL_PHASES</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> ALL_PHASES</pre>
<dl>
<dt><span class="seeLabel">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>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Phase</h4>
<pre>public&nbsp;Phase()</pre>
<div class="block">Default constructor</div>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Phase</h4>
<pre>public&nbsp;Phase&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;phaseName)</pre>
<div class="block">Create a named Phase</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>phaseName</code> - the name for this Phase</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="addHandler(org.apache.axis2.engine.Handler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addHandler&#8203;(<a href="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="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the Handler to add</dd>
</dl>
</li>
</ul>
<a id="addHandler(org.apache.axis2.description.HandlerDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addHandler&#8203;(<a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)
throws <a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>handlerDesc</code> - the HandlerDescription to add</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../phaseresolver/PhaseException.html" title="class in org.apache.axis2.phaseresolver">PhaseException</a></code> - if there is a problem</dd>
</dl>
</li>
</ul>
<a id="addHandler(org.apache.axis2.engine.Handler,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addHandler&#8203;(<a href="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="paramLabel">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 id="checkPostConditions(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkPostConditions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;checkPostConditions&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>msgContext</code> - the active MessageContext</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../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 id="checkPreconditions(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkPreconditions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;checkPreconditions&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>msgContext</code> - the active MessageContext</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../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 id="init(org.apache.axis2.description.HandlerDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init&#8203;(<a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerdesc)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Handler.html#init(org.apache.axis2.description.HandlerDescription)">Handler</a></code></span></div>
<div class="block">Initialize a Handler.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Handler.html#init(org.apache.axis2.description.HandlerDescription)">init</a></code>&nbsp;in interface&nbsp;<code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlerdesc</code> - the HandlerDescription for this Handler</dd>
</dl>
</li>
</ul>
<a id="invoke(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invoke</h4>
<pre class="methodSignature">public final&nbsp;<a href="Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a>&nbsp;invoke&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgctx)
throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Invoke all the handlers in this Phase</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Handler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</a></code>&nbsp;in interface&nbsp;<code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msgctx</code> - the current MessageContext</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An InvocationResponse that indicates what
the next step in the message processing should be.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
<a id="flowComplete(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flowComplete</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flowComplete&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">Handler</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a></code>&nbsp;in interface&nbsp;<code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msgContext</code> - the <code>MessageContext</code> to process with this
<code>Handler</code>.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="getHandlerCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getHandlerCount()</pre>
</li>
</ul>
<a id="getHandlerDesc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerDesc</h4>
<pre class="methodSignature">public&nbsp;<a href="../description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;getHandlerDesc()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Handler.html#getHandlerDesc()">Handler</a></code></span></div>
<div class="block">Gets the HandlerDescription of a handler.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Handler.html#getHandlerDesc()">getHandlerDesc</a></code>&nbsp;in interface&nbsp;<code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns HandlerDescription.</dd>
</dl>
</li>
</ul>
<a id="getHandlers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlers</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="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="returnLabel">Returns:</span></dt>
<dd>Returns an ArrayList of Handlers</dd>
</dl>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Handler.html#getName()">Handler</a></code></span></div>
<div class="block">Return the name of this Handler</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Handler.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the handler's name as a String</dd>
</dl>
</li>
</ul>
<a id="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameter</h4>
<pre class="methodSignature">public&nbsp;<a href="../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;getParameter&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Handler.html#getParameter(java.lang.String)">Handler</a></code></span></div>
<div class="block">Get a Parameter from this Handler</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Handler.html#getParameter(java.lang.String)">getParameter</a></code>&nbsp;in interface&nbsp;<code><a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the desired value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Parameter, or null.</dd>
</dl>
</li>
</ul>
<a id="getPhaseName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPhaseName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getPhaseName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the name.</dd>
</dl>
</li>
</ul>
<a id="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setName&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;phaseName)</pre>
</li>
</ul>
<a id="setPhaseFirst(org.apache.axis2.engine.Handler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPhaseFirst</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPhaseFirst&#8203;(<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)
throws <a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the Handler to add</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../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 id="setPhaseLast(org.apache.axis2.engine.Handler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPhaseLast</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPhaseLast&#8203;(<a href="Handler.html" title="interface in org.apache.axis2.engine">Handler</a>&nbsp;handler)
throws <a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the Handler to add</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../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 id="removeHandler(org.apache.axis2.description.HandlerDescription)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeHandler&#8203;(<a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>handlerDesc</code> - the HandlerDescription to remove</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>