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