Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / apidocs / org / apache / shiro / authc / SimpleAuthenticationInfo.html
blob: deb4e9b818f9e9fc55f82a590681521cb98c33e6 [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_21) on Thu May 30 14:51:23 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SimpleAuthenticationInfo (Apache Shiro 1.2.1 API)</title>
<meta name="date" content="2013-05-30">
<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="SimpleAuthenticationInfo (Apache Shiro 1.2.1 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/SimpleAuthenticationInfo.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/SimpleAccount.html" title="class in org.apache.shiro.authc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/shiro/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/authc/SimpleAuthenticationInfo.html" target="_top">Frames</a></li>
<li><a href="SimpleAuthenticationInfo.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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 SimpleAuthenticationInfo" class="title">Class SimpleAuthenticationInfo</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.SimpleAuthenticationInfo</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/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>, <a href="../../../../org/apache/shiro/authc/MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a>, <a href="../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.38">SimpleAuthenticationInfo</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/MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a>, <a href="../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a></pre>
<div class="block">Simple implementation of the <a href="../../../../org/apache/shiro/authc/MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>MergableAuthenticationInfo</code></a> interface that holds the principals and
credentials.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.9</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/realm/AuthenticatingRealm.html" title="class in org.apache.shiro.realm"><code>AuthenticatingRealm</code></a>,
<a href="../../../../serialized-form.html#org.apache.shiro.authc.SimpleAuthenticationInfo">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/SimpleAuthenticationInfo.html#credentials">credentials</a></strong></code>
<div class="block">The credentials verifying the account principals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#credentialsSalt">credentialsSalt</a></strong></code>
<div class="block">Any salt used in hashing the credentials.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#principals">principals</a></strong></code>
<div class="block">The principals identifying the account associated with this AuthenticationInfo instance.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/SimpleAuthenticationInfo.html#SimpleAuthenticationInfo()">SimpleAuthenticationInfo</a></strong>()</code>
<div class="block">Default no-argument constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#SimpleAuthenticationInfo(java.lang.Object, java.lang.Object, org.apache.shiro.util.ByteSource, java.lang.String)">SimpleAuthenticationInfo</a></strong>(<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;principal,
<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;hashedCredentials,
<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;credentialsSalt,
<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;realmName)</code>
<div class="block">Constructor that takes in a single 'primary' principal of the account, its corresponding hashed credentials,
the salt used to hash the credentials, and the name of the realm to associate with the principals.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#SimpleAuthenticationInfo(java.lang.Object, java.lang.Object, java.lang.String)">SimpleAuthenticationInfo</a></strong>(<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;principal,
<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;credentials,
<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;realmName)</code>
<div class="block">Constructor that takes in a single 'primary' principal of the account and its corresponding credentials,
associated with the specified realm.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#SimpleAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection, java.lang.Object)">SimpleAuthenticationInfo</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals,
<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;credentials)</code>
<div class="block">Constructor that takes in an account's identifying principal(s) and its corresponding credentials that verify
the principals.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#SimpleAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection, java.lang.Object, org.apache.shiro.util.ByteSource)">SimpleAuthenticationInfo</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals,
<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;hashedCredentials,
<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;credentialsSalt)</code>
<div class="block">Constructor that takes in an account's identifying principal(s), hashed credentials used to verify the
principals, and the salt used when hashing the credentials.</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#equals(java.lang.Object)">equals</a></strong>(<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;o)</code>
<div class="block">Returns <code>true</code> if the Object argument is an <code>instanceof SimpleAuthenticationInfo</code> and
its <a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a> are equal to this instance's principals, <code>false</code> otherwise.</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/SimpleAuthenticationInfo.html#getCredentials()">getCredentials</a></strong>()</code>
<div class="block">Returns the credentials associated with the corresponding Subject.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getCredentialsSalt()">getCredentialsSalt</a></strong>()</code>
<div class="block">Returns the salt used to hash the credentials, or <code>null</code> if no salt was used or credentials were not
hashed at all.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()">getPrincipals</a></strong>()</code>
<div class="block">Returns all principals associated with the corresponding Subject.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns the hashcode of the internal <a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#merge(org.apache.shiro.authc.AuthenticationInfo)">merge</a></strong>(<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>&nbsp;info)</code>
<div class="block">Takes the specified <code>info</code> argument and adds its principals and credentials into this instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#setCredentials(java.lang.Object)">setCredentials</a></strong>(<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;credentials)</code>
<div class="block">Sets the credentials that verify the principals/identity of the associated Realm account.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#setCredentialsSalt(org.apache.shiro.util.ByteSource)">setCredentialsSalt</a></strong>(<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;salt)</code>
<div class="block">Sets the salt used to hash the credentials, or <code>null</code> if no salt was used or credentials were not
hashed at all.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#setPrincipals(org.apache.shiro.subject.PrincipalCollection)">setPrincipals</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals)</code>
<div class="block">Sets the identifying principal(s) represented by this instance.</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/SimpleAuthenticationInfo.html#toString()">toString</a></strong>()</code>
<div class="block">Simple implementation that merely returns <code><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a>.toString()</code></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#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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="principals">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>principals</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.43">principals</a></pre>
<div class="block">The principals identifying the account associated with this AuthenticationInfo instance.</div>
</li>
</ul>
<a name="credentials">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>credentials</h4>
<pre>protected&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> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.47">credentials</a></pre>
<div class="block">The credentials verifying the account principals.</div>
</li>
</ul>
<a name="credentialsSalt">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>credentialsSalt</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.54">credentialsSalt</a></pre>
<div class="block">Any salt used in hashing the credentials.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SimpleAuthenticationInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SimpleAuthenticationInfo</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.59">SimpleAuthenticationInfo</a>()</pre>
<div class="block">Default no-argument constructor.</div>
</li>
</ul>
<a name="SimpleAuthenticationInfo(java.lang.Object, java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SimpleAuthenticationInfo</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.73">SimpleAuthenticationInfo</a>(<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;principal,
<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;credentials,
<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;realmName)</pre>
<div class="block">Constructor that takes in a single 'primary' principal of the account and its corresponding credentials,
associated with the specified realm.
<p/>
This is a convenience constructor and will construct a <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject"><code>PrincipalCollection</code></a> based
on the <code>principal</code> and <code>realmName</code> argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - the 'primary' principal associated with the specified realm.</dd><dd><code>credentials</code> - the credentials that verify the given principal.</dd><dd><code>realmName</code> - the realm from where the principal and credentials were acquired.</dd></dl>
</li>
</ul>
<a name="SimpleAuthenticationInfo(java.lang.Object, java.lang.Object, org.apache.shiro.util.ByteSource, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SimpleAuthenticationInfo</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.92">SimpleAuthenticationInfo</a>(<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;principal,
<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;hashedCredentials,
<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;credentialsSalt,
<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;realmName)</pre>
<div class="block">Constructor that takes in a single 'primary' principal of the account, its corresponding hashed credentials,
the salt used to hash the credentials, and the name of the realm to associate with the principals.
<p/>
This is a convenience constructor and will construct a <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject"><code>PrincipalCollection</code></a> based
on the <code>principal</code> and <code>realmName</code> argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - the 'primary' principal associated with the specified realm.</dd><dd><code>hashedCredentials</code> - the hashed credentials that verify the given principal.</dd><dd><code>credentialsSalt</code> - the salt used when hashing the given hashedCredentials</dd><dd><code>realmName</code> - the realm from where the principal and credentials were acquired.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html" title="class in org.apache.shiro.authc.credential"><code>HashedCredentialsMatcher</code></a></dd></dl>
</li>
</ul>
<a name="SimpleAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SimpleAuthenticationInfo</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.105">SimpleAuthenticationInfo</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals,
<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;credentials)</pre>
<div class="block">Constructor that takes in an account's identifying principal(s) and its corresponding credentials that verify
the principals.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - a Realm's account's identifying principal(s)</dd><dd><code>credentials</code> - the accounts corresponding principals that verify the principals.</dd></dl>
</li>
</ul>
<a name="SimpleAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection, java.lang.Object, org.apache.shiro.util.ByteSource)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleAuthenticationInfo</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.120">SimpleAuthenticationInfo</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals,
<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;hashedCredentials,
<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;credentialsSalt)</pre>
<div class="block">Constructor that takes in an account's identifying principal(s), hashed credentials used to verify the
principals, and the salt used when hashing the credentials.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - a Realm's account's identifying principal(s)</dd><dd><code>hashedCredentials</code> - the hashed credentials that verify the principals.</dd><dd><code>credentialsSalt</code> - the salt used when hashing the hashedCredentials.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html" title="class in org.apache.shiro.authc.credential"><code>HashedCredentialsMatcher</code></a></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="getPrincipals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrincipals</h4>
<pre>public&nbsp;<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.127">getPrincipals</a>()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#getPrincipals()">AuthenticationInfo</a></code></strong></div>
<div class="block">Returns all principals associated with the corresponding Subject. Each principal is an identifying piece of
information useful to the application such as a username, or user id, a given name, etc - anything useful
to the application to identify the current <code>Subject</code>.
<p/>
The returned PrincipalCollection should <em>not</em> contain any credentials used to verify principals, such
as passwords, private keys, etc. Those should be instead returned by <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#getCredentials()"><code>getCredentials()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#getPrincipals()">getPrincipals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>all principals associated with the corresponding Subject.</dd></dl>
</li>
</ul>
<a name="setPrincipals(org.apache.shiro.subject.PrincipalCollection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrincipals</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.136">setPrincipals</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals)</pre>
<div class="block">Sets the identifying principal(s) represented by this instance.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - the indentifying attributes of the corresponding Realm account.</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/SimpleAuthenticationInfo.html#line.140">getCredentials</a>()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#getCredentials()">AuthenticationInfo</a></code></strong></div>
<div class="block">Returns the credentials associated with the corresponding Subject. A credential verifies one or more of the
<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#getPrincipals()"><code>principals</code></a> associated with the Subject, such as a password or private key. Credentials
are used by Shiro particularly during the authentication process to ensure that submitted credentials
during a login attempt match exactly the credentials here in the <code>AuthenticationInfo</code> instance.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#getCredentials()">getCredentials</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the credentials associated with the corresponding Subject.</dd></dl>
</li>
</ul>
<a name="setCredentials(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCredentials</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.149">setCredentials</a>(<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;credentials)</pre>
<div class="block">Sets the credentials that verify the principals/identity of the associated Realm account.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>credentials</code> - attribute(s) that verify the account's identity/principals, such as a password or private key.</dd></dl>
</li>
</ul>
<a name="getCredentialsSalt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredentialsSalt</h4>
<pre>public&nbsp;<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.166">getCredentialsSalt</a>()</pre>
<div class="block">Returns the salt used to hash the credentials, or <code>null</code> if no salt was used or credentials were not
hashed at all.
<p/>
Note that this attribute is <em>NOT</em> handled in the
<a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#merge(org.apache.shiro.authc.AuthenticationInfo)"><code>merge</code></a> method - a hash salt is only useful within a single realm (as each
realm will perform it's own Credentials Matching logic), and once finished in that realm, Shiro has no further
use for salts. Therefore it doesn't make sense to 'merge' salts in a multi-realm scenario.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html#getCredentialsSalt()">getCredentialsSalt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the salt used to hash the credentials, or <code>null</code> if no salt was used or credentials were not
hashed at all.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="setCredentialsSalt(org.apache.shiro.util.ByteSource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCredentialsSalt</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.183">setCredentialsSalt</a>(<a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a>&nbsp;salt)</pre>
<div class="block">Sets the salt used to hash the credentials, or <code>null</code> if no salt was used or credentials were not
hashed at all.
<p/>
Note that this attribute is <em>NOT</em> handled in the
<a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#merge(org.apache.shiro.authc.AuthenticationInfo)"><code>merge</code></a> method - a hash salt is only useful within a single realm (as each
realm will perform it's own Credentials Matching logic), and once finished in that realm, Shiro has no further
use for salts. Therefore it doesn't make sense to 'merge' salts in a multi-realm scenario.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>salt</code> - the salt used to hash the credentials, or <code>null</code> if no salt was used or credentials were not
hashed at all.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="merge(org.apache.shiro.authc.AuthenticationInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.193">merge</a>(<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>&nbsp;info)</pre>
<div class="block">Takes the specified <code>info</code> argument and adds its principals and credentials into this instance.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/MergableAuthenticationInfo.html#merge(org.apache.shiro.authc.AuthenticationInfo)">merge</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - the <code>AuthenticationInfo</code> to add into this instance.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.252">equals</a>(<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;o)</pre>
<div class="block">Returns <code>true</code> if the Object argument is an <code>instanceof SimpleAuthenticationInfo</code> and
its <a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a> are equal to this instance's principals, <code>false</code> otherwise.</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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">Parameters:</span></dt><dd><code>o</code> - the object to compare for equality.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the Object argument is an <code>instanceof SimpleAuthenticationInfo</code> and
its <a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a> are equal to this instance's principals, <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/SimpleAuthenticationInfo.html#line.269">hashCode</a>()</pre>
<div class="block">Returns the hashcode of the internal <a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a> instance.</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#hashCode()" title="class or interface in java.lang">hashCode</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 hashcode of the internal <a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a> instance.</dd></dl>
</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/SimpleAuthenticationInfo.html#line.278">toString</a>()</pre>
<div class="block">Simple implementation that merely returns <code><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a>.toString()</code></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><code><a href="../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html#getPrincipals()"><code>principals</code></a>.toString()</code></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/SimpleAuthenticationInfo.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/SimpleAccount.html" title="class in org.apache.shiro.authc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/shiro/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/authc/SimpleAuthenticationInfo.html" target="_top">Frames</a></li>
<li><a href="SimpleAuthenticationInfo.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>