| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AbstractAuthenticator (Apache Shiro 1.12.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractAuthenticator (Apache Shiro 1.12.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.authc</a></div> |
| <h2 title="Class AbstractAuthenticator" class="title">Class AbstractAuthenticator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.authc.AbstractAuthenticator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></code>, <code><a href="LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="pam/ModularRealmAuthenticator.html" title="class in org.apache.shiro.authc.pam">ModularRealmAuthenticator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.43">AbstractAuthenticator</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a>, <a href="LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></pre> |
| <div class="block">Superclass for almost all <a href="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="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="#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="simpleTagLabel">Since:</span></dt> |
| <dd>0.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractAuthenticator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Default no-argument constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></span>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Implementation of the <a href="Authenticator.html" title="interface in org.apache.shiro.authc"><code>Authenticator</code></a> interface that functions in the following manner: |
| |
| Calls template <a href="#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="#notifyFailure(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)"><code>notify</code></a> any registered |
| <a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s of the exception and then propagate the exception |
| for the caller to handle. |
| If no exception is thrown (indicating a successful login), |
| <a href="#notifySuccess(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)"><code>notify</code></a> any registered |
| <a href="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 id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doAuthenticate(org.apache.shiro.authc.AuthenticationToken)">doAuthenticate</a></span>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Template design pattern hook for subclasses to implement specific authentication behavior.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationListeners()">getAuthenticationListeners</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="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 id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyFailure(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)">notifyFailure</a></span>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae)</code></th> |
| <td class="colLast"> |
| <div class="block">Notifies any registered <a href="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 id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyLogout(org.apache.shiro.subject.PrincipalCollection)">notifyLogout</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</code></th> |
| <td class="colLast"> |
| <div class="block">Notifies any registered <a href="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 id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifySuccess(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">notifySuccess</a></span>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code></th> |
| <td class="colLast"> |
| <div class="block">Notifies any registered <a href="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 id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onLogout(org.apache.shiro.subject.PrincipalCollection)">onLogout</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</code></th> |
| <td class="colLast"> |
| <div class="block">This implementation merely calls |
| <a href="#notifyLogout(org.apache.shiro.subject.PrincipalCollection)"><code>notifyLogout</code></a> to allow any registered listeners |
| to react to the logout.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthenticationListeners(java.util.Collection)">setAuthenticationListeners</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>> listeners)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="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 id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractAuthenticator</h4> |
| <pre>public <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="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> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setAuthenticationListeners(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticationListeners</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.84">setAuthenticationListeners</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>> listeners)</pre> |
| <div class="block">Sets the <a href="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="paramLabel">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 id="getAuthenticationListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthenticationListeners</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a>> <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.100">getAuthenticationListeners</a>()</pre> |
| <div class="block">Returns the <a href="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="returnLabel">Returns:</span></dt> |
| <dd>the <a href="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 id="notifySuccess(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifySuccess</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.119">notifySuccess</a>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</pre> |
| <div class="block">Notifies any registered <a href="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="AuthenticationListener.html#onSuccess(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)"><code>onSuccess</code></a> |
| for each.</div> |
| <dl> |
| <dt><span class="paramLabel">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 id="notifyFailure(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifyFailure</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.136">notifyFailure</a>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae)</pre> |
| <div class="block">Notifies any registered <a href="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="AuthenticationListener.html#onFailure(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)"><code>onFailure</code></a> |
| for each.</div> |
| <dl> |
| <dt><span class="paramLabel">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 id="notifyLogout(org.apache.shiro.subject.PrincipalCollection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifyLogout</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.151">notifyLogout</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</pre> |
| <div class="block">Notifies any registered <a href="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="AuthenticationListener.html#onLogout(org.apache.shiro.subject.PrincipalCollection)"><code>onLogout</code></a> |
| for each.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying principals of the <code>Subject</code>/account logging out.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onLogout(org.apache.shiro.subject.PrincipalCollection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onLogout</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.164">onLogout</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</pre> |
| <div class="block">This implementation merely calls |
| <a href="#notifyLogout(org.apache.shiro.subject.PrincipalCollection)"><code>notifyLogout</code></a> to allow any registered listeners |
| to react to the logout.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="LogoutAware.html#onLogout(org.apache.shiro.subject.PrincipalCollection)">onLogout</a></code> in interface <code><a href="LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying principals of the <code>Subject</code>/account logging out.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="authenticate(org.apache.shiro.authc.AuthenticationToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authenticate</h4> |
| <pre class="methodSignature">public final <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.188">authenticate</a>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token) |
| throws <a href="AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> |
| <div class="block">Implementation of the <a href="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="#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="#notifyFailure(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)"><code>notify</code></a> any registered |
| <a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc"><code>AuthenticationListener</code></a>s of the exception and then propagate the exception |
| for the caller to handle.</li> |
| <li>If no exception is thrown (indicating a successful login), |
| <a href="#notifySuccess(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)"><code>notify</code></a> any registered |
| <a href="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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Authenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></code> in interface <code><a href="Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - the submitted token representing the subject's (user's) login principals and credentials.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the AuthenticationInfo referencing the authenticated user's account data.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="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="seeLabel">See Also:</span></dt> |
| <dd><a href="ExpiredCredentialsException.html" title="class in org.apache.shiro.authc"><code>ExpiredCredentialsException</code></a>, |
| <a href="IncorrectCredentialsException.html" title="class in org.apache.shiro.authc"><code>IncorrectCredentialsException</code></a>, |
| <a href="ExcessiveAttemptsException.html" title="class in org.apache.shiro.authc"><code>ExcessiveAttemptsException</code></a>, |
| <a href="LockedAccountException.html" title="class in org.apache.shiro.authc"><code>LockedAccountException</code></a>, |
| <a href="ConcurrentAccessException.html" title="class in org.apache.shiro.authc"><code>ConcurrentAccessException</code></a>, |
| <a href="UnknownAccountException.html" title="class in org.apache.shiro.authc"><code>UnknownAccountException</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doAuthenticate(org.apache.shiro.authc.AuthenticationToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>doAuthenticate</h4> |
| <pre class="methodSignature">protected abstract <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../src-html/org/apache/shiro/authc/AbstractAuthenticator.html#line.257">doAuthenticate</a>​(<a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token) |
| throws <a href="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="#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="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - the authentication token encapsulating the user's login information.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>AuthenticationInfo</code> object encapsulating the user's account information |
| important to Shiro.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |