Author: remm
Date: Mon Jul 10 13:22:01 2023
New Revision: 1910918
URL: http://svn.apache.org/viewvc?rev=1910918&view=rev
Log:
Docs update for 9.0.78 (part 2)
Added:
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/ContextNamingInfoListener.html
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/PropertiesRoleMappingListener.html
Added:
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/ContextNamingInfoListener.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/ContextNamingInfoListener.html?rev=1910918&view=auto
==============================================================================
---
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/ContextNamingInfoListener.html
(added)
+++
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/ContextNamingInfoListener.html
Mon Jul 10 13:22:01 2023
@@ -0,0 +1,382 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>ContextNamingInfoListener (Apache Tomcat 9.0.78 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="ContextNamingInfoListener (Apache Tomcat
9.0.78 API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var data = {"i0":10,"i1":10,"i2":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.78</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.core</a></div>
+<h2 title="Class ContextNamingInfoListener" class="title">Class
ContextNamingInfoListener</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.catalina.core.ContextNamingInfoListener</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">ContextNamingInfoListener</span>
+extends java.lang.Object
+implements <a href="../LifecycleListener.html" title="interface in
org.apache.catalina">LifecycleListener</a></pre>
+<div class="block">Implementation of <code>LifecycleListener</code> that will
create context naming information environment entries.
+ <p>
+ This listener must only be nested within <a href="../Context.html"
title="interface in org.apache.catalina"><code>Context</code></a> elements.
+ <p>
+ The following entries will be added to the initial context
(<code>java:comp/env</code> implied):
+ <ul>
+ <li>Path: <code>context/path</code> from <a
href="../Context.html#getPath()"><code>Context.getPath()</code></a></li>
+ <li>Encoded Path: <code>context/encodedPath</code> from <a
href="../Context.html#getEncodedPath()"><code>Context.getEncodedPath()</code></a></li>
+ <li>Webapp Version: <code>context/webappVersion</code> from <a
href="../Context.html#getWebappVersion()"><code>Context.getWebappVersion()</code></a></li>
+ <li>Name: <code>context/name</code> from <a
href="../Container.html#getName()"><code>Container.getName()</code></a></li>
+ <li>Base Name: <code>context/baseName</code> from <a
href="../Context.html#getBaseName()"><code>Context.getBaseName()</code></a></li>
+ <li>Display Name: <code>context/displayName</code> from <a
href="../Context.html#getDisplayName()"><code>Context.getDisplayName()</code></a></li>
+ </ul>
+ <p>
+ See the <a
href="https://tomcat.apache.org/tomcat-9.0-doc/config/context.html#Naming";>Tomcat
documentation</a> for
+ more details on the values.</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()">ContextNamingInfoListener</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>boolean</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#isEmptyOnRoot()">isEmptyOnRoot</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Gets whether paths and name for the root context will be
empty.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#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="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#setEmptyOnRoot(boolean)">setEmptyOnRoot</a></span>​(boolean emptyOnRoot)</code></th>
+<td class="colLast">
+<div class="block">Sets whether for the root context <code>context/path</code>
and <code>context/encodedPath</code> will contain <code>"/"</code>
+ and <code>context/name</code> will contain <code>"ROOT"</code> with a
version, if any.</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>ContextNamingInfoListener</h4>
+<pre>public ContextNamingInfoListener()</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="setEmptyOnRoot(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setEmptyOnRoot</h4>
+<pre
class="methodSignature">public void setEmptyOnRoot​(boolean emptyOnRoot)</pre>
+<div class="block">Sets whether for the root context <code>context/path</code>
and <code>context/encodedPath</code> will contain <code>"/"</code>
+ and <code>context/name</code> will contain <code>"ROOT"</code> with a
version, if any.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>emptyOnRoot</code> - whether paths and name for root context shall
be empty</dd>
+</dl>
+</li>
+</ul>
+<a id="isEmptyOnRoot()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isEmptyOnRoot</h4>
+<pre class="methodSignature">public boolean isEmptyOnRoot()</pre>
+<div class="block">Gets whether paths and name for the root context will be
empty.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>indicator whether paths and name for the root context will be empty</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.78</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>
Added:
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/PropertiesRoleMappingListener.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/PropertiesRoleMappingListener.html?rev=1910918&view=auto
==============================================================================
---
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/PropertiesRoleMappingListener.html
(added)
+++
tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/core/PropertiesRoleMappingListener.html
Mon Jul 10 13:22:01 2023
@@ -0,0 +1,419 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>PropertiesRoleMappingListener (Apache Tomcat 9.0.78 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="PropertiesRoleMappingListener (Apache
Tomcat 9.0.78 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.78</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.core</a></div>
+<h2 title="Class PropertiesRoleMappingListener" class="title">Class
PropertiesRoleMappingListener</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.catalina.core.PropertiesRoleMappingListener</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">PropertiesRoleMappingListener</span>
+extends java.lang.Object
+implements <a href="../LifecycleListener.html" title="interface in
org.apache.catalina">LifecycleListener</a></pre>
+<div class="block">Implementation of <code>LifecycleListener</code> that will
populate the context's role mapping from a properties file.
+ <p>
+ This listener must only be nested within <a href="../Context.html"
title="interface in org.apache.catalina"><code>Context</code></a> elements.
+ <p>
+ The keys represent application roles (e.g., admin, user, uservisor, etc.)
while the values represent technical roles
+ (e.g., DNs, SIDs, UUIDs, etc.). A key can also be prefixed if, e.g., the
properties file contains generic
+ application configuration as well: <code>app-roles.</code>.
+ <p>
+ Note: The default value for the <code>roleMappingFile</code> is
<code>webapp:/WEB-INF/role-mapping.properties</code>.</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()">PropertiesRoleMappingListener</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>java.lang.String</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#getKeyPrefix()">getKeyPrefix</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Gets the prefix to filter from property keys.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#getRoleMappingFile()">getRoleMappingFile</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Gets the path to the role mapping properties file.</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="#setKeyPrefix(java.lang.String)">setKeyPrefix</a></span>​(java.lang.String keyPrefix)</code></th>
+<td class="colLast">
+<div class="block">Sets the prefix to filter from property keys.</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="#setRoleMappingFile(java.lang.String)">setRoleMappingFile</a></span>​(java.lang.String roleMappingFile)</code></th>
+<td class="colLast">
+<div class="block">Sets the path to the role mapping properties file.</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>PropertiesRoleMappingListener</h4>
+<pre>public PropertiesRoleMappingListener()</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="setRoleMappingFile(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setRoleMappingFile</h4>
+<pre
class="methodSignature">public void setRoleMappingFile​(java.lang.String roleMappingFile)</pre>
+<div class="block">Sets the path to the role mapping properties file. You can
use protocol <code>webapp:</code> and whatever
+ <a href="../../tomcat/util/file/ConfigFileLoader.html" title="class in
org.apache.tomcat.util.file"><code>ConfigFileLoader</code></a> supports.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>roleMappingFile</code> - the role mapping properties file to load
from</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.NullPointerException</code> - if roleMappingFile is
null</dd>
+<dd><code>java.lang.IllegalArgumentException</code> - if roleMappingFile is
empty</dd>
+</dl>
+</li>
+</ul>
+<a id="getRoleMappingFile()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRoleMappingFile</h4>
+<pre
class="methodSignature">public java.lang.String getRoleMappingFile()</pre>
+<div class="block">Gets the path to the role mapping properties file.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the path to the role mapping properties file</dd>
+</dl>
+</li>
+</ul>
+<a id="setKeyPrefix(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setKeyPrefix</h4>
+<pre
class="methodSignature">public void setKeyPrefix​(java.lang.String keyPrefix)</pre>
+<div class="block">Sets the prefix to filter from property keys. All other
keys will be ignored which do not have the prefix.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>keyPrefix</code> - the properties key prefix</dd>
+</dl>
+</li>
+</ul>
+<a id="getKeyPrefix()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getKeyPrefix</h4>
+<pre
class="methodSignature">public java.lang.String getKeyPrefix()</pre>
+<div class="block">Gets the prefix to filter from property keys.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the properties key prefix</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.78</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
