blob: 82c193b30c4549da259e7644e4d074bd7f307d42 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>FormAuthenticationFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.filter.authc;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UsernamePasswordToken;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Requires the requesting user to be authenticated for the request to continue, and if they are not, forces the user</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * to login via by redirecting them to the {@link #setLoginUrl(String) loginUrl} you configure.</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * &lt;p&gt;This filter constructs a {@link UsernamePasswordToken UsernamePasswordToken} with the values found in</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * {@link #setUsernameParam(String) username}, {@link #setPasswordParam(String) password},</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * and {@link #setRememberMeParam(String) rememberMe} request parameters. It then calls</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#login(org.apache.shiro.authc.AuthenticationToken) Subject.login(usernamePasswordToken)},</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * effectively automatically performing a login attempt. Note that the login attempt will only occur when the</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * {@link #isLoginSubmission(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isLoginSubmission(request,response)}</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * is &lt;code&gt;true&lt;/code&gt;, which by default occurs when the request is for the {@link #setLoginUrl(String) loginUrl} and</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * is a POST request.</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;p&gt;If the login attempt fails, the resulting &lt;code&gt;AuthenticationException&lt;/code&gt; fully qualified class name will</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * be set as a request attribute under the {@link #setFailureKeyAttribute(String) failureKeyAttribute} key. This</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * FQCN can be used as an i18n key or lookup mechanism to explain to the user why their login attempt failed</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * (e.g. no account, incorrect password, etc).</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * &lt;p&gt;If you would prefer to handle the authentication validation and login in your own code, consider using the</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * {@link PassThruAuthenticationFilter} instead, which allows requests to the</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * {@link #loginUrl} to pass through to your application's code directly.</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @see PassThruAuthenticationFilter</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html">FormAuthenticationFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html">AuthenticatingFilter</a> {
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a name="62" href="#62">62</a>
<a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ERROR_KEY_ATTRIBUTE_NAME = <span class="jxr_string">"shiroLoginFailure"</span>;
<a name="64" href="#64">64</a>
<a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_USERNAME_PARAM = <span class="jxr_string">"username"</span>;
<a name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_PASSWORD_PARAM = <span class="jxr_string">"password"</span>;
<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_REMEMBER_ME_PARAM = <span class="jxr_string">"rememberMe"</span>;
<a name="68" href="#68">68</a>
<a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(FormAuthenticationFilter.<strong class="jxr_keyword">class</strong>);
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> String usernameParam = DEFAULT_USERNAME_PARAM;
<a name="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> String passwordParam = DEFAULT_PASSWORD_PARAM;
<a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> String rememberMeParam = DEFAULT_REMEMBER_ME_PARAM;
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> String failureKeyAttribute = DEFAULT_ERROR_KEY_ATTRIBUTE_NAME;
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html">FormAuthenticationFilter</a>() {
<a name="78" href="#78">78</a> setLoginUrl(DEFAULT_LOGIN_URL);
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> @Override
<a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLoginUrl(String loginUrl) {
<a name="83" href="#83">83</a> String previous = getLoginUrl();
<a name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> (previous != <strong class="jxr_keyword">null</strong>) {
<a name="85" href="#85">85</a> <strong class="jxr_keyword">this</strong>.appliedPaths.remove(previous);
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a> <strong class="jxr_keyword">super</strong>.setLoginUrl(loginUrl);
<a name="88" href="#88">88</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="89" href="#89">89</a> log.trace(<span class="jxr_string">"Adding login url to applied paths."</span>);
<a name="90" href="#90">90</a> }
<a name="91" href="#91">91</a> <strong class="jxr_keyword">this</strong>.appliedPaths.put(getLoginUrl(), <strong class="jxr_keyword">null</strong>);
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> String getUsernameParam() {
<a name="95" href="#95">95</a> <strong class="jxr_keyword">return</strong> usernameParam;
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Sets the request parameter name to look for when acquiring the username. Unless overridden by calling this</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * method, the default is &lt;code&gt;username&lt;/code&gt;.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> *</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @param usernameParam the name of the request param to check for acquiring the username.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em>
<a name="104" href="#104">104</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUsernameParam(String usernameParam) {
<a name="105" href="#105">105</a> <strong class="jxr_keyword">this</strong>.usernameParam = usernameParam;
<a name="106" href="#106">106</a> }
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> String getPasswordParam() {
<a name="109" href="#109">109</a> <strong class="jxr_keyword">return</strong> passwordParam;
<a name="110" href="#110">110</a> }
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Sets the request parameter name to look for when acquiring the password. Unless overridden by calling this</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * method, the default is &lt;code&gt;password&lt;/code&gt;.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> *</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @param passwordParam the name of the request param to check for acquiring the password.</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> */</em>
<a name="118" href="#118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPasswordParam(String passwordParam) {
<a name="119" href="#119">119</a> <strong class="jxr_keyword">this</strong>.passwordParam = passwordParam;
<a name="120" href="#120">120</a> }
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> String getRememberMeParam() {
<a name="123" href="#123">123</a> <strong class="jxr_keyword">return</strong> rememberMeParam;
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Sets the request parameter name to look for when acquiring the rememberMe boolean value. Unless overridden</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * by calling this method, the default is &lt;code&gt;rememberMe&lt;/code&gt;.</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * RememberMe will be &lt;code&gt;true&lt;/code&gt; if the parameter value equals any of those supported by</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.util.WebUtils#isTrue(javax.servlet.ServletRequest, String) WebUtils.isTrue(request,value)}, &lt;code&gt;false&lt;/code&gt;</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * otherwise.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> *</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param rememberMeParam the name of the request param to check for acquiring the rememberMe boolean value.</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
<a name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRememberMeParam(String rememberMeParam) {
<a name="137" href="#137">137</a> <strong class="jxr_keyword">this</strong>.rememberMeParam = rememberMeParam;
<a name="138" href="#138">138</a> }
<a name="139" href="#139">139</a>
<a name="140" href="#140">140</a> <strong class="jxr_keyword">public</strong> String getFailureKeyAttribute() {
<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> failureKeyAttribute;
<a name="142" href="#142">142</a> }
<a name="143" href="#143">143</a>
<a name="144" href="#144">144</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFailureKeyAttribute(String failureKeyAttribute) {
<a name="145" href="#145">145</a> <strong class="jxr_keyword">this</strong>.failureKeyAttribute = failureKeyAttribute;
<a name="146" href="#146">146</a> }
<a name="147" href="#147">147</a>
<a name="148" href="#148">148</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onAccessDenied(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> Exception {
<a name="149" href="#149">149</a> <strong class="jxr_keyword">if</strong> (isLoginRequest(request, response)) {
<a name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> (isLoginSubmission(request, response)) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="152" href="#152">152</a> log.trace(<span class="jxr_string">"Login submission detected. Attempting to execute login."</span>);
<a name="153" href="#153">153</a> }
<a name="154" href="#154">154</a> <strong class="jxr_keyword">return</strong> executeLogin(request, response);
<a name="155" href="#155">155</a> } <strong class="jxr_keyword">else</strong> {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="157" href="#157">157</a> log.trace(<span class="jxr_string">"Login page view."</span>);
<a name="158" href="#158">158</a> }
<a name="159" href="#159">159</a> <em class="jxr_comment">//allow them to see the login page ;)</em>
<a name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="161" href="#161">161</a> }
<a name="162" href="#162">162</a> } <strong class="jxr_keyword">else</strong> {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="164" href="#164">164</a> log.trace(<span class="jxr_string">"Attempting to access a path which requires authentication. Forwarding to the "</span> +
<a name="165" href="#165">165</a> <span class="jxr_string">"Authentication url ["</span> + getLoginUrl() + <span class="jxr_string">"]"</span>);
<a name="166" href="#166">166</a> }
<a name="167" href="#167">167</a>
<a name="168" href="#168">168</a> saveRequestAndRedirectToLogin(request, response);
<a name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> false;
<a name="170" href="#170">170</a> }
<a name="171" href="#171">171</a> }
<a name="172" href="#172">172</a>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * This default implementation merely returns &lt;code&gt;true&lt;/code&gt; if the request is an HTTP &lt;code&gt;POST&lt;/code&gt;,</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * &lt;code&gt;false&lt;/code&gt; otherwise. Can be overridden by subclasses for custom login submission detection behavior.</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> *</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em>
<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse.</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if the request is an HTTP &lt;code&gt;POST&lt;/code&gt;, &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em>
<a name="181" href="#181">181</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a name="182" href="#182">182</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginSubmission(ServletRequest request, ServletResponse response) {
<a name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> (request instanceof HttpServletRequest) &amp;&amp; WebUtils.toHttp(request).getMethod().equalsIgnoreCase(POST_METHOD);
<a name="184" href="#184">184</a> }
<a name="185" href="#185">185</a>
<a name="186" href="#186">186</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> createToken(ServletRequest request, ServletResponse response) {
<a name="187" href="#187">187</a> String username = getUsername(request);
<a name="188" href="#188">188</a> String password = getPassword(request);
<a name="189" href="#189">189</a> <strong class="jxr_keyword">return</strong> createToken(username, password, request, response);
<a name="190" href="#190">190</a> }
<a name="191" href="#191">191</a>
<a name="192" href="#192">192</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isRememberMe(ServletRequest request) {
<a name="193" href="#193">193</a> <strong class="jxr_keyword">return</strong> WebUtils.isTrue(request, getRememberMeParam());
<a name="194" href="#194">194</a> }
<a name="195" href="#195">195</a>
<a name="196" href="#196">196</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onLoginSuccess(<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject,
<a name="197" href="#197">197</a> ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> Exception {
<a name="198" href="#198">198</a> issueSuccessRedirect(request, response);
<a name="199" href="#199">199</a> <em class="jxr_comment">//we handled the success redirect directly, prevent the chain from continuing:</em>
<a name="200" href="#200">200</a> <strong class="jxr_keyword">return</strong> false;
<a name="201" href="#201">201</a> }
<a name="202" href="#202">202</a>
<a name="203" href="#203">203</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onLoginFailure(<a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a> e,
<a name="204" href="#204">204</a> ServletRequest request, ServletResponse response) {
<a name="205" href="#205">205</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="206" href="#206">206</a> log.debug( <span class="jxr_string">"Authentication exception"</span>, e );
<a name="207" href="#207">207</a> }
<a name="208" href="#208">208</a> setFailureAttribute(request, e);
<a name="209" href="#209">209</a> <em class="jxr_comment">//login failed, let request continue back to the login page:</em>
<a name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="211" href="#211">211</a> }
<a name="212" href="#212">212</a>
<a name="213" href="#213">213</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setFailureAttribute(ServletRequest request, <a href="../../../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a> ae) {
<a name="214" href="#214">214</a> String className = ae.getClass().getName();
<a name="215" href="#215">215</a> request.setAttribute(getFailureKeyAttribute(), className);
<a name="216" href="#216">216</a> }
<a name="217" href="#217">217</a>
<a name="218" href="#218">218</a> <strong class="jxr_keyword">protected</strong> String getUsername(ServletRequest request) {
<a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> WebUtils.getCleanParam(request, getUsernameParam());
<a name="220" href="#220">220</a> }
<a name="221" href="#221">221</a>
<a name="222" href="#222">222</a> <strong class="jxr_keyword">protected</strong> String getPassword(ServletRequest request) {
<a name="223" href="#223">223</a> <strong class="jxr_keyword">return</strong> WebUtils.getCleanParam(request, getPasswordParam());
<a name="224" href="#224">224</a> }
<a name="225" href="#225">225</a>
<a name="226" href="#226">226</a>
<a name="227" href="#227">227</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>