Author: remm
Date: Tue Oct 10 11:41:10 2023
New Revision: 1912866
URL: http://svn.apache.org/viewvc?rev=1912866&view=rev
Log:
Docs for 9.0.81
Added:
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/security/TLSCertificateReloadListener.html
Added:
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/security/TLSCertificateReloadListener.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/security/TLSCertificateReloadListener.html?rev=1912866&view=auto
==============================================================================
---
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/security/TLSCertificateReloadListener.html
(added)
+++
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/security/TLSCertificateReloadListener.html
Tue Oct 10 11:41:10 2023
@@ -0,0 +1,427 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>TLSCertificateReloadListener (Apache Tomcat 9.0.81 API
Documentation)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css"
title="Style">
+<link rel="stylesheet" type="text/css"
href="../../../../jquery/jquery-ui.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="../../../../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.6.1.min.js"></script>
+<script type="text/javascript"
src="../../../../jquery/jquery-ui.min.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="TLSCertificateReloadListener (Apache Tomcat
9.0.81 API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+var pathtoroot = "../../../../";
+var useModuleDirectories = true;
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<header role="banner">
+<nav role="navigation">
+<div class="fixedNav">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation
links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../index.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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 class="aboutLanguage"><b>Apache Tomcat 9.0.81</b></div>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses.html">All 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: </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="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </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"> </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> <a
href="package-summary.html">org.apache.catalina.security</a></div>
+<h2 title="Class TLSCertificateReloadListener" class="title">Class
TLSCertificateReloadListener</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.catalina.security.TLSCertificateReloadListener</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><code><a href="../LifecycleListener.html" title="interface in
org.apache.catalina">LifecycleListener</a></code></dd>
+</dl>
+<hr>
+<pre>public class <span
class="typeNameLabel">TLSCertificateReloadListener</span>
+extends java.lang.Object
+implements <a href="../LifecycleListener.html" title="interface in
org.apache.catalina">LifecycleListener</a></pre>
+<div class="block">A <a href="../LifecycleListener.html" title="interface in
org.apache.catalina"><code>LifecycleListener</code></a> that may be used to
monitor the expiration dates of TLS certificates and trigger
+ automatic reloading of the TLS configuration a set number of days before the
TLS certificate expires.
+ <p>
+ This listener assumes there is some other process (certbot, cloud
infrastructure, etc) that renews the certificate on
+ a regular basis and replaces the current certificate with the new one.
+ <p>
+ This listener does <b>NOT</b> re-read the Tomcat configuration from
server.xml. If you make changes to server.xml you
+ must restart the Tomcat process to pick up those changes.
+ <p></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<section>
+<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"> </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()">TLSCertificateReloadListener</a></span>()</code></th>
+<td class="colLast"> </td>
+</tr>
+</table>
+</li>
+</ul>
+</section>
+<!-- ========== METHOD SUMMARY =========== -->
+<section>
+<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"> </span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd"> </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>int</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#getCheckPeriod()">getCheckPeriod</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Get the time, in seconds, between reloading checks.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#getDaysBefore()">getDaysBefore</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Get the number of days before the expiry of a TLS
certificate that it is expected that the new certificate will
+ be in place and the reloading can be triggered.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#lifecycleEvent(org.apache.catalina.LifecycleEvent)">lifecycleEvent</a></span>​(<a
href="../LifecycleEvent.html" title="class in
org.apache.catalina">LifecycleEvent</a> event)</code></th>
+<td class="colLast">
+<div class="block">Acknowledge the occurrence of the specified event.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#setCheckPeriod(int)">setCheckPeriod</a></span>​(int checkPeriod)</code></th>
+<td class="colLast">
+<div class="block">Set the time, in seconds, between reloading checks.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#setDaysBefore(int)">setDaysBefore</a></span>​(int daysBefore)</code></th>
+<td class="colLast">
+<div class="block">Set the number of days before the expiry of a TLS
certificate that it is expected that the new certificate will
+ be in place and the reloading can be triggered.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class 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>
+<ul class="blockList">
+<li class="blockList"><a id="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a id="<init>()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>TLSCertificateReloadListener</h4>
+<pre>public TLSCertificateReloadListener()</pre>
+</li>
+</ul>
+</li>
+</ul>
+</section>
+<!-- ============ METHOD DETAIL ========== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a id="getCheckPeriod()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCheckPeriod</h4>
+<pre class="methodSignature">public int getCheckPeriod()</pre>
+<div class="block">Get the time, in seconds, between reloading checks.
+ <p>
+ The periodic process for <code>LifecycleListener</code> typically runs much
more frequently than this listener
+ requires. This attribute controls the period between checks.
+ <p>
+ If not specified, a default of 86,400 seconds (24 hours) is used.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The time, in seconds, between reloading checks</dd>
+</dl>
+</li>
+</ul>
+<a id="setCheckPeriod(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setCheckPeriod</h4>
+<pre
class="methodSignature">public void setCheckPeriod​(int checkPeriod)</pre>
+<div class="block">Set the time, in seconds, between reloading checks.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>checkPeriod</code> - The new time, in seconds, between reloading
checks</dd>
+</dl>
+</li>
+</ul>
+<a id="getDaysBefore()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDaysBefore</h4>
+<pre class="methodSignature">public int getDaysBefore()</pre>
+<div class="block">Get the number of days before the expiry of a TLS
certificate that it is expected that the new certificate will
+ be in place and the reloading can be triggered.
+ <p>
+ If not specified, a default of 14 days is used.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The number of days before the expiry of a TLS certificate that the
reloading will be triggered</dd>
+</dl>
+</li>
+</ul>
+<a id="setDaysBefore(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDaysBefore</h4>
+<pre
class="methodSignature">public void setDaysBefore​(int daysBefore)</pre>
+<div class="block">Set the number of days before the expiry of a TLS
certificate that it is expected that the new certificate will
+ be in place and the reloading can be triggered.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>daysBefore</code> - the number of days before the expiry of the
current certificate that reloading will be
+ triggered</dd>
+</dl>
+</li>
+</ul>
+<a id="lifecycleEvent(org.apache.catalina.LifecycleEvent)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>lifecycleEvent</h4>
+<pre class="methodSignature">public void lifecycleEvent​(<a
href="../LifecycleEvent.html" title="class in
org.apache.catalina">LifecycleEvent</a> event)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from
interface: <code><a
href="../LifecycleListener.html#lifecycleEvent(org.apache.catalina.LifecycleEvent)">LifecycleListener</a></code></span></div>
+<div class="block">Acknowledge the occurrence of the specified event.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a
href="../LifecycleListener.html#lifecycleEvent(org.apache.catalina.LifecycleEvent)">lifecycleEvent</a></code> in
interface <code><a href="../LifecycleListener.html" title="interface in
org.apache.catalina">LifecycleListener</a></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - LifecycleEvent that has occurred</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="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 class="aboutLanguage"><b>Apache Tomcat 9.0.81</b></div>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<div>
+<ul class="subNavList">
+<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="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </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 © 2000-2023 Apache Software
Foundation. All Rights Reserved.</small></p>
+</footer>
+</body>
+</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
