Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.8.0 / xref / org / apache / shiro / web / filter / authc / FormAuthenticationFilter.html
blob: 93167de4219fdfa99034de07aee2f6fcb291379b [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=UTF-8" />
<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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.filter.authc;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UsernamePasswordToken;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">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 class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * to login via by redirecting them to the {@link #setLoginUrl(String) loginUrl} you configure.</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * &lt;p&gt;This filter constructs a {@link UsernamePasswordToken UsernamePasswordToken} with the values found in</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * {@link #setUsernameParam(String) username}, {@link #setPasswordParam(String) password},</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * and {@link #setRememberMeParam(String) rememberMe} request parameters. It then calls</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#login(org.apache.shiro.authc.AuthenticationToken) Subject.login(usernamePasswordToken)},</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * effectively automatically performing a login attempt. Note that the login attempt will only occur when the</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * {@link #isLoginSubmission(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isLoginSubmission(request,response)}</em>
<a class="jxr_linenumber" name="L44" href="#L44">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 class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * is a POST request.</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L47" href="#L47">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 class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * be set as a request attribute under the {@link #setFailureKeyAttribute(String) failureKeyAttribute} key. This</em>
<a class="jxr_linenumber" name="L49" href="#L49">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 class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * (e.g. no account, incorrect password, etc).</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L52" href="#L52">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 class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * {@link PassThruAuthenticationFilter} instead, which allows requests to the</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * {@link #loginUrl} to pass through to your application's code directly.</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @see PassThruAuthenticationFilter</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="FormAuthenticationFilter" href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#FormAuthenticationFilter">FormAuthenticationFilter</a> <strong class="jxr_keyword">extends</strong> <a name="AuthenticatingFilter" href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#AuthenticatingFilter">AuthenticatingFilter</a> {
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">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 class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">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 class="jxr_linenumber" name="L66" href="#L66">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 class="jxr_linenumber" name="L67" href="#L67">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 class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">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 class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> String usernameParam = DEFAULT_USERNAME_PARAM;
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> String passwordParam = DEFAULT_PASSWORD_PARAM;
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> String rememberMeParam = DEFAULT_REMEMBER_ME_PARAM;
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> String failureKeyAttribute = DEFAULT_ERROR_KEY_ATTRIBUTE_NAME;
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> <a name="FormAuthenticationFilter" href="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html#FormAuthenticationFilter">FormAuthenticationFilter</a>() {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> setLoginUrl(DEFAULT_LOGIN_URL);
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> @Override
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLoginUrl(String loginUrl) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> String previous = getLoginUrl();
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (previous != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">this</strong>.appliedPaths.remove(previous);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">super</strong>.setLoginUrl(loginUrl);
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L89" href="#L89">89</a> log.trace(<span class="jxr_string">"Adding login url to applied paths."</span>);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">this</strong>.appliedPaths.put(getLoginUrl(), <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> String getUsernameParam() {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">return</strong> usernameParam;
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L99" href="#L99">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 class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * method, the default is &lt;code&gt;username&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @param usernameParam the name of the request param to check for acquiring the username.</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUsernameParam(String usernameParam) {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">this</strong>.usernameParam = usernameParam;
<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
<a class="jxr_linenumber" name="L107" href="#L107">107</a>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> String getPasswordParam() {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> passwordParam;
<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
<a class="jxr_linenumber" name="L111" href="#L111">111</a>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L113" href="#L113">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 class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * method, the default is &lt;code&gt;password&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @param passwordParam the name of the request param to check for acquiring the password.</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPasswordParam(String passwordParam) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">this</strong>.passwordParam = passwordParam;
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> String getRememberMeParam() {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> rememberMeParam;
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * Sets the request parameter name to look for when acquiring the rememberMe boolean value. Unless overridden</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * by calling this method, the default is &lt;code&gt;rememberMe&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L130" href="#L130">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 class="jxr_linenumber" name="L131" href="#L131">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 class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * otherwise.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @param rememberMeParam the name of the request param to check for acquiring the rememberMe boolean value.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRememberMeParam(String rememberMeParam) {
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">this</strong>.rememberMeParam = rememberMeParam;
<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> String getFailureKeyAttribute() {
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> failureKeyAttribute;
<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
<a class="jxr_linenumber" name="L143" href="#L143">143</a>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFailureKeyAttribute(String failureKeyAttribute) {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">this</strong>.failureKeyAttribute = failureKeyAttribute;
<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
<a class="jxr_linenumber" name="L147" href="#L147">147</a>
<a class="jxr_linenumber" name="L148" href="#L148">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 class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (isLoginRequest(request, response)) {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (isLoginSubmission(request, response)) {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> log.trace(<span class="jxr_string">"Login submission detected. Attempting to execute login."</span>);
<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">return</strong> executeLogin(request, response);
<a class="jxr_linenumber" name="L155" href="#L155">155</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> log.trace(<span class="jxr_string">"Login page view."</span>);
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_comment">//allow them to see the login page ;)</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L164" href="#L164">164</a> log.trace(<span class="jxr_string">"Attempting to access a path which requires authentication. Forwarding to the "</span> +
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <span class="jxr_string">"Authentication url ["</span> + getLoginUrl() + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
<a class="jxr_linenumber" name="L167" href="#L167">167</a>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> saveRequestAndRedirectToLogin(request, response);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L174" href="#L174">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 class="jxr_linenumber" name="L175" href="#L175">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 class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse.</em>
<a class="jxr_linenumber" name="L179" href="#L179">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 class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginSubmission(ServletRequest request, ServletResponse response) {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> (request instanceof HttpServletRequest) &amp;&amp; WebUtils.toHttp(request).getMethod().equalsIgnoreCase(POST_METHOD);
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">protected</strong> <a name="AuthenticationToken" href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> createToken(ServletRequest request, ServletResponse response) {
<a class="jxr_linenumber" name="L187" href="#L187">187</a> String username = getUsername(request);
<a class="jxr_linenumber" name="L188" href="#L188">188</a> String password = getPassword(request);
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">return</strong> createToken(username, password, request, response);
<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isRememberMe(ServletRequest request) {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">return</strong> WebUtils.isTrue(request, getRememberMeParam());
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onLoginSuccess(<a name="AuthenticationToken" href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="Subject" href="../../../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject,
<a class="jxr_linenumber" name="L197" href="#L197">197</a> ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> issueSuccessRedirect(request, response);
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_comment">//we handled the success redirect directly, prevent the chain from continuing:</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onLoginFailure(<a name="AuthenticationToken" href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="AuthenticationException" href="../../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> e,
<a class="jxr_linenumber" name="L204" href="#L204">204</a> ServletRequest request, ServletResponse response) {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> log.debug( <span class="jxr_string">"Authentication exception"</span>, e );
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a> setFailureAttribute(request, e);
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_comment">//login failed, let request continue back to the login page:</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L211" href="#L211">211</a> }
<a class="jxr_linenumber" name="L212" href="#L212">212</a>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setFailureAttribute(ServletRequest request, <a name="AuthenticationException" href="../../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> ae) {
<a class="jxr_linenumber" name="L214" href="#L214">214</a> String className = ae.getClass().getName();
<a class="jxr_linenumber" name="L215" href="#L215">215</a> request.setAttribute(getFailureKeyAttribute(), className);
<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
<a class="jxr_linenumber" name="L217" href="#L217">217</a>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">protected</strong> String getUsername(ServletRequest request) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">return</strong> WebUtils.getCleanParam(request, getUsernameParam());
<a class="jxr_linenumber" name="L220" href="#L220">220</a> }
<a class="jxr_linenumber" name="L221" href="#L221">221</a>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">protected</strong> String getPassword(ServletRequest request) {
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">return</strong> WebUtils.getCleanParam(request, getPasswordParam());
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a>
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>