Author: remm Date: Sat Nov 9 14:02:17 2024 New Revision: 1921830 URL: http://svn.apache.org/viewvc?rev=1921830&view=rev Log: Docs update for 9.0.97
Added: tomcat/site/trunk/docs/tomcat-9.0-doc/annotationapi/script-dir/jquery-3.7.1.min.js (with props) tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.ResourceLock.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.PropertyStore.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.ProppatchOperation.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/util/FastRateLimiter.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/util/RateLimiter.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/buf/ToStringUtil.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/collections/ConcurrentLruCache.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/WebdavIfHeader.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/net/openssl/OpenSSLStatus.Name.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/script-dir/jquery-3.7.1.min.js (with props) tomcat/site/trunk/docs/tomcat-9.0-doc/elapi/script-dir/jquery-3.7.1.min.js (with props) tomcat/site/trunk/docs/tomcat-9.0-doc/jaspicapi/script-dir/jquery-3.7.1.min.js (with props) tomcat/site/trunk/docs/tomcat-9.0-doc/jspapi/script-dir/jquery-3.7.1.min.js (with props) tomcat/site/trunk/docs/tomcat-9.0-doc/servletapi/script-dir/jquery-3.7.1.min.js (with props) tomcat/site/trunk/docs/tomcat-9.0-doc/websocketapi/script-dir/jquery-3.7.1.min.js (with props) Removed: tomcat/site/trunk/docs/tomcat-9.0-doc/annotationapi/script-dir/jquery-3.6.1.min.js tomcat/site/trunk/docs/tomcat-9.0-doc/api/script-dir/jquery-3.6.1.min.js tomcat/site/trunk/docs/tomcat-9.0-doc/elapi/script-dir/jquery-3.6.1.min.js tomcat/site/trunk/docs/tomcat-9.0-doc/jaspicapi/script-dir/jquery-3.6.1.min.js tomcat/site/trunk/docs/tomcat-9.0-doc/jspapi/script-dir/jquery-3.6.1.min.js tomcat/site/trunk/docs/tomcat-9.0-doc/servletapi/script-dir/jquery-3.6.1.min.js tomcat/site/trunk/docs/tomcat-9.0-doc/websocketapi/script-dir/jquery-3.6.1.min.js Added: tomcat/site/trunk/docs/tomcat-9.0-doc/annotationapi/script-dir/jquery-3.7.1.min.js URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/annotationapi/script-dir/jquery-3.7.1.min.js?rev=1921830&view=auto ============================================================================== Binary file - no diff available. Propchange: tomcat/site/trunk/docs/tomcat-9.0-doc/annotationapi/script-dir/jquery-3.7.1.min.js ------------------------------------------------------------------------------ svn:mime-type = application/javascript Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.ResourceLock.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.ResourceLock.html?rev=1921830&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.ResourceLock.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.ResourceLock.html Sat Nov 9 14:02:17 2024 @@ -0,0 +1,183 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>WebResourceLockSet.ResourceLock (Apache Tomcat 9.0.97 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.catalina, interface: WebResourceLockSet, class: ResourceLock"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var pathtoroot = "../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.97</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.catalina</a></div> +<h1 title="Class WebResourceLockSet.ResourceLock" class="title">Class WebResourceLockSet.ResourceLock</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.catalina.WebResourceLockSet.ResourceLock</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing interface:</dt> +<dd><a href="WebResourceLockSet.html" title="interface in org.apache.catalina">WebResourceLockSet</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">WebResourceLockSet.ResourceLock</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicInteger.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicInteger</a></code></div> +<div class="col-second even-row-color"><code><a href="#count" class="member-name-link">count</a></code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#key" class="member-name-link">key</a></code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock</a></code></div> +<div class="col-second even-row-color"><code><a href="#reentrantLock" class="member-name-link">reentrantLock</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">ResourceLock</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="count"> +<h3>count</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicInteger.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicInteger</a></span> <span class="element-name">count</span></div> +</section> +</li> +<li> +<section class="detail" id="reentrantLock"> +<h3>reentrantLock</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock</a></span> <span class="element-name">reentrantLock</span></div> +</section> +</li> +<li> +<section class="detail" id="key"> +<h3>key</h3> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">key</span></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(java.lang.String)"> +<h3>ResourceLock</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ResourceLock</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</span></div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.html?rev=1921830&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/WebResourceLockSet.html Sat Nov 9 14:02:17 2024 @@ -0,0 +1,212 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>WebResourceLockSet (Apache Tomcat 9.0.97 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.catalina, interface: WebResourceLockSet"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.97</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.catalina</a></div> +<h1 title="Interface WebResourceLockSet" class="title">Interface WebResourceLockSet</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="webresources/DirResourceSet.html" title="class in org.apache.catalina.webresources">DirResourceSet</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">WebResourceLockSet</span></div> +<div class="block">Interface implemented by <a href="WebResourceSet.html" title="interface in org.apache.catalina"><code>WebResourceSet</code></a> implementations that wish to provide locking functionality.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Interface</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static class </code></div> +<div class="col-second even-row-color"><code><a href="WebResourceLockSet.ResourceLock.html" class="type-name-link" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#lockForRead(java.lang.String)" class="member-name-link">lockForRead</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Lock the resource at the provided path for reading.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#lockForWrite(java.lang.String)" class="member-name-link">lockForWrite</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Lock the resource at the provided path for writing.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unlockForRead(org.apache.catalina.WebResourceLockSet.ResourceLock)" class="member-name-link">unlockForRead</a><wbr>(<a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a> resourceLock)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Release a read lock from the resource associated with the given <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unlockForWrite(org.apache.catalina.WebResourceLockSet.ResourceLock)" class="member-name-link">unlockForWrite</a><wbr>(<a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a> resourceLock)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Release the write lock from the resource associated with the given <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a>.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="lockForRead(java.lang.String)"> +<h3>lockForRead</h3> +<div class="member-signature"><span class="return-type"><a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a></span> <span class="element-name">lockForRead</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path)</span></div> +<div class="block">Lock the resource at the provided path for reading. The resource is not required to exist. Read locks are not + exclusive.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>path</code> - The path to the resource to be locked for reading</dd> +<dt>Returns:</dt> +<dd>The <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a> that must be passed to <a href="#unlockForRead(org.apache.catalina.WebResourceLockSet.ResourceLock)"><code>unlockForRead(ResourceLock)</code></a> to release the lock</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="unlockForRead(org.apache.catalina.WebResourceLockSet.ResourceLock)"> +<h3>unlockForRead</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">unlockForRead</span><wbr><span class="parameters">(<a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a> resourceLock)</span></div> +<div class="block">Release a read lock from the resource associated with the given <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resourceLock</code> - The <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a> associated with the resource for which a read lock should be + released</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="lockForWrite(java.lang.String)"> +<h3>lockForWrite</h3> +<div class="member-signature"><span class="return-type"><a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a></span> <span class="element-name">lockForWrite</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path)</span></div> +<div class="block">Lock the resource at the provided path for writing. The resource is not required to exist. Write locks are + exclusive.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>path</code> - The path to the resource to be locked for writing</dd> +<dt>Returns:</dt> +<dd>The <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a> that must be passed to <a href="#unlockForWrite(org.apache.catalina.WebResourceLockSet.ResourceLock)"><code>unlockForWrite(ResourceLock)</code></a> to release the lock</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="unlockForWrite(org.apache.catalina.WebResourceLockSet.ResourceLock)"> +<h3>unlockForWrite</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">unlockForWrite</span><wbr><span class="parameters">(<a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina">WebResourceLockSet.ResourceLock</a> resourceLock)</span></div> +<div class="block">Release the write lock from the resource associated with the given <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a>.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resourceLock</code> - The <a href="WebResourceLockSet.ResourceLock.html" title="class in org.apache.catalina"><code>WebResourceLockSet.ResourceLock</code></a> associated with the resource for which the write lock should be + released</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.PropertyStore.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.PropertyStore.html?rev=1921830&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.PropertyStore.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.PropertyStore.html Sat Nov 9 14:02:17 2024 @@ -0,0 +1,247 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>WebdavServlet.PropertyStore (Apache Tomcat 9.0.97 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.catalina.servlets, class: WebdavServlet, interface: PropertyStore"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.97</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.catalina.servlets</a></div> +<h1 title="Interface WebdavServlet.PropertyStore" class="title">Interface WebdavServlet.PropertyStore</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="WebdavServlet.html" title="class in org.apache.catalina.servlets">WebdavServlet</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">WebdavServlet.PropertyStore</span></div> +<div class="block">Handling of dead properties on resources. This interface allows + providing storage for dead properties. Store configuration is done + through the <code>propertyStore</code> init parameter of the WebDAV + Servlet, which should contain the class name of the store.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#copy(java.lang.String,java.lang.String)" class="member-name-link">copy</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> source, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> destination)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Copy resource.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#delete(java.lang.String)" class="member-name-link">delete</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resource)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Delete specified resource.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#destroy()" class="member-name-link">destroy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Destroy the store.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#init()" class="member-name-link">init</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Initialize the store.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#periodicEvent()" class="member-name-link">periodicEvent</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Periodic event for maintenance tasks.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#propfind(java.lang.String,org.w3c.dom.Node,boolean,org.apache.catalina.util.XMLWriter)" class="member-name-link">propfind</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resource, + <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html" title="class or interface in org.w3c.dom" class="external-link">Node</a> property, + boolean nameOnly, + <a href="../util/XMLWriter.html" title="class in org.apache.catalina.util">XMLWriter</a> generatedXML)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Generate propfind XML fragments for dead properties.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#proppatch(java.lang.String,java.util.ArrayList)" class="member-name-link">proppatch</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resource, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="WebdavServlet.ProppatchOperation.html" title="class in org.apache.catalina.servlets">WebdavServlet.ProppatchOperation</a>> operations)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Apply proppatch to the specified resource.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="init()"> +<h3>init</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">init</span>()</div> +<div class="block">Initialize the store. This is tied to the Servlet lifecycle and is called by its init method.</div> +</section> +</li> +<li> +<section class="detail" id="destroy()"> +<h3>destroy</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">destroy</span>()</div> +<div class="block">Destroy the store. This is tied to the Servlet lifecycle and is called by its destroy method.</div> +</section> +</li> +<li> +<section class="detail" id="periodicEvent()"> +<h3>periodicEvent</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">periodicEvent</span>()</div> +<div class="block">Periodic event for maintenance tasks.</div> +</section> +</li> +<li> +<section class="detail" id="copy(java.lang.String,java.lang.String)"> +<h3>copy</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> source, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> destination)</span></div> +<div class="block">Copy resource. Dead properties should be copied to the destination path.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>source</code> - the copy source path</dd> +<dd><code>destination</code> - the copy destination path</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="delete(java.lang.String)"> +<h3>delete</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">delete</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resource)</span></div> +<div class="block">Delete specified resource. Dead properties on a deleted resource should be deleted.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resource</code> - the path of the resource to delete</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="propfind(java.lang.String,org.w3c.dom.Node,boolean,org.apache.catalina.util.XMLWriter)"> +<h3>propfind</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">propfind</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resource, + <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html" title="class or interface in org.w3c.dom" class="external-link">Node</a> property, + boolean nameOnly, + <a href="../util/XMLWriter.html" title="class in org.apache.catalina.util">XMLWriter</a> generatedXML)</span></div> +<div class="block">Generate propfind XML fragments for dead properties.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resource</code> - the resource path</dd> +<dd><code>property</code> - the dead property, if null then all dead properties must be written</dd> +<dd><code>nameOnly</code> - true if only the property name element should be generated</dd> +<dd><code>generatedXML</code> - the current generated XML for the PROPFIND response</dd> +<dt>Returns:</dt> +<dd>true if a property was specified and a corresponding dead property was found on the resource, + false otherwise</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="proppatch(java.lang.String,java.util.ArrayList)"> +<h3>proppatch</h3> +<div class="member-signature"><span class="return-type">void</span> <span class="element-name">proppatch</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resource, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="WebdavServlet.ProppatchOperation.html" title="class in org.apache.catalina.servlets">WebdavServlet.ProppatchOperation</a>> operations)</span></div> +<div class="block">Apply proppatch to the specified resource.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>resource</code> - the resource path on which to apply the proppatch</dd> +<dd><code>operations</code> - the set and remove to apply, the final status codes of the result should be set on each + operation</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.ProppatchOperation.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.ProppatchOperation.html?rev=1921830&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.ProppatchOperation.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/servlets/WebdavServlet.ProppatchOperation.html Sat Nov 9 14:02:17 2024 @@ -0,0 +1,234 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>WebdavServlet.ProppatchOperation (Apache Tomcat 9.0.97 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.catalina.servlets, class: WebdavServlet, class: ProppatchOperation"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.97</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.catalina.servlets</a></div> +<h1 title="Class WebdavServlet.ProppatchOperation" class="title">Class WebdavServlet.ProppatchOperation</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.catalina.servlets.WebdavServlet.ProppatchOperation</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="WebdavServlet.html" title="class in org.apache.catalina.servlets">WebdavServlet</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">WebdavServlet.ProppatchOperation</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">Represents a PROPPATCH sub operation to be performed.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType,org.w3c.dom.Node)" class="member-name-link">ProppatchOperation</a><wbr>(org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType updateType, + <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html" title="class or interface in org.w3c.dom" class="external-link">Node</a> propertyNode)</code></div> +<div class="col-last even-row-color"> +<div class="block">PROPPATCH operation constructor.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html" title="class or interface in org.w3c.dom" class="external-link">Node</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPropertyNode()" class="member-name-link">getPropertyNode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProtectedProperty()" class="member-name-link">getProtectedProperty</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStatusCode()" class="member-name-link">getStatusCode</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpdateType()" class="member-name-link">getUpdateType</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStatusCode(int)" class="member-name-link">setStatusCode</a><wbr>(int statusCode)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType,org.w3c.dom.Node)"> +<h3>ProppatchOperation</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ProppatchOperation</span><wbr><span class="parameters">(org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType updateType, + <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html" title="class or interface in org.w3c.dom" class="external-link">Node</a> propertyNode)</span></div> +<div class="block">PROPPATCH operation constructor.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>updateType</code> - the update type, either SET or REMOVE</dd> +<dd><code>propertyNode</code> - the XML node that contains the property name (and value if SET)</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getUpdateType()"> +<h3>getUpdateType</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType</span> <span class="element-name">getUpdateType</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the updateType for this operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPropertyNode()"> +<h3>getPropertyNode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html" title="class or interface in org.w3c.dom" class="external-link">Node</a></span> <span class="element-name">getPropertyNode</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the propertyNode the XML node that contains the property name (and value if SET)</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getStatusCode()"> +<h3>getStatusCode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getStatusCode</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the statusCode the statusCode to set as a result of the operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setStatusCode(int)"> +<h3>setStatusCode</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStatusCode</span><wbr><span class="parameters">(int statusCode)</span></div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>statusCode</code> - the statusCode to set as a result of the operation</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getProtectedProperty()"> +<h3>getProtectedProperty</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getProtectedProperty</span>()</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd><code>true</code> if the property is protected</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/util/FastRateLimiter.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/util/FastRateLimiter.html?rev=1921830&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/util/FastRateLimiter.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/util/FastRateLimiter.html Sat Nov 9 14:02:17 2024 @@ -0,0 +1,294 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>FastRateLimiter (Apache Tomcat 9.0.97 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.catalina.util, class: FastRateLimiter"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.97</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.catalina.util</a></div> +<h1 title="Class FastRateLimiter" class="title">Class FastRateLimiter</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.catalina.util.FastRateLimiter</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FastRateLimiter</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> +implements <a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></span></div> +<div class="block">A RateLimiter that compromises accuracy for speed in order to provide maximum throughput.</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FastRateLimiter</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#destroy()" class="member-name-link">destroy</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Cleanup no longer needed resources.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TimeBucketCounter.html" title="class in org.apache.catalina.util">TimeBucketCounter</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBucketCounter()" class="member-name-link">getBucketCounter</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDuration()" class="member-name-link">getDuration</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRequests()" class="member-name-link">getRequests</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#increment(java.lang.String)" class="member-name-link">increment</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ipAddress)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Increments the number of requests by the given ipAddress in the current time window.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDuration(int)" class="member-name-link">setDuration</a><wbr>(int duration)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the configured duration value in seconds.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFilterConfig(javax.servlet.FilterConfig)" class="member-name-link">setFilterConfig</a><wbr>(<a href="../../../../../servletapi/javax/servlet/FilterConfig.html" title="class or interface in javax.servlet" class="external-link">FilterConfig</a> filterConfig)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Pass the FilterConfig to configure the filter.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRequests(int)" class="member-name-link">setRequests</a><wbr>(int requests)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the configured number of requests allowed per time window.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>FastRateLimiter</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FastRateLimiter</span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getDuration()"> +<h3>getDuration</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getDuration</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#getDuration()">getDuration</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +<dt>Returns:</dt> +<dd>the actual duration of a time window in seconds</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setDuration(int)"> +<h3>setDuration</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDuration</span><wbr><span class="parameters">(int duration)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RateLimiter.html#setDuration(int)">RateLimiter</a></code></span></div> +<div class="block">Sets the configured duration value in seconds.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#setDuration(int)">setDuration</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +<dt>Parameters:</dt> +<dd><code>duration</code> - The duration of the time window in seconds</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getRequests()"> +<h3>getRequests</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRequests</span>()</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#getRequests()">getRequests</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +<dt>Returns:</dt> +<dd>the maximum number of requests allowed per time window</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setRequests(int)"> +<h3>setRequests</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRequests</span><wbr><span class="parameters">(int requests)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RateLimiter.html#setRequests(int)">RateLimiter</a></code></span></div> +<div class="block">Sets the configured number of requests allowed per time window.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#setRequests(int)">setRequests</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +<dt>Parameters:</dt> +<dd><code>requests</code> - The number of requests per time window</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="increment(java.lang.String)"> +<h3>increment</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">increment</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ipAddress)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RateLimiter.html#increment(java.lang.String)">RateLimiter</a></code></span></div> +<div class="block">Increments the number of requests by the given ipAddress in the current time window.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#increment(java.lang.String)">increment</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +<dt>Parameters:</dt> +<dd><code>ipAddress</code> - the ip address</dd> +<dt>Returns:</dt> +<dd>the new value after incrementing</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="destroy()"> +<h3>destroy</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">destroy</span>()</div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RateLimiter.html#destroy()">RateLimiter</a></code></span></div> +<div class="block">Cleanup no longer needed resources.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#destroy()">destroy</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setFilterConfig(javax.servlet.FilterConfig)"> +<h3>setFilterConfig</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setFilterConfig</span><wbr><span class="parameters">(<a href="../../../../../servletapi/javax/servlet/FilterConfig.html" title="class or interface in javax.servlet" class="external-link">FilterConfig</a> filterConfig)</span></div> +<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RateLimiter.html#setFilterConfig(javax.servlet.FilterConfig)">RateLimiter</a></code></span></div> +<div class="block">Pass the FilterConfig to configure the filter.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="RateLimiter.html#setFilterConfig(javax.servlet.FilterConfig)">setFilterConfig</a></code> in interface <code><a href="RateLimiter.html" title="interface in org.apache.catalina.util">RateLimiter</a></code></dd> +<dt>Parameters:</dt> +<dd><code>filterConfig</code> - The FilterConfig used to configure the associated filter</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getBucketCounter()"> +<h3>getBucketCounter</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TimeBucketCounter.html" title="class in org.apache.catalina.util">TimeBucketCounter</a></span> <span class="element-name">getBucketCounter</span>()</div> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org