| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.web.filter.authc;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.subject.Subject;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.web.filter.AccessControlFilter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.web.util.WebUtils;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import javax.servlet.ServletRequest;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import javax.servlet.ServletResponse;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Base class for all Filters that require the current user to be authenticated. This class encapsulates the<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * logic of checking whether a user is already authenticated in the system while subclasses are required to perform<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * specific logic for unauthenticated requests.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * @since 0.9<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> */<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public abstract class AuthenticationFilter extends AccessControlFilter {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> //TODO - complete JavaDoc<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> public static final String DEFAULT_SUCCESS_URL = "/";<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private String successUrl = DEFAULT_SUCCESS_URL;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Returns the success url to use as the default location a user is sent after logging in. Typically a redirect<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * after login will redirect to the originally request URL; this property is provided mainly as a fallback in case<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * the original request URL is not available or not specified.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p/><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * The default value is {@link #DEFAULT_SUCCESS_URL}.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> *<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @return the success url to use as the default location a user is sent after logging in.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public String getSuccessUrl() {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> return successUrl;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> }<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Sets the default/fallback success url to use as the default location a user is sent after logging in. Typically<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * a redirect after login will redirect to the originally request URL; this property is provided mainly as a<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * fallback in case the original request URL is not available or not specified.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <p/><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * The default value is {@link #DEFAULT_SUCCESS_URL}.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> *<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @param successUrl the success URL to redirect the user to after a successful login.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public void setSuccessUrl(String successUrl) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> this.successUrl = successUrl;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Determines whether the current subject is authenticated.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <p/><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * The default implementation {@link #getSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) acquires}<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * the currently executing Subject and then returns<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * {@link org.apache.shiro.subject.Subject#isAuthenticated() subject.isAuthenticated()};<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @return true if the subject is authenticated; false if the subject is unauthenticated<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> Subject subject = getSubject(request, response);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return subject.isAuthenticated() && subject.getPrincipal() != null;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Redirects to user to the previously attempted URL after a successful login. This implementation simply calls<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <code>{@link org.apache.shiro.web.util.WebUtils WebUtils}.{@link WebUtils#redirectToSavedRequest(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String) redirectToSavedRequest}</code><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * using the {@link #getSuccessUrl() successUrl} as the {@code fallbackUrl} argument to that call.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param request the incoming request<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param response the outgoing response<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @throws Exception if there is a problem redirecting.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> protected void issueSuccessRedirect(ServletRequest request, ServletResponse response) throws Exception {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> WebUtils.redirectToSavedRequest(request, response, getSuccessUrl());<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span>}<a name="line.97"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
