Google Git
Sign in
apache / archiva-web-content / 93f0714e1ce373f15c1c887c5b960ff2c62a38e4 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / policy / UserSecurityPolicy.html
blob: cfa42a2f237bb49015999dd0835b7cf30965e598 [file] [log] [blame]
<!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>UserSecurityPolicy (Apache Archiva Redback 3.0.0-SNAPSHOT API)</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="UserSecurityPolicy (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"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};
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";
</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="class-use/UserSecurityPolicy.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">
<li><a href="../../../../../org/apache/archiva/redback/policy/SignonCookieSettings.html" title="class in org.apache.archiva.redback.policy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/archiva/redback/policy/UserValidationSettings.html" title="interface in org.apache.archiva.redback.policy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/archiva/redback/policy/UserSecurityPolicy.html" target="_top">Frames</a></li>
<li><a href="UserSecurityPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.archiva.redback.policy</div>
<h2 title="Interface UserSecurityPolicy" class="title">Interface UserSecurityPolicy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/archiva/redback/policy/DefaultUserSecurityPolicy.html" title="class in org.apache.archiva.redback.policy">DefaultUserSecurityPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.29">UserSecurityPolicy</a></pre>
<div class="block">User Security Policy Settings.
TODO roll password management into it's own object.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&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="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/archiva/redback/policy/UserSecurityPolicy.html#addPasswordRule-org.apache.archiva.redback.policy.PasswordRule-">addPasswordRule</a></span>(<a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy">PasswordRule</a>&nbsp;rule)</code>
<div class="block">Add a Specific Rule to the Password Rules List.</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/archiva/redback/policy/UserSecurityPolicy.html#extensionChangePassword-org.apache.archiva.redback.users.User-">extensionChangePassword</a></span>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code>
<div class="block">Extension Point - Change the password of a user.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#extensionChangePassword-org.apache.archiva.redback.users.User-boolean-">extensionChangePassword</a></span>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
boolean&nbsp;passwordChangeRequired)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#extensionExcessiveLoginAttempts-org.apache.archiva.redback.users.User-">extensionExcessiveLoginAttempts</a></span>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code>
<div class="block">Extension Point - Test if user has excessive logins</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#extensionPasswordExpiration-org.apache.archiva.redback.users.User-">extensionPasswordExpiration</a></span>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code>
<div class="block">Extension Point - Test User for Password Expiration.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getId--">getId</a></span>()</code>
<div class="block">Get identifying string for the User Security Policy implementation.</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/archiva/redback/policy/UserSecurityPolicy.html#getLoginAttemptCount--">getLoginAttemptCount</a></span>()</code>
<div class="block">Gets the count of login attempts to allow.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/archiva/redback/policy/PasswordEncoder.html" title="interface in org.apache.archiva.redback.policy">PasswordEncoder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getPasswordEncoder--">getPasswordEncoder</a></span>()</code>
<div class="block">Gets the password encoder to use.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getPasswordExpirationDays--">getPasswordExpirationDays</a></span>()</code>
<div class="block">Gets the policy of how long a password will be valid until it expires.</div>
</td>
</tr>
<tr id="i9" 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">List</a>&lt;<a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy">PasswordRule</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getPasswordRules--">getPasswordRules</a></span>()</code>
<div class="block">Get the Password Rules List.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getPreviousPasswordsCount--">getPreviousPasswordsCount</a></span>()</code>
<div class="block">Gets the count of Previous Passwords that should be tracked.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/archiva/redback/policy/CookieSettings.html" title="interface in org.apache.archiva.redback.policy">CookieSettings</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getRememberMeCookieSettings--">getRememberMeCookieSettings</a></span>()</code>
<div class="block">Get the Remember Me Settings.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/archiva/redback/policy/CookieSettings.html" title="interface in org.apache.archiva.redback.policy">CookieSettings</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getSignonCookieSettings--">getSignonCookieSettings</a></span>()</code>
<div class="block">Get the Single Sign On Settings.</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">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getUnlockableAccounts--">getUnlockableAccounts</a></span>()</code>
<div class="block">Gets a list of accounts which should never be locked by security policy</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/archiva/redback/policy/UserValidationSettings.html" title="interface in org.apache.archiva.redback.policy">UserValidationSettings</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#getUserValidationSettings--">getUserValidationSettings</a></span>()</code>
<div class="block">Get the Validation Settings.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#isEnabled--">isEnabled</a></span>()</code>
<div class="block">Determines if the policies are enabled or not.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setEnabled-boolean-">setEnabled</a></span>(boolean&nbsp;enabled)</code>
<div class="block">Enable the policies or not.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setLoginAttemptCount-int-">setLoginAttemptCount</a></span>(int&nbsp;count)</code>
<div class="block">Sets the count of login attempts to allow.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setPasswordExpirationDays-int-">setPasswordExpirationDays</a></span>(int&nbsp;passwordExpiry)</code>
<div class="block">Sets the policy of how long a password will be valid until it expires.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setPasswordRules-java.util.List-">setPasswordRules</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy">PasswordRule</a>&gt;&nbsp;rules)</code>
<div class="block">Set the Password Rules List.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setPreviousPasswordsCount-int-">setPreviousPasswordsCount</a></span>(int&nbsp;count)</code>
<div class="block">Sets the count of previous passwords that should be tracked.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setUnlockableAccounts-java.util.List-">setUnlockableAccounts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;unlockableAccounts)</code>
<div class="block">Sets a list of accounts which should never be locked by security policy</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#setUserValidationSettings-org.apache.archiva.redback.policy.UserValidationSettings-">setUserValidationSettings</a></span>(<a href="../../../../../org/apache/archiva/redback/policy/UserValidationSettings.html" title="interface in org.apache.archiva.redback.policy">UserValidationSettings</a>&nbsp;settings)</code>
<div class="block">Set the Validation Settings.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/policy/UserSecurityPolicy.html#validatePassword-org.apache.archiva.redback.users.User-">validatePassword</a></span>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)</code>
<div class="block">Validate the incoming <a href="../../../../../org/apache/archiva/redback/users/User.html#getPassword--"><code>User.getPassword()</code></a> against the specified
PasswordRules.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre><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>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.36">getId</a>()</pre>
<div class="block">Get identifying string for the User Security Policy implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id for the security policy implementation.</dd>
</dl>
</li>
</ul>
<a name="getPasswordEncoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPasswordEncoder</h4>
<pre><a href="../../../../../org/apache/archiva/redback/policy/PasswordEncoder.html" title="interface in org.apache.archiva.redback.policy">PasswordEncoder</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.47">getPasswordEncoder</a>()</pre>
<div class="block">Gets the password encoder to use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the PasswordEncoder implementation to use.</dd>
</dl>
</li>
</ul>
<a name="addPasswordRule-org.apache.archiva.redback.policy.PasswordRule-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPasswordRule</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.54">addPasswordRule</a>(<a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy">PasswordRule</a>&nbsp;rule)</pre>
<div class="block">Add a Specific Rule to the Password Rules List.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rule</code> - the rule to add.</dd>
</dl>
</li>
</ul>
<a name="getPasswordRules--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPasswordRules</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy">PasswordRule</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.61">getPasswordRules</a>()</pre>
<div class="block">Get the Password Rules List.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of <a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy"><code>PasswordRule</code></a> objects.</dd>
</dl>
</li>
</ul>
<a name="setPasswordRules-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPasswordRules</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.68">setPasswordRules</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy">PasswordRule</a>&gt;&nbsp;rules)</pre>
<div class="block">Set the Password Rules List.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rules</code> - the list of <a href="../../../../../org/apache/archiva/redback/policy/PasswordRule.html" title="interface in org.apache.archiva.redback.policy"><code>PasswordRule</code></a> objects.</dd>
</dl>
</li>
</ul>
<a name="getPreviousPasswordsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreviousPasswordsCount</h4>
<pre>int&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.75">getPreviousPasswordsCount</a>()</pre>
<div class="block">Gets the count of Previous Passwords that should be tracked.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the count of previous passwords to track.</dd>
</dl>
</li>
</ul>
<a name="setPreviousPasswordsCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreviousPasswordsCount</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.82">setPreviousPasswordsCount</a>(int&nbsp;count)</pre>
<div class="block">Sets the count of previous passwords that should be tracked.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>count</code> - the count of previous passwords to track.</dd>
</dl>
</li>
</ul>
<a name="getLoginAttemptCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoginAttemptCount</h4>
<pre>int&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.89">getLoginAttemptCount</a>()</pre>
<div class="block">Gets the count of login attempts to allow.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the count of login attempts to allow.</dd>
</dl>
</li>
</ul>
<a name="setLoginAttemptCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoginAttemptCount</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.96">setLoginAttemptCount</a>(int&nbsp;count)</pre>
<div class="block">Sets the count of login attempts to allow.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>count</code> - the count of login attempts to allow.</dd>
</dl>
</li>
</ul>
<a name="getUserValidationSettings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserValidationSettings</h4>
<pre><a href="../../../../../org/apache/archiva/redback/policy/UserValidationSettings.html" title="interface in org.apache.archiva.redback.policy">UserValidationSettings</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.103">getUserValidationSettings</a>()</pre>
<div class="block">Get the Validation Settings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the validation settings.</dd>
</dl>
</li>
</ul>
<a name="setUserValidationSettings-org.apache.archiva.redback.policy.UserValidationSettings-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserValidationSettings</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.110">setUserValidationSettings</a>(<a href="../../../../../org/apache/archiva/redback/policy/UserValidationSettings.html" title="interface in org.apache.archiva.redback.policy">UserValidationSettings</a>&nbsp;settings)</pre>
<div class="block">Set the Validation Settings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>settings</code> - the settings.</dd>
</dl>
</li>
</ul>
<a name="getSignonCookieSettings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSignonCookieSettings</h4>
<pre><a href="../../../../../org/apache/archiva/redback/policy/CookieSettings.html" title="interface in org.apache.archiva.redback.policy">CookieSettings</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.117">getSignonCookieSettings</a>()</pre>
<div class="block">Get the Single Sign On Settings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the single sign on settings.</dd>
</dl>
</li>
</ul>
<a name="getRememberMeCookieSettings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRememberMeCookieSettings</h4>
<pre><a href="../../../../../org/apache/archiva/redback/policy/CookieSettings.html" title="interface in org.apache.archiva.redback.policy">CookieSettings</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.124">getRememberMeCookieSettings</a>()</pre>
<div class="block">Get the Remember Me Settings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remember me settings.</dd>
</dl>
</li>
</ul>
<a name="setEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnabled</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.133">setEnabled</a>(boolean&nbsp;enabled)</pre>
<div class="block">Enable the policies or not.
Useful in code when application startup or application init is being performed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabled</code> - true if enabled.</dd>
</dl>
</li>
</ul>
<a name="isEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.140">isEnabled</a>()</pre>
<div class="block">Determines if the policies are enabled or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if enabled.</dd>
</dl>
</li>
</ul>
<a name="setPasswordExpirationDays-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPasswordExpirationDays</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.147">setPasswordExpirationDays</a>(int&nbsp;passwordExpiry)</pre>
<div class="block">Sets the policy of how long a password will be valid until it expires.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>passwordExpiry</code> - the number of days until a password expires. (or -1 to disable)</dd>
</dl>
</li>
</ul>
<a name="getPasswordExpirationDays--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPasswordExpirationDays</h4>
<pre>int&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.154">getPasswordExpirationDays</a>()</pre>
<div class="block">Gets the policy of how long a password will be valid until it expires.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of days until a password expires. (or -1 for disabled)</dd>
</dl>
</li>
</ul>
<a name="getUnlockableAccounts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnlockableAccounts</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.160">getUnlockableAccounts</a>()</pre>
<div class="block">Gets a list of accounts which should never be locked by security policy</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>accounts that should never be locked</dd>
</dl>
</li>
</ul>
<a name="setUnlockableAccounts-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnlockableAccounts</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.166">setUnlockableAccounts</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;unlockableAccounts)</pre>
<div class="block">Sets a list of accounts which should never be locked by security policy</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unlockableAccounts</code> - </dd>
</dl>
</li>
</ul>
<a name="extensionChangePassword-org.apache.archiva.redback.users.User-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensionChangePassword</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.181">extensionChangePassword</a>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="../../../../../org/apache/archiva/redback/policy/PasswordRuleViolationException.html" title="class in org.apache.archiva.redback.policy">PasswordRuleViolationException</a></pre>
<div class="block">Extension Point - Change the password of a user.
This method does not check if a user is allowed to change his/her password.
Any kind of authorization checks for password change allowed on guest or
anonymous users needs to occur before calling this method.
This method does not persist the newly changed user password.
That will require a call to <a href="../../../../../org/apache/archiva/redback/users/UserManager.html#updateUser-org.apache.archiva.redback.users.User-"><code>UserManager.updateUser(User)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user password to validate, remember, and encode.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/policy/PasswordRuleViolationException.html" title="class in org.apache.archiva.redback.policy">PasswordRuleViolationException</a></code> - if the new password violates the password rules</dd>
</dl>
</li>
</ul>
<a name="extensionChangePassword-org.apache.archiva.redback.users.User-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensionChangePassword</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.184">extensionChangePassword</a>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
boolean&nbsp;passwordChangeRequired)
throws <a href="../../../../../org/apache/archiva/redback/policy/PasswordRuleViolationException.html" title="class in org.apache.archiva.redback.policy">PasswordRuleViolationException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/policy/PasswordRuleViolationException.html" title="class in org.apache.archiva.redback.policy">PasswordRuleViolationException</a></code></dd>
</dl>
</li>
</ul>
<a name="extensionPasswordExpiration-org.apache.archiva.redback.users.User-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensionPasswordExpiration</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.193">extensionPasswordExpiration</a>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="../../../../../org/apache/archiva/redback/policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></pre>
<div class="block">Extension Point - Test User for Password Expiration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to test password expiration against.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></code> - if the password has expired</dd>
</dl>
</li>
</ul>
<a name="extensionExcessiveLoginAttempts-org.apache.archiva.redback.users.User-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensionExcessiveLoginAttempts</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.202">extensionExcessiveLoginAttempts</a>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="../../../../../org/apache/archiva/redback/policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a></pre>
<div class="block">Extension Point - Test if user has excessive logins</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to test excessive logins against.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a></code> - if the number of logins was exceeded</dd>
</dl>
</li>
</ul>
<a name="validatePassword-org.apache.archiva.redback.users.User-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validatePassword</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/policy/UserSecurityPolicy.html#line.212">validatePassword</a>(<a href="../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user)
throws <a href="../../../../../org/apache/archiva/redback/policy/PasswordRuleViolationException.html" title="class in org.apache.archiva.redback.policy">PasswordRuleViolationException</a></pre>
<div class="block">Validate the incoming <a href="../../../../../org/apache/archiva/redback/users/User.html#getPassword--"><code>User.getPassword()</code></a> against the specified
PasswordRules.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to validate.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/policy/PasswordRuleViolationException.html" title="class in org.apache.archiva.redback.policy">PasswordRuleViolationException</a></code> - if the password is not valid</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="class-use/UserSecurityPolicy.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">
<li><a href="../../../../../org/apache/archiva/redback/policy/SignonCookieSettings.html" title="class in org.apache.archiva.redback.policy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/archiva/redback/policy/UserValidationSettings.html" title="interface in org.apache.archiva.redback.policy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/archiva/redback/policy/UserSecurityPolicy.html" target="_top">Frames</a></li>
<li><a href="UserSecurityPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>