Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.1 / apidocs / org / apache / shiro / web / filter / authc / FormAuthenticationFilter.html
blob: 96de24cdaebf0660280e09e5e7c2497cd708062a [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 Wed May 01 07:16:45 RET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FormAuthenticationFilter (Apache Shiro 1.4.1 API)</title>
<meta name="date" content="2019-05-01">
<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="FormAuthenticationFilter (Apache Shiro 1.4.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FormAuthenticationFilter.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/authc/BasicHttpAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/shiro/web/filter/authc/LogoutFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html" target="_top">Frames</a></li>
<li><a href="FormAuthenticationFilter.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.web.filter.authc</div>
<h2 title="Class FormAuthenticationFilter" class="title">Class FormAuthenticationFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.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><a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.ServletContextSupport</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.NameableFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.OncePerRequestFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AdviceFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">org.apache.shiro.web.filter.PathMatchingFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">org.apache.shiro.web.filter.AccessControlFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">org.apache.shiro.web.filter.authc.AuthenticationFilter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">org.apache.shiro.web.filter.authc.AuthenticatingFilter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.web.filter.authc.FormAuthenticationFilter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>javax.servlet.Filter, <a href="../../../../../../org/apache/shiro/util/Nameable.html" title="interface in org.apache.shiro.util">Nameable</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathConfigProcessor.html" title="interface in org.apache.shiro.web.filter">PathConfigProcessor</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.59">FormAuthenticationFilter</a>
extends <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></pre>
<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.
<p/>
<p>This filter constructs a <a href="../../../../../../org/apache/shiro/authc/UsernamePasswordToken.html" title="class in org.apache.shiro.authc"><code>UsernamePasswordToken</code></a> with the values found in
<a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setUsernameParam-java.lang.String-"><code>username</code></a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setPasswordParam-java.lang.String-"><code>password</code></a>,
and <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setRememberMeParam-java.lang.String-"><code>rememberMe</code></a> request parameters. It then calls
<a href="../../../../../../org/apache/shiro/subject/Subject.html#login-org.apache.shiro.authc.AuthenticationToken-"><code>Subject.login(usernamePasswordToken)</code></a>,
effectively automatically performing a login attempt. Note that the login attempt will only occur when the
<a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#isLoginSubmission-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>isLoginSubmission(request,response)</code></a>
is <code>true</code>, which by default occurs when the request is for the <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setLoginUrl-java.lang.String-"><code>loginUrl</code></a> and
is a POST request.
<p/>
<p>If the login attempt fails, the resulting <code>AuthenticationException</code> fully qualified class name will
be set as a request attribute under the <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setFailureKeyAttribute-java.lang.String-"><code>failureKeyAttribute</code></a> key. This
FQCN can be used as an i18n key or lookup mechanism to explain to the user why their login attempt failed
(e.g. no account, incorrect password, etc).
<p/>
<p>If you would prefer to handle the authentication validation and login in your own code, consider using the
<a href="../../../../../../org/apache/shiro/web/filter/authc/PassThruAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><code>PassThruAuthenticationFilter</code></a> instead, which allows requests to the
<a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#loginUrl"><code>AccessControlFilter.loginUrl</code></a> to pass through to your application's code directly.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.9</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/shiro/web/filter/authc/PassThruAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><code>PassThruAuthenticationFilter</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#DEFAULT_ERROR_KEY_ATTRIBUTE_NAME">DEFAULT_ERROR_KEY_ATTRIBUTE_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#DEFAULT_PASSWORD_PARAM">DEFAULT_PASSWORD_PARAM</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#DEFAULT_REMEMBER_ME_PARAM">DEFAULT_REMEMBER_ME_PARAM</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#DEFAULT_USERNAME_PARAM">DEFAULT_USERNAME_PARAM</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticatingFilter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.web.filter.authc.<a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#PERMISSIVE">PERMISSIVE</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticationFilter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.web.filter.authc.<a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticationFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#DEFAULT_SUCCESS_URL">DEFAULT_SUCCESS_URL</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.AccessControlFilter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.web.filter.<a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#DEFAULT_LOGIN_URL">DEFAULT_LOGIN_URL</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#GET_METHOD">GET_METHOD</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#POST_METHOD">POST_METHOD</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.PathMatchingFilter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.web.filter.<a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">PathMatchingFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#appliedPaths">appliedPaths</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#pathMatcher">pathMatcher</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.servlet.OncePerRequestFilter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#ALREADY_FILTERED_SUFFIX">ALREADY_FILTERED_SUFFIX</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.servlet.AbstractFilter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#filterConfig">filterConfig</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#FormAuthenticationFilter--">FormAuthenticationFilter</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#createToken-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">createToken</a></span>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#getFailureKeyAttribute--">getFailureKeyAttribute</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#getPassword-javax.servlet.ServletRequest-">getPassword</a></span>(javax.servlet.ServletRequest&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#getPasswordParam--">getPasswordParam</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#getRememberMeParam--">getRememberMeParam</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#getUsername-javax.servlet.ServletRequest-">getUsername</a></span>(javax.servlet.ServletRequest&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#getUsernameParam--">getUsernameParam</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#isLoginSubmission-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">isLoginSubmission</a></span>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</code>
<div class="block">This default implementation merely returns <code>true</code> if the request is an HTTP <code>POST</code>,
<code>false</code> otherwise.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#isRememberMe-javax.servlet.ServletRequest-">isRememberMe</a></span>(javax.servlet.ServletRequest&nbsp;request)</code>
<div class="block">Returns <code>true</code> if &quot;rememberMe&quot; should be enabled for the login attempt associated with the
current <code>request</code>, <code>false</code> otherwise.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onAccessDenied</a></span>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</code>
<div class="block">Processes requests where the subject was denied access as determined by the
<a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#isAccessAllowed-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-"><code>isAccessAllowed</code></a>
method.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#onLoginFailure-org.apache.shiro.authc.AuthenticationToken-org.apache.shiro.authc.AuthenticationException-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onLoginFailure</a></span>(<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token,
<a href="../../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a>&nbsp;e,
javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#onLoginSuccess-org.apache.shiro.authc.AuthenticationToken-org.apache.shiro.subject.Subject-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onLoginSuccess</a></span>(<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token,
<a href="../../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject,
javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setFailureAttribute-javax.servlet.ServletRequest-org.apache.shiro.authc.AuthenticationException-">setFailureAttribute</a></span>(javax.servlet.ServletRequest&nbsp;request,
<a href="../../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a>&nbsp;ae)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setFailureKeyAttribute-java.lang.String-">setFailureKeyAttribute</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;failureKeyAttribute)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setLoginUrl-java.lang.String-">setLoginUrl</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loginUrl)</code>
<div class="block">Sets the login URL used to authenticate a user.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setPasswordParam-java.lang.String-">setPasswordParam</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;passwordParam)</code>
<div class="block">Sets the request parameter name to look for when acquiring the password.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setRememberMeParam-java.lang.String-">setRememberMeParam</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;rememberMeParam)</code>
<div class="block">Sets the request parameter name to look for when acquiring the rememberMe boolean value.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#setUsernameParam-java.lang.String-">setUsernameParam</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;usernameParam)</code>
<div class="block">Sets the request parameter name to look for when acquiring the username.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticatingFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.filter.authc.<a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#cleanup-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Exception-">cleanup</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken-java.lang.String-java.lang.String-boolean-java.lang.String-">createToken</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken-java.lang.String-java.lang.String-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">createToken</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#executeLogin-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">executeLogin</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#getHost-javax.servlet.ServletRequest-">getHost</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isAccessAllowed-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-">isAccessAllowed</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isPermissive-java.lang.Object-">isPermissive</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticationFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.filter.authc.<a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticationFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#getSuccessUrl--">getSuccessUrl</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#issueSuccessRedirect-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">issueSuccessRedirect</a>, <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#setSuccessUrl-java.lang.String-">setSuccessUrl</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.AccessControlFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.filter.<a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#getLoginUrl--">getLoginUrl</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#getSubject-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">getSubject</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#isLoginRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">isLoginRequest</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-">onAccessDenied</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onPreHandle-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-">onPreHandle</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#redirectToLogin-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">redirectToLogin</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#saveRequest-javax.servlet.ServletRequest-">saveRequest</a>, <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#saveRequestAndRedirectToLogin-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">saveRequestAndRedirectToLogin</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.PathMatchingFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.filter.<a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">PathMatchingFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#getPathWithinApplication-javax.servlet.ServletRequest-">getPathWithinApplication</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#isEnabled-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.String-java.lang.Object-">isEnabled</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#pathsMatch-java.lang.String-javax.servlet.ServletRequest-">pathsMatch</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#pathsMatch-java.lang.String-java.lang.String-">pathsMatch</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#preHandle-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">preHandle</a>, <a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#processPathConfig-java.lang.String-java.lang.String-">processPathConfig</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.AdviceFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html" title="class in org.apache.shiro.web.servlet">AdviceFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#afterCompletion-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Exception-">afterCompletion</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#doFilterInternal-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilterInternal</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#executeChain-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">executeChain</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#postHandle-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">postHandle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.OncePerRequestFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter</a>, <a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#getAlreadyFilteredAttributeName--">getAlreadyFilteredAttributeName</a>, <a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled--">isEnabled</a>, <a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">isEnabled</a>, <a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#setEnabled-boolean-">setEnabled</a>, <a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#shouldNotFilter-javax.servlet.ServletRequest-">shouldNotFilter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.NameableFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">NameableFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html#getName--">getName</a>, <a href="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html#setName-java.lang.String-">setName</a>, <a href="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html#toStringBuilder--">toStringBuilder</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.AbstractFilter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#destroy--">destroy</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getFilterConfig--">getFilterConfig</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getInitParam-java.lang.String-">getInitParam</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#init-javax.servlet.FilterConfig-">init</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#onFilterConfigSet--">onFilterConfigSet</a>, <a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#setFilterConfig-javax.servlet.FilterConfig-">setFilterConfig</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.ServletContextSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.servlet.<a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">ServletContextSupport</a></h3>
<code><a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getContextAttribute-java.lang.String-">getContextAttribute</a>, <a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getContextInitParam-java.lang.String-">getContextInitParam</a>, <a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getServletContext--">getServletContext</a>, <a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#removeContextAttribute-java.lang.String-">removeContextAttribute</a>, <a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#setContextAttribute-java.lang.String-java.lang.Object-">setContextAttribute</a>, <a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#setServletContext-javax.servlet.ServletContext-">setServletContext</a>, <a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.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://docs.oracle.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://docs.oracle.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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_ERROR_KEY_ATTRIBUTE_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_ERROR_KEY_ATTRIBUTE_NAME</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.63">DEFAULT_ERROR_KEY_ATTRIBUTE_NAME</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.FormAuthenticationFilter.DEFAULT_ERROR_KEY_ATTRIBUTE_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_USERNAME_PARAM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_USERNAME_PARAM</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.65">DEFAULT_USERNAME_PARAM</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.FormAuthenticationFilter.DEFAULT_USERNAME_PARAM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_PASSWORD_PARAM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_PASSWORD_PARAM</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.66">DEFAULT_PASSWORD_PARAM</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.FormAuthenticationFilter.DEFAULT_PASSWORD_PARAM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_REMEMBER_ME_PARAM">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_REMEMBER_ME_PARAM</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.67">DEFAULT_REMEMBER_ME_PARAM</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.FormAuthenticationFilter.DEFAULT_REMEMBER_ME_PARAM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FormAuthenticationFilter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FormAuthenticationFilter</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.77">FormAuthenticationFilter</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="setLoginUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoginUrl</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.82">setLoginUrl</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loginUrl)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#setLoginUrl-java.lang.String-">AccessControlFilter</a></code></span></div>
<div class="block">Sets the login URL used to authenticate a user.
<p/>
Most Shiro filters use this url as the location to redirect a user when the filter requires
authentication. Unless overridden, the <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#DEFAULT_LOGIN_URL"><code>DEFAULT_LOGIN_URL</code></a> is assumed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#setLoginUrl-java.lang.String-">setLoginUrl</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loginUrl</code> - the login URL used to authenticate a user, used when redirecting users if authentication is required.</dd>
</dl>
</li>
</ul>
<a name="getUsernameParam--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsernameParam</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.94">getUsernameParam</a>()</pre>
</li>
</ul>
<a name="setUsernameParam-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsernameParam</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.104">setUsernameParam</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;usernameParam)</pre>
<div class="block">Sets the request parameter name to look for when acquiring the username. Unless overridden by calling this
method, the default is <code>username</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>usernameParam</code> - the name of the request param to check for acquiring the username.</dd>
</dl>
</li>
</ul>
<a name="getPasswordParam--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPasswordParam</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.108">getPasswordParam</a>()</pre>
</li>
</ul>
<a name="setPasswordParam-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPasswordParam</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.118">setPasswordParam</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;passwordParam)</pre>
<div class="block">Sets the request parameter name to look for when acquiring the password. Unless overridden by calling this
method, the default is <code>password</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>passwordParam</code> - the name of the request param to check for acquiring the password.</dd>
</dl>
</li>
</ul>
<a name="getRememberMeParam--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRememberMeParam</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.122">getRememberMeParam</a>()</pre>
</li>
</ul>
<a name="setRememberMeParam-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRememberMeParam</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.136">setRememberMeParam</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;rememberMeParam)</pre>
<div class="block">Sets the request parameter name to look for when acquiring the rememberMe boolean value. Unless overridden
by calling this method, the default is <code>rememberMe</code>.
<p/>
RememberMe will be <code>true</code> if the parameter value equals any of those supported by
<a href="../../../../../../org/apache/shiro/web/util/WebUtils.html#isTrue-javax.servlet.ServletRequest-java.lang.String-"><code>WebUtils.isTrue(request,value)</code></a>, <code>false</code>
otherwise.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rememberMeParam</code> - the name of the request param to check for acquiring the rememberMe boolean value.</dd>
</dl>
</li>
</ul>
<a name="getFailureKeyAttribute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailureKeyAttribute</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.140">getFailureKeyAttribute</a>()</pre>
</li>
</ul>
<a name="setFailureKeyAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFailureKeyAttribute</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.144">setFailureKeyAttribute</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;failureKeyAttribute)</pre>
</li>
</ul>
<a name="onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onAccessDenied</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.148">onAccessDenied</a>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">AccessControlFilter</a></code></span></div>
<div class="block">Processes requests where the subject was denied access as determined by the
<a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#isAccessAllowed-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-"><code>isAccessAllowed</code></a>
method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onAccessDenied</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the incoming <code>ServletRequest</code></dd>
<dd><code>response</code> - the outgoing <code>ServletResponse</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the request should continue to be processed; false if the subclass will
handle/render the response directly.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if there is an error processing the request.</dd>
</dl>
</li>
</ul>
<a name="isLoginSubmission-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLoginSubmission</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.182">isLoginSubmission</a>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</pre>
<div class="block">This default implementation merely returns <code>true</code> if the request is an HTTP <code>POST</code>,
<code>false</code> otherwise. Can be overridden by subclasses for custom login submission detection behavior.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the incoming ServletRequest</dd>
<dd><code>response</code> - the outgoing ServletResponse.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the request is an HTTP <code>POST</code>, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="createToken-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createToken</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.186">createToken</a>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">createToken</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></code></dd>
</dl>
</li>
</ul>
<a name="isRememberMe-javax.servlet.ServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRememberMe</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.192">isRememberMe</a>(javax.servlet.ServletRequest&nbsp;request)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isRememberMe-javax.servlet.ServletRequest-">AuthenticatingFilter</a></code></span></div>
<div class="block">Returns <code>true</code> if &quot;rememberMe&quot; should be enabled for the login attempt associated with the
current <code>request</code>, <code>false</code> otherwise.
<p/>
This implementation always returns <code>false</code> and is provided as a template hook to subclasses that
support <code>rememberMe</code> logins and wish to determine <code>rememberMe</code> in a custom mannner
based on the current <code>request</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isRememberMe-javax.servlet.ServletRequest-">isRememberMe</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the incoming ServletRequest</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if &quot;rememberMe&quot; should be enabled for the login attempt associated with the
current <code>request</code>, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="onLoginSuccess-org.apache.shiro.authc.AuthenticationToken-org.apache.shiro.subject.Subject-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onLoginSuccess</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.196">onLoginSuccess</a>(<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token,
<a href="../../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject,
javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#onLoginSuccess-org.apache.shiro.authc.AuthenticationToken-org.apache.shiro.subject.Subject-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onLoginSuccess</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="onLoginFailure-org.apache.shiro.authc.AuthenticationToken-org.apache.shiro.authc.AuthenticationException-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onLoginFailure</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.203">onLoginFailure</a>(<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a>&nbsp;token,
<a href="../../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a>&nbsp;e,
javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#onLoginFailure-org.apache.shiro.authc.AuthenticationToken-org.apache.shiro.authc.AuthenticationException-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onLoginFailure</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></code></dd>
</dl>
</li>
</ul>
<a name="setFailureAttribute-javax.servlet.ServletRequest-org.apache.shiro.authc.AuthenticationException-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFailureAttribute</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.213">setFailureAttribute</a>(javax.servlet.ServletRequest&nbsp;request,
<a href="../../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a>&nbsp;ae)</pre>
</li>
</ul>
<a name="getUsername-javax.servlet.ServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsername</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.218">getUsername</a>(javax.servlet.ServletRequest&nbsp;request)</pre>
</li>
</ul>
<a name="getPassword-javax.servlet.ServletRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPassword</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#line.222">getPassword</a>(javax.servlet.ServletRequest&nbsp;request)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FormAuthenticationFilter.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/authc/BasicHttpAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/shiro/web/filter/authc/LogoutFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html" target="_top">Frames</a></li>
<li><a href="FormAuthenticationFilter.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2004&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>