| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>UsernamePasswordToken (Apache Shiro :: Core 1.10.0 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="UsernamePasswordToken (Apache Shiro :: Core 1.10.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= 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/UsernamePasswordToken.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 Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.authc</a></div> |
| <h2 title="Class UsernamePasswordToken" class="title">Class UsernamePasswordToken</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.authc.UsernamePasswordToken</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code>, <code><a href="HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a></code>, <code><a href="RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.45">UsernamePasswordToken</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a>, <a href="RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></pre> |
| <div class="block"><p>A simple username/password authentication token to support the most widely-used authentication mechanism. This |
| class also implements the <a href="RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>RememberMeAuthenticationToken</code></a> interface to support |
| "Remember Me" services across user sessions as well as the |
| <a href="HostAuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>HostAuthenticationToken</code></a> interface to retain the host name |
| or IP address location from where the authentication attempt is occurring.</p> |
| <p/> |
| <p>"Remember Me" authentications are disabled by default, but if the application developer wishes to allow |
| it for a login attempt, all that is necessary is to call <a href="#setRememberMe(boolean)"><code>setRememberMe(true)</code></a>. If the underlying |
| <tt>SecurityManager</tt> implementation also supports <tt>RememberMe</tt> services, the user's identity will be |
| remembered across sessions. |
| <p/> |
| <p>Note that this class stores a password as a char[] instead of a String |
| (which may seem more logical). This is because Strings are immutable and their |
| internal value cannot be overwritten - meaning even a nulled String instance might be accessible in memory at a later |
| time (e.g. memory dump). This is not good for sensitive information such as passwords. For more information, see the |
| <a href="http://java.sun.com/j2se/1.5.0/docs/guide/security/jce/JCERefGuide.html#PBEEx"> |
| Java Cryptography Extension Reference Guide</a>.</p> |
| <p/> |
| <p>To avoid this possibility of later memory access, the application developer should always call |
| <a href="#clear()"><code>clear()</code></a> after using the token to perform a login attempt.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.shiro.authc.UsernamePasswordToken">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">UsernamePasswordToken</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">JavaBeans compatible no-arg constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,char%5B%5D)">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <a href="#getHost()"><code>host</code></a> and a |
| <tt>rememberMe</tt> default of <tt>false</tt>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,char%5B%5D,boolean)">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password, |
| boolean rememberMe)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,char%5B%5D,boolean,java.lang.String)">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password, |
| boolean rememberMe, |
| <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> host)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is occurring.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,char%5B%5D,java.lang.String)">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password, |
| <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> host)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String)">UsernamePasswordToken</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" class="externalLink">String</a> 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> password)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <a href="#getHost()"><code>host</code></a> and |
| a <tt>rememberMe</tt> default of <tt>false</tt></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,boolean)">UsernamePasswordToken</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" class="externalLink">String</a> 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> password, |
| boolean rememberMe)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,boolean,java.lang.String)">UsernamePasswordToken</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" class="externalLink">String</a> 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> password, |
| boolean rememberMe, |
| <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> host)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is occurring.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)">UsernamePasswordToken</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" class="externalLink">String</a> 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> password, |
| <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> host)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt></div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clears out (nulls) the username, password, rememberMe, and inetAddress.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCredentials()">getCredentials</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="#getPassword()"><code>password</code></a> char array.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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="#getHost()">getHost</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the host name or IP string from where the authentication attempt occurs.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>char[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPassword()">getPassword</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the password submitted during an authentication attempt as a character array.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrincipal()">getPrincipal</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Simply returns <a href="#getUsername()"><code>getUsername()</code></a>.</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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsername()">getUsername</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the username submitted during an authentication attempt.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRememberMe()">isRememberMe</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered |
| across sessions, <tt>false</tt> otherwise.</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="#setHost(java.lang.String)">setHost</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" class="externalLink">String</a> host)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the host name or IP string from where the authentication attempt occurs.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPassword(char%5B%5D)">setPassword</a></span>​(char[] password)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the password for submission during an authentication attempt.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRememberMe(boolean)">setRememberMe</a></span>​(boolean rememberMe)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets if the submitting user wishes their identity (principal(s)) to be remembered across sessions.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">String</a> username)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the username for submission during an authentication attempt.</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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the String representation.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.83">UsernamePasswordToken</a>()</pre> |
| <div class="block">JavaBeans compatible no-arg constructor.</div> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,char[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.94">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <a href="#getHost()"><code>host</code></a> and a |
| <tt>rememberMe</tt> default of <tt>false</tt>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password character array submitted for authentication</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.110">UsernamePasswordToken</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" class="externalLink">String</a> 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> password)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <a href="#getHost()"><code>host</code></a> and |
| a <tt>rememberMe</tt> default of <tt>false</tt> |
| <p/> |
| <p>This is a convenience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password string submitted for authentication</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,char[],java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.123">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password, |
| <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> host)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password string submitted for authentication</dd> |
| <dd><code>host</code> - the host name or IP string from where the attempt is occurring</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.140">UsernamePasswordToken</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" class="externalLink">String</a> 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> password, |
| <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> host)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt> |
| <p/> |
| <p>This is a convenience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password string submitted for authentication</dd> |
| <dd><code>host</code> - the host name or IP string from where the attempt is occurring</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,char[],boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.153">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password, |
| boolean rememberMe)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password string submitted for authentication</dd> |
| <dd><code>rememberMe</code> - if the user wishes their identity to be remembered across sessions</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.170">UsernamePasswordToken</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" class="externalLink">String</a> 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> password, |
| boolean rememberMe)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions. |
| <p/> |
| <p>This is a convenience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password string submitted for authentication</dd> |
| <dd><code>rememberMe</code> - if the user wishes their identity to be remembered across sessions</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,char[],boolean,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.184">UsernamePasswordToken</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" class="externalLink">String</a> username, |
| char[] password, |
| boolean rememberMe, |
| <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> host)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is occurring.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password character array submitted for authentication</dd> |
| <dd><code>rememberMe</code> - if the user wishes their identity to be remembered across sessions</dd> |
| <dd><code>host</code> - the host name or IP string from where the attempt is occurring</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,java.lang.String,boolean,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UsernamePasswordToken</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.208">UsernamePasswordToken</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" class="externalLink">String</a> 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> password, |
| boolean rememberMe, |
| <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> host)</pre> |
| <div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is occurring. |
| <p/> |
| <p>This is a convenience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username submitted for authentication</dd> |
| <dd><code>password</code> - the password string submitted for authentication</dd> |
| <dd><code>rememberMe</code> - if the user wishes their identity to be remembered across sessions</dd> |
| <dd><code>host</code> - the host name or IP string from where the attempt is occurring</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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="getUsername()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsername</h4> |
| <pre class="methodSignature">public <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/shiro/authc/UsernamePasswordToken.html#line.222">getUsername</a>()</pre> |
| <div class="block">Returns the username submitted during an authentication attempt.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username submitted during an authentication attempt.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUsername(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsername</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.231">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" class="externalLink">String</a> username)</pre> |
| <div class="block">Sets the username for submission during an authentication attempt.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username to be used for submission during an authentication attempt.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPassword()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPassword</h4> |
| <pre class="methodSignature">public char[] <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.241">getPassword</a>()</pre> |
| <div class="block">Returns the password submitted during an authentication attempt as a character array.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the password submitted during an authentication attempt as a character array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPassword(char[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPassword</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.250">setPassword</a>​(char[] password)</pre> |
| <div class="block">Sets the password for submission during an authentication attempt.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>password</code> - the password to be used for submission during an authentication attempt.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipal</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.260">getPrincipal</a>()</pre> |
| <div class="block">Simply returns <a href="#getUsername()"><code>getUsername()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AuthenticationToken.html#getPrincipal()">getPrincipal</a></code> in interface <code><a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="#getUsername()"><code>username</code></a>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AuthenticationToken.html#getPrincipal()"><code>AuthenticationToken.getPrincipal()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCredentials()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCredentials</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.270">getCredentials</a>()</pre> |
| <div class="block">Returns the <a href="#getPassword()"><code>password</code></a> char array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AuthenticationToken.html#getCredentials()">getCredentials</a></code> in interface <code><a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="#getPassword()"><code>password</code></a> char array.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AuthenticationToken.html#getCredentials()"><code>AuthenticationToken.getCredentials()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature">public <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/shiro/authc/UsernamePasswordToken.html#line.285">getHost</a>()</pre> |
| <div class="block">Returns the host name or IP string from where the authentication attempt occurs. May be <tt>null</tt> if the |
| host name/IP is unknown or explicitly omitted. It is up to the Authenticator implementation processing this |
| token if an authentication attempt without a host is valid or not. |
| <p/> |
| <p>(Shiro's default Authenticator allows <tt>null</tt> hosts to support localhost and proxy server environments).</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="HostAuthenticationToken.html#getHost()">getHost</a></code> in interface <code><a href="HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the host from where the authentication attempt occurs, or <tt>null</tt> if it is unknown or |
| explicitly omitted.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHost(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHost</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.299">setHost</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" class="externalLink">String</a> host)</pre> |
| <div class="block">Sets the host name or IP string from where the authentication attempt occurs. It is up to the Authenticator |
| implementation processing this token if an authentication attempt without a host is valid or not. |
| <p/> |
| <p>(Shiro's default Authenticator |
| allows <tt>null</tt> hosts to allow localhost and proxy server environments).</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>host</code> - the host name or IP string from where the attempt is occurring</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRememberMe()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRememberMe</h4> |
| <pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.311">isRememberMe</a>()</pre> |
| <div class="block">Returns <tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered |
| across sessions, <tt>false</tt> otherwise. Unless overridden, this value is <tt>false</tt> by default.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RememberMeAuthenticationToken.html#isRememberMe()">isRememberMe</a></code> in interface <code><a href="RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered |
| across sessions, <tt>false</tt> otherwise (<tt>false</tt> by default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRememberMe(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRememberMe</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.323">setRememberMe</a>​(boolean rememberMe)</pre> |
| <div class="block">Sets if the submitting user wishes their identity (principal(s)) to be remembered across sessions. Unless |
| overridden, the default value is <tt>false</tt>, indicating <em>not</em> to be remembered across sessions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rememberMe</code> - value indicating if the user wishes their identity (principal(s)) to be remembered across |
| sessions.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.335">clear</a>()</pre> |
| <div class="block">Clears out (nulls) the username, password, rememberMe, and inetAddress. The password bytes are explicitly set to |
| <tt>0x00</tt> before nulling to eliminate the possibility of memory access at a later time.</div> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <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/shiro/authc/UsernamePasswordToken.html#line.357">toString</a>()</pre> |
| <div class="block">Returns the String representation. It does not include the password in the resulting |
| string for security reasons to prevent accidentally printing out a password |
| that might be widely viewable).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the String representation of the <tt>UsernamePasswordToken</tt>, omitting |
| the password.</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/UsernamePasswordToken.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 Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |