Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.5 / apidocs / org / apache / shiro / authc / UsernamePasswordToken.html
blob: 848d80ee935e7e50317f1f777572d27a297206f4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Wed May 25 23:25:53 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>UsernamePasswordToken (Apache Shiro 1.2.5 API)</title>
<meta name="date" content="2016-05-25">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UsernamePasswordToken (Apache Shiro 1.2.5 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/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">
<li><a href="../../../../org/apache/shiro/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/authc/UsernamePasswordToken.html" target="_top">Frames</a></li>
<li><a href="UsernamePasswordToken.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.shiro.authc</div>
<h2 title="Class UsernamePasswordToken" class="title">Class UsernamePasswordToken</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.authc.UsernamePasswordToken</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>, <a href="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a>, <a href="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.45">UsernamePasswordToken</a>
extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a>, <a href="../../../../org/apache/shiro/authc/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="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>RememberMeAuthenticationToken</code></a> interface to support
&quot;Remember Me&quot; services across user sessions as well as the
<a href="../../../../org/apache/shiro/authc/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 occuring.</p>
<p/>
<p>&quot;Remember Me&quot; 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="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#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="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#clear()"><code>clear()</code></a> after using the token to perform a login attempt.</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.1</dd>
<dt><span class="strong">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 ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken()">UsernamePasswordToken</a></strong>()</code>
<div class="block">JavaBeans compatible no-arg constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[])">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password)</code>
<div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted
during an authentication attempt, with a <tt>null</tt> <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><code>host</code></a> and a
<tt>rememberMe</tt> default of <tt>false</tt>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[], boolean)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password,
boolean&nbsp;rememberMe)</code>
<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">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[], boolean, java.lang.String)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password,
boolean&nbsp;rememberMe,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</code>
<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 ocurring.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[], java.lang.String)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</code>
<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">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>
<div class="block">Constructs a new UsernamePasswordToken encapsulating the username and password submitted
during an authentication attempt, with a <tt>null</tt> <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><code>host</code></a> and
a <tt>rememberMe</tt> default of <tt>false</tt>
<p/></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String, boolean)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
boolean&nbsp;rememberMe)</code>
<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">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String, boolean, java.lang.String)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
boolean&nbsp;rememberMe,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</code>
<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 ocurring.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String, java.lang.String)">UsernamePasswordToken</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</code>
<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/></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#clear()">clear</a></strong>()</code>
<div class="block">Clears out (nulls) the username, password, rememberMe, and inetAddress.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getCredentials()">getCredentials</a></strong>()</code>
<div class="block">Returns the <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()"><code>password</code></a> char array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()">getHost</a></strong>()</code>
<div class="block">Returns the host name or IP string from where the authentication attempt occurs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>char[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()">getPassword</a></strong>()</code>
<div class="block">Returns the password submitted during an authentication attempt as a character array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPrincipal()">getPrincipal</a></strong>()</code>
<div class="block">Simply returns <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()"><code>getUsername()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()">getUsername</a></strong>()</code>
<div class="block">Returns the username submitted during an authentication attempt.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#isRememberMe()">isRememberMe</a></strong>()</code>
<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 class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#setHost(java.lang.String)">setHost</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</code>
<div class="block">Sets the host name or IP string from where the authentication attempt occurs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#setPassword(char[])">setPassword</a></strong>(char[]&nbsp;password)</code>
<div class="block">Sets the password for submission during an authentication attempt.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#setRememberMe(boolean)">setRememberMe</a></strong>(boolean&nbsp;rememberMe)</code>
<div class="block">Sets if the submitting user wishes their identity (pricipal(s)) to be remembered across sessions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#setUsername(java.lang.String)">setUsername</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username)</code>
<div class="block">Sets the username for submission during an authentication attempt.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#toString()">toString</a></strong>()</code>
<div class="block">Returns the String representation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UsernamePasswordToken()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<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 name="UsernamePasswordToken(java.lang.String, char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.94">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;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="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><code>host</code></a> and a
<tt>rememberMe</tt> default of <tt>false</tt>.</div>
<dl><dt><span class="strong">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 name="UsernamePasswordToken(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.110">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><code>host</code></a> and
a <tt>rememberMe</tt> default of <tt>false</tt>
<p/>
<p>This is a convience 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="strong">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 name="UsernamePasswordToken(java.lang.String, char[], java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.123">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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="strong">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 occuring</dd><dt><span class="strong">Since:</span></dt>
<dd>0.2</dd></dl>
</li>
</ul>
<a name="UsernamePasswordToken(java.lang.String, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.140">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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 convience 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="strong">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 occuring</dd><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd></dl>
</li>
</ul>
<a name="UsernamePasswordToken(java.lang.String, char[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.153">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password,
boolean&nbsp;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="strong">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="strong">Since:</span></dt>
<dd>0.9</dd></dl>
</li>
</ul>
<a name="UsernamePasswordToken(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.170">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
boolean&nbsp;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 convience 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="strong">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="strong">Since:</span></dt>
<dd>0.9</dd></dl>
</li>
</ul>
<a name="UsernamePasswordToken(java.lang.String, char[], boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.184">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
char[]&nbsp;password,
boolean&nbsp;rememberMe,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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 ocurring.</div>
<dl><dt><span class="strong">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 occuring</dd><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd></dl>
</li>
</ul>
<a name="UsernamePasswordToken(java.lang.String, java.lang.String, boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UsernamePasswordToken</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.208">UsernamePasswordToken</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
boolean&nbsp;rememberMe,
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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 ocurring.
<p/>
<p>This is a convience 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="strong">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 occuring</dd><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/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="strong">Returns:</span></dt><dd>the username submitted during an authentication attempt.</dd></dl>
</li>
</ul>
<a name="setUsername(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsername</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.231">setUsername</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username)</pre>
<div class="block">Sets the username for submission during an authentication attempt.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - the username to be used for submission during an authentication attempt.</dd></dl>
</li>
</ul>
<a name="getPassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</h4>
<pre>public&nbsp;char[]&nbsp;<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="strong">Returns:</span></dt><dd>the password submitted during an authentication attempt as a character array.</dd></dl>
</li>
</ul>
<a name="setPassword(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.250">setPassword</a>(char[]&nbsp;password)</pre>
<div class="block">Sets the password for submission during an authentication attempt.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - the password to be used for submission during an authentication attemp.</dd></dl>
</li>
</ul>
<a name="getPrincipal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrincipal</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.260">getPrincipal</a>()</pre>
<div class="block">Simply returns <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()"><code>getUsername()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/AuthenticationToken.html#getPrincipal()">getPrincipal</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()"><code>username</code></a>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/authc/AuthenticationToken.html#getPrincipal()"><code>AuthenticationToken.getPrincipal()</code></a></dd></dl>
</li>
</ul>
<a name="getCredentials()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredentials</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.270">getCredentials</a>()</pre>
<div class="block">Returns the <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()"><code>password</code></a> char array.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/AuthenticationToken.html#getCredentials()">getCredentials</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()"><code>password</code></a> char array.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/authc/AuthenticationToken.html#getCredentials()"><code>AuthenticationToken.getCredentials()</code></a></dd></dl>
</li>
</ul>
<a name="getHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHost</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/HostAuthenticationToken.html#getHost()">getHost</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a></code></dd>
<dt><span class="strong">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="strong">Since:</span></dt>
<dd>1.0</dd></dl>
</li>
</ul>
<a name="setHost(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHost</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.299">setHost</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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="strong">Parameters:</span></dt><dd><code>host</code> - the host name or IP string from where the attempt is occuring</dd><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd></dl>
</li>
</ul>
<a name="isRememberMe()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRememberMe</h4>
<pre>public&nbsp;boolean&nbsp;<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html#isRememberMe()">isRememberMe</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></code></dd>
<dt><span class="strong">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="strong">Since:</span></dt>
<dd>0.9</dd></dl>
</li>
</ul>
<a name="setRememberMe(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRememberMe</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.323">setRememberMe</a>(boolean&nbsp;rememberMe)</pre>
<div class="block">Sets if the submitting user wishes their identity (pricipal(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="strong">Parameters:</span></dt><dd><code>rememberMe</code> - value inidicating if the user wishes their identity (principal(s)) to be remembered across
sessions.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.9</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;<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 name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/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 accidentially printing out a password
that might be widely viewable).</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the String representation of the <tt>UsernamePasswordToken</tt>, omitting
the password.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/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">
<li><a href="../../../../org/apache/shiro/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/authc/UsernamePasswordToken.html" target="_top">Frames</a></li>
<li><a href="UsernamePasswordToken.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>