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