blob: be76845b140dc7ff642209e8c3d35384d44bea51 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>CloseableDoSFilter (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<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.5.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="CloseableDoSFilter (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":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 = false;
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/CloseableDoSFilter.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>Field&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>Field&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.eclipse.jetty.servlets</a></div>
<h2 title="Class CloseableDoSFilter" class="title">Class CloseableDoSFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="DoSFilter.html" title="class in org.eclipse.jetty.servlets">org.eclipse.jetty.servlets.DoSFilter</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.servlets.CloseableDoSFilter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.Filter</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">CloseableDoSFilter</span>
extends <a href="DoSFilter.html" title="class in org.eclipse.jetty.servlets">DoSFilter</a></pre>
<div class="block">This is an extension to <a href="DoSFilter.html" title="class in org.eclipse.jetty.servlets"><code>DoSFilter</code></a> that uses Jetty APIs to
abruptly close the connection when the request times out.</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.eclipse.jetty.servlets.DoSFilter">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.servlets.<a href="DoSFilter.html" title="class in org.eclipse.jetty.servlets">DoSFilter</a></h3>
<code><a href="DoSFilter.Action.html" title="enum in org.eclipse.jetty.servlets">DoSFilter.Action</a>, <a href="DoSFilter.Listener.html" title="class in org.eclipse.jetty.servlets">DoSFilter.Listener</a>, <a href="DoSFilter.OverLimit.html" title="interface in org.eclipse.jetty.servlets">DoSFilter.OverLimit</a>, <a href="DoSFilter.RateType.html" title="enum in org.eclipse.jetty.servlets">DoSFilter.RateType</a></code></li>
</ul>
</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()">CloseableDoSFilter</a></span>()</code></th>
<td class="colLast">&nbsp;</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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestTimeout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.Thread)">onRequestTimeout</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
java.lang.Thread&nbsp;handlingThread)</code></th>
<td class="colLast">
<div class="block">Invoked when the request handling exceeds <a href="DoSFilter.html#getMaxRequestMs()"><code>DoSFilter.getMaxRequestMs()</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.servlets.DoSFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.servlets.<a href="DoSFilter.html" title="class in org.eclipse.jetty.servlets">DoSFilter</a></h3>
<code><a href="DoSFilter.html#addWhitelistAddress(java.lang.String)">addWhitelistAddress</a>, <a href="DoSFilter.html#checkWhitelist(java.lang.String)">checkWhitelist</a>, <a href="DoSFilter.html#checkWhitelist(java.util.List,java.lang.String)">checkWhitelist</a>, <a href="DoSFilter.html#clearWhitelist()">clearWhitelist</a>, <a href="DoSFilter.html#closeConnection(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.Thread)">closeConnection</a>, <a href="DoSFilter.html#destroy()">destroy</a>, <a href="DoSFilter.html#doFilter(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,javax.servlet.FilterChain)">doFilter</a>, <a href="DoSFilter.html#doFilter(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">doFilter</a>, <a href="DoSFilter.html#doFilterChain(javax.servlet.FilterChain,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doFilterChain</a>, <a href="DoSFilter.html#extractUserId(javax.servlet.ServletRequest)">extractUserId</a>, <a href="DoSFilter.html#getDelayMs()">getDelayMs</a>, <a href="DoSFilter.html#getListener()">getListener</a>, <a href="DoSFilter.html#getMaxIdleTrackerMs()">getMaxIdleTrackerMs</a>, <a href="DoSFilter.html#getMaxPriority()">getMaxPriority</a>, <a href="DoSFilter.html#getMaxRequestMs()">getMaxRequestMs</a>, <a href="DoSFilter.html#getMaxRequestsPerSec()">getMaxRequestsPerSec</a>, <a href="DoSFilter.html#getMaxWaitMs()">getMaxWaitMs</a>, <a href="DoSFilter.html#getName()">getName</a>, <a href="DoSFilter.html#getThrottledRequests()">getThrottledRequests</a>, <a href="DoSFilter.html#getThrottleMs()">getThrottleMs</a>, <a href="DoSFilter.html#getTooManyCode()">getTooManyCode</a>, <a href="DoSFilter.html#getWhitelist()">getWhitelist</a>, <a href="DoSFilter.html#init(javax.servlet.FilterConfig)">init</a>, <a href="DoSFilter.html#isEnabled()">isEnabled</a>, <a href="DoSFilter.html#isInsertHeaders()">isInsertHeaders</a>, <a href="DoSFilter.html#isRemotePort()">isRemotePort</a>, <a href="DoSFilter.html#isTrackSessions()">isTrackSessions</a>, <a href="DoSFilter.html#removeFromRateTracker(java.lang.String)">removeFromRateTracker</a>, <a href="DoSFilter.html#removeWhitelistAddress(java.lang.String)">removeWhitelistAddress</a>, <a href="DoSFilter.html#setDelayMs(long)">setDelayMs</a>, <a href="DoSFilter.html#setEnabled(boolean)">setEnabled</a>, <a href="DoSFilter.html#setInsertHeaders(boolean)">setInsertHeaders</a>, <a href="DoSFilter.html#setListener(org.eclipse.jetty.servlets.DoSFilter.Listener)">setListener</a>, <a href="DoSFilter.html#setMaxIdleTrackerMs(long)">setMaxIdleTrackerMs</a>, <a href="DoSFilter.html#setMaxRequestMs(long)">setMaxRequestMs</a>, <a href="DoSFilter.html#setMaxRequestsPerSec(int)">setMaxRequestsPerSec</a>, <a href="DoSFilter.html#setMaxWaitMs(long)">setMaxWaitMs</a>, <a href="DoSFilter.html#setName(java.lang.String)">setName</a>, <a href="DoSFilter.html#setRemotePort(boolean)">setRemotePort</a>, <a href="DoSFilter.html#setThrottledRequests(int)">setThrottledRequests</a>, <a href="DoSFilter.html#setThrottleMs(long)">setThrottleMs</a>, <a href="DoSFilter.html#setTooManyCode(int)">setTooManyCode</a>, <a href="DoSFilter.html#setTrackSessions(boolean)">setTrackSessions</a>, <a href="DoSFilter.html#setWhitelist(java.lang.String)">setWhitelist</a>, <a href="DoSFilter.html#startScheduler()">startScheduler</a>, <a href="DoSFilter.html#stopScheduler()">stopScheduler</a>, <a href="DoSFilter.html#subnetMatch(java.lang.String,java.lang.String)">subnetMatch</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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="blockListLast">
<li class="blockList">
<h4>CloseableDoSFilter</h4>
<pre>public&nbsp;CloseableDoSFilter()</pre>
</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="onRequestTimeout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.Thread)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onRequestTimeout</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;onRequestTimeout&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
java.lang.Thread&nbsp;handlingThread)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="DoSFilter.html#onRequestTimeout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.Thread)">DoSFilter</a></code></span></div>
<div class="block">Invoked when the request handling exceeds <a href="DoSFilter.html#getMaxRequestMs()"><code>DoSFilter.getMaxRequestMs()</code></a>.
<p>
By default, an HTTP 503 response is returned and the handling thread is interrupted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="DoSFilter.html#onRequestTimeout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.Thread)">onRequestTimeout</a></code>&nbsp;in class&nbsp;<code><a href="DoSFilter.html" title="class in org.eclipse.jetty.servlets">DoSFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the current request</dd>
<dd><code>response</code> - the current response</dd>
<dd><code>handlingThread</code> - the handling thread</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/CloseableDoSFilter.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>Field&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>Field&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 &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>