| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.6) on Mon Mar 23 13:31:56 EDT 2020 --> |
| <title>org.apache.shiro.authc (Apache Shiro 1.5.2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-03-23"> |
| <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="org.apache.shiro.authc (Apache Shiro 1.5.2 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <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"> |
| <h1 title="Package" class="title">Package org.apache.shiro.authc</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Core interfaces and exceptions concerning Authentication (the act of logging-in). |
| <p/> |
| Shiro abbreviates the word 'AuthentiCation' as <tt>authc</tt> to distinguish it separately from |
| 'AuthoriZation', abbreviated as <tt>authz</tt>. |
| <p/> |
| The primary item of interest in this package is the <tt>Authenticator</tt> interface, which acts as the |
| entry point (facade) to all other other authentication components. Other components, interfaces and |
| exceptions are here to support <tt>Authenticator</tt> implementations.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Account.html" title="interface in org.apache.shiro.authc">Account</a></th> |
| <td class="colLast"> |
| <div class="block">An <tt>Account</tt> is a convenience interface that extends both <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> and |
| <a href="../authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz"><code>AuthorizationInfo</code></a> and represents authentication and authorization for a <em>single account</em> in a |
| <em>single Realm</em>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></th> |
| <td class="colLast"> |
| <div class="block"><code>AuthenticationInfo</code> represents a Subject's (aka user's) stored account information relevant to the |
| authentication/log-in process only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AuthenticationListener.html" title="interface in org.apache.shiro.authc">AuthenticationListener</a></th> |
| <td class="colLast"> |
| <div class="block">An <code>AuthenticationListener</code> listens for notifications while <code>Subject</code>s authenticate with the system.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></th> |
| <td class="colLast"> |
| <div class="block">An <tt>AuthenticationToken</tt> is a consolidation of an account's principals and supporting |
| credentials submitted by a user during an authentication attempt.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></th> |
| <td class="colLast"> |
| <div class="block">An Authenticator is responsible for authenticating accounts in an application.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</a></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="altColor"> |
| <th class="colFirst" scope="row"><a href="LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a></th> |
| <td class="colLast"> |
| <div class="block">An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a></th> |
| <td class="colLast"> |
| <div class="block">An extension of the <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> interface to be implemented by |
| classes that support merging with other <a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</a></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> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a></th> |
| <td class="colLast"> |
| <div class="block">Interface representing account information that may use a salt when hashing credentials.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractAuthenticator.html" title="class in org.apache.shiro.authc">AbstractAuthenticator</a></th> |
| <td class="colLast"> |
| <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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="BearerToken.html" title="class in org.apache.shiro.authc">BearerToken</a></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="altColor"> |
| <th class="colFirst" scope="row"><a href="SimpleAccount.html" title="class in org.apache.shiro.authc">SimpleAccount</a></th> |
| <td class="colLast"> |
| <div class="block">Simple implementation of the <a href="Account.html" title="interface in org.apache.shiro.authc"><code>Account</code></a> interface that |
| contains principal and credential and authorization information (roles and permissions) as instance variables and |
| exposes them via getters and setters using standard JavaBean notation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SimpleAuthenticationInfo.html" title="class in org.apache.shiro.authc">SimpleAuthenticationInfo</a></th> |
| <td class="colLast"> |
| <div class="block">Simple implementation of the <a href="MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>MergableAuthenticationInfo</code></a> interface that holds the principals and |
| credentials.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="UsernamePasswordToken.html" title="class in org.apache.shiro.authc">UsernamePasswordToken</a></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> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AccountException.html" title="class in org.apache.shiro.authc">AccountException</a></th> |
| <td class="colLast"> |
| <div class="block">Exception thrown due to a problem with the account |
| under which an authentication attempt is being executed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></th> |
| <td class="colLast"> |
| <div class="block">General exception thrown due to an error during the Authentication process.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ConcurrentAccessException.html" title="class in org.apache.shiro.authc">ConcurrentAccessException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when an authentication attempt has been received for an account that has already been |
| authenticated (i.e.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CredentialsException.html" title="class in org.apache.shiro.authc">CredentialsException</a></th> |
| <td class="colLast"> |
| <div class="block">Exception thrown due to a problem with the credential(s) submitted for an |
| account during the authentication process.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DisabledAccountException.html" title="class in org.apache.shiro.authc">DisabledAccountException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when attempting to authenticate and the corresponding account has been disabled for |
| some reason.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ExcessiveAttemptsException.html" title="class in org.apache.shiro.authc">ExcessiveAttemptsException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when a system is configured to only allow a certain number of authentication attempts |
| over a period of time and the current session has failed to authenticate successfully within |
| that number.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ExpiredCredentialsException.html" title="class in org.apache.shiro.authc">ExpiredCredentialsException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown during the authentication process when the system determines the submitted credential(s) |
| has expired and will not allow login.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="IncorrectCredentialsException.html" title="class in org.apache.shiro.authc">IncorrectCredentialsException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when attempting to authenticate with credential(s) that do not match the actual |
| credentials associated with the account principal.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="LockedAccountException.html" title="class in org.apache.shiro.authc">LockedAccountException</a></th> |
| <td class="colLast"> |
| <div class="block">A special kind of <tt>DisabledAccountException</tt>, this exception is thrown when attempting |
| to authenticate and the corresponding account has been disabled explicitly due to being locked.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="UnknownAccountException.html" title="class in org.apache.shiro.authc">UnknownAccountException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when attempting to authenticate with a principal that doesn't exist in the system (e.g.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <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> |
