Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.2 / apidocs / org / apache / shiro / authc / AbstractAuthenticator.html
blob: c707a4ac30c7bb87a3f98abd698f74dce954566e [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 15:02:15 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>AbstractAuthenticator (Apache Shiro 1.2.2 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="AbstractAuthenticator (Apache Shiro 1.2.2 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/AbstractAuthenticator.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>Prev Class</li>
<li><a href="../../../../org/apache/shiro/authc/Account.html" title="interface 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/AbstractAuthenticator.html" target="_top">Frames</a></li>
<li><a href="AbstractAuthenticator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.shiro.authc</div>
<h2 title="Class AbstractAuthenticator" class="title">Class AbstractAuthenticator</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.AbstractAuthenticator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/shiro/authc/Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a>, <a href="../../../../org/apache/shiro/authc/LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html" title="class in org.apache.shiro.authc.pam">ModularRealmAuthenticator</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.43">AbstractAuthenticator</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/Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a>, <a href="../../../../org/apache/shiro/authc/LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></pre>
<div class="block">Superclass for almost all <a href="../../../../org/apache/shiro/authc/Authenticator.html" title="interface in org.apache.shiro.authc"><code>Authenticator</code></a> implementations that performs the common work around authentication
attempts.
<p/>
This class delegates the actual authentication attempt to subclasses but supports notification for
successful and failed logins as well as logouts. Notification is sent to one or more registered
<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s to allow for custom processing logic
when these conditions occur.
<p/>
In most cases, the only thing a subclass needs to do (via its <a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#doAuthenticate(org.apache.shiro.authc.AuthenticationToken)"><code>doAuthenticate(org.apache.shiro.authc.AuthenticationToken)</code></a> implementation)
is perform the actual principal/credential verification process for the submitted <code>AuthenticationToken</code>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.1</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#AbstractAuthenticator()">AbstractAuthenticator</a></strong>()</code>
<div class="block">Default no-argument constructor.</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><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td>
<td class="colLast"><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>&nbsp;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="rowColor">
<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"><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>&nbsp;token)</code>
<div class="block">Template design pattern hook for subclasses to implement specific authentication behavior.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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>&lt;<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#getAuthenticationListeners()">getAuthenticationListeners</a></strong>()</code>
<div class="block">Returns the <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that should be notified during authentication
attempts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><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>&nbsp;token,
<a href="../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a>&nbsp;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"><code><strong><a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifyLogout(org.apache.shiro.subject.PrincipalCollection)">notifyLogout</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">Notifies any registered <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that a
<code>Subject</code> has logged-out.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><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>&nbsp;token,
<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>&nbsp;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="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#onLogout(org.apache.shiro.subject.PrincipalCollection)">onLogout</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">This implementation merely calls
<a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifyLogout(org.apache.shiro.subject.PrincipalCollection)"><code>notifyLogout</code></a> to allow any registered listeners
to react to the logout.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#setAuthenticationListeners(java.util.Collection)">setAuthenticationListeners</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>&lt;<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>&gt;&nbsp;listeners)</code>
<div class="block">Sets the <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that should be notified during authentication
attempts.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractAuthenticator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractAuthenticator</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.69">AbstractAuthenticator</a>()</pre>
<div class="block">Default no-argument constructor. Ensures the internal
<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a> collection is a non-null <code>ArrayList</code>.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setAuthenticationListeners(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthenticationListeners</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.85">setAuthenticationListeners</a>(<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>&lt;<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>&gt;&nbsp;listeners)</pre>
<div class="block">Sets the <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that should be notified during authentication
attempts.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listeners</code> - one or more <code>AuthenticationListener</code>s that should be notified due to an
authentication attempt.</dd></dl>
</li>
</ul>
<a name="getAuthenticationListeners()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationListeners</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>&gt;&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.101">getAuthenticationListeners</a>()</pre>
<div class="block">Returns the <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that should be notified during authentication
attempts.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s that should be notified during authentication
attempts.</dd></dl>
</li>
</ul>
<a name="notifySuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifySuccess</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.119">notifySuccess</a>(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token,
<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>&nbsp;info)</pre>
<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>. This implementation merely iterates over the internal <code>listeners</code> collection and
calls <a href="../../../../org/apache/shiro/authc/AuthenticationListener.html#onSuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)"><code>onSuccess</code></a>
for each.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the submitted <code>AuthenticationToken</code> that resulted in a successful authentication.</dd><dd><code>info</code> - the returned <code>AuthenticationInfo</code> resulting from the successful authentication.</dd></dl>
</li>
</ul>
<a name="notifyFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyFailure</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.136">notifyFailure</a>(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token,
<a href="../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a>&nbsp;ae)</pre>
<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. This implementation merely
iterates over the internal <code>listeners</code> collection and calls
<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html#onFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)"><code>onFailure</code></a>
for each.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the submitted <code>AuthenticationToken</code> that resulted in a failed authentication.</dd><dd><code>ae</code> - the resulting <code>AuthenticationException</code> that caused the authentication to fail.</dd></dl>
</li>
</ul>
<a name="notifyLogout(org.apache.shiro.subject.PrincipalCollection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyLogout</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.151">notifyLogout</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals)</pre>
<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 a
<code>Subject</code> has logged-out. This implementation merely
iterates over the internal <code>listeners</code> collection and calls
<a href="../../../../org/apache/shiro/authc/AuthenticationListener.html#onLogout(org.apache.shiro.subject.PrincipalCollection)"><code>onLogout</code></a>
for each.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - the identifying principals of the <code>Subject</code>/account logging out.</dd></dl>
</li>
</ul>
<a name="onLogout(org.apache.shiro.subject.PrincipalCollection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onLogout</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.164">onLogout</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals)</pre>
<div class="block">This implementation merely calls
<a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#notifyLogout(org.apache.shiro.subject.PrincipalCollection)"><code>notifyLogout</code></a> to allow any registered listeners
to react to the logout.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/LogoutAware.html#onLogout(org.apache.shiro.subject.PrincipalCollection)">onLogout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - the identifying principals of the <code>Subject</code>/account logging out.</dd></dl>
</li>
</ul>
<a name="authenticate(org.apache.shiro.authc.AuthenticationToken)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre>public final&nbsp;<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.188">authenticate</a>(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token)
throws <a href="../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre>
<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:
<ol>
<li>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.</li>
<li>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.</li>
<li>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.</li>
<li>Return the <code>AuthenticationInfo</code></li>
</ol></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/Authenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/authc/Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the submitted token representing the subject's (user's) login principals and credentials.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the AuthenticationInfo referencing the authenticated user's account data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - if there is any problem during the authentication process - see the
interface's JavaDoc for a more detailed explanation.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/authc/ExpiredCredentialsException.html" title="class in org.apache.shiro.authc"><code>ExpiredCredentialsException</code></a>,
<a href="../../../../org/apache/shiro/authc/IncorrectCredentialsException.html" title="class in org.apache.shiro.authc"><code>IncorrectCredentialsException</code></a>,
<a href="../../../../org/apache/shiro/authc/ExcessiveAttemptsException.html" title="class in org.apache.shiro.authc"><code>ExcessiveAttemptsException</code></a>,
<a href="../../../../org/apache/shiro/authc/LockedAccountException.html" title="class in org.apache.shiro.authc"><code>LockedAccountException</code></a>,
<a href="../../../../org/apache/shiro/authc/ConcurrentAccessException.html" title="class in org.apache.shiro.authc"><code>ConcurrentAccessException</code></a>,
<a href="../../../../org/apache/shiro/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><code>UnknownAccountException</code></a></dd></dl>
</li>
</ul>
<a name="doAuthenticate(org.apache.shiro.authc.AuthenticationToken)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doAuthenticate</h4>
<pre>protected abstract&nbsp;<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.255">doAuthenticate</a>(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token)
throws <a href="../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre>
<div class="block">Template design pattern hook for subclasses to implement specific authentication behavior.
<p/>
Common behavior for most authentication attempts is encapsulated in the
<a href="../../../../org/apache/shiro/authc/AbstractAuthenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)"><code>authenticate(org.apache.shiro.authc.AuthenticationToken)</code></a> method and that method invokes this one for custom behavior.
<p/>
<b>N.B.</b> Subclasses <em>should</em> throw some kind of
<code>AuthenticationException</code> if there is a problem during
authentication instead of returning <code>null</code>. A <code>null</code> return value indicates
a configuration or programming error, since <code>AuthenticationException</code>s should
indicate any expected problem (such as an unknown account or username, or invalid password, etc).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the authentication token encapsulating the user's login information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <code>AuthenticationInfo</code> object encapsulating the user's account information
important to Shiro.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - if there is a problem logging in the user.</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/AbstractAuthenticator.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>Prev Class</li>
<li><a href="../../../../org/apache/shiro/authc/Account.html" title="interface 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/AbstractAuthenticator.html" target="_top">Frames</a></li>
<li><a href="AbstractAuthenticator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>