blob: 82c0b77728dc22ca097a24ffb2d05875724e23f4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_201) on Sat Feb 22 18:53:56 CET 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.shiro.web.filter.authc (Apache Shiro :: Web 1.5.1 API)</title>
<meta name="date" content="2020-02-22">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.shiro.web.filter.authc (Apache Shiro :: Web 1.5.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/shiro/web/filter/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/shiro/web/filter/authz/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/shiro/web/filter/authc/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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="Package" class="title">Package&nbsp;org.apache.shiro.web.filter.authc</h1>
<div class="docSummary">
<div class="block">Servlet <a href="https://docs.oracle.com/javaee/5/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>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/AnonymousFilter.html" title="class in org.apache.shiro.web.filter.authc">AnonymousFilter</a></td>
<td class="colLast">
<div class="block">Filter that allows access to a path immeidately without performing security checks of any kind.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></td>
<td class="colLast">
<div class="block">An <code>AuthenticationFilter</code> that is capable of automatically performing an authentication attempt
based on the incoming request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticationFilter</a></td>
<td class="colLast">
<div class="block">Base class for all Filters that require the current user to be authenticated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">BasicHttpAuthenticationFilter</a></td>
<td class="colLast">
<div class="block">Requires the requesting user to be <code>authenticated</code> for the
request to continue, and if they're not, requires the user to login via the HTTP Basic protocol-specific challenge.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/BearerHttpAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">BearerHttpAuthenticationFilter</a></td>
<td class="colLast">
<div class="block">Requires the requesting user to be <code>authenticated</code> for the
request to continue, and if they're not, requires the user to login via the HTTP Bearer protocol-specific challenge.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">FormAuthenticationFilter</a></td>
<td class="colLast">
<div class="block">Requires the requesting user to be authenticated for the request to continue, and if they are not, forces the user
to login via by redirecting them to the <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setLoginUrl-java.lang.String-"><code>loginUrl</code></a> you configure.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/LogoutFilter.html" title="class in org.apache.shiro.web.filter.authc">LogoutFilter</a></td>
<td class="colLast">
<div class="block">Simple Filter that, upon receiving a request, will immediately log-out the currently executing
<a href="../../../../../../org/apache/shiro/web/filter/authc/LogoutFilter.html#getSubject-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>subject</code></a>
and then redirect them to a configured <a href="../../../../../../org/apache/shiro/web/filter/authc/LogoutFilter.html#getRedirectUrl--"><code>redirectUrl</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/PassThruAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">PassThruAuthenticationFilter</a></td>
<td class="colLast">
<div class="block">An authentication filter that redirects the user to the login page when they are trying to access
a protected resource.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/shiro/web/filter/authc/UserFilter.html" title="class in org.apache.shiro.web.filter.authc">UserFilter</a></td>
<td class="colLast">
<div class="block">Filter that allows access to resources if the accessor is a known user, which is defined as
having a known principal.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.shiro.web.filter.authc Description">Package org.apache.shiro.web.filter.authc Description</h2>
<div class="block">Servlet <a href="https://docs.oracle.com/javaee/5/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>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/shiro/web/filter/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/shiro/web/filter/authz/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/shiro/web/filter/authc/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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 &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>