blob: bd9e0435910cd447b50ff12d027a24807e10c1dd [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.web.filter.authc;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import javax.servlet.ServletRequest;</a>
<span class="sourceLineNo">022</span><a id="line.22">import javax.servlet.ServletResponse;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">/**</a>
<span class="sourceLineNo">025</span><a id="line.25"> * An authentication filter that redirects the user to the login page when they are trying to access</a>
<span class="sourceLineNo">026</span><a id="line.26"> * a protected resource. However, if the user is trying to access the login page, the filter lets</a>
<span class="sourceLineNo">027</span><a id="line.27"> * the request pass through to the application code.</a>
<span class="sourceLineNo">028</span><a id="line.28"> * &lt;p/&gt;</a>
<span class="sourceLineNo">029</span><a id="line.29"> * The difference between this filter and the {@link FormAuthenticationFilter FormAuthenticationFilter} is that</a>
<span class="sourceLineNo">030</span><a id="line.30"> * on a login submission (by default an HTTP POST to the login URL), the &lt;code&gt;FormAuthenticationFilter&lt;/code&gt; filter</a>
<span class="sourceLineNo">031</span><a id="line.31"> * attempts to automatically authenticate the user by passing the &lt;code&gt;username&lt;/code&gt; and &lt;code&gt;password&lt;/code&gt;</a>
<span class="sourceLineNo">032</span><a id="line.32"> * request parameter values to</a>
<span class="sourceLineNo">033</span><a id="line.33"> * {@link org.apache.shiro.subject.Subject#login(org.apache.shiro.authc.AuthenticationToken) Subject.login(usernamePasswordToken)}</a>
<span class="sourceLineNo">034</span><a id="line.34"> * directly.</a>
<span class="sourceLineNo">035</span><a id="line.35"> * &lt;p/&gt;</a>
<span class="sourceLineNo">036</span><a id="line.36"> * Conversely, this controller always passes all requests to the {@link #setLoginUrl loginUrl} through, both GETs and</a>
<span class="sourceLineNo">037</span><a id="line.37"> * POSTs. This is useful in cases where the developer wants to write their own login behavior, which should include a</a>
<span class="sourceLineNo">038</span><a id="line.38"> * call to {@link org.apache.shiro.subject.Subject#login(org.apache.shiro.authc.AuthenticationToken) Subject.login(AuthenticationToken)}</a>
<span class="sourceLineNo">039</span><a id="line.39"> * at some point. For example, if the developer has their own custom MVC login controller or validator,</a>
<span class="sourceLineNo">040</span><a id="line.40"> * this &lt;code&gt;PassThruAuthenticationFilter&lt;/code&gt; may be appropriate.</a>
<span class="sourceLineNo">041</span><a id="line.41"> *</a>
<span class="sourceLineNo">042</span><a id="line.42"> * @see FormAuthenticationFilter</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @since 0.9</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45">public class PassThruAuthenticationFilter extends AuthenticationFilter {</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {</a>
<span class="sourceLineNo">050</span><a id="line.50"> if (isLoginRequest(request, response)) {</a>
<span class="sourceLineNo">051</span><a id="line.51"> return true;</a>
<span class="sourceLineNo">052</span><a id="line.52"> } else {</a>
<span class="sourceLineNo">053</span><a id="line.53"> saveRequestAndRedirectToLogin(request, response);</a>
<span class="sourceLineNo">054</span><a id="line.54"> return false;</a>
<span class="sourceLineNo">055</span><a id="line.55"> }</a>
<span class="sourceLineNo">056</span><a id="line.56"> }</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58">}</a>
</pre>
</div>
</main>
</body>
</html>