| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <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.spring.web;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.config.Ini;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.mgt.SecurityManager;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.util.CollectionUtils;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.util.Nameable;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.util.StringUtils;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.web.config.IniFilterChainResolverFactory;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.web.filter.AccessControlFilter;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.web.filter.authc.AuthenticationFilter;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.shiro.web.filter.authz.AuthorizationFilter;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.shiro.web.filter.mgt.DefaultFilterChainManager;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.shiro.web.filter.mgt.FilterChainManager;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.shiro.web.mgt.WebSecurityManager;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.shiro.web.servlet.AbstractShiroFilter;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.slf4j.Logger;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.slf4j.LoggerFactory;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.springframework.beans.BeansException;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.springframework.beans.factory.BeanInitializationException;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.springframework.beans.factory.FactoryBean;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.springframework.beans.factory.config.BeanPostProcessor;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import javax.servlet.Filter;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import java.util.LinkedHashMap;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import java.util.Map;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span>/**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * {@link org.springframework.beans.factory.FactoryBean FactoryBean} to be used in Spring-based web applications for<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * defining the master Shiro Filter.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <h4>Usage</h4><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Declare a DelegatingFilterProxy in {@code web.xml}, matching the filter name to the bean id:<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <pre><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * &lt;filter&gt;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * &lt;filter-name&gt;<b>shiroFilter</b>&lt;/filter-name&gt;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * &lt;filter-class&gt;org.springframework.web.filter.DelegatingFilterProxy&lt;filter-class&gt;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * &lt;init-param&gt;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * &lt;param-name&gt;targetFilterLifecycle&lt;/param-name&gt;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * &lt;param-value&gt;true&lt;/param-value&gt;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * &lt;/init-param&gt;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * &lt;/filter&gt;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * </pre><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Then, in your spring XML file that defines your web ApplicationContext:<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <pre><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * &lt;bean id="<b>shiroFilter</b>" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean"&gt;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * &lt;property name="securityManager" ref="securityManager"/&gt;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * &lt;!-- other properties as necessary ... --&gt;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * &lt;/bean&gt;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * </pre><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <h4>Filter Auto-Discovery</h4><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * While there is a {@link #setFilters(java.util.Map) filters} property that allows you to assign a filter beans<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * to the 'pool' of filters available when defining {@link #setFilterChainDefinitions(String) filter chains}, it is<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * optional.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p/><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * This implementation is also a {@link BeanPostProcessor} and will acquire<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * any {@link javax.servlet.Filter Filter} beans defined independently in your Spring application context. Upon<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * discovery, they will be automatically added to the {@link #setFilters(java.util.Map) map} keyed by the bean ID.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * That ID can then be used in the filter chain definitions, for example:<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <pre><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * &lt;bean id="<b>myCustomFilter</b>" class="com.class.that.implements.javax.servlet.Filter"/&gt;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * ...<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * &lt;bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean"&gt;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * ...<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * &lt;property name="filterChainDefinitions"&gt;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * &lt;value&gt;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * /some/path/** = authc, <b>myCustomFilter</b><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * &lt;/value&gt;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * &lt;/property&gt;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * &lt;/bean&gt;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * </pre><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * <h4>Global Property Values</h4><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Most Shiro servlet Filter implementations exist for defining custom Filter<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * {@link #setFilterChainDefinitions(String) chain definitions}. Most implementations subclass one of the<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * {@link AccessControlFilter}, {@link AuthenticationFilter}, {@link AuthorizationFilter} classes to simplify things,<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * and each of these 3 classes has configurable properties that are application-specific.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * <p/><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * A dilemma arises where, if you want to for example set the application's 'loginUrl' for any Filter, you don't want<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * to have to manually specify that value for <em>each</em> filter instance definied.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * <p/><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * To prevent configuration duplication, this implementation provides the following properties to allow you<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * to set relevant values in only one place:<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * <ul><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <li>{@link #setLoginUrl(String)}</li><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * <li>{@link #setSuccessUrl(String)}</li><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <li>{@link #setUnauthorizedUrl(String)}</li><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * </ul><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Then at startup, any values specified via these 3 properties will be applied to all configured<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Filter instances so you don't have to specify them individually on each filter instance. To ensure your own custom<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * filters benefit from this convenience, your filter implementation should subclass one of the 3 mentioned<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * earlier.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> *<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @see org.springframework.web.filter.DelegatingFilterProxy DelegatingFilterProxy<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @since 1.0<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span>public class ShiroFilterFactoryBean implements FactoryBean, BeanPostProcessor {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> private static transient final Logger log = LoggerFactory.getLogger(ShiroFilterFactoryBean.class);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> private SecurityManager securityManager;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> private Map<String, Filter> filters;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> private Map<String, String> filterChainDefinitionMap; //urlPathExpression_to_comma-delimited-filter-chain-definition<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> private String loginUrl;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> private String successUrl;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> private String unauthorizedUrl;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> private AbstractShiroFilter instance;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> public ShiroFilterFactoryBean() {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> this.filters = new LinkedHashMap<String, Filter>();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> this.filterChainDefinitionMap = new LinkedHashMap<String, String>(); //order matters!<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * Sets the application {@code SecurityManager} instance to be used by the constructed Shiro Filter. This is a<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * required property - failure to set it will throw an initialization exception.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> *<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @return the application {@code SecurityManager} instance to be used by the constructed Shiro Filter.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public SecurityManager getSecurityManager() {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return securityManager;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> /**<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * Sets the application {@code SecurityManager} instance to be used by the constructed Shiro Filter. This is a<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * required property - failure to set it will throw an initialization exception.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> *<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @param securityManager the application {@code SecurityManager} instance to be used by the constructed Shiro Filter.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public void setSecurityManager(SecurityManager securityManager) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> this.securityManager = securityManager;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> /**<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * Returns the application's login URL to be assigned to all acquired Filters that subclass<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * {@link AccessControlFilter} or {@code null} if no value should be assigned globally. The default value<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * is {@code null}.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> *<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @return the application's login URL to be assigned to all acquired Filters that subclass<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * {@link AccessControlFilter} or {@code null} if no value should be assigned globally.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @see #setLoginUrl<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> */<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> public String getLoginUrl() {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> return loginUrl;<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> /**<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * Sets the application's login URL to be assigned to all acquired Filters that subclass<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * {@link AccessControlFilter}. This is a convenience mechanism: for all configured {@link #setFilters filters},<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * as well for any default ones ({@code authc}, {@code user}, etc), this value will be passed on to each Filter<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * via the {@link AccessControlFilter#setLoginUrl(String)} method<b>*</b>. This eliminates the need to<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * configure the 'loginUrl' property manually on each filter instance, and instead that can be configured once<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * via this attribute.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * <p/><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * <b>*</b>If a filter already has already been explicitly configured with a value, it will<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * <em>not</em> receive this value. Individual filter configuration overrides this global convenience property.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> *<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param loginUrl the application's login URL to apply to as a convenience to all discovered<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * {@link AccessControlFilter} instances.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @see AccessControlFilter#setLoginUrl(String)<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> */<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> public void setLoginUrl(String loginUrl) {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> this.loginUrl = loginUrl;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> }<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> /**<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * Returns the application's after-login success URL to be assigned to all acquired Filters that subclass<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally. The default value<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * is {@code null}.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> *<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @return the application's after-login success URL to be assigned to all acquired Filters that subclass<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally.<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * @see #setSuccessUrl<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> */<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> public String getSuccessUrl() {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> return successUrl;<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> /**<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * Sets the application's after-login success URL to be assigned to all acquired Filters that subclass<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * {@link AuthenticationFilter}. This is a convenience mechanism: for all configured {@link #setFilters filters},<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * as well for any default ones ({@code authc}, {@code user}, etc), this value will be passed on to each Filter<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * via the {@link AuthenticationFilter#setSuccessUrl(String)} method<b>*</b>. This eliminates the need to<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * configure the 'successUrl' property manually on each filter instance, and instead that can be configured once<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * via this attribute.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * <p/><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * <b>*</b>If a filter already has already been explicitly configured with a value, it will<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * <em>not</em> receive this value. Individual filter configuration overrides this global convenience property.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> *<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @param successUrl the application's after-login success URL to apply to as a convenience to all discovered<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * {@link AccessControlFilter} instances.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * @see AuthenticationFilter#setSuccessUrl(String)<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> */<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public void setSuccessUrl(String successUrl) {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> this.successUrl = successUrl;<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> /**<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * Returns the application's after-login success URL to be assigned to all acquired Filters that subclass<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally. The default value<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * is {@code null}.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> *<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @return the application's after-login success URL to be assigned to all acquired Filters that subclass<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally.<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @see #setSuccessUrl<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> */<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> public String getUnauthorizedUrl() {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> return unauthorizedUrl;<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> /**<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * Sets the application's 'unauthorized' URL to be assigned to all acquired Filters that subclass<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * {@link AuthorizationFilter}. This is a convenience mechanism: for all configured {@link #setFilters filters},<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * as well for any default ones ({@code roles}, {@code perms}, etc), this value will be passed on to each Filter<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * via the {@link AuthorizationFilter#setUnauthorizedUrl(String)} method<b>*</b>. This eliminates the need to<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * configure the 'unauthorizedUrl' property manually on each filter instance, and instead that can be configured once<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * via this attribute.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * <p/><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * <b>*</b>If a filter already has already been explicitly configured with a value, it will<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * <em>not</em> receive this value. Individual filter configuration overrides this global convenience property.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> *<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param unauthorizedUrl the application's 'unauthorized' URL to apply to as a convenience to all discovered<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * {@link AuthorizationFilter} instances.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @see AuthorizationFilter#setUnauthorizedUrl(String)<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> */<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> public void setUnauthorizedUrl(String unauthorizedUrl) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> this.unauthorizedUrl = unauthorizedUrl;<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> /**<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * Returns the filterName-to-Filter map of filters available for reference when defining filter chain definitions.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * All filter chain definitions will reference filters by the names in this map (i.e. the keys).<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> *<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @return the filterName-to-Filter map of filters available for reference when defining filter chain definitions.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> */<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> public Map<String, Filter> getFilters() {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> return filters;<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> /**<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Sets the filterName-to-Filter map of filters available for reference when creating<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * {@link #setFilterChainDefinitionMap(java.util.Map) filter chain definitions}.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * <p/><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * <b>Note:</b> This property is optional: this {@code FactoryBean} implementation will discover all beans in the<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * web application context that implement the {@link Filter} interface and automatically add them to this filter<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * map under their bean name.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * <p/><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * For example, just defining this bean in a web Spring XML application context:<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * <pre><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * &lt;bean id=&quot;myFilter&quot; class=&quot;com.class.that.implements.javax.servlet.Filter&quot;&gt;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * ...<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * &lt;/bean&gt;</pre><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * Will automatically place that bean into this Filters map under the key '<b>myFilter</b>'.<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> *<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @param filters the optional filterName-to-Filter map of filters available for reference when creating<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * {@link #setFilterChainDefinitionMap (java.util.Map) filter chain definitions}.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> */<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public void setFilters(Map<String, Filter> filters) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> this.filters = filters;<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> /**<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * Returns the chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * by the Shiro Filter. Each map entry should conform to the format defined by the<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * {@link FilterChainManager#createChain(String, String)} JavaDoc, where the map key is the chain name (e.g. URL<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * path expression) and the map value is the comma-delimited string chain definition.<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> *<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * @return he chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * by the Shiro Filter.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> */<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> public Map<String, String> getFilterChainDefinitionMap() {<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> return filterChainDefinitionMap;<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> /**<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * Sets the chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * by the Shiro Filter. Each map entry should conform to the format defined by the<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * {@link FilterChainManager#createChain(String, String)} JavaDoc, where the map key is the chain name (e.g. URL<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * path expression) and the map value is the comma-delimited string chain definition.<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> *<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * @param filterChainDefinitionMap the chainName-to-chainDefinition map of chain definitions to use for creating<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * filter chains intercepted by the Shiro Filter.<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> */<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> public void setFilterChainDefinitionMap(Map<String, String> filterChainDefinitionMap) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> this.filterChainDefinitionMap = filterChainDefinitionMap;<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> /**<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * A convenience method that sets the {@link #setFilterChainDefinitionMap(java.util.Map) filterChainDefinitionMap}<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * property by accepting a {@link java.util.Properties Properties}-compatible string (multi-line key/value pairs).<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * Each key/value pair must conform to the format defined by the<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * {@link FilterChainManager#createChain(String,String)} JavaDoc - each property key is an ant URL<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * path expression and the value is the comma-delimited chain definition.<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> *<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * @param definitions a {@link java.util.Properties Properties}-compatible string (multi-line key/value pairs)<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * where each key/value pair represents a single urlPathExpression-commaDelimitedChainDefinition.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> */<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> public void setFilterChainDefinitions(String definitions) {<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> Ini ini = new Ini();<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> ini.load(definitions);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> //did they explicitly state a 'urls' section? Not necessary, but just in case:<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> Ini.Section section = ini.getSection(IniFilterChainResolverFactory.URLS);<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> if (CollectionUtils.isEmpty(section)) {<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> //no urls section. Since this _is_ a urls chain definition property, just assume the<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> //default section contains only the definitions:<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> section = ini.getSection(Ini.DEFAULT_SECTION_NAME);<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> setFilterChainDefinitionMap(section);<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> /**<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * Lazily creates and returns a {@link AbstractShiroFilter} concrete instance via the<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * {@link #createInstance} method.<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> *<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @return the application's Shiro Filter instance used to filter incoming web requests.<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * @throws Exception if there is a problem creating the {@code Filter} instance.<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> */<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> public Object getObject() throws Exception {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> if (instance == null) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> instance = createInstance();<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> return instance;<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> /**<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * Returns <code>{@link org.apache.shiro.web.servlet.AbstractShiroFilter}.class</code><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> *<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * @return <code>{@link org.apache.shiro.web.servlet.AbstractShiroFilter}.class</code><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> */<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> public Class getObjectType() {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> return SpringShiroFilter.class;<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> }<a name="line.355"></a> |
| <span class="sourceLineNo">356</span><a name="line.356"></a> |
| <span class="sourceLineNo">357</span> /**<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * Returns {@code true} always. There is almost always only ever 1 Shiro {@code Filter} per web application.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> *<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * @return {@code true} always. There is almost always only ever 1 Shiro {@code Filter} per web application.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> */<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> public boolean isSingleton() {<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> return true;<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> }<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> protected FilterChainManager createFilterChainManager() {<a name="line.366"></a> |
| <span class="sourceLineNo">367</span><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> DefaultFilterChainManager manager = new DefaultFilterChainManager();<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> Map<String, Filter> defaultFilters = manager.getFilters();<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> //apply global settings if necessary:<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> for (Filter filter : defaultFilters.values()) {<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> applyGlobalPropertiesIfNecessary(filter);<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> }<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> //Apply the acquired and/or configured filters:<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> Map<String, Filter> filters = getFilters();<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> if (!CollectionUtils.isEmpty(filters)) {<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> for (Map.Entry<String, Filter> entry : filters.entrySet()) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> String name = entry.getKey();<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> Filter filter = entry.getValue();<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> applyGlobalPropertiesIfNecessary(filter);<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> if (filter instanceof Nameable) {<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> ((Nameable) filter).setName(name);<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> }<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> //'init' argument is false, since Spring-configured filters should be initialized<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> //in Spring (i.e. 'init-method=blah') or implement InitializingBean:<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> manager.addFilter(name, filter, false);<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> }<a name="line.389"></a> |
| <span class="sourceLineNo">390</span><a name="line.390"></a> |
| <span class="sourceLineNo">391</span> //build up the chains:<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> Map<String, String> chains = getFilterChainDefinitionMap();<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> if (!CollectionUtils.isEmpty(chains)) {<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> for (Map.Entry<String, String> entry : chains.entrySet()) {<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> String url = entry.getKey();<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> String chainDefinition = entry.getValue();<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> manager.createChain(url, chainDefinition);<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> }<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> }<a name="line.399"></a> |
| <span class="sourceLineNo">400</span><a name="line.400"></a> |
| <span class="sourceLineNo">401</span> return manager;<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> /**<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * This implementation:<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * <ol><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * <li>Ensures the required {@link #setSecurityManager(org.apache.shiro.mgt.SecurityManager) securityManager}<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * property has been set</li><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * <li>{@link #createFilterChainManager() Creates} a {@link FilterChainManager} instance that reflects the<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * configured {@link #setFilters(java.util.Map) filters} and<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * {@link #setFilterChainDefinitionMap(java.util.Map) filter chain definitions}</li><a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * <li>Wraps the FilterChainManager with a suitable<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * {@link org.apache.shiro.web.filter.mgt.FilterChainResolver FilterChainResolver} since the Shiro Filter<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * implementations do not know of {@code FilterChainManager}s</li><a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * <li>Sets both the {@code SecurityManager} and {@code FilterChainResolver} instances on a new Shiro Filter<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * instance and returns that filter instance.</li><a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * </ol><a name="line.417"></a> |
| <span class="sourceLineNo">418</span> *<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * @return a new Shiro Filter reflecting any configured filters and filter chain definitions.<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * @throws Exception if there is a problem creating the AbstractShiroFilter instance.<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> */<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> protected AbstractShiroFilter createInstance() throws Exception {<a name="line.422"></a> |
| <span class="sourceLineNo">423</span><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> log.debug("Creating Shiro Filter instance.");<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> SecurityManager securityManager = getSecurityManager();<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> if (securityManager == null) {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> String msg = "SecurityManager property must be set.";<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> throw new BeanInitializationException(msg);<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> }<a name="line.430"></a> |
| <span class="sourceLineNo">431</span><a name="line.431"></a> |
| <span class="sourceLineNo">432</span> if (!(securityManager instanceof WebSecurityManager)) {<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> String msg = "The security manager does not implement the WebSecurityManager interface.";<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> throw new BeanInitializationException(msg);<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> }<a name="line.435"></a> |
| <span class="sourceLineNo">436</span><a name="line.436"></a> |
| <span class="sourceLineNo">437</span> FilterChainManager manager = createFilterChainManager();<a name="line.437"></a> |
| <span class="sourceLineNo">438</span><a name="line.438"></a> |
| <span class="sourceLineNo">439</span> //Expose the constructed FilterChainManager by first wrapping it in a<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> // FilterChainResolver implementation. The AbstractShiroFilter implementations<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> // do not know about FilterChainManagers - only resolvers:<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> PathMatchingFilterChainResolver chainResolver = new PathMatchingFilterChainResolver();<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> chainResolver.setFilterChainManager(manager);<a name="line.443"></a> |
| <span class="sourceLineNo">444</span><a name="line.444"></a> |
| <span class="sourceLineNo">445</span> //Now create a concrete ShiroFilter instance and apply the acquired SecurityManager and built<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> //FilterChainResolver. It doesn't matter that the instance is an anonymous inner class<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> //here - we're just using it because it is a concrete AbstractShiroFilter instance that accepts<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> //injection of the SecurityManager and FilterChainResolver:<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> return new SpringShiroFilter((WebSecurityManager) securityManager, chainResolver);<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> }<a name="line.450"></a> |
| <span class="sourceLineNo">451</span><a name="line.451"></a> |
| <span class="sourceLineNo">452</span> private void applyLoginUrlIfNecessary(Filter filter) {<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> String loginUrl = getLoginUrl();<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> if (StringUtils.hasText(loginUrl) && (filter instanceof AccessControlFilter)) {<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> AccessControlFilter acFilter = (AccessControlFilter) filter;<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> //only apply the login url if they haven't explicitly configured one already:<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> String existingLoginUrl = acFilter.getLoginUrl();<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> if (AccessControlFilter.DEFAULT_LOGIN_URL.equals(existingLoginUrl)) {<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> acFilter.setLoginUrl(loginUrl);<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> }<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> }<a name="line.462"></a> |
| <span class="sourceLineNo">463</span><a name="line.463"></a> |
| <span class="sourceLineNo">464</span> private void applySuccessUrlIfNecessary(Filter filter) {<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> String successUrl = getSuccessUrl();<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> if (StringUtils.hasText(successUrl) && (filter instanceof AuthenticationFilter)) {<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> AuthenticationFilter authcFilter = (AuthenticationFilter) filter;<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> //only apply the successUrl if they haven't explicitly configured one already:<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> String existingSuccessUrl = authcFilter.getSuccessUrl();<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> if (AuthenticationFilter.DEFAULT_SUCCESS_URL.equals(existingSuccessUrl)) {<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> authcFilter.setSuccessUrl(successUrl);<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> }<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> }<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> }<a name="line.474"></a> |
| <span class="sourceLineNo">475</span><a name="line.475"></a> |
| <span class="sourceLineNo">476</span> private void applyUnauthorizedUrlIfNecessary(Filter filter) {<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> String unauthorizedUrl = getUnauthorizedUrl();<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> if (StringUtils.hasText(unauthorizedUrl) && (filter instanceof AuthorizationFilter)) {<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> AuthorizationFilter authzFilter = (AuthorizationFilter) filter;<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> //only apply the unauthorizedUrl if they haven't explicitly configured one already:<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> String existingUnauthorizedUrl = authzFilter.getUnauthorizedUrl();<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> if (existingUnauthorizedUrl == null) {<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> authzFilter.setUnauthorizedUrl(unauthorizedUrl);<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> }<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> }<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> }<a name="line.486"></a> |
| <span class="sourceLineNo">487</span><a name="line.487"></a> |
| <span class="sourceLineNo">488</span> private void applyGlobalPropertiesIfNecessary(Filter filter) {<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> applyLoginUrlIfNecessary(filter);<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> applySuccessUrlIfNecessary(filter);<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> applyUnauthorizedUrlIfNecessary(filter);<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> }<a name="line.492"></a> |
| <span class="sourceLineNo">493</span><a name="line.493"></a> |
| <span class="sourceLineNo">494</span> /**<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * Inspects a bean, and if it implements the {@link Filter} interface, automatically adds that filter<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * instance to the internal {@link #setFilters(java.util.Map) filters map} that will be referenced<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * later during filter chain construction.<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> */<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> if (bean instanceof Filter) {<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> log.debug("Found filter chain candidate filter '{}'", beanName);<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> Filter filter = (Filter) bean;<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> applyGlobalPropertiesIfNecessary(filter);<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> getFilters().put(beanName, filter);<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> } else {<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> log.trace("Ignoring non-Filter bean '{}'", beanName);<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> }<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> return bean;<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> }<a name="line.509"></a> |
| <span class="sourceLineNo">510</span><a name="line.510"></a> |
| <span class="sourceLineNo">511</span> /**<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * Does nothing - only exists to satisfy the BeanPostProcessor interface and immediately returns the<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * {@code bean} argument.<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> */<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> return bean;<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> }<a name="line.517"></a> |
| <span class="sourceLineNo">518</span><a name="line.518"></a> |
| <span class="sourceLineNo">519</span> /**<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * Ordinarily the {@code AbstractShiroFilter} must be subclassed to additionally perform configuration<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * and initialization behavior. Because this {@code FactoryBean} implementation manually builds the<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * {@link AbstractShiroFilter}'s<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> * {@link AbstractShiroFilter#setSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager) securityManager} and<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> * {@link AbstractShiroFilter#setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver) filterChainResolver}<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * properties, the only thing left to do is set those properties explicitly. We do that in a simple<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> * concrete subclass in the constructor.<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> */<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> private static final class SpringShiroFilter extends AbstractShiroFilter {<a name="line.528"></a> |
| <span class="sourceLineNo">529</span><a name="line.529"></a> |
| <span class="sourceLineNo">530</span> protected SpringShiroFilter(WebSecurityManager webSecurityManager, FilterChainResolver resolver) {<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> super();<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> if (webSecurityManager == null) {<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> throw new IllegalArgumentException("WebSecurityManager property cannot be null.");<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> }<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> setSecurityManager(webSecurityManager);<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> if (resolver != null) {<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> setFilterChainResolver(resolver);<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> }<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> }<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> }<a name="line.540"></a> |
| <span class="sourceLineNo">541</span>}<a name="line.541"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
