http://git-wip-us.apache.org/repos/asf/shiro-site/blob/5896aacc/static/1.2.1/apidocs/org/apache/shiro/authc/class-use/AuthenticationToken.html ---------------------------------------------------------------------- diff --git a/static/1.2.1/apidocs/org/apache/shiro/authc/class-use/AuthenticationToken.html b/static/1.2.1/apidocs/org/apache/shiro/authc/class-use/AuthenticationToken.html deleted file mode 100644 index 8ed477e..0000000 --- a/static/1.2.1/apidocs/org/apache/shiro/authc/class-use/AuthenticationToken.html +++ /dev/null @@ -1,1107 +0,0 @@ -<!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:31 PDT 2013 --> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>Uses of Interface org.apache.shiro.authc.AuthenticationToken (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="Uses of Interface org.apache.shiro.authc.AuthenticationToken (Apache Shiro 1.2.1 API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- Begin Google Analytics code --> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-11551827-1']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <!-- End Google Analytics code --> -<!-- ========= 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><a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">Class</a></li> -<li class="navBarCell1Rev">Use</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>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/shiro/authc/class-use/AuthenticationToken.html" target="_top">Frames</a></li> -<li><a href="AuthenticationToken.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> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h2 title="Uses of Interface org.apache.shiro.authc.AuthenticationToken" class="title">Uses of Interface<br>org.apache.shiro.authc.AuthenticationToken</h2> -</div> -<div class="classUseContainer"> -<ul class="blockList"> -<li class="blockList"> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> -<caption><span>Packages that use <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Package</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.authc">org.apache.shiro.authc</a></td> -<td class="colLast"> -<div class="block">Core interfaces and exceptions concerning Authentication (the act of logging-in).</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.authc.credential">org.apache.shiro.authc.credential</a></td> -<td class="colLast"> -<div class="block">Support for validating <em>credentials</em> (such as passwords or X509 certificates) during - authentication via the <a href="../../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html" title="interface in org.apache.shiro.authc.credential"><code>CredentialsMatcher</code></a> - interface and its supporting implementations.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.authc.pam">org.apache.shiro.authc.pam</a></td> -<td class="colLast"> -<div class="block">Support for <em>PAM</em>, or <b>P</b>luggable <b>A</b>uthentication <b>M</b>odules, which is - the capability to authenticate a user against multiple configurable (pluggable) <em>modules</em> (Shiro - calls these <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s).</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.cas">org.apache.shiro.cas</a></td> -<td class="colLast"> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.mgt">org.apache.shiro.mgt</a></td> -<td class="colLast"> -<div class="block">Provides the master <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> interface and a default implementation - hierarchy for managing all aspects of Shiro's functionality in an application.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm">org.apache.shiro.realm</a></td> -<td class="colLast"> -<div class="block">Components and sub-packages used in supporting the core <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a> interface.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.activedirectory">org.apache.shiro.realm.activedirectory</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from a Microsoft Active Directory.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.jdbc">org.apache.shiro.realm.jdbc</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from an RDBMS (Relational Database Management System) using the - JDBC API.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.ldap">org.apache.shiro.realm.ldap</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from an LDAP (Lightweight Directory Access Protocol) server - utilizing LDAP/Naming APIs.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.subject">org.apache.shiro.subject</a></td> -<td class="colLast"> -<div class="block">Components supporting the <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> interface, the most important concept in - Shiro's API.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.subject.support">org.apache.shiro.subject.support</a></td> -<td class="colLast"> -<div class="block">Concrete support implementations of most of the <code>org.apache.shiro.subject</code> interfaces.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.web.filter.authc">org.apache.shiro.web.filter.authc</a></td> -<td class="colLast"> -<div class="block">Servlet <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet"><code>Filter</code></a> implementations specific to controlling access based on a - subject's authentication status, or those that can execute authentications (log-ins) directly.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"> -<ul class="blockList"> -<li class="blockList"><a name="org.apache.shiro.authc"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> -<caption><span>Subinterfaces of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Interface and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>interface </code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a></strong></code> -<div class="block">A <code>HostAuthenticationToken</code> retains the host information from where - an authentication attempt originates.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>interface </code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></strong></code> -<div class="block">An <code>AuthenticationToken</code> that indicates if the user wishes their identity to be remembered across sessions.</div> -</td> -</tr> -</tbody> -</table> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> that implement <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>class </code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/UsernamePasswordToken.html" title="class in org.apache.shiro.authc">UsernamePasswordToken</a></strong></code> -<div class="block">A simple username/password authentication token to support the most widely-used authentication mechanism.</div> -</td> -</tr> -</tbody> -</table> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">Authenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/Authenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> authenticationToken)</code> -<div class="block">Authenticates a user based on the submitted <code>AuthenticationToken</code>.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AbstractAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Implementation of the <a href="../../../../../org/apache/shiro/authc/Authenticator.html" title="interface in org.apache.shiro.authc"><code>Authenticator</code></a> interface that functions in the following manner: - - Calls template <a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#doAuthenticate(org.apache.shiro.authc.AuthenticationToken)"><code>doAuthenticate</code></a> method for subclass execution of the actual - authentication behavior. - If an <code>AuthenticationException</code> is thrown during <code>doAuthenticate</code>, - <a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifyFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)"><code>notify</code></a> any registered - <a href="../../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s of the exception and then propogate the exception - for the caller to handle. - If no exception is thrown (indicating a successful login), - <a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifySuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)"><code>notify</code></a> any registered - <a href="../../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s of the successful attempt. - Return the <code>AuthenticationInfo</code> - </div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AbstractAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#doAuthenticate(org.apache.shiro.authc.AuthenticationToken)">doAuthenticate</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Template design pattern hook for subclasses to implement specific authentication behavior.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">AbstractAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifyFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)">notifyFailure</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae)</code> -<div class="block">Notifies any registered <a href="../../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that - authentication failed for the - specified <code>token</code> which resulted in the specified <code>ae</code> exception.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">AbstractAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifySuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">notifySuccess</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Notifies any registered <a href="../../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that - authentication was successful for the specified <code>token</code> which resulted in the specified - <code>info</code>.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">AuthenticationListener.</span><code><strong><a href="../../../../../org/apache/shiro/authc/AuthenticationListener.html#onFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)">onFailure</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae)</code> -<div class="block">Callback triggered when an authentication attempt for a <code>Subject</code> has failed.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">AuthenticationListener.</span><code><strong><a href="../../../../../org/apache/shiro/authc/AuthenticationListener.html#onSuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">onSuccess</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Callback triggered when an authentication attempt for a <code>Subject</code> has succeeded.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.authc.credential"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/authc/credential/package-summary.html">org.apache.shiro.authc.credential</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/authc/credential/package-summary.html">org.apache.shiro.authc.credential</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">SimpleCredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">This implementation acquires the <code>token</code>'s credentials - (via <a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html#getCredentials(org.apache.shiro.authc.AuthenticationToken)"><code>getCredentials(token)</code></a>) - and then the <code>account</code>'s credentials - (via <a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html#getCredentials(org.apache.shiro.authc.AuthenticationInfo)"><code>getCredentials(account)</code></a>) and then passes both of - them to the <a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html#equals(java.lang.Object, java.lang.Object)"><code>equals(tokenCredentials, accountCredentials)</code></a> method for equality - comparison.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">PasswordMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/PasswordMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">HashedCredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">This implementation first hashes the <code>token</code>'s credentials, potentially using a - <code>salt</code> if the <code>info</code> argument is a - <a href="../../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a>.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">CredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Returns <code>true</code> if the provided token credentials match the stored account credentials, - <code>false</code> otherwise.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">AllowAllCredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/AllowAllCredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Returns <code>true</code> <em>always</em> no matter what the method arguments are.</div> -</td> -</tr> -<tr class="rowColor"> -<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"><span class="strong">SimpleCredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html#getCredentials(org.apache.shiro.authc.AuthenticationToken)">getCredentials</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Returns the <code>token</code>'s credentials.</div> -</td> -</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"><span class="strong">HashedCredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#getSalt(org.apache.shiro.authc.AuthenticationToken)">getSalt</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block"><strong>Deprecated.</strong> -<div class="block"><i>since Shiro 1.1. Hash salting is now expected to be based on if the <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> - returned from the <code>Realm</code> is a <a href="../../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> instance and its - <a href="../../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html#getCredentialsSalt()"><code>getCredentialsSalt()</code></a> method returns a non-null value. - This method and the 1.0 behavior still exists for backwards compatibility if the <code>Realm</code> does not return - <code>SaltedAuthenticationInfo</code> instances, but <b>it is highly recommended that <code>Realm</code> implementations - that support hashed credentials start returning <a href="../../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> - instances as soon as possible</b>.<p/> - This is because salts should always be obtained from the stored account information and - never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for - attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user - are almost impossible to break. This method will be removed in Shiro 2.0.</i></div> -</div> -</td> -</tr> -<tr class="rowColor"> -<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"><span class="strong">PasswordMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/PasswordMatcher.html#getSubmittedPassword(org.apache.shiro.authc.AuthenticationToken)">getSubmittedPassword</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> </td> -</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"><span class="strong">HashedCredentialsMatcher.</span><code><strong><a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#hashProvidedCredentials(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">hashProvidedCredentials</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Hash the provided <code>token</code>'s credentials using the salt stored with the account if the - <code>info</code> instance is an <code>instanceof</code> <a href="../../../../../org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> (see - the class-level JavaDoc for why this is the preferred approach).</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.authc.pam"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/authc/pam/package-summary.html">org.apache.shiro.authc.pam</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/authc/pam/package-summary.html">org.apache.shiro.authc.pam</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Method invoked by the ModularAuthenticator signifying that all of its configured Realms have been consulted - for account data, allowing post-proccessing after all realms have completed.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AtLeastOneSuccessfulStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AtLeastOneSuccessfulStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Ensures that the <code>aggregate</code> method argument is not <code>null</code> and - <code>aggregate.<a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#getPrincipals()"><code>getPrincipals()</code></a></code> - is not <code>null</code>, and if either is <code>null</code>, throws an AuthenticationException to indicate - that none of the realms authenticated successfully.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AbstractAuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Simply returns the <code>aggregate</code> argument without modification.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#afterAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo, java.lang.Throwable)">afterAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> singleRealmInfo, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregateInfo, - <a href="http://java.sun.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</code> -<div class="block">Method invoked by the ModularAuthenticator just after the given realm has been consulted for authentication, - allowing post-authentication-attempt logic for that realm only.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AllSuccessfulStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AllSuccessfulStrategy.html#afterAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo, java.lang.Throwable)">afterAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate, - <a href="http://java.sun.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</code> -<div class="block">Merges the specified <code>info</code> into the <code>aggregate</code> argument and returns it (just as the - parent implementation does), but additionally ensures the following: - - if the <code>Throwable</code> argument is not <code>null</code>, re-throws it to immediately cancel the - authentication process, since this strategy requires all realms to authenticate successfully. - neither the <code>info</code> or <code>aggregate</code> argument is <code>null</code> to ensure that each - realm did in fact authenticate successfully - </div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AbstractAuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#afterAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo, java.lang.Throwable)">afterAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> singleRealmInfo, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregateInfo, - <a href="http://java.sun.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</code> -<div class="block">Base implementation that will aggregate the specified <code>singleRealmInfo</code> into the - <code>aggregateInfo</code> and then returns the aggregate.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">FirstSuccessfulStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/FirstSuccessfulStrategy.html#beforeAllAttempts(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Returns <code>null</code> immediately, relying on this class's <a href="../../../../../org/apache/shiro/authc/pam/FirstSuccessfulStrategy.html#merge(org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo)"><code>merge</code></a> implementation to return - only the first <code>info</code> object it encounters, ignoring all subsequent ones.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#beforeAllAttempts(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Method invoked by the ModularAuthenticator signifying that the authentication process is about to begin for the - specified <code>token</code> - called before any <code>Realm</code> is actually invoked.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AbstractAuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#beforeAllAttempts(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Simply returns <code>new <a href="../../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html" title="class in org.apache.shiro.authc"><code>SimpleAuthenticationInfo</code></a>();</code>, which supports - aggregating account data across realms.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Method invoked by the ModularAuthenticator just prior to the realm being consulted for account data, - allowing pre-authentication-attempt logic for that realm only.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AllSuccessfulStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AllSuccessfulStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Because all realms in this strategy must complete successfully, this implementation ensures that the given - <code>Realm</code> <a href="../../../../../org/apache/shiro/realm/Realm.html#supports(org.apache.shiro.authc.AuthenticationToken)"><code>supports</code></a> the given - <code>token</code> argument.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AbstractAuthenticationStrategy.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Simply returns the <code>aggregate</code> method argument, without modification.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">ModularRealmAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html#doAuthenticate(org.apache.shiro.authc.AuthenticationToken)">doAuthenticate</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> authenticationToken)</code> -<div class="block">Attempts to authenticate the given token by iterating over the internal collection of - <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">ModularRealmAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html#doMultiRealmAuthentication(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)">doMultiRealmAuthentication</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Performs the multi-realm authentication attempt by calling back to a <a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam"><code>AuthenticationStrategy</code></a> object - as each realm is consulted for <code>AuthenticationInfo</code> for the specified <code>token</code>.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">ModularRealmAuthenticator.</span><code><strong><a href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html#doSingleRealmAuthentication(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken)">doSingleRealmAuthentication</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Performs the authentication attempt by interacting with the single configured realm, which is significantly - simpler than performing multi-realm logic.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.cas"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/cas/package-summary.html">org.apache.shiro.cas</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../../org/apache/shiro/cas/package-summary.html">org.apache.shiro.cas</a> that implement <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>class </code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/cas/CasToken.html" title="class in org.apache.shiro.cas">CasToken</a></strong></code> -<div class="block">This class represents a token for a CAS authentication (service ticket + user id + remember me).</div> -</td> -</tr> -</tbody> -</table> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/cas/package-summary.html">org.apache.shiro.cas</a> that return <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></td> -<td class="colLast"><span class="strong">CasFilter.</span><code><strong><a href="../../../../../org/apache/shiro/cas/CasFilter.html#createToken(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">createToken</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, - <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> -<div class="block">The token created for this authentication is a CasToken containing the CAS service ticket received on the CAS service url (on which - the filter must be configured).</div> -</td> -</tr> -</tbody> -</table> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/cas/package-summary.html">org.apache.shiro.cas</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">CasRealm.</span><code><strong><a href="../../../../../org/apache/shiro/cas/CasRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Authenticates a user and retrieves its information.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><span class="strong">CasFilter.</span><code><strong><a href="../../../../../org/apache/shiro/cas/CasFilter.html#onLoginFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">onLoginFailure</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae, - <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, - <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> -<div class="block">If login has failed, redirect user to the CAS error page (no ticket or ticket validation failed) except if the user is already - authenticated, in which case redirect to the default success url.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><span class="strong">CasFilter.</span><code><strong><a href="../../../../../org/apache/shiro/cas/CasFilter.html#onLoginSuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.subject.Subject, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">onLoginSuccess</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, - <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> -<div class="block">If login has been successful, redirect user to the original protected url.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.mgt"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/mgt/package-summary.html">org.apache.shiro.mgt</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/mgt/package-summary.html">org.apache.shiro.mgt</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticatingSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/AuthenticatingSecurityManager.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Delegates to the wrapped <a href="../../../../../org/apache/shiro/authc/Authenticator.html" title="interface in org.apache.shiro.authc"><code>Authenticator</code></a> for authentication.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> -<td class="colLast"><span class="strong">DefaultSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/DefaultSecurityManager.html#createSubject(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.subject.Subject)">createSubject</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, - <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> existing)</code> -<div class="block">Creates a <code>Subject</code> instance for the user represented by the given method arguments.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><span class="strong">AbstractRememberMeManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#isRememberMe(org.apache.shiro.authc.AuthenticationToken)">isRememberMe</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Determines whether or not remember me services should be performed for the specified token.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> -<td class="colLast"><span class="strong">SecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/SecurityManager.html#login(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken)">login</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> authenticationToken)</code> -<div class="block">Logs in the specified Subject using the given <code>authenticationToken</code>, returning an updated Subject - instance reflecting the authenticated state if successful or throwing <code>AuthenticationException</code> if it is - not.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> -<td class="colLast"><span class="strong">DefaultSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/DefaultSecurityManager.html#login(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken)">login</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">First authenticates the <code>AuthenticationToken</code> argument, and if successful, constructs a - <code>Subject</code> instance representing the authenticated account's identity.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">DefaultSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/DefaultSecurityManager.html#onFailedLogin(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException, org.apache.shiro.subject.Subject)">onFailedLogin</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae, - <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">RememberMeManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/RememberMeManager.html#onFailedLogin(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)">onFailedLogin</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae)</code> -<div class="block">Reacts to a failed authentication attempt, typically by forgetting any previously remembered principals for the - Subject.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">AbstractRememberMeManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#onFailedLogin(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)">onFailedLogin</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae)</code> -<div class="block">Reacts to a failed login by immediately <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#forgetIdentity(org.apache.shiro.subject.Subject)"><code>forgetting</code></a> any - previously remembered identity.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">DefaultSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/DefaultSecurityManager.html#onSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.subject.Subject)">onSuccessfulLogin</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, - <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">RememberMeManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/RememberMeManager.html#onSuccessfulLogin(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">onSuccessfulLogin</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Reacts to a successful authentication attempt, typically saving the principals to be retrieved ('remembered') - for future system access.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">AbstractRememberMeManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#onSuccessfulLogin(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">onSuccessfulLogin</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Reacts to the successful login attempt by first always <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#forgetIdentity(org.apache.shiro.subject.Subject)"><code>forgetting</code></a> any previously - stored identity.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">AbstractRememberMeManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#rememberIdentity(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">rememberIdentity</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> authcInfo)</code> -<div class="block">Remembers a subject-unique identity for retrieval later.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">DefaultSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/DefaultSecurityManager.html#rememberMeFailedLogin(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException, org.apache.shiro.subject.Subject)">rememberMeFailedLogin</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ex, - <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">DefaultSecurityManager.</span><code><strong><a href="../../../../../org/apache/shiro/mgt/DefaultSecurityManager.html#rememberMeSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.subject.Subject)">rememberMeSuccessfulLogin</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, - <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code> </td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/realm/package-summary.html">org.apache.shiro.realm</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/realm/package-summary.html">org.apache.shiro.realm</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#assertCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">assertCredentialsMatch</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Asserts that the submitted <code>AuthenticationToken</code>'s credentials match the stored account - <code>AuthenticationInfo</code>'s credentials, and if not, throws an <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc"><code>AuthenticationException</code></a>.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">SimpleAccountRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/SimpleAccountRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given - authentication token.</div> -</td> -</tr> -<tr class="rowColor"> -<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"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationCacheKey</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Returns the key under which <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> instances are cached if authentication caching is enabled.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">Realm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/Realm.html#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Returns an account's authentication-specific information for the specified <tt>token</tt>, - or <tt>null</tt> if no account could be found based on the <tt>token</tt>.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">This implementation functions as follows: - - It attempts to acquire any cached <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> corresponding to the specified - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> argument.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#isAuthenticationCachingEnabled(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">isAuthenticationCachingEnabled</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code> -<div class="block">Returns <code>true</code> if authentication caching should be utilized based on the specified - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> and/or <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a>, <code>false</code> otherwise.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">Realm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/Realm.html#supports(org.apache.shiro.authc.AuthenticationToken)">supports</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Returns <tt>true</tt> if this realm wishes to authenticate the Subject represented by the given - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> instance, <tt>false</tt> otherwise.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#supports(org.apache.shiro.authc.AuthenticationToken)">supports</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Convenience implementation that returns - <tt>getAuthenticationTokenClass().isAssignableFrom( token.getClass() );</tt>.</div> -</td> -</tr> -</tbody> -</table> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Method parameters in <a href="../../../../../org/apache/shiro/realm/package-summary.html">org.apache.shiro.realm</a> with type arguments of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">AuthenticatingRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#setAuthenticationTokenClass(java.lang.Class)">setAuthenticationTokenClass</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>> authenticationTokenClass)</code> -<div class="block">Sets the authenticationToken class supported by this realm.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.activedirectory"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/realm/activedirectory/package-summary.html">org.apache.shiro.realm.activedirectory</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/realm/activedirectory/package-summary.html">org.apache.shiro.realm.activedirectory</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">ActiveDirectoryRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/activedirectory/ActiveDirectoryRealm.html#queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.realm.ldap.LdapContextFactory)">queryForAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a> ldapContextFactory)</code> -<div class="block">Builds an <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> object by querying the active directory LDAP context for the - specified username.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.jdbc"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/realm/jdbc/package-summary.html">org.apache.shiro.realm.jdbc</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/realm/jdbc/package-summary.html">org.apache.shiro.realm.jdbc</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">JdbcRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> </td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.ldap"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../../../../org/apache/shiro/realm/ldap/package-summary.html">org.apache.shiro.realm.ldap</a></h3> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Methods in <a href="../../../../../org/apache/shiro/realm/ldap/package-summary.html">org.apache.shiro.realm.ldap</a> with parameters of type <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><span class="strong">JndiLdapRealm.</span><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/JndiLdapRealm.html#createAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, java.lang.Object, java.lang.Object, javax.naming.ldap.LdapContext)">createAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <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> ldapPrincipal, - <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> ldapCredentials, -
<TRUNCATED>
