| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.7) on Mon Aug 17 10:33:47 EDT 2020 --> |
| <title>Uses of Interface org.apache.shiro.authc.AuthenticationToken (Apache Shiro :: Core 1.6.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-08-17"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.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.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Uses of Interface org.apache.shiro.authc.AuthenticationToken (Apache Shiro :: Core 1.6.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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"> |
| <!-- ========= 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><a href="../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" 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> |
| <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> |
| <main role="main"> |
| <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 class="useSummary"> |
| <caption><span>Packages that use <a href="../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"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.authc">org.apache.shiro.authc</a></th> |
| <td class="colLast"> |
| <div class="block">Core interfaces and exceptions concerning Authentication (the act of logging-in).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.authc.credential">org.apache.shiro.authc.credential</a></th> |
| <td class="colLast"> |
| <div class="block">Support for validating <em>credentials</em> (such as passwords or X509 certificates) during |
| authentication via the <a href="../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"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.authc.pam">org.apache.shiro.authc.pam</a></th> |
| <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="../../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.mgt">org.apache.shiro.mgt</a></th> |
| <td class="colLast"> |
| <div class="block">Provides the master <a href="../../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="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.realm">org.apache.shiro.realm</a></th> |
| <td class="colLast"> |
| <div class="block">Components and sub-packages used in supporting the core <a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a> interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.realm.activedirectory">org.apache.shiro.realm.activedirectory</a></th> |
| <td class="colLast"> |
| <div class="block">Realms that acquire security data from a Microsoft Active Directory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.realm.jdbc">org.apache.shiro.realm.jdbc</a></th> |
| <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="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.realm.ldap">org.apache.shiro.realm.ldap</a></th> |
| <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="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.subject">org.apache.shiro.subject</a></th> |
| <td class="colLast"> |
| <div class="block">Components supporting the <a href="../../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="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.shiro.subject.support">org.apache.shiro.subject.support</a></th> |
| <td class="colLast"> |
| <div class="block">Concrete support implementations of most of the <code>org.apache.shiro.subject</code> interfaces.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.authc"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../package-summary.html">org.apache.shiro.authc</a></h3> |
| <table class="useSummary"> |
| <caption><span>Subinterfaces of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../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="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a></span></code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></span></code></th> |
| <td class="colLast"> |
| <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 class="useSummary"> |
| <caption><span>Classes in <a href="../package-summary.html">org.apache.shiro.authc</a> that implement <a href="../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="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../BearerToken.html" title="class in org.apache.shiro.authc">BearerToken</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> that contains an a Bearer token or API key, typically received via an HTTP <code>Authorization</code> header.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../UsernamePasswordToken.html" title="class in org.apache.shiro.authc">UsernamePasswordToken</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A simple username/password authentication token to support the most widely-used authentication mechanism.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../package-summary.html">org.apache.shiro.authc</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr 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"><span class="typeNameLabel">AbstractAuthenticator.</span><code><span class="memberNameLink"><a href="../AbstractAuthenticator.html#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="../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="../AbstractAuthenticator.html#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="../AbstractAuthenticator.html#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 class="rowColor"> |
| <td class="colFirst"><code><a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Authenticator.</span><code><span class="memberNameLink"><a href="../Authenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> authenticationToken)</code></th> |
| <td class="colLast"> |
| <div class="block">Authenticates a user based on the submitted <code>AuthenticationToken</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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"><span class="typeNameLabel">AbstractAuthenticator.</span><code><span class="memberNameLink"><a href="../AbstractAuthenticator.html#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 class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractAuthenticator.</span><code><span class="memberNameLink"><a href="../AbstractAuthenticator.html#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 class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractAuthenticator.</span><code><span class="memberNameLink"><a href="../AbstractAuthenticator.html#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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticationListener.</span><code><span class="memberNameLink"><a href="../AuthenticationListener.html#onFailure(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)">onFailure</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">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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticationListener.</span><code><span class="memberNameLink"><a href="../AuthenticationListener.html#onSuccess(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">onSuccess</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">Callback triggered when an authentication attempt for a <code>Subject</code> has succeeded.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.authc.credential"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../credential/package-summary.html">org.apache.shiro.authc.credential</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../credential/package-summary.html">org.apache.shiro.authc.credential</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AllowAllCredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/AllowAllCredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</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">Returns <code>true</code> <em>always</em> no matter what the method arguments are.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">CredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/CredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</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">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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">HashedCredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/HashedCredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</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">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="../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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">PasswordMatcher.</span><code><span class="memberNameLink"><a href="../credential/PasswordMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SimpleCredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/SimpleCredentialsMatcher.html#doCredentialsMatch(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">doCredentialsMatch</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">This implementation acquires the <code>token</code>'s credentials |
| (via <a href="../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="../credential/SimpleCredentialsMatcher.html#getCredentials(org.apache.shiro.authc.AuthenticationInfo)"><code>getCredentials(account)</code></a>) and then passes both of |
| them to the <a href="../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>protected <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></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SimpleCredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/SimpleCredentialsMatcher.html#getCredentials(org.apache.shiro.authc.AuthenticationToken)">getCredentials</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>token</code>'s credentials.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">HashedCredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/HashedCredentialsMatcher.html#getSalt(org.apache.shiro.authc.AuthenticationToken)">getSalt</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">since Shiro 1.1.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">PasswordMatcher.</span><code><span class="memberNameLink"><a href="../credential/PasswordMatcher.html#getSubmittedPassword(org.apache.shiro.authc.AuthenticationToken)">getSubmittedPassword</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">HashedCredentialsMatcher.</span><code><span class="memberNameLink"><a href="../credential/HashedCredentialsMatcher.html#hashProvidedCredentials(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">hashProvidedCredentials</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">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="../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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.authc.pam"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../pam/package-summary.html">org.apache.shiro.authc.pam</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../pam/package-summary.html">org.apache.shiro.authc.pam</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr 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"><span class="typeNameLabel">AbstractAuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../pam/AbstractAuthenticationStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</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> aggregate)</code></th> |
| <td class="colLast"> |
| <div class="block">Simply returns the <code>aggregate</code> argument without modification.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AtLeastOneSuccessfulStrategy.</span><code><span class="memberNameLink"><a href="../pam/AtLeastOneSuccessfulStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</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> aggregate)</code></th> |
| <td class="colLast"> |
| <div class="block">Ensures that the <code>aggregate</code> method argument is not <code>null</code> and |
| <code>aggregate.<a href="../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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../pam/AuthenticationStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</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> aggregate)</code></th> |
| <td class="colLast"> |
| <div class="block">Method invoked by the ModularAuthenticator signifying that all of its configured Realms have been consulted |
| for account data, allowing post-processing after all realms have completed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractAuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../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></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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> singleRealmInfo, |
| <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregateInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> t)</code></th> |
| <td class="colLast"> |
| <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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AllSuccessfulStrategy.</span><code><span class="memberNameLink"><a href="../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></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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, |
| <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> t)</code></th> |
| <td class="colLast"> |
| <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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../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></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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> singleRealmInfo, |
| <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregateInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> t)</code></th> |
| <td class="colLast"> |
| <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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractAuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../pam/AbstractAuthenticationStrategy.html#beforeAllAttempts(java.util.Collection,org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</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><? extends <a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Simply returns <code>new <a href="../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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../pam/AuthenticationStrategy.html#beforeAllAttempts(java.util.Collection,org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</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><? extends <a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">FirstSuccessfulStrategy.</span><code><span class="memberNameLink"><a href="../pam/FirstSuccessfulStrategy.html#beforeAllAttempts(java.util.Collection,org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</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><? extends <a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>null</code> immediately, relying on this class's <a href="../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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractAuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../pam/AbstractAuthenticationStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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> aggregate)</code></th> |
| <td class="colLast"> |
| <div class="block">Simply returns the <code>aggregate</code> method argument, without modification.</div> |
| </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">AllSuccessfulStrategy.</span><code><span class="memberNameLink"><a href="../pam/AllSuccessfulStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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">Because all realms in this strategy must complete successfully, this implementation ensures that the given |
| <code>Realm</code> <a href="../../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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticationStrategy.</span><code><span class="memberNameLink"><a href="../pam/AuthenticationStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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> aggregate)</code></th> |
| <td class="colLast"> |
| <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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">FirstSuccessfulStrategy.</span><code><span class="memberNameLink"><a href="../pam/FirstSuccessfulStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <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> aggregate)</code></th> |
| <td class="colLast"> |
| <div class="block">Throws ShortCircuitIterationException if stopAfterFirstSuccess is set and authentication is |
| successful with a previously consulted realm.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ModularRealmAuthenticator.</span><code><span class="memberNameLink"><a href="../pam/ModularRealmAuthenticator.html#doAuthenticate(org.apache.shiro.authc.AuthenticationToken)">doAuthenticate</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> authenticationToken)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to authenticate the given token by iterating over the internal collection of |
| <a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ModularRealmAuthenticator.</span><code><span class="memberNameLink"><a href="../pam/ModularRealmAuthenticator.html#doMultiRealmAuthentication(java.util.Collection,org.apache.shiro.authc.AuthenticationToken)">doMultiRealmAuthentication</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="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs the multi-realm authentication attempt by calling back to a <a href="../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="rowColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ModularRealmAuthenticator.</span><code><span class="memberNameLink"><a href="../pam/ModularRealmAuthenticator.html#doSingleRealmAuthentication(org.apache.shiro.realm.Realm,org.apache.shiro.authc.AuthenticationToken)">doSingleRealmAuthentication</a></span>​(<a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.mgt"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../mgt/package-summary.html">org.apache.shiro.mgt</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../mgt/package-summary.html">org.apache.shiro.mgt</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr 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"><span class="typeNameLabel">AuthenticatingSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/AuthenticatingSecurityManager.html#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">Delegates to the wrapped <a href="../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="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/DefaultSecurityManager.html#createSubject(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)">createSubject</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, |
| <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> existing)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractRememberMeManager.</span><code><span class="memberNameLink"><a href="../../mgt/AbstractRememberMeManager.html#isRememberMe(org.apache.shiro.authc.AuthenticationToken)">isRememberMe</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <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="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/DefaultSecurityManager.html#login(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken)">login</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <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="altColor"> |
| <td class="colFirst"><code><a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/SecurityManager.html#login(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken)">login</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> authenticationToken)</code></th> |
| <td class="colLast"> |
| <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="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractRememberMeManager.</span><code><span class="memberNameLink"><a href="../../mgt/AbstractRememberMeManager.html#onFailedLogin(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)">onFailedLogin</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <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">Reacts to a failed login by immediately <a href="../../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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/DefaultSecurityManager.html#onFailedLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException,org.apache.shiro.subject.Subject)">onFailedLogin</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, |
| <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">RememberMeManager.</span><code><span class="memberNameLink"><a href="../../mgt/RememberMeManager.html#onFailedLogin(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)">onFailedLogin</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <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">Reacts to a failed authentication attempt, typically by forgetting any previously remembered principals for the |
| Subject.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractRememberMeManager.</span><code><span class="memberNameLink"><a href="../../mgt/AbstractRememberMeManager.html#onSuccessfulLogin(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">onSuccessfulLogin</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <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">Reacts to the successful login attempt by first always <a href="../../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>protected void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/DefaultSecurityManager.html#onSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)">onSuccessfulLogin</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, |
| <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">RememberMeManager.</span><code><span class="memberNameLink"><a href="../../mgt/RememberMeManager.html#onSuccessfulLogin(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">onSuccessfulLogin</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <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">Reacts to a successful authentication attempt, typically saving the principals to be retrieved ('remembered') |
| for future system access.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractRememberMeManager.</span><code><span class="memberNameLink"><a href="../../mgt/AbstractRememberMeManager.html#rememberIdentity(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">rememberIdentity</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <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> authcInfo)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/DefaultSecurityManager.html#rememberMeFailedLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException,org.apache.shiro.subject.Subject)">rememberMeFailedLogin</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> ex, |
| <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSecurityManager.</span><code><span class="memberNameLink"><a href="../../mgt/DefaultSecurityManager.html#rememberMeSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)">rememberMeSuccessfulLogin</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, |
| <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.realm"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../realm/package-summary.html">org.apache.shiro.realm</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../realm/package-summary.html">org.apache.shiro.realm</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#assertCredentialsMatch(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">assertCredentialsMatch</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">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="../AuthenticationException.html" title="class in org.apache.shiro.authc"><code>AuthenticationException</code></a>.</div> |
| </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given |
| authentication token.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SimpleAccountRealm.</span><code><span class="memberNameLink"><a href="../../realm/SimpleAccountRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationCacheKey</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the key under which <a href="../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="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">This implementation functions as follows: |
| |
| It attempts to acquire any cached <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> corresponding to the specified |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> argument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Realm.</span><code><span class="memberNameLink"><a href="../../realm/Realm.html#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <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="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#isAuthenticationCachingEnabled(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">isAuthenticationCachingEnabled</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">Returns <code>true</code> if authentication caching should be utilized based on the specified |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> and/or <a href="../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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#supports(org.apache.shiro.authc.AuthenticationToken)">supports</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience implementation that returns |
| <tt>getAuthenticationTokenClass().isAssignableFrom( token.getClass() );</tt>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Realm.</span><code><span class="memberNameLink"><a href="../../realm/Realm.html#supports(org.apache.shiro.authc.AuthenticationToken)">supports</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <tt>true</tt> if this realm wishes to authenticate the Subject represented by the given |
| <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc"><code>AuthenticationToken</code></a> instance, <tt>false</tt> otherwise.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Method parameters in <a href="../../realm/package-summary.html">org.apache.shiro.realm</a> with type arguments of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AuthenticatingRealm.</span><code><span class="memberNameLink"><a href="../../realm/AuthenticatingRealm.html#setAuthenticationTokenClass(java.lang.Class)">setAuthenticationTokenClass</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><? extends <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>> authenticationTokenClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the authenticationToken class supported by this realm.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.realm.activedirectory"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../realm/activedirectory/package-summary.html">org.apache.shiro.realm.activedirectory</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../realm/activedirectory/package-summary.html">org.apache.shiro.realm.activedirectory</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveDirectoryRealm.</span><code><span class="memberNameLink"><a href="../../realm/activedirectory/ActiveDirectoryRealm.html#queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.realm.ldap.LdapContextFactory)">queryForAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../../realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a> ldapContextFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">Builds an <a href="../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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.realm.jdbc"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../realm/jdbc/package-summary.html">org.apache.shiro.realm.jdbc</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../realm/jdbc/package-summary.html">org.apache.shiro.realm.jdbc</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">JdbcRealm.</span><code><span class="memberNameLink"><a href="../../realm/jdbc/JdbcRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.realm.ldap"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../realm/ldap/package-summary.html">org.apache.shiro.realm.ldap</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../realm/ldap/package-summary.html">org.apache.shiro.realm.ldap</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultLdapRealm.</span><code><span class="memberNameLink"><a href="../../realm/ldap/DefaultLdapRealm.html#createAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken,java.lang.Object,java.lang.Object,javax.naming.ldap.LdapContext)">createAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <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> ldapPrincipal, |
| <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> ldapCredentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap" class="externalLink">LdapContext</a> ldapContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> resulting from a Subject's successful LDAP authentication attempt.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractLdapRealm.</span><code><span class="memberNameLink"><a href="../../realm/ldap/AbstractLdapRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultLdapRealm.</span><code><span class="memberNameLink"><a href="../../realm/ldap/DefaultLdapRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Delegates to <a href="../../realm/ldap/DefaultLdapRealm.html#queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.realm.ldap.LdapContextFactory)"><code>DefaultLdapRealm.queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, LdapContextFactory)</code></a>, |
| wrapping any <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming" class="externalLink"><code>NamingException</code></a>s in a Shiro <a href="../AuthenticationException.html" title="class in org.apache.shiro.authc"><code>AuthenticationException</code></a> to satisfy the parent method |
| signature.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultLdapRealm.</span><code><span class="memberNameLink"><a href="../../realm/ldap/DefaultLdapRealm.html#getLdapPrincipal(org.apache.shiro.authc.AuthenticationToken)">getLdapPrincipal</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the principal to use when creating the LDAP connection for an authentication attempt.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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"><span class="typeNameLabel">AbstractLdapRealm.</span><code><span class="memberNameLink"><a href="../../realm/ldap/AbstractLdapRealm.html#queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.realm.ldap.LdapContextFactory)">queryForAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../../realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a> ldapContextFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">Abstract method that should be implemented by subclasses to builds an |
| <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> object by querying the LDAP context for the |
| specified username.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultLdapRealm.</span><code><span class="memberNameLink"><a href="../../realm/ldap/DefaultLdapRealm.html#queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.realm.ldap.LdapContextFactory)">queryForAuthenticationInfo</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../../realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a> ldapContextFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">This implementation opens an LDAP connection using the token's |
| <a href="../../realm/ldap/DefaultLdapRealm.html#getLdapPrincipal(org.apache.shiro.authc.AuthenticationToken)"><code>discovered principal</code></a> and provided |
| <a href="../AuthenticationToken.html#getCredentials()"><code>credentials</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.subject"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../subject/package-summary.html">org.apache.shiro.subject</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../subject/package-summary.html">org.apache.shiro.subject</a> that return <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SubjectContext.</span><code><span class="memberNameLink"><a href="../../subject/SubjectContext.html#getAuthenticationToken()">getAuthenticationToken</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../subject/package-summary.html">org.apache.shiro.subject</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Subject.</span><code><span class="memberNameLink"><a href="../../subject/Subject.html#login(org.apache.shiro.authc.AuthenticationToken)">login</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs a login attempt for this Subject/user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SubjectContext.</span><code><span class="memberNameLink"><a href="../../subject/SubjectContext.html#setAuthenticationToken(org.apache.shiro.authc.AuthenticationToken)">setAuthenticationToken</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.shiro.subject.support"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> in <a href="../../subject/support/package-summary.html">org.apache.shiro.subject.support</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../subject/support/package-summary.html">org.apache.shiro.subject.support</a> that return <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSubjectContext.</span><code><span class="memberNameLink"><a href="../../subject/support/DefaultSubjectContext.html#getAuthenticationToken()">getAuthenticationToken</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../subject/support/package-summary.html">org.apache.shiro.subject.support</a> with parameters of type <a href="../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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DelegatingSubject.</span><code><span class="memberNameLink"><a href="../../subject/support/DelegatingSubject.html#login(org.apache.shiro.authc.AuthenticationToken)">login</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">DefaultSubjectContext.</span><code><span class="memberNameLink"><a href="../../subject/support/DefaultSubjectContext.html#setAuthenticationToken(org.apache.shiro.authc.AuthenticationToken)">setAuthenticationToken</a></span>​(<a href="../AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <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><a href="../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" 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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
