http://git-wip-us.apache.org/repos/asf/shiro-site/blob/5896aacc/static/1.2.1/apidocs/org/apache/shiro/authc/package-use.html ---------------------------------------------------------------------- diff --git a/static/1.2.1/apidocs/org/apache/shiro/authc/package-use.html b/static/1.2.1/apidocs/org/apache/shiro/authc/package-use.html deleted file mode 100644 index f7e4b2c..0000000 --- a/static/1.2.1/apidocs/org/apache/shiro/authc/package-use.html +++ /dev/null @@ -1,711 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:32 PDT 2013 --> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>Uses of Package org.apache.shiro.authc (Apache Shiro 1.2.1 API)</title> -<meta name="date" content="2013-05-30"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.apache.shiro.authc (Apache Shiro 1.2.1 API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- Begin Google Analytics code --> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-11551827-1']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <!-- End Google Analytics code --> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li>Class</li> -<li class="navBarCell1Rev">Use</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/shiro/authc/package-use.html" target="_top">Frames</a></li> -<li><a href="package-use.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Uses of Package org.apache.shiro.authc" class="title">Uses of Package<br>org.apache.shiro.authc</h1> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> -<caption><span>Packages that use <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Package</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.authc">org.apache.shiro.authc</a></td> -<td class="colLast"> -<div class="block">Core interfaces and exceptions concerning Authentication (the act of logging-in).</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.authc.credential">org.apache.shiro.authc.credential</a></td> -<td class="colLast"> -<div class="block">Support for validating <em>credentials</em> (such as passwords or X509 certificates) during - authentication via the <a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html" title="interface in org.apache.shiro.authc.credential"><code>CredentialsMatcher</code></a> - interface and its supporting implementations.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.authc.pam">org.apache.shiro.authc.pam</a></td> -<td class="colLast"> -<div class="block">Support for <em>PAM</em>, or <b>P</b>luggable <b>A</b>uthentication <b>M</b>odules, which is - the capability to authenticate a user against multiple configurable (pluggable) <em>modules</em> (Shiro - calls these <a href="../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s).</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.cas">org.apache.shiro.cas</a></td> -<td class="colLast"> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.mgt">org.apache.shiro.mgt</a></td> -<td class="colLast"> -<div class="block">Provides the master <a href="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> interface and a default implementation - hierarchy for managing all aspects of Shiro's functionality in an application.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm">org.apache.shiro.realm</a></td> -<td class="colLast"> -<div class="block">Components and sub-packages used in supporting the core <a href="../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a> interface.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.activedirectory">org.apache.shiro.realm.activedirectory</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from a Microsoft Active Directory.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.jdbc">org.apache.shiro.realm.jdbc</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from an RDBMS (Relational Database Management System) using the - JDBC API.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.ldap">org.apache.shiro.realm.ldap</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from an LDAP (Lightweight Directory Access Protocol) server - utilizing LDAP/Naming APIs.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.realm.text">org.apache.shiro.realm.text</a></td> -<td class="colLast"> -<div class="block">Realms that acquire security data from text-based data sources such as <code>File</code>s or - text streams.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.subject">org.apache.shiro.subject</a></td> -<td class="colLast"> -<div class="block">Components supporting the <a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> interface, the most important concept in - Shiro's API.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.subject.support">org.apache.shiro.subject.support</a></td> -<td class="colLast"> -<div class="block">Concrete support implementations of most of the <code>org.apache.shiro.subject</code> interfaces.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="#org.apache.shiro.web.filter.authc">org.apache.shiro.web.filter.authc</a></td> -<td class="colLast"> -<div class="block">Servlet <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true"; title="class or interface in javax.servlet"><code>Filter</code></a> implementations specific to controlling access based on a - subject's authentication status, or those that can execute authentications (log-ins) directly.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.shiro.web.mgt">org.apache.shiro.web.mgt</a></td> -<td class="colLast"> -<div class="block">Components supporting web-specific - <a href="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> implementations.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.authc"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/Account.html#org.apache.shiro.authc">Account</a> -<div class="block">An <tt>Account</tt> is a convenience interface that extends both <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> and - <a href="../../../../org/apache/shiro/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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AccountException.html#org.apache.shiro.authc">AccountException</a> -<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="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.authc">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.authc">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationListener.html#org.apache.shiro.authc">AuthenticationListener</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.authc">AuthenticationToken</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/Authenticator.html#org.apache.shiro.authc">Authenticator</a> -<div class="block">An Authenticator is responsible for authenticating accounts in an application.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/CredentialsException.html#org.apache.shiro.authc">CredentialsException</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/DisabledAccountException.html#org.apache.shiro.authc">DisabledAccountException</a> -<div class="block">Thrown when attempting to authenticate and the corresponding account has been disabled for - some reason.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/HostAuthenticationToken.html#org.apache.shiro.authc">HostAuthenticationToken</a> -<div class="block">A <code>HostAuthenticationToken</code> retains the host information from where - an authentication attempt originates.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.authc">LogoutAware</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/MergableAuthenticationInfo.html#org.apache.shiro.authc">MergableAuthenticationInfo</a> -<div class="block">An extension of the <a href="../../../../org/apache/shiro/authc/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="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> instances.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/RememberMeAuthenticationToken.html#org.apache.shiro.authc">RememberMeAuthenticationToken</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/SaltedAuthenticationInfo.html#org.apache.shiro.authc">SaltedAuthenticationInfo</a> -<div class="block">Interface representing account information that may use a salt when hashing credentials.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.authc.credential"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/authc/credential/package-summary.html">org.apache.shiro.authc.credential</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.authc.credential">AuthenticationInfo</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.authc.credential">AuthenticationToken</a> -<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> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.authc.pam"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/authc/pam/package-summary.html">org.apache.shiro.authc.pam</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AbstractAuthenticator.html#org.apache.shiro.authc.pam">AbstractAuthenticator</a> -<div class="block">Superclass for almost all <a href="../../../../org/apache/shiro/authc/Authenticator.html" title="interface in org.apache.shiro.authc"><code>Authenticator</code></a> implementations that performs the common work around authentication - attempts.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.authc.pam">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.authc.pam">AuthenticationInfo</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.authc.pam">AuthenticationToken</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/Authenticator.html#org.apache.shiro.authc.pam">Authenticator</a> -<div class="block">An Authenticator is responsible for authenticating accounts in an application.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.authc.pam">LogoutAware</a> -<div class="block">An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.cas"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/cas/package-summary.html">org.apache.shiro.cas</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.cas">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.cas">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.cas">AuthenticationToken</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.cas">LogoutAware</a> -<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="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/RememberMeAuthenticationToken.html#org.apache.shiro.cas">RememberMeAuthenticationToken</a> -<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> -</li> -<li class="blockList"><a name="org.apache.shiro.mgt"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/mgt/package-summary.html">org.apache.shiro.mgt</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.mgt">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.mgt">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.mgt">AuthenticationToken</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/Authenticator.html#org.apache.shiro.mgt">Authenticator</a> -<div class="block">An Authenticator is responsible for authenticating accounts in an application.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/realm/package-summary.html">org.apache.shiro.realm</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.realm">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.realm">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.realm">AuthenticationToken</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.realm">LogoutAware</a> -<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="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/SimpleAccount.html#org.apache.shiro.realm">SimpleAccount</a> -<div class="block">Simple implementation of the <a href="../../../../org/apache/shiro/authc/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> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.activedirectory"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/realm/activedirectory/package-summary.html">org.apache.shiro.realm.activedirectory</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.realm.activedirectory">AuthenticationInfo</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.realm.activedirectory">AuthenticationToken</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.realm.activedirectory">LogoutAware</a> -<div class="block">An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.jdbc"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/realm/jdbc/package-summary.html">org.apache.shiro.realm.jdbc</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.realm.jdbc">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.realm.jdbc">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.realm.jdbc">AuthenticationToken</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.realm.jdbc">LogoutAware</a> -<div class="block">An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.ldap"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/realm/ldap/package-summary.html">org.apache.shiro.realm.ldap</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.realm.ldap">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.realm.ldap">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.realm.ldap">AuthenticationToken</a> -<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="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.realm.ldap">LogoutAware</a> -<div class="block">An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.realm.text"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/realm/text/package-summary.html">org.apache.shiro.realm.text</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/LogoutAware.html#org.apache.shiro.realm.text">LogoutAware</a> -<div class="block">An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.subject"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/subject/package-summary.html">org.apache.shiro.subject</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.subject">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.subject">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.subject">AuthenticationToken</a> -<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> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.subject.support"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/subject/support/package-summary.html">org.apache.shiro.subject.support</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.subject.support">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationInfo.html#org.apache.shiro.subject.support">AuthenticationInfo</a> -<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"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.subject.support">AuthenticationToken</a> -<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> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.web.filter.authc"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/web/filter/authc/package-summary.html">org.apache.shiro.web.filter.authc</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationException.html#org.apache.shiro.web.filter.authc">AuthenticationException</a> -<div class="block">General exception thrown due to an error during the Authentication process.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/AuthenticationToken.html#org.apache.shiro.web.filter.authc">AuthenticationToken</a> -<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> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.shiro.web.mgt"> -<!-- --> -</a> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a> used by <a href="../../../../org/apache/shiro/web/mgt/package-summary.html">org.apache.shiro.web.mgt</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../org/apache/shiro/authc/class-use/Authenticator.html#org.apache.shiro.web.mgt">Authenticator</a> -<div class="block">An Authenticator is responsible for authenticating accounts in an application.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li>Class</li> -<li class="navBarCell1Rev">Use</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/shiro/authc/package-use.html" target="_top">Frames</a></li> -<li><a href="package-use.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/shiro-site/blob/5896aacc/static/1.2.1/apidocs/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html ---------------------------------------------------------------------- diff --git a/static/1.2.1/apidocs/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html b/static/1.2.1/apidocs/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html deleted file mode 100644 index 220785b..0000000 --- a/static/1.2.1/apidocs/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html +++ /dev/null @@ -1,406 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:23 PDT 2013 --> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>AbstractAuthenticationStrategy (Apache Shiro 1.2.1 API)</title> -<meta name="date" content="2013-05-30"> -<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="AbstractAuthenticationStrategy (Apache Shiro 1.2.1 API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- Begin Google Analytics code --> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-11551827-1']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <!-- End Google Analytics code --> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/AbstractAuthenticationStrategy.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../org/apache/shiro/authc/pam/AllSuccessfulStrategy.html" title="class in org.apache.shiro.authc.pam"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html" target="_top">Frames</a></li> -<li><a href="AbstractAuthenticationStrategy.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.shiro.authc.pam</div> -<h2 title="Class AbstractAuthenticationStrategy" class="title">Class AbstractAuthenticationStrategy</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.shiro.authc.pam.AbstractAuthenticationStrategy</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam">AuthenticationStrategy</a></dd> -</dl> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../../../org/apache/shiro/authc/pam/AllSuccessfulStrategy.html" title="class in org.apache.shiro.authc.pam">AllSuccessfulStrategy</a>, <a href="../../../../../org/apache/shiro/authc/pam/AtLeastOneSuccessfulStrategy.html" title="class in org.apache.shiro.authc.pam">AtLeastOneSuccessfulStrategy</a>, <a href="../../../../../org/apache/shiro/authc/pam/FirstSuccessfulStrategy.html" title="class in org.apache.shiro.authc.pam">FirstSuccessfulStrategy</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.33">AbstractAuthenticationStrategy</a> -extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> -implements <a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam">AuthenticationStrategy</a></pre> -<div class="block">Abstract base implementation for Shiro's concrete <code>AuthenticationStrategy</code> - implementations.</div> -<dl><dt><span class="strong">Since:</span></dt> - <dd>0.9</dd></dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#AbstractAuthenticationStrategy()">AbstractAuthenticationStrategy</a></strong>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Simply returns the <code>aggregate</code> argument without modification.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#afterAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo, java.lang.Throwable)">afterAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> singleRealmInfo, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregateInfo, - <a href="http://java.sun.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t)</code> -<div class="block">Base implementation that will aggregate the specified <code>singleRealmInfo</code> into the - <code>aggregateInfo</code> and then returns the aggregate.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#beforeAllAttempts(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> -<div class="block">Simply returns <code>new <a href="../../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html" title="class in org.apache.shiro.authc"><code>SimpleAuthenticationInfo</code></a>();</code>, which supports - aggregating account data across realms.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></strong>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Simply returns the <code>aggregate</code> method argument, without modification.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#merge(org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo)">merge</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</code> -<div class="block">Merges the specified <code>info</code> argument into the <code>aggregate</code> argument and then returns an - aggregate for continued use throughout the login process.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-exter nal=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="AbstractAuthenticationStrategy()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>AbstractAuthenticationStrategy</h4> -<pre>public <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.33">AbstractAuthenticationStrategy</a>()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="beforeAllAttempts(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>beforeAllAttempts</h4> -<pre>public <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.39">beforeAllAttempts</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token) - throws <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> -<div class="block">Simply returns <code>new <a href="../../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html" title="class in org.apache.shiro.authc"><code>SimpleAuthenticationInfo</code></a>();</code>, which supports - aggregating account data across realms.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#beforeAllAttempts(java.util.Collection, org.apache.shiro.authc.AuthenticationToken)">beforeAllAttempts</a></code> in interface <code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam">AuthenticationStrategy</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>realms</code> - the Realms that will be consulted during the authentication process for the specified token.</dd><dd><code>token</code> - the Principal/Credential representation to be used during authentication for a corresponding subject.</dd> -<dt><span class="strong">Returns:</span></dt><dd>an empty AuthenticationInfo object that will populated with data from multiple realms.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - if the strategy implementation does not wish the Authentication attempt to execute.</dd></dl> -</li> -</ul> -<a name="beforeAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>beforeAttempt</h4> -<pre>public <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.46">beforeAttempt</a>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate) - throws <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> -<div class="block">Simply returns the <code>aggregate</code> method argument, without modification.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#beforeAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">beforeAttempt</a></code> in interface <code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam">AuthenticationStrategy</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>realm</code> - the realm that will be consulted for <code>AuthenticationInfo</code> for the specified <code>token</code>.</dd><dd><code>token</code> - the <code>AuthenticationToken</code> submitted for the subject attempting system log-in.</dd><dd><code>aggregate</code> - the aggregated AuthenticationInfo object being used across the multi-realm authentication attempt</dd> -<dt><span class="strong">Returns:</span></dt><dd>the AuthenticationInfo object that will be presented to further realms in the authentication process - returning - the <code>aggregate</code> method argument is the normal case if no special action needs to be taken.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - an exception thrown by the Strategy implementation if it wishes the login - process for the associated subject (user) to stop immediately.</dd></dl> -</li> -</ul> -<a name="afterAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo, java.lang.Throwable)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>afterAttempt</h4> -<pre>public <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.54">afterAttempt</a>(<a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm, - <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> singleRealmInfo, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregateInfo, - <a href="http://java.sun.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t) - throws <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> -<div class="block">Base implementation that will aggregate the specified <code>singleRealmInfo</code> into the - <code>aggregateInfo</code> and then returns the aggregate. Can be overridden by subclasses for custom behavior.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#afterAttempt(org.apache.shiro.realm.Realm, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo, java.lang.Throwable)">afterAttempt</a></code> in interface <code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam">AuthenticationStrategy</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>realm</code> - the realm that was just consulted for <code>AuthenticationInfo</code> for the given <code>token</code>.</dd><dd><code>token</code> - the <code>AuthenticationToken</code> submitted for the subject attempting system log-in.</dd><dd><code>singleRealmInfo</code> - the info returned from a single realm.</dd><dd><code>aggregateInfo</code> - the aggregate info representing all realms in a multi-realm environment.</dd><dd><code>t</code> - the Throwable thrown by the Realm during the attempt, or <code>null</code> if the method returned normally.</dd> -<dt><span class="strong">Returns:</span></dt><dd>the AuthenticationInfo object that will be presented to further realms in the authentication process - returning - the <code>aggregateAccount</code> method argument is the normal case if no special action needs to be taken.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - an exception thrown by the Strategy implementation if it wishes the login process - for the associated subject (user) to stop immediately.</dd></dl> -</li> -</ul> -<a name="merge(org.apache.shiro.authc.AuthenticationInfo, org.apache.shiro.authc.AuthenticationInfo)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>merge</h4> -<pre>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.80">merge</a>(<a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate)</pre> -<div class="block">Merges the specified <code>info</code> argument into the <code>aggregate</code> argument and then returns an - aggregate for continued use throughout the login process. - <p/> - This implementation merely checks to see if the specified <code>aggregate</code> argument is an instance of - <a href="../../../../../org/apache/shiro/authc/MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>MergableAuthenticationInfo</code></a>, and if so, calls - <code>aggregate.merge(info)</code> If it is <em>not</em> an instance of - <code>MergableAuthenticationInfo</code>, an <a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang"><code>IllegalArgumentException</code></a> is thrown. - Can be overridden by subclasses for custom merging behavior if implementing the - <a href="../../../../../org/apache/shiro/authc/MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>MergableAuthenticationInfo</code></a> is not desired for some reason.</div> -</li> -</ul> -<a name="afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>afterAllAttempts</h4> -<pre>public <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../../src-html/org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#line.93">afterAllAttempts</a>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, - <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> aggregate) - throws <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> -<div class="block">Simply returns the <code>aggregate</code> argument without modification. Can be overridden for custom behavior.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">afterAllAttempts</a></code> in interface <code><a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html" title="interface in org.apache.shiro.authc.pam">AuthenticationStrategy</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the <code>AuthenticationToken</code> submitted for the subject attempting system log-in.</dd><dd><code>aggregate</code> - the aggregate <code>AuthenticationInfo</code> instance populated by all realms during the log-in attempt.</dd> -<dt><span class="strong">Returns:</span></dt><dd>the final <code>AuthenticationInfo</code> object to return to the Authenticator.authenticate() caller.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - if the Strategy implementation wishes to fail the authentication attempt.</dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/AbstractAuthenticationStrategy.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../org/apache/shiro/authc/pam/AllSuccessfulStrategy.html" title="class in org.apache.shiro.authc.pam"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html" target="_top">Frames</a></li> -<li><a href="AbstractAuthenticationStrategy.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> -</body> -</html>
