| <!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>User (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="User (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,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":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/User.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/users/PermanentUserException.html" title="class in org.apache.archiva.redback.users"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/archiva/redback/users/UserManager.html" title="interface in org.apache.archiva.redback.users"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/archiva/redback/users/User.html" target="_top">Frames</a></li> |
| <li><a href="User.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.archiva.redback.users</div> |
| <h2 title="Interface User" class="title">Interface User</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/archiva/redback/users/jpa/model/JpaUser.html" title="class in org.apache.archiva.redback.users.jpa.model">JpaUser</a>, <a href="../../../../../org/apache/archiva/redback/common/ldap/user/LdapUser.html" title="class in org.apache.archiva.redback.common.ldap.user">LdapUser</a>, <a href="../../../../../org/apache/archiva/redback/users/memory/SimpleUser.html" title="class in org.apache.archiva.redback.users.memory">SimpleUser</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.32">User</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">The User Object.</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"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/archiva/redback/users/User.html#addPreviousEncodedPassword-java.lang.String-">addPreviousEncodedPassword</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> encodedPassword)</code> |
| <div class="block">Add encoded password to previously passwords in encoded format.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getAccountCreationDate--">getAccountCreationDate</a></span>()</code> |
| <div class="block">Get the Creation Date for this account.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getCountFailedLoginAttempts--">getCountFailedLoginAttempts</a></span>()</code> |
| <div class="block">Get Count of Failed Login Attempts.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/users/User.html#getEmail--">getEmail</a></span>()</code> |
| <div class="block">Gets the email address for this user.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getEncodedPassword--">getEncodedPassword</a></span>()</code> |
| <div class="block">Gets the Encoded Password.</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/users/User.html#getFullName--">getFullName</a></span>()</code> |
| <div class="block">Gets the Full Name for this user.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getLastLoginDate--">getLastLoginDate</a></span>()</code> |
| <div class="block">Get the Last Successful Login Date for this account.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getLastPasswordChange--">getLastPasswordChange</a></span>()</code> |
| <div class="block">Gets the Date of the Last Password Change.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getPassword--">getPassword</a></span>()</code> |
| <div class="block">Gets the Raw (unencoded) Password.</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><<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/users/User.html#getPreviousEncodedPasswords--">getPreviousEncodedPasswords</a></span>()</code> |
| <div class="block">Gets the list of previous password (in encoded format).</div> |
| </td> |
| </tr> |
| <tr id="i10" 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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#getUserManagerId--">getUserManagerId</a></span>()</code> |
| <div class="block">as we can user multiple userManagers implementation we must track from which one this one comes.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/users/User.html#getUsername--">getUsername</a></span>()</code> |
| <div class="block">Gets the User Name for this user.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#isLocked--">isLocked</a></span>()</code> |
| <div class="block">Determines if this user account is locked from use or not.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#isPasswordChangeRequired--">isPasswordChangeRequired</a></span>()</code> |
| <div class="block">Determines if this user account must change their password on next login.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#isPermanent--">isPermanent</a></span>()</code> |
| <div class="block">Gets the flag indicating if this user is a permanent user or not.</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/users/User.html#isValidated--">isValidated</a></span>()</code> |
| <div class="block">Gets the flag indicating if this user has been validated (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/users/User.html#setAccountCreationDate-java.util.Date-">setAccountCreationDate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date)</code> |
| <div class="block">Set the Creation Date for this account.</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/users/User.html#setCountFailedLoginAttempts-int-">setCountFailedLoginAttempts</a></span>(int count)</code> |
| <div class="block">Set the count of failed login attempts.</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/users/User.html#setEmail-java.lang.String-">setEmail</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> address)</code> |
| <div class="block">Sets the email address for this user.</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/users/User.html#setEncodedPassword-java.lang.String-">setEncodedPassword</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> encodedPassword)</code> |
| <div class="block">Sets the Encoded Password.</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/users/User.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> name)</code> |
| <div class="block">Sets the Full Name for this user.</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/users/User.html#setLastLoginDate-java.util.Date-">setLastLoginDate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date)</code> |
| <div class="block">Sets the Last Successful Login Date for this account.</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/users/User.html#setLastPasswordChange-java.util.Date-">setLastPasswordChange</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> passwordChangeDate)</code> |
| <div class="block">Sets the Last Password Change Date.</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/users/User.html#setLocked-boolean-">setLocked</a></span>(boolean locked)</code> |
| <div class="block">Sets the locked state of this account.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.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> rawPassword)</code> |
| <div class="block">Sets the raw (unencoded) password for this user.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#setPasswordChangeRequired-boolean-">setPasswordChangeRequired</a></span>(boolean changeRequired)</code> |
| <div class="block">Sets the flag to indicate if this user must change their password on next login.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#setPermanent-boolean-">setPermanent</a></span>(boolean permanent)</code> |
| <div class="block">Sets the permanent flag for this user.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#setPreviousEncodedPasswords-java.util.List-">setPreviousEncodedPasswords</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><<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>> encodedPasswordList)</code> |
| <div class="block">Sets the list of previous passwords (in encoded format)</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.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> name)</code> |
| <div class="block">Sets the User Name for this user.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/User.html#setValidated-boolean-">setValidated</a></span>(boolean valid)</code> |
| <div class="block">Sets the flag indicating if this user has been validated (or not)</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="getUsername--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsername</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> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.47">getUsername</a>()</pre> |
| <div class="block">Gets the User Name for this user. |
| |
| This field is required, and should never be empty.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUsername-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsername</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.56">setUsername</a>(<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> name)</pre> |
| <div class="block">Sets the User Name for this user. |
| |
| This field is required, and should never be empty.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the user name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFullName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullName</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> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.65">getFullName</a>()</pre> |
| <div class="block">Gets the Full Name for this user. |
| |
| This field is required, and should never be empty.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFullName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFullName</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.74">setFullName</a>(<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> name)</pre> |
| <div class="block">Sets the Full Name for this user. |
| |
| This field is required, and should never be empty.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the full name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEmail--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmail</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> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.83">getEmail</a>()</pre> |
| <div class="block">Gets the email address for this user. |
| |
| This field is required, and should never be empty.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the email address.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEmail-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmail</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.92">setEmail</a>(<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> address)</pre> |
| <div class="block">Sets the email address for this user. |
| |
| This field is required, and should never be empty.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - the email address.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPassword--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPassword</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> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.121">getPassword</a>()</pre> |
| <div class="block">Gets the Raw (unencoded) Password. |
| Used only on password change requests. |
| |
| <p> |
| <b>Notes for User Providers</b> |
| </p> |
| <ol> |
| <li> |
| Providers need to look for a value in here to indicate if the user is |
| intending to change their password. |
| </li> |
| <li> |
| The providers of this interface need to use this field, encode the password, place it's value |
| into the encodedPassword field, and clear out the raw unencoded password field. |
| </li> |
| <li> |
| This field should never be stored on disk. |
| </li> |
| </ol></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the raw encoded password.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPassword-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPassword</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.129">setPassword</a>(<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> rawPassword)</pre> |
| <div class="block">Sets the raw (unencoded) password for this user.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawPassword</code> - the raw unencoded password for this user.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/archiva/redback/users/User.html#getPassword--"><code>getPassword()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncodedPassword--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncodedPassword</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> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.136">getEncodedPassword</a>()</pre> |
| <div class="block">Gets the Encoded Password.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the encoded password.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncodedPassword-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncodedPassword</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.145">setEncodedPassword</a>(<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> encodedPassword)</pre> |
| <div class="block">Sets the Encoded Password. |
| |
| This field is populated by the <a href="../../../../../org/apache/archiva/redback/users/UserManager.html" title="interface in org.apache.archiva.redback.users"><code>UserManager</code></a> process.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedPassword</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastPasswordChange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastPasswordChange</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.154">getLastPasswordChange</a>()</pre> |
| <div class="block">Gets the Date of the Last Password Change. |
| |
| Used by password management policies to enforce password expiration rules.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the date of the last password change.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLastPasswordChange-java.util.Date-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLastPasswordChange</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.163">setLastPasswordChange</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> passwordChangeDate)</pre> |
| <div class="block">Sets the Last Password Change Date. |
| |
| This field is populated by the <a href="../../../../../org/apache/archiva/redback/users/UserManager.html" title="interface in org.apache.archiva.redback.users"><code>UserManager</code></a> process.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>passwordChangeDate</code> - the date that the last password change occured.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPreviousEncodedPasswords--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPreviousEncodedPasswords</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><<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>> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.172">getPreviousEncodedPasswords</a>()</pre> |
| <div class="block">Gets the list of previous password (in encoded format). |
| |
| Used by password management policies to enforce password reuse rules.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> objects. Represents previous passwords (in encoded format).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPreviousEncodedPasswords-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPreviousEncodedPasswords</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.179">setPreviousEncodedPasswords</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><<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>> encodedPasswordList)</pre> |
| <div class="block">Sets the list of previous passwords (in encoded format)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedPasswordList</code> - (list of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> objects.) the previously passwords in encoded format.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPreviousEncodedPassword-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPreviousEncodedPassword</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.186">addPreviousEncodedPassword</a>(<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> encodedPassword)</pre> |
| <div class="block">Add encoded password to previously passwords in encoded format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedPassword</code> - the encoded password to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPermanent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermanent</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.197">isPermanent</a>()</pre> |
| <div class="block">Gets the flag indicating if this user is a permanent user or not. |
| |
| Usually Root / Admin / Guest users are flagged as such.</div> |
| </li> |
| </ul> |
| <a name="setPermanent-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermanent</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.206">setPermanent</a>(boolean permanent)</pre> |
| <div class="block">Sets the permanent flag for this user. |
| |
| Users such as Root / Admin / Guest are typically flagged as permanent.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permanent</code> - true if permanent.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLocked--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocked</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.216">isLocked</a>()</pre> |
| <div class="block">Determines if this user account is locked from use or not. |
| |
| This state is set from an administrative point of view, or due to |
| excessive failed login attempts.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if account is locked.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocked-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocked</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.223">setLocked</a>(boolean locked)</pre> |
| <div class="block">Sets the locked state of this account.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locked</code> - true if account is to be locked.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPasswordChangeRequired--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPasswordChangeRequired</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.230">isPasswordChangeRequired</a>()</pre> |
| <div class="block">Determines if this user account must change their password on next login.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if user must change password on next login.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPasswordChangeRequired-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPasswordChangeRequired</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.237">setPasswordChangeRequired</a>(boolean changeRequired)</pre> |
| <div class="block">Sets the flag to indicate if this user must change their password on next login.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>changeRequired</code> - true if user must change password on next login.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValidated--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidated</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.244">isValidated</a>()</pre> |
| <div class="block">Gets the flag indicating if this user has been validated (or not)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if validated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValidated-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidated</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.251">setValidated</a>(boolean valid)</pre> |
| <div class="block">Sets the flag indicating if this user has been validated (or not)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valid</code> - true if validated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCountFailedLoginAttempts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountFailedLoginAttempts</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.262">getCountFailedLoginAttempts</a>()</pre> |
| <div class="block">Get Count of Failed Login Attempts.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the count of failed login attempts.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCountFailedLoginAttempts-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCountFailedLoginAttempts</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.269">setCountFailedLoginAttempts</a>(int count)</pre> |
| <div class="block">Set the count of failed login attempts.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>count</code> - the count of failed login attempts.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAccountCreationDate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccountCreationDate</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.276">getAccountCreationDate</a>()</pre> |
| <div class="block">Get the Creation Date for this account.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the date of creation for this account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAccountCreationDate-java.util.Date-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccountCreationDate</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.281">setAccountCreationDate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date)</pre> |
| <div class="block">Set the Creation Date for this account.</div> |
| </li> |
| </ul> |
| <a name="getLastLoginDate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastLoginDate</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.288">getLastLoginDate</a>()</pre> |
| <div class="block">Get the Last Successful Login Date for this account.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the date of the last successful login</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLastLoginDate-java.util.Date-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLastLoginDate</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.293">setLastLoginDate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date)</pre> |
| <div class="block">Sets the Last Successful Login Date for this account.</div> |
| </li> |
| </ul> |
| <a name="getUserManagerId--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUserManagerId</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> <a href="../../../../../src-html/org/apache/archiva/redback/users/User.html#line.300">getUserManagerId</a>()</pre> |
| <div class="block">as we can user multiple userManagers implementation we must track from which one this one comes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>userManager id</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</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/User.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/users/PermanentUserException.html" title="class in org.apache.archiva.redback.users"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/archiva/redback/users/UserManager.html" title="interface in org.apache.archiva.redback.users"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/archiva/redback/users/User.html" target="_top">Frames</a></li> |
| <li><a href="User.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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 © 2006–2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
