blob: c11d85e95182c2a8dbb03763fde1ff39c0723d7b [file] [log] [blame]
<!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>DefaultConnectionListenerFailureHandler (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="DefaultConnectionListenerFailureHandler (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/DefaultConnectionListenerFailureHandler.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/transport/http/server/DefaultConnectionListener.html" title="class in org.apache.axis2.transport.http.server"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultHttpConnectionManager.html" title="class in org.apache.axis2.transport.http.server"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html" target="_top">Frames</a></li>
<li><a href="DefaultConnectionListenerFailureHandler.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.transport.http.server</div>
<h2 title="Class DefaultConnectionListenerFailureHandler" class="title">Class DefaultConnectionListenerFailureHandler</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.transport.http.server.DefaultConnectionListenerFailureHandler</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/transport/http/server/ConnectionListenerFailureHandler.html" title="interface in org.apache.axis2.transport.http.server">ConnectionListenerFailureHandler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DefaultConnectionListenerFailureHandler</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">Object</a>
implements <a href="../../../../../../org/apache/axis2/transport/http/server/ConnectionListenerFailureHandler.html" title="interface in org.apache.axis2.transport.http.server">ConnectionListenerFailureHandler</a></pre>
<div class="block">Default hander for failures in connection listener IOProcessors.
Supports configuration of number retries, delay per retry, and uptime interval considered a success (resets number retries to zero).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html#maxRetries">maxRetries</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html#retryDelay">retryDelay</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html#successInterval">successInterval</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/transport/http/server/DefaultConnectionListenerFailureHandler.html#DefaultConnectionListenerFailureHandler()">DefaultConnectionListenerFailureHandler</a></strong>()</code>
<div class="block">Create a new DefaultConnectionListenerFailureHandler with default settings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html#DefaultConnectionListenerFailureHandler(int, int, int)">DefaultConnectionListenerFailureHandler</a></strong>(int&nbsp;retryDelay,
int&nbsp;successInterval,
int&nbsp;maxRetries)</code>
<div class="block">Create a new DefaultConnectionListenerFailureHandler</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html#failed(org.apache.axis2.transport.http.server.IOProcessor, java.lang.Throwable)">failed</a></strong>(<a href="../../../../../../org/apache/axis2/transport/http/server/IOProcessor.html" title="interface in org.apache.axis2.transport.http.server">IOProcessor</a>&nbsp;connectionListener,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</code>
<div class="block">Default behavior is to log a warning and attempt retry per constructor config, eventually failing with a logged error and notification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html#notifyAbnormalTermination(org.apache.axis2.transport.http.server.IOProcessor, java.lang.String, java.lang.Throwable)">notifyAbnormalTermination</a></strong>(<a href="../../../../../../org/apache/axis2/transport/http/server/IOProcessor.html" title="interface in org.apache.axis2.transport.http.server">IOProcessor</a>&nbsp;connectionListener,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</code>
<div class="block">Default bevarior is to log the error.</div>
</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="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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">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">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">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">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">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">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">notifyAll</a>, <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">toString</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">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">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">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="retryDelay">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retryDelay</h4>
<pre>protected&nbsp;int retryDelay</pre>
</li>
</ul>
<a name="successInterval">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>successInterval</h4>
<pre>protected&nbsp;int successInterval</pre>
</li>
</ul>
<a name="maxRetries">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>maxRetries</h4>
<pre>protected&nbsp;int maxRetries</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultConnectionListenerFailureHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultConnectionListenerFailureHandler</h4>
<pre>public&nbsp;DefaultConnectionListenerFailureHandler()</pre>
<div class="block">Create a new DefaultConnectionListenerFailureHandler with default settings.
retryDelay is 1 second, successInterval is 60 seconds, maxRetries is 10</div>
</li>
</ul>
<a name="DefaultConnectionListenerFailureHandler(int, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultConnectionListenerFailureHandler</h4>
<pre>public&nbsp;DefaultConnectionListenerFailureHandler(int&nbsp;retryDelay,
int&nbsp;successInterval,
int&nbsp;maxRetries)</pre>
<div class="block">Create a new DefaultConnectionListenerFailureHandler</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>retryDelay</code> - millis to wait before retrying</dd><dd><code>successInterval</code> - millis after which an initial or retry attempt will be deemed a success, resetting retry count to 0</dd><dd><code>maxRetries</code> - maximum number of retries allowed without a success, after which the listener will terminate</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="failed(org.apache.axis2.transport.http.server.IOProcessor, java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failed</h4>
<pre>public&nbsp;boolean&nbsp;failed(<a href="../../../../../../org/apache/axis2/transport/http/server/IOProcessor.html" title="interface in org.apache.axis2.transport.http.server">IOProcessor</a>&nbsp;connectionListener,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</pre>
<div class="block">Default behavior is to log a warning and attempt retry per constructor config, eventually failing with a logged error and notification.
May subclass and override this method to change the behavior.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/axis2/transport/http/server/ConnectionListenerFailureHandler.html#failed(org.apache.axis2.transport.http.server.IOProcessor, java.lang.Throwable)">failed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/axis2/transport/http/server/ConnectionListenerFailureHandler.html" title="interface in org.apache.axis2.transport.http.server">ConnectionListenerFailureHandler</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>connectionListener</code> - the associated connection listener</dd><dd><code>cause</code> - cause of failure</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the listener should attempt to re-establish itself, false if it should terminate.</dd></dl>
</li>
</ul>
<a name="notifyAbnormalTermination(org.apache.axis2.transport.http.server.IOProcessor, java.lang.String, java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>notifyAbnormalTermination</h4>
<pre>public&nbsp;void&nbsp;notifyAbnormalTermination(<a href="../../../../../../org/apache/axis2/transport/http/server/IOProcessor.html" title="interface in org.apache.axis2.transport.http.server">IOProcessor</a>&nbsp;connectionListener,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</pre>
<div class="block">Default bevarior is to log the error.
May subclass and override this method to change behavior.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/axis2/transport/http/server/ConnectionListenerFailureHandler.html#notifyAbnormalTermination(org.apache.axis2.transport.http.server.IOProcessor, java.lang.String, java.lang.Throwable)">notifyAbnormalTermination</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/axis2/transport/http/server/ConnectionListenerFailureHandler.html" title="interface in org.apache.axis2.transport.http.server">ConnectionListenerFailureHandler</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>connectionListener</code> - the associated connection listener</dd><dd><code>message</code> - explanation of termination</dd><dd><code>cause</code> - last exception that is causing termination</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/DefaultConnectionListenerFailureHandler.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/transport/http/server/DefaultConnectionListener.html" title="class in org.apache.axis2.transport.http.server"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/axis2/transport/http/server/DefaultHttpConnectionManager.html" title="class in org.apache.axis2.transport.http.server"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/transport/http/server/DefaultConnectionListenerFailureHandler.html" target="_top">Frames</a></li>
<li><a href="DefaultConnectionListenerFailureHandler.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>