| <!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 org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.web.filter.AccessControlFilter;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.web.util.WebUtils;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.ServletRequest;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.ServletResponse;</a> |
| <span class="sourceLineNo">027</span><a id="line.27"></a> |
| <span class="sourceLineNo">028</span><a id="line.28">/**</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * Base class for all Filters that require the current user to be authenticated. This class encapsulates the</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * logic of checking whether a user is already authenticated in the system while subclasses are required to perform</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * specific logic for unauthenticated requests.</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> *</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * @since 0.9</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> */</a> |
| <span class="sourceLineNo">035</span><a id="line.35">public abstract class AuthenticationFilter extends AccessControlFilter {</a> |
| <span class="sourceLineNo">036</span><a id="line.36"></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> //TODO - complete JavaDoc</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> public static final String DEFAULT_SUCCESS_URL = "/";</a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> private String successUrl = DEFAULT_SUCCESS_URL;</a> |
| <span class="sourceLineNo">042</span><a id="line.42"></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> /**</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * Returns the success url to use as the default location a user is sent after logging in. Typically a redirect</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * after login will redirect to the originally request URL; this property is provided mainly as a fallback in case</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * the original request URL is not available or not specified.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <p/></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * The default value is {@link #DEFAULT_SUCCESS_URL}.</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> *</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * @return the success url to use as the default location a user is sent after logging in.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> */</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> public String getSuccessUrl() {</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> return successUrl;</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> }</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"> * Sets the default/fallback success url to use as the default location a user is sent after logging in. Typically</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * a redirect after login will redirect to the originally request URL; this property is provided mainly as a</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * fallback in case the original request URL is not available or not specified.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * <p/></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * The default value is {@link #DEFAULT_SUCCESS_URL}.</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> *</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @param successUrl the success URL to redirect the user to after a successful login.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> */</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> public void setSuccessUrl(String successUrl) {</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> this.successUrl = successUrl;</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> }</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"></a> |
| <span class="sourceLineNo">070</span><a id="line.70"> /**</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * Determines whether the current subject is authenticated.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * <p/></a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * The default implementation {@link #getSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) acquires}</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * the currently executing Subject and then returns</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * {@link org.apache.shiro.subject.Subject#isAuthenticated() subject.isAuthenticated()};</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> *</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @return true if the subject is authenticated; false if the subject is unauthenticated</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> */</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> Subject subject = getSubject(request, response);</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> return subject.isAuthenticated() && subject.getPrincipal() != null;</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> }</a> |
| <span class="sourceLineNo">083</span><a id="line.83"></a> |
| <span class="sourceLineNo">084</span><a id="line.84"> /**</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * Redirects to user to the previously attempted URL after a successful login. This implementation simply calls</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * <code>{@link org.apache.shiro.web.util.WebUtils WebUtils}.{@link WebUtils#redirectToSavedRequest(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String) redirectToSavedRequest}</code></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * using the {@link #getSuccessUrl() successUrl} as the {@code fallbackUrl} argument to that call.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> *</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @param request the incoming request</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @param response the outgoing response</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * @throws Exception if there is a problem redirecting.</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> */</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> protected void issueSuccessRedirect(ServletRequest request, ServletResponse response) throws Exception {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> WebUtils.redirectToSavedRequest(request, response, getSuccessUrl());</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96"></a> |
| <span class="sourceLineNo">097</span><a id="line.97">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |