http://git-wip-us.apache.org/repos/asf/shiro-site/blob/5896aacc/static/1.2.1/apidocs/deprecated-list.html ---------------------------------------------------------------------- diff --git a/static/1.2.1/apidocs/deprecated-list.html b/static/1.2.1/apidocs/deprecated-list.html deleted file mode 100644 index 4bfe7a1..0000000 --- a/static/1.2.1/apidocs/deprecated-list.html +++ /dev/null @@ -1,335 +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:33 PDT 2013 --> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>Deprecated List (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="Deprecated List (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>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li class="navBarCell1Rev">Deprecated</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?deprecated-list.html" target="_top">Frames</a></li> -<li><a href="deprecated-list.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="Deprecated API" class="title">Deprecated API</h1> -<h2 title="Contents">Contents</h2> -<ul> -<li><a href="#class">Deprecated Classes</a></li> -<li><a href="#field">Deprecated Fields</a></li> -<li><a href="#method">Deprecated Methods</a></li> -</ul> -</div> -<div class="contentContainer"><a name="class"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<table border="0" cellpadding="3" cellspacing="0" summary="Deprecated Classes table, listing deprecated classes, and an explanation"> -<caption><span>Deprecated Classes</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/crypto/hash/AbstractHash.html" title="class in org.apache.shiro.crypto.hash">org.apache.shiro.crypto.hash.AbstractHash</a> -<div class="block"><i>in Shiro 1.1 in favor of using the concrete <a href="org/apache/shiro/crypto/hash/SimpleHash.html" title="class in org.apache.shiro.crypto.hash"><code>SimpleHash</code></a> implementation directly.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap">org.apache.shiro.realm.ldap.DefaultLdapContextFactory</a> -<div class="block"><i>replaced by the <a href="org/apache/shiro/realm/ldap/JndiLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap"><code>JndiLdapContextFactory</code></a> implementation. This implementation will be removed - prior to Shiro 2.0</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/web/servlet/IniShiroFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.IniShiroFilter</a> -<div class="block"><i>in 1.2 in favor of using the <a href="org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a></i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/Md2CredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">org.apache.shiro.authc.credential.Md2CredentialsMatcher</a> -<div class="block"><i>since 1.1 - use the HashedCredentialsMatcher directly and set its - <a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashAlgorithmName(java.lang.String)"><code>hashAlgorithmName</code></a> property.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/Md5CredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">org.apache.shiro.authc.credential.Md5CredentialsMatcher</a> -<div class="block"><i>since 1.1 - use the HashedCredentialsMatcher directly and set its - <a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashAlgorithmName(java.lang.String)"><code>hashAlgorithmName</code></a> property.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/Sha1CredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">org.apache.shiro.authc.credential.Sha1CredentialsMatcher</a> -<div class="block"><i>since 1.1 - use the HashedCredentialsMatcher directly and set its - <a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashAlgorithmName(java.lang.String)"><code>hashAlgorithmName</code></a> property.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/Sha256CredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">org.apache.shiro.authc.credential.Sha256CredentialsMatcher</a> -<div class="block"><i>since 1.1 - use the HashedCredentialsMatcher directly and set its - <a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashAlgorithmName(java.lang.String)"><code>hashAlgorithmName</code></a> property.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/Sha384CredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">org.apache.shiro.authc.credential.Sha384CredentialsMatcher</a> -<div class="block"><i>since 1.1 - use the HashedCredentialsMatcher directly and set its - <a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashAlgorithmName(java.lang.String)"><code>hashAlgorithmName</code></a> property.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/Sha512CredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">org.apache.shiro.authc.credential.Sha512CredentialsMatcher</a> -<div class="block"><i>since 1.1 - use the HashedCredentialsMatcher directly and set its - <a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashAlgorithmName(java.lang.String)"><code>hashAlgorithmName</code></a> property.</i></div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -<a name="field"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<table border="0" cellpadding="3" cellspacing="0" summary="Deprecated Fields table, listing deprecated fields, and an explanation"> -<caption><span>Deprecated Fields</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Field and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/web/mgt/DefaultWebSecurityManager.html#HTTP_SESSION_MODE">org.apache.shiro.web.mgt.DefaultWebSecurityManager.HTTP_SESSION_MODE</a></td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/web/mgt/DefaultWebSecurityManager.html#NATIVE_SESSION_MODE">org.apache.shiro.web.mgt.DefaultWebSecurityManager.NATIVE_SESSION_MODE</a></td> -</tr> -</tbody> -</table> -</li> -</ul> -<a name="method"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<table border="0" cellpadding="3" cellspacing="0" summary="Deprecated Methods table, listing deprecated methods, and an explanation"> -<caption><span>Deprecated Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/mgt/DefaultSecurityManager.html#bind(org.apache.shiro.subject.Subject)">org.apache.shiro.mgt.DefaultSecurityManager.bind(Subject)</a> -<div class="block"><i>in favor of <a href="org/apache/shiro/mgt/DefaultSecurityManager.html#save(org.apache.shiro.subject.Subject)"><code>save(subject)</code></a>.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/realm/ldap/LdapContextFactory.html#getLdapContext(java.lang.String, java.lang.String)">org.apache.shiro.realm.ldap.LdapContextFactory.getLdapContext(String, String)</a> -<div class="block"><i>the <a href="org/apache/shiro/realm/ldap/LdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)"><code>LdapContextFactory.getLdapContext(Object, Object)</code></a> method should be used in all cases to ensure more than - String principals and credentials can be used.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/realm/ldap/JndiLdapContextFactory.html#getLdapContext(java.lang.String, java.lang.String)">org.apache.shiro.realm.ldap.JndiLdapContextFactory.getLdapContext(String, String)</a> -<div class="block"><i>the <a href="org/apache/shiro/realm/ldap/JndiLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)"><code>JndiLdapContextFactory.getLdapContext(Object, Object)</code></a> method should be used in all cases to ensure more than - String principals and credentials can be used. Shiro no longer calls this method - it will be - removed before the 2.0 release.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.String, java.lang.String)">org.apache.shiro.realm.ldap.DefaultLdapContextFactory.getLdapContext(String, String)</a> -<div class="block"><i>the <a href="org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)"><code>DefaultLdapContextFactory.getLdapContext(Object, Object)</code></a> method should be used in all cases to ensure more than - String principals and credentials can be used. Shiro no longer calls this method - it will be - removed before the 2.0 release.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#getSalt(org.apache.shiro.authc.AuthenticationToken)">org.apache.shiro.authc.credential.HashedCredentialsMatcher.getSalt(AuthenticationToken)</a> -<div class="block"><i>since Shiro 1.1. Hash salting is now expected to be based on if the <a href="org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> - returned from the <code>Realm</code> is a <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> instance and its - <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html#getCredentialsSalt()"><code>getCredentialsSalt()</code></a> method returns a non-null value. - This method and the 1.0 behavior still exists for backwards compatibility if the <code>Realm</code> does not return - <code>SaltedAuthenticationInfo</code> instances, but <b>it is highly recommended that <code>Realm</code> implementations - that support hashed credentials start returning <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> - instances as soon as possible</b>.<p/> - This is because salts should always be obtained from the stored account information and - never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for - attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user - are almost impossible to break. This method will be removed in Shiro 2.0.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/web/mgt/DefaultWebSecurityManager.html#getSessionMode()">org.apache.shiro.web.mgt.DefaultWebSecurityManager.getSessionMode()</a></td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#isHashSalted()">org.apache.shiro.authc.credential.HashedCredentialsMatcher.isHashSalted()</a> -<div class="block"><i>since Shiro 1.1. Hash salting is now expected to be based on if the <a href="org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> - returned from the <code>Realm</code> is a <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> instance and its - <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html#getCredentialsSalt()"><code>getCredentialsSalt()</code></a> method returns a non-null value. - This method and the 1.0 behavior still exists for backwards compatibility if the <code>Realm</code> does not return - <code>SaltedAuthenticationInfo</code> instances, but <b>it is highly recommended that <code>Realm</code> implementations - that support hashed credentials start returning <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> - instances as soon as possible</b>. - <p/> - This is because salts should always be obtained from the stored account information and - never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for - attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user - are almost impossible to break. This method will be removed in Shiro 2.0.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/mgt/DefaultSubjectFactory.html#newSubjectInstance(org.apache.shiro.subject.PrincipalCollection, boolean, java.lang.String, org.apache.shiro.session.Session, org.apache.shiro.mgt.SecurityManager)">org.apache.shiro.mgt.DefaultSubjectFactory.newSubjectInstance(PrincipalCollection, boolean, String, Session, SecurityManager)</a> -<div class="block"><i>since 1.2 - override <a href="org/apache/shiro/mgt/DefaultSubjectFactory.html#createSubject(org.apache.shiro.subject.SubjectContext)"><code>DefaultSubjectFactory.createSubject(org.apache.shiro.subject.SubjectContext)</code></a> directly if you - need to instantiate a custom <a href="org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> class.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/web/mgt/DefaultWebSubjectFactory.html#newSubjectInstance(org.apache.shiro.subject.PrincipalCollection, boolean, java.lang.String, org.apache.shiro.session.Session, javax.servlet.ServletRequest, javax.servlet.ServletResponse, org.apache.shiro.mgt.SecurityManager)">org.apache.shiro.web.mgt.DefaultWebSubjectFactory.newSubjectInstance(PrincipalCollection, boolean, String, Session, ServletRequest, ServletResponse, SecurityManager)</a> -<div class="block"><i>since 1.2 - override <a href="org/apache/shiro/web/mgt/DefaultWebSubjectFactory.html#createSubject(org.apache.shiro.subject.SubjectContext)"><code>DefaultWebSubjectFactory.createSubject(org.apache.shiro.subject.SubjectContext)</code></a> directly if you - need to instantiate a custom <a href="org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> class.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/authc/credential/HashedCredentialsMatcher.html#setHashSalted(boolean)">org.apache.shiro.authc.credential.HashedCredentialsMatcher.setHashSalted(boolean)</a> -<div class="block"><i>since Shiro 1.1. Hash salting is now expected to be based on if the <a href="org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> - returned from the <code>Realm</code> is a <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> instance and its - <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html#getCredentialsSalt()"><code>getCredentialsSalt()</code></a> method returns a non-null value. - This method and the 1.0 behavior still exists for backwards compatibility if the <code>Realm</code> does not return - <code>SaltedAuthenticationInfo</code> instances, but <b>it is highly recommended that <code>Realm</code> implementations - that support hashed credentials start returning <a href="org/apache/shiro/authc/SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>SaltedAuthenticationInfo</code></a> - instances as soon as possible</b>. - <p/> - This is because salts should always be obtained from the stored account information and - never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for - attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user - are almost impossible to break. This method will be removed in Shiro 2.0.</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSearchBase(java.lang.String)">org.apache.shiro.realm.ldap.DefaultLdapContextFactory.setSearchBase(String)</a> -<div class="block"><i>this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/web/mgt/DefaultWebSecurityManager.html#setSessionMode(java.lang.String)">org.apache.shiro.web.mgt.DefaultWebSecurityManager.setSessionMode(String)</a> -<div class="block"><i>since 1.2</i></div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><a href="org/apache/shiro/web/servlet/OncePerRequestFilter.html#shouldNotFilter(javax.servlet.ServletRequest)">org.apache.shiro.web.servlet.OncePerRequestFilter.shouldNotFilter(ServletRequest)</a> -<div class="block"><i>in favor of overriding <a href="org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>OncePerRequestFilter.isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</code></a> - for custom behavior. This method will be removed in Shiro 2.0.</i></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><a href="org/apache/shiro/mgt/DefaultSecurityManager.html#unbind(org.apache.shiro.subject.Subject)">org.apache.shiro.mgt.DefaultSecurityManager.unbind(Subject)</a> -<div class="block"><i>in Shiro 1.2 in favor of <a href="org/apache/shiro/mgt/DefaultSecurityManager.html#delete(org.apache.shiro.subject.Subject)"><code>DefaultSecurityManager.delete(org.apache.shiro.subject.Subject)</code></a></i></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>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li class="navBarCell1Rev">Deprecated</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?deprecated-list.html" target="_top">Frames</a></li> -<li><a href="deprecated-list.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/help-doc.html ---------------------------------------------------------------------- diff --git a/static/1.2.1/apidocs/help-doc.html b/static/1.2.1/apidocs/help-doc.html deleted file mode 100644 index ea20d99..0000000 --- a/static/1.2.1/apidocs/help-doc.html +++ /dev/null @@ -1,223 +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:34 PDT 2013 --> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>API Help (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="API Help (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>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li><a href="deprecated-list.html">Deprecated</a></li> -<li><a href="index-all.html">Index</a></li> -<li class="navBarCell1Rev">Help</li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> -<li><a href="help-doc.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 class="title">How This API Document Is Organized</h1> -<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<h2>Overview</h2> -<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p> -</li> -<li class="blockList"> -<h2>Package</h2> -<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p> -<ul> -<li>Interfaces (italic)</li> -<li>Classes</li> -<li>Enums</li> -<li>Exceptions</li> -<li>Errors</li> -<li>Annotation Types</li> -</ul> -</li> -<li class="blockList"> -<h2>Class/Interface</h2> -<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p> -<ul> -<li>Class inheritance diagram</li> -<li>Direct Subclasses</li> -<li>All Known Subinterfaces</li> -<li>All Known Implementing Classes</li> -<li>Class/interface declaration</li> -<li>Class/interface description</li> -</ul> -<ul> -<li>Nested Class Summary</li> -<li>Field Summary</li> -<li>Constructor Summary</li> -<li>Method Summary</li> -</ul> -<ul> -<li>Field Detail</li> -<li>Constructor Detail</li> -<li>Method Detail</li> -</ul> -<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> -</li> -<li class="blockList"> -<h2>Annotation Type</h2> -<p>Each annotation type has its own separate page with the following sections:</p> -<ul> -<li>Annotation Type declaration</li> -<li>Annotation Type description</li> -<li>Required Element Summary</li> -<li>Optional Element Summary</li> -<li>Element Detail</li> -</ul> -</li> -<li class="blockList"> -<h2>Enum</h2> -<p>Each enum has its own separate page with the following sections:</p> -<ul> -<li>Enum declaration</li> -<li>Enum description</li> -<li>Enum Constant Summary</li> -<li>Enum Constant Detail</li> -</ul> -</li> -<li class="blockList"> -<h2>Use</h2> -<p>Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</p> -</li> -<li class="blockList"> -<h2>Tree (Class Hierarchy)</h2> -<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p> -<ul> -<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> -<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> -</ul> -</li> -<li class="blockList"> -<h2>Deprecated API</h2> -<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> -</li> -<li class="blockList"> -<h2>Index</h2> -<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> -</li> -<li class="blockList"> -<h2>Prev/Next</h2> -<p>These links take you to the next or previous class, interface, package, or related page.</p> -</li> -<li class="blockList"> -<h2>Frames/No Frames</h2> -<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> -</li> -<li class="blockList"> -<h2>All Classes</h2> -<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> -</li> -<li class="blockList"> -<h2>Serialized Form</h2> -<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p> -</li> -<li class="blockList"> -<h2>Constant Field Values</h2> -<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> -</li> -</ul> -<em>This help file applies to API documentation generated using the standard doclet.</em></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>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li><a href="deprecated-list.html">Deprecated</a></li> -<li><a href="index-all.html">Index</a></li> -<li class="navBarCell1Rev">Help</li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> -<li><a href="help-doc.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>
