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