Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / users / UserManager.html
blob: 66762e34c6ecdcd7f7221579369659ce7a1fcb5d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>UserManager (Apache Archiva Redback 3.0.0-SNAPSHOT API)</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.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UserManager (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/UserManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.archiva.redback.users</a></div>
<h2 title="Interface UserManager" class="title">Interface UserManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractUserManager.html" title="class in org.apache.archiva.redback.users">AbstractUserManager</a></code>, <code><a href="cached/CachedUserManager.html" title="class in org.apache.archiva.redback.users.cached">CachedUserManager</a></code>, <code><a href="configurable/ConfigurableUserManager.html" title="class in org.apache.archiva.redback.users.configurable">ConfigurableUserManager</a></code>, <code><a href="jpa/JpaUserManager.html" title="class in org.apache.archiva.redback.users.jpa">JpaUserManager</a></code>, <code><a href="ldap/LdapUserManager.html" title="class in org.apache.archiva.redback.users.ldap">LdapUserManager</a></code>, <code><a href="memory/MemoryUserManager.html" title="class in org.apache.archiva.redback.users.memory">MemoryUserManager</a></code></dd>
</dl>
<hr>
<pre>public interface <a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.36">UserManager</a></pre>
<div class="block">User Manager Interface</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Jason van Zyl, <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#GUEST_USERNAME">GUEST_USERNAME</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addUser(org.apache.archiva.redback.users.User)">addUser</a></span>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">Add a User.</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="#addUserManagerListener(org.apache.archiva.redback.users.UserManagerListener)">addUserManagerListener</a></span>&#8203;(<a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users">UserManagerListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Add a <a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users"><code>UserManagerListener</code></a> to track major events in the
UserManager.</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="#addUserUnchecked(org.apache.archiva.redback.users.User)">addUserUnchecked</a></span>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">Add a user to the database without checking for consistency or adjusting the password.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createGuestUser()">createGuestUser</a></span>()</code></th>
<td class="colLast">
<div class="block">Factory method to create the guest user.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createUser(java.lang.String,java.lang.String,java.lang.String)">createUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fullName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;emailAddress)</code></th>
<td class="colLast">
<div class="block">Factory method to create new User Objects based on provider specific
implementation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createUserQuery()">createUserQuery</a></span>()</code></th>
<td class="colLast">
<div class="block">Factory method to create <a href="UserQuery.html" title="interface in org.apache.archiva.redback.users"><code>UserQuery</code></a>s based on provider specific
implementations.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteUser(java.lang.String)">deleteUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)</code></th>
<td class="colLast">
<div class="block">Delete a user using the username.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#eraseDatabase()">eraseDatabase</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findUser(java.lang.String)">findUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)</code></th>
<td class="colLast">
<div class="block">Find a User using a User name.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findUser(java.lang.String,boolean)">findUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
boolean&nbsp;useCache)</code></th>
<td class="colLast">
<div class="block">Find a User using a User name.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findUsersByEmailKey(java.lang.String,boolean)">findUsersByEmailKey</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;emailKey,
boolean&nbsp;orderAscending)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findUsersByFullNameKey(java.lang.String,boolean)">findUsersByFullNameKey</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fullNameKey,
boolean&nbsp;orderAscending)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findUsersByQuery(org.apache.archiva.redback.users.UserQuery)">findUsersByQuery</a></span>&#8203;(<a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a>&nbsp;query)</code></th>
<td class="colLast">
<div class="block">Find users matching properties, ordering and range as specified by the
<a href="UserQuery.html" title="interface in org.apache.archiva.redback.users"><code>UserQuery</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findUsersByUsernameKey(java.lang.String,boolean)">findUsersByUsernameKey</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;usernameKey,
boolean&nbsp;orderAscending)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptionKey()">getDescriptionKey</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGuestUser()">getGuestUser</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the guest user.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th>
<td class="colLast">
<div class="block">An Identifier for the UserManager.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsers()">getUsers</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the List of <a href="User.html" title="interface in org.apache.archiva.redback.users"><code>User</code></a> objects.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsers(boolean)">getUsers</a></span>&#8203;(boolean&nbsp;orderAscending)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize()">initialize</a></span>()</code></th>
<td class="colLast">
<div class="block">consumer of user manager can use it to reload various configuration
with the configurable implementation is possible to change dynamically the real implementation used.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFinalImplementation()">isFinalImplementation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadOnly()">isReadOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Is the UserManager read only? if so then create and modify actions are to be disabled</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeUserManagerListener(org.apache.archiva.redback.users.UserManagerListener)">removeUserManagerListener</a></span>&#8203;(<a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users">UserManagerListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Remove a <a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users"><code>UserManagerListener</code></a> from the collection of listeners.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateUser(org.apache.archiva.redback.users.User)">updateUser</a></span>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">Update a User.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateUser(org.apache.archiva.redback.users.User,boolean)">updateUser</a></span>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
boolean&nbsp;passwordChangeRequired)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#userExists(java.lang.String)">userExists</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;principal)</code></th>
<td class="colLast">
<div class="block">true if the user exists, false if it doesn't</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="GUEST_USERNAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GUEST_USERNAME</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.39">GUEST_USERNAME</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.archiva.redback.users.UserManager.GUEST_USERNAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isReadOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadOnly</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.46">isReadOnly</a>()</pre>
<div class="block">Is the UserManager read only? if so then create and modify actions are to be disabled</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean true if user manager is disabled</dd>
</dl>
</li>
</ul>
<a id="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.53">getId</a>()</pre>
<div class="block">An Identifier for the UserManager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user manager identifier.</dd>
</dl>
</li>
</ul>
<a id="addUserManagerListener(org.apache.archiva.redback.users.UserManagerListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addUserManagerListener</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.61">addUserManagerListener</a>&#8203;(<a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users">UserManagerListener</a>&nbsp;listener)</pre>
<div class="block">Add a <a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users"><code>UserManagerListener</code></a> to track major events in the
UserManager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener to add.</dd>
</dl>
</li>
</ul>
<a id="removeUserManagerListener(org.apache.archiva.redback.users.UserManagerListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeUserManagerListener</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.68">removeUserManagerListener</a>&#8203;(<a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users">UserManagerListener</a>&nbsp;listener)</pre>
<div class="block">Remove a <a href="UserManagerListener.html" title="interface in org.apache.archiva.redback.users"><code>UserManagerListener</code></a> from the collection of listeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener to remove.</dd>
</dl>
</li>
</ul>
<a id="createUser(java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.83">createUser</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fullName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;emailAddress)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Factory method to create new User Objects based on provider specific
implementation.
User objects created this way do not exist in the provider's underlying
data store until a call to <a href="#addUser(org.apache.archiva.redback.users.User)"><code>addUser(User)</code></a> is made.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the username for this user.</dd>
<dd><code>fullName</code> - the full name for this user.</dd>
<dd><code>emailAddress</code> - the email address for this user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new user object ready to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="createGuestUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGuestUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.92">createGuestUser</a>()
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Factory method to create the guest user.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The guest user</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="createUserQuery()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createUserQuery</h4>
<pre class="methodSignature"><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.101">createUserQuery</a>()</pre>
<div class="block">Factory method to create <a href="UserQuery.html" title="interface in org.apache.archiva.redback.users"><code>UserQuery</code></a>s based on provider specific
implementations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the provider implementation of UserQuery</dd>
</dl>
</li>
</ul>
<a id="getUsers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.109">getUsers</a>()
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Get the List of <a href="User.html" title="interface in org.apache.archiva.redback.users"><code>User</code></a> objects.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the List of <a href="User.html" title="interface in org.apache.archiva.redback.users"><code>User</code></a> Objects.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="getUsers(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.112">getUsers</a>&#8203;(boolean&nbsp;orderAscending)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="addUser(org.apache.archiva.redback.users.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.122">addUser</a>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Add a User.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to add.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user that was just added.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="updateUser(org.apache.archiva.redback.users.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.132">updateUser</a>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a>,
<a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Update a User.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to update.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user that was just updated.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a></code> - if the user was not found to update.</dd>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="findUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.142">findUser</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)
throws <a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a>,
<a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Find a User using a User name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the username to find.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a></code> - if the user was not found.</dd>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="findUser(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.154">findUser</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
boolean&nbsp;useCache)
throws <a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a>,
<a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Find a User using a User name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the username to find.</dd>
<dd><code>useCache</code> - to use or not caching</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a></code> - if the user was not found.</dd>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a id="getGuestUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGuestUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.162">getGuestUser</a>()
throws <a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a>,
<a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Get the guest user.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the guest user.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a></code></dd>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="findUsersByUsernameKey(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findUsersByUsernameKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.165">findUsersByUsernameKey</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;usernameKey,
boolean&nbsp;orderAscending)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="findUsersByFullNameKey(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findUsersByFullNameKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.168">findUsersByFullNameKey</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fullNameKey,
boolean&nbsp;orderAscending)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="findUsersByEmailKey(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findUsersByEmailKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.171">findUsersByEmailKey</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;emailKey,
boolean&nbsp;orderAscending)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="findUsersByQuery(org.apache.archiva.redback.users.UserQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findUsersByQuery</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.181">findUsersByQuery</a>&#8203;(<a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a>&nbsp;query)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Find users matching properties, ordering and range as specified by the
<a href="UserQuery.html" title="interface in org.apache.archiva.redback.users"><code>UserQuery</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - the query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a List of <a href="User.html" title="interface in org.apache.archiva.redback.users"><code>User</code></a> objects.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="userExists(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userExists</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.190">userExists</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;principal)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">true if the user exists, false if it doesn't</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>principal</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if user exists</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="deleteUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteUser</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.199">deleteUser</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)
throws <a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a>,
<a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Delete a user using the username.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the username to look for.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a></code> - the user was not found.</dd>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="addUserUnchecked(org.apache.archiva.redback.users.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addUserUnchecked</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.208">addUserUnchecked</a>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<div class="block">Add a user to the database without checking for consistency or adjusting the password. Should only be used for
re-importing known-good data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to add</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="eraseDatabase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eraseDatabase</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.211">eraseDatabase</a>()</pre>
</li>
</ul>
<a id="updateUser(org.apache.archiva.redback.users.User,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateUser</h4>
<pre class="methodSignature"><a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.213">updateUser</a>&#8203;(<a href="User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
boolean&nbsp;passwordChangeRequired)
throws <a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a>,
<a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UserNotFoundException.html" title="class in org.apache.archiva.redback.users">UserNotFoundException</a></code></dd>
<dd><code><a href="UserManagerException.html" title="class in org.apache.archiva.redback.users">UserManagerException</a></code></dd>
</dl>
</li>
</ul>
<a id="initialize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.223">initialize</a>()</pre>
<div class="block">consumer of user manager can use it to reload various configuration
with the configurable implementation is possible to change dynamically the real implementation used.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a id="isFinalImplementation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFinalImplementation</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.229">isFinalImplementation</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this implementation is a final one and not a wrapper (configurable, cached)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a id="getDescriptionKey()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDescriptionKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/UserManager.html#line.235">getDescriptionKey</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a key to be able to customize label in UI</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>