Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/GenericUser.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/GenericUser.html?rev=1893319&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/GenericUser.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/GenericUser.html Mon Sep 13 18:58:18 2021 @@ -0,0 +1,721 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GenericUser (Apache Tomcat 9.0.53 API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="GenericUser (Apache Tomcat 9.0.53 API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="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.53</b></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/catalina/users/GenericRole.html" title="class in org.apache.catalina.users"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/catalina/users/MemoryGroup.html" title="class in org.apache.catalina.users"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/catalina/users/GenericUser.html" target="_top">Frames</a></li> +<li><a href="GenericUser.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.catalina.users</div> +<h2 title="Class GenericUser" class="title">Class GenericUser<UD extends <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">org.apache.catalina.users.AbstractUser</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.catalina.users.GenericUser<UD></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>UD</code> - The specific type of UserDase with which this role is associated</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true"; title="class or interface in java.security">Principal</a>, <a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/catalina/users/MemoryUser.html" title="class in org.apache.catalina.users">MemoryUser</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">GenericUser<UD extends <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a>></span> +extends <a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></pre> +<div class="block"><p>Concrete implementation of <a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina"><code>User</code></a> for a + <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a>.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Craig R. McClanahan</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/catalina/users/GenericUser.html" title="type parameter in GenericUser">UD</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#database">database</a></span></code> +<div class="block">The <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a> that owns this user.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CopyOnWriteArrayList.html?is-external=true"; title="class or interface in java.util.concurrent">CopyOnWriteArrayList</a><<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#groups">groups</a></span></code> +<div class="block">The set of <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s that this user is a member of.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CopyOnWriteArrayList.html?is-external=true"; title="class or interface in java.util.concurrent">CopyOnWriteArrayList</a><<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#roles">roles</a></span></code> +<div class="block">The set of <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s associated with this user.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.catalina.users.AbstractUser"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.catalina.users.<a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></h3> +<code><a href="../../../../org/apache/catalina/users/AbstractUser.html#fullName">fullName</a>, <a href="../../../../org/apache/catalina/users/AbstractUser.html#password">password</a>, <a href="../../../../org/apache/catalina/users/AbstractUser.html#username">username</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<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="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#addGroup-org.apache.catalina.Group-">addGroup</a></span>(<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a> group)</code> +<div class="block">Add a new <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a> to those this user belongs to.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#addRole-org.apache.catalina.Role-">addRole</a></span>(<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a> role)</code> +<div class="block">Add a new <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a> to those assigned specifically to this user.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#getGroups--">getGroups</a></span>()</code> +<div class="block">Return the set of <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s to which this user belongs.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#getRoles--">getRoles</a></span>()</code> +<div class="block">Return the set of <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s assigned specifically to this user.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#getUserDatabase--">getUserDatabase</a></span>()</code> +<div class="block">Return the <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a> within which this User is defined.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#isInGroup-org.apache.catalina.Group-">isInGroup</a></span>(<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a> group)</code> +<div class="block">Is this user in the specified group?</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#isInRole-org.apache.catalina.Role-">isInRole</a></span>(<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a> role)</code> +<div class="block">Is this user specifically assigned the specified <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>?</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#removeGroup-org.apache.catalina.Group-">removeGroup</a></span>(<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a> group)</code> +<div class="block">Remove a <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a> from those this user belongs to.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#removeGroups--">removeGroups</a></span>()</code> +<div class="block">Remove all <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s from those this user belongs to.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#removeRole-org.apache.catalina.Role-">removeRole</a></span>(<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a> role)</code> +<div class="block">Remove a <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a> from those assigned to this user.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#removeRoles--">removeRoles</a></span>()</code> +<div class="block">Remove all <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s from those assigned to this user.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#setFullName-java.lang.String-">setFullName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> fullName)</code> +<div class="block">Set the full name of this user.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#setPassword-java.lang.String-">setPassword</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> password)</code> +<div class="block">Set the logon password of this user, optionally prefixed with the + identifier of an encoding scheme surrounded by curly braces, such as + <code>{md5}xxxxx</code>.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/GenericUser.html#setUsername-java.lang.String-">setUsername</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> username)</code> +<div class="block">Set the logon username of this user, which must be unique within + the scope of a <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.catalina.users.AbstractUser"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.catalina.users.<a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></h3> +<code><a href="../../../../org/apache/catalina/users/AbstractUser.html#getFullName--">getFullName</a>, <a href="../../../../org/apache/catalina/users/AbstractUser.html#getName--">getName</a>, <a href="../../../../org/apache/catalina/users/AbstractUser.html#getPassword--">getPassword</a>, <a href="../../../../org/apache/catalina/users/AbstractUser.html#getUsername--">getUsername</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Ob ject.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.security.Principal"> +<!-- --> +</a> +<h3>Methods inherited from interface java.security.<a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true"; title="class or interface in java.security">Principal</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true#implies-javax.security.auth.Subject-"; title="class or interface in java.security">implies</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true#toString--"; title="class or interface in java.security">toString</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="database"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>database</h4> +<pre>protected final <a href="../../../../org/apache/catalina/users/GenericUser.html" title="type parameter in GenericUser">UD</a> extends <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a> database</pre> +<div class="block">The <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a> that owns this user.</div> +</li> +</ul> +<a name="groups"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>groups</h4> +<pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CopyOnWriteArrayList.html?is-external=true"; title="class or interface in java.util.concurrent">CopyOnWriteArrayList</a><<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a>> groups</pre> +<div class="block">The set of <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s that this user is a member of.</div> +</li> +</ul> +<a name="roles"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>roles</h4> +<pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CopyOnWriteArrayList.html?is-external=true"; title="class or interface in java.util.concurrent">CopyOnWriteArrayList</a><<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a>> roles</pre> +<div class="block">The set of <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s associated with this user.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getGroups--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGroups</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a>> getGroups()</pre> +<div class="block">Return the set of <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s to which this user belongs.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#getGroups--">getGroups</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#getGroups--">getGroups</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the set of <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s to which this user belongs.</dd> +</dl> +</li> +</ul> +<a name="getRoles--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRoles</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a>> getRoles()</pre> +<div class="block">Return the set of <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s assigned specifically to this user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#getRoles--">getRoles</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#getRoles--">getRoles</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the set of <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s assigned specifically to this user.</dd> +</dl> +</li> +</ul> +<a name="getUserDatabase--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserDatabase</h4> +<pre>public <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a> getUserDatabase()</pre> +<div class="block">Return the <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a> within which this User is defined.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a> within which this User is defined.</dd> +</dl> +</li> +</ul> +<a name="addGroup-org.apache.catalina.Group-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGroup</h4> +<pre>public void addGroup(<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a> group)</pre> +<div class="block">Add a new <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a> to those this user belongs to.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#addGroup-org.apache.catalina.Group-">addGroup</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#addGroup-org.apache.catalina.Group-">addGroup</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - The new group</dd> +</dl> +</li> +</ul> +<a name="addRole-org.apache.catalina.Role-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addRole</h4> +<pre>public void addRole(<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a> role)</pre> +<div class="block">Add a new <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a> to those assigned specifically to this user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#addRole-org.apache.catalina.Role-">addRole</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#addRole-org.apache.catalina.Role-">addRole</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>role</code> - The new role</dd> +</dl> +</li> +</ul> +<a name="isInGroup-org.apache.catalina.Group-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInGroup</h4> +<pre>public boolean isInGroup(<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a> group)</pre> +<div class="block">Is this user in the specified group?</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#isInGroup-org.apache.catalina.Group-">isInGroup</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#isInGroup-org.apache.catalina.Group-">isInGroup</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - The group to check</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if the user is in the specified group</dd> +</dl> +</li> +</ul> +<a name="isInRole-org.apache.catalina.Role-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInRole</h4> +<pre>public boolean isInRole(<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a> role)</pre> +<div class="block">Is this user specifically assigned the specified <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>? This + method does <strong>NOT</strong> check for roles inherited based on + <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a> membership.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#isInRole-org.apache.catalina.Role-">isInRole</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#isInRole-org.apache.catalina.Role-">isInRole</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>role</code> - The role to check</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if the user has the specified role</dd> +</dl> +</li> +</ul> +<a name="removeGroup-org.apache.catalina.Group-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeGroup</h4> +<pre>public void removeGroup(<a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina">Group</a> group)</pre> +<div class="block">Remove a <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a> from those this user belongs to.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#removeGroup-org.apache.catalina.Group-">removeGroup</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#removeGroup-org.apache.catalina.Group-">removeGroup</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - The old group</dd> +</dl> +</li> +</ul> +<a name="removeGroups--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeGroups</h4> +<pre>public void removeGroups()</pre> +<div class="block">Remove all <a href="../../../../org/apache/catalina/Group.html" title="interface in org.apache.catalina"><code>Group</code></a>s from those this user belongs to.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#removeGroups--">removeGroups</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#removeGroups--">removeGroups</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +</dl> +</li> +</ul> +<a name="removeRole-org.apache.catalina.Role-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeRole</h4> +<pre>public void removeRole(<a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina">Role</a> role)</pre> +<div class="block">Remove a <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a> from those assigned to this user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#removeRole-org.apache.catalina.Role-">removeRole</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#removeRole-org.apache.catalina.Role-">removeRole</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>role</code> - The old role</dd> +</dl> +</li> +</ul> +<a name="removeRoles--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeRoles</h4> +<pre>public void removeRoles()</pre> +<div class="block">Remove all <a href="../../../../org/apache/catalina/Role.html" title="interface in org.apache.catalina"><code>Role</code></a>s from those assigned to this user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#removeRoles--">removeRoles</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#removeRoles--">removeRoles</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +</dl> +</li> +</ul> +<a name="setFullName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFullName</h4> +<pre>public void setFullName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> fullName)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/catalina/users/AbstractUser.html#setFullName-java.lang.String-">AbstractUser</a></code></span></div> +<div class="block">Set the full name of this user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#setFullName-java.lang.String-">setFullName</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#setFullName-java.lang.String-">setFullName</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fullName</code> - The new full name</dd> +</dl> +</li> +</ul> +<a name="setPassword-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPassword</h4> +<pre>public void setPassword(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> password)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/catalina/users/AbstractUser.html#setPassword-java.lang.String-">AbstractUser</a></code></span></div> +<div class="block">Set the logon password of this user, optionally prefixed with the + identifier of an encoding scheme surrounded by curly braces, such as + <code>{md5}xxxxx</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#setPassword-java.lang.String-">setPassword</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#setPassword-java.lang.String-">setPassword</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>password</code> - The new logon password</dd> +</dl> +</li> +</ul> +<a name="setUsername-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUsername</h4> +<pre>public void setUsername(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> username)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/catalina/users/AbstractUser.html#setUsername-java.lang.String-">AbstractUser</a></code></span></div> +<div class="block">Set the logon username of this user, which must be unique within + the scope of a <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina"><code>UserDatabase</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/User.html#setUsername-java.lang.String-">setUsername</a></code> in interface <code><a href="../../../../org/apache/catalina/User.html" title="interface in org.apache.catalina">User</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/users/AbstractUser.html#setUsername-java.lang.String-">setUsername</a></code> in class <code><a href="../../../../org/apache/catalina/users/AbstractUser.html" title="class in org.apache.catalina.users">AbstractUser</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>username</code> - The new logon username</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.security">equals</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true"; title="class or interface in java.security">Principal</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true#hashCode--"; title="class or interface in java.security">hashCode</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true"; title="class or interface in java.security">Principal</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="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.53</b></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/catalina/users/GenericRole.html" title="class in org.apache.catalina.users"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/catalina/users/MemoryGroup.html" title="class in org.apache.catalina.users"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/catalina/users/GenericUser.html" target="_top">Frames</a></li> +<li><a href="GenericUser.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.</small></p> +</body> +</html>
Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/SparseUserDatabase.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/SparseUserDatabase.html?rev=1893319&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/SparseUserDatabase.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/catalina/users/SparseUserDatabase.html Mon Sep 13 18:58:18 2021 @@ -0,0 +1,300 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SparseUserDatabase (Apache Tomcat 9.0.53 API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SparseUserDatabase (Apache Tomcat 9.0.53 API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="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.53</b></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/catalina/users/MemoryUserDatabaseFactory.html" title="class in org.apache.catalina.users"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/catalina/users/SparseUserDatabase.html" target="_top">Frames</a></li> +<li><a href="SparseUserDatabase.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </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 name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.catalina.users</div> +<h2 title="Class SparseUserDatabase" class="title">Class SparseUserDatabase</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.catalina.users.SparseUserDatabase</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/catalina/users/DataSourceUserDatabase.html" title="class in org.apache.catalina.users">DataSourceUserDatabase</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">SparseUserDatabase</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/SparseUserDatabase.html#SparseUserDatabase--">SparseUserDatabase</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<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="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/catalina/users/SparseUserDatabase.html#isSparse--">isSparse</a></span>()</code> +<div class="block">Is the database data loaded on demand.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.catalina.UserDatabase"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.catalina.<a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a></h3> +<code><a href="../../../../org/apache/catalina/UserDatabase.html#backgroundProcess--">backgroundProcess</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#close--">close</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#createGroup-java.lang.String-java.lang.String-">createGroup</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#createRole-java.lang.String-java.lang.String-">createRole</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#createUser-java.lang.String-java.lang.String-java.lang.String-">createUser</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#findGroup-java.lang.String-">findGroup</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#findRole-java.lang.String-">findRole</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#findUser-java.lang.String-">findUser</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#getGroups--">getGroups</a>, <a href="../../../../org/apache/ catalina/UserDatabase.html#getId--">getId</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#getRoles--">getRoles</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#getUsers--">getUsers</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#isAvailable--">isAvailable</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#modifiedGroup-org.apache.catalina.Group-">modifiedGroup</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#modifiedRole-org.apache.catalina.Role-">modifiedRole</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#modifiedUser-org.apache.catalina.User-">modifiedUser</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#open--">open</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#removeGroup-org.apache.catalina.Group-">removeGroup</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#removeRole-org.apache.catalina.Role-">removeRole</a>, <a href="../../../../org/apac he/catalina/UserDatabase.html#removeUser-org.apache.catalina.User-">removeUser</a>, <a href="../../../../org/apache/catalina/UserDatabase.html#save--">save</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SparseUserDatabase--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SparseUserDatabase</h4> +<pre>public SparseUserDatabase()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isSparse--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isSparse</h4> +<pre>public boolean isSparse()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/catalina/UserDatabase.html#isSparse--">UserDatabase</a></code></span></div> +<div class="block">Is the database data loaded on demand. This is used to avoid eager + loading of the full database data, for example for JMX registration of + all objects.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/catalina/UserDatabase.html#isSparse--">isSparse</a></code> in interface <code><a href="../../../../org/apache/catalina/UserDatabase.html" title="interface in org.apache.catalina">UserDatabase</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>false</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="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.53</b></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/catalina/users/MemoryUserDatabaseFactory.html" title="class in org.apache.catalina.users"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/catalina/users/SparseUserDatabase.html" target="_top">Frames</a></li> +<li><a href="SparseUserDatabase.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </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 name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.</small></p> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
