| <!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=UTF-8" /> |
| <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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.spring.web; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.Ini; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.Nameable; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.config.IniFilterChainResolverFactory; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.AccessControlFilter; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.authc.AuthenticationFilter; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.authz.AuthorizationFilter; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.DefaultFilterChainManager; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainManager; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainResolver; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.WebSecurityManager; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.AbstractShiroFilter; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.springframework.beans.BeansException; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.BeanInitializationException; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.FactoryBean; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.config.BeanPostProcessor; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter; |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap; |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * {@link org.springframework.beans.factory.FactoryBean FactoryBean} to be used in Spring-based web applications for</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * defining the master Shiro Filter.</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <h4>Usage</h4></em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Declare a DelegatingFilterProxy in {@code web.xml}, matching the filter name to the bean id:</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &lt;filter&gt;</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;filter-name&gt;<b>shiroFilter</b>&lt;/filter-name&gt;</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * &lt;filter-class&gt;org.springframework.web.filter.DelegatingFilterProxy&lt;filter-class&gt;</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * &lt;init-param&gt;</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * &lt;param-name&gt;targetFilterLifecycle&lt;/param-name&gt;</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * &lt;param-value&gt;true&lt;/param-value&gt;</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * &lt;/init-param&gt;</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * &lt;/filter&gt;</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Then, in your spring XML file that defines your web ApplicationContext:</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * &lt;bean id="<b>shiroFilter</b>" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean"&gt;</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * &lt;property name="securityManager" ref="securityManager"/&gt;</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * &lt;!-- other properties as necessary ... --&gt;</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * &lt;/bean&gt;</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * <h4>Filter Auto-Discovery</h4></em> |
| <a class="jxr_linenumber" name="L70" href="#L70">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 class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * to the 'pool' of filters available when defining {@link #setFilterChainDefinitions(String) filter chains}, it is</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * optional.</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * This implementation is also a {@link BeanPostProcessor} and will acquire</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * any {@link javax.servlet.Filter Filter} beans defined independently in your Spring application context. Upon</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">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 class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * That ID can then be used in the filter chain definitions, for example:</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * &lt;bean id="<b>myCustomFilter</b>" class="com.class.that.implements.javax.servlet.Filter"/&gt;</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * &lt;bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean"&gt;</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * &lt;property name="filterChainDefinitions"&gt;</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * &lt;value&gt;</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * /some/path/** = authc, <b>myCustomFilter</b></em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * &lt;/value&gt;</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * &lt;/property&gt;</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * &lt;/bean&gt;</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * <h4>Global Property Values</h4></em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Most Shiro servlet Filter implementations exist for defining custom Filter</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * {@link #setFilterChainDefinitions(String) chain definitions}. Most implementations subclass one of the</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * {@link AccessControlFilter}, {@link AuthenticationFilter}, {@link AuthorizationFilter} classes to simplify things,</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * and each of these 3 classes has configurable properties that are application-specific.</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L97" href="#L97">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 class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * to have to manually specify that value for <em>each</em> filter instance definied.</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * To prevent configuration duplication, this implementation provides the following properties to allow you</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * to set relevant values in only one place:</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <li>{@link #setLoginUrl(String)}</li></em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <li>{@link #setSuccessUrl(String)}</li></em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <li>{@link #setUnauthorizedUrl(String)}</li></em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Then at startup, any values specified via these 3 properties will be applied to all configured</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">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 class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * filters benefit from this convenience, your filter implementation should subclass one of the 3 mentioned</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * earlier.</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @see org.springframework.web.filter.DelegatingFilterProxy DelegatingFilterProxy</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">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> <strong class="jxr_keyword">implements</strong> FactoryBean, BeanPostProcessor { |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> |
| <a class="jxr_linenumber" name="L118" href="#L118">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 class="jxr_linenumber" name="L119" href="#L119">119</a> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager; |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">private</strong> Map<String, Filter> filters; |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> |
| <a class="jxr_linenumber" name="L124" href="#L124">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 class="jxr_linenumber" name="L125" href="#L125">125</a> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> String loginUrl; |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">private</strong> String successUrl; |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">private</strong> String unauthorizedUrl; |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html">AbstractShiroFilter</a> instance; |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/spring/web/ShiroFilterFactoryBean.html">ShiroFilterFactoryBean</a>() { |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">this</strong>.filters = <strong class="jxr_keyword">new</strong> LinkedHashMap<String, Filter>(); |
| <a class="jxr_linenumber" name="L134" href="#L134">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 class="jxr_linenumber" name="L135" href="#L135">135</a> } |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">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 class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * required property - failure to set it will throw an initialization exception.</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @return the application {@code SecurityManager} instance to be used by the constructed Shiro Filter.</em> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> getSecurityManager() { |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> securityManager; |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> } |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">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 class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * required property - failure to set it will throw an initialization exception.</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @param securityManager the application {@code SecurityManager} instance to be used by the constructed Shiro Filter.</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">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 class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">this</strong>.securityManager = securityManager; |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> } |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Returns the application's login URL to be assigned to all acquired Filters that subclass</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * {@link AccessControlFilter} or {@code null} if no value should be assigned globally. The default value</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * is {@code null}.</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @return the application's login URL to be assigned to all acquired Filters that subclass</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * {@link AccessControlFilter} or {@code null} if no value should be assigned globally.</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @see #setLoginUrl</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> String getLoginUrl() { |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> loginUrl; |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> } |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Sets the application's login URL to be assigned to all acquired Filters that subclass</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * {@link AccessControlFilter}. This is a convenience mechanism: for all configured {@link #setFilters filters},</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">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 class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * via the {@link AccessControlFilter#setLoginUrl(String)} method<b>*</b>. This eliminates the need to</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * configure the 'loginUrl' property manually on each filter instance, and instead that can be configured once</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * via this attribute.</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * <b>*</b>If a filter already has already been explicitly configured with a value, it will</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * <em>not</em> receive this value. Individual filter configuration overrides this global convenience property.</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @param loginUrl the application's login URL to apply to as a convenience to all discovered</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * {@link AccessControlFilter} instances.</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * @see AccessControlFilter#setLoginUrl(String)</em> |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLoginUrl(String loginUrl) { |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">this</strong>.loginUrl = loginUrl; |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> } |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">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 class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally. The default value</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * is {@code null}.</em> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L194" href="#L194">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 class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally.</em> |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * @see #setSuccessUrl</em> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">public</strong> String getSuccessUrl() { |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> successUrl; |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> } |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">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 class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * {@link AuthenticationFilter}. This is a convenience mechanism: for all configured {@link #setFilters filters},</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">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 class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * via the {@link AuthenticationFilter#setSuccessUrl(String)} method<b>*</b>. This eliminates the need to</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * configure the 'successUrl' property manually on each filter instance, and instead that can be configured once</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * via this attribute.</em> |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * <b>*</b>If a filter already has already been explicitly configured with a value, it will</em> |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * <em>not</em> receive this value. Individual filter configuration overrides this global convenience property.</em> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L213" href="#L213">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 class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * {@link AccessControlFilter} instances.</em> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @see AuthenticationFilter#setSuccessUrl(String)</em> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSuccessUrl(String successUrl) { |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">this</strong>.successUrl = successUrl; |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> } |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L222" href="#L222">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 class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally. The default value</em> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * is {@code null}.</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">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 class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * {@link AuthenticationFilter} or {@code null} if no value should be assigned globally.</em> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * @see #setSuccessUrl</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">public</strong> String getUnauthorizedUrl() { |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">return</strong> unauthorizedUrl; |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> } |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * Sets the application's 'unauthorized' URL to be assigned to all acquired Filters that subclass</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * {@link AuthorizationFilter}. This is a convenience mechanism: for all configured {@link #setFilters filters},</em> |
| <a class="jxr_linenumber" name="L237" href="#L237">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 class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * via the {@link AuthorizationFilter#setUnauthorizedUrl(String)} method<b>*</b>. This eliminates the need to</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * configure the 'unauthorizedUrl' property manually on each filter instance, and instead that can be configured once</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * via this attribute.</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * <b>*</b>If a filter already has already been explicitly configured with a value, it will</em> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * <em>not</em> receive this value. Individual filter configuration overrides this global convenience property.</em> |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @param unauthorizedUrl the application's 'unauthorized' URL to apply to as a convenience to all discovered</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * {@link AuthorizationFilter} instances.</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @see AuthorizationFilter#setUnauthorizedUrl(String)</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUnauthorizedUrl(String unauthorizedUrl) { |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">this</strong>.unauthorizedUrl = unauthorizedUrl; |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> } |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * Returns the filterName-to-Filter map of filters available for reference when defining filter chain definitions.</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">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 class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @return the filterName-to-Filter map of filters available for reference when defining filter chain definitions.</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">public</strong> Map<String, Filter> getFilters() { |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> filters; |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> } |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * Sets the filterName-to-Filter map of filters available for reference when creating</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * {@link #setFilterChainDefinitionMap(java.util.Map) filter chain definitions}.</em> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L267" href="#L267">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 class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * web application context that implement the {@link Filter} interface and automatically add them to this filter</em> |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * map under their bean name.</em> |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * For example, just defining this bean in a web Spring XML application context:</em> |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L273" href="#L273">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 class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * &lt;/bean&gt;</pre></em> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * Will automatically place that bean into this Filters map under the key '<b>myFilter</b>'.</em> |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @param filters the optional filterName-to-Filter map of filters available for reference when creating</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * {@link #setFilterChainDefinitionMap (java.util.Map) filter chain definitions}.</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilters(Map<String, Filter> filters) { |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">this</strong>.filters = filters; |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> } |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * Returns the chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted</em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * by the Shiro Filter. Each map entry should conform to the format defined by the</em> |
| <a class="jxr_linenumber" name="L288" href="#L288">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 class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * path expression) and the map value is the comma-delimited string chain definition.</em> |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @return he chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted</em> |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * by the Shiro Filter.</em> |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">public</strong> Map<String, String> getFilterChainDefinitionMap() { |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">return</strong> filterChainDefinitionMap; |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> } |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * Sets the chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted</em> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * by the Shiro Filter. Each map entry should conform to the format defined by the</em> |
| <a class="jxr_linenumber" name="L301" href="#L301">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 class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * path expression) and the map value is the comma-delimited string chain definition.</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @param filterChainDefinitionMap the chainName-to-chainDefinition map of chain definitions to use for creating</em> |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * filter chains intercepted by the Shiro Filter.</em> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilterChainDefinitionMap(Map<String, String> filterChainDefinitionMap) { |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">this</strong>.filterChainDefinitionMap = filterChainDefinitionMap; |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> } |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * A convenience method that sets the {@link #setFilterChainDefinitionMap(java.util.Map) filterChainDefinitionMap}</em> |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * property by accepting a {@link java.util.Properties Properties}-compatible string (multi-line key/value pairs).</em> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * Each key/value pair must conform to the format defined by the</em> |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * {@link FilterChainManager#createChain(String,String)} JavaDoc - each property key is an ant URL</em> |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * path expression and the value is the comma-delimited chain definition.</em> |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @param definitions a {@link java.util.Properties Properties}-compatible string (multi-line key/value pairs)</em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * where each key/value pair represents a single urlPathExpression-commaDelimitedChainDefinition.</em> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilterChainDefinitions(String definitions) { |
| <a class="jxr_linenumber" name="L322" href="#L322">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 class="jxr_linenumber" name="L323" href="#L323">323</a> ini.load(definitions); |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_comment">//did they explicitly state a 'urls' section? Not necessary, but just in case:</em> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> Ini.Section section = ini.getSection(IniFilterChainResolverFactory.URLS); |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(section)) { |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_comment">//no urls section. Since this _is_ a urls chain definition property, just assume the</em> |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_comment">//default section contains only the definitions:</em> |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> section = ini.getSection(Ini.DEFAULT_SECTION_NAME); |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> } |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> setFilterChainDefinitionMap(section); |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> } |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * Lazily creates and returns a {@link AbstractShiroFilter} concrete instance via the</em> |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * {@link #createInstance} method.</em> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @return the application's Shiro Filter instance used to filter incoming web requests.</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * @throws Exception if there is a problem creating the {@code Filter} instance.</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">public</strong> Object getObject() <strong class="jxr_keyword">throws</strong> Exception { |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">if</strong> (instance == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> instance = createInstance(); |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> } |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">return</strong> instance; |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> } |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * Returns <code>{@link org.apache.shiro.web.servlet.AbstractShiroFilter}.class</code></em> |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * @return <code>{@link org.apache.shiro.web.servlet.AbstractShiroFilter}.class</code></em> |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong class="jxr_keyword">public</strong> Class getObjectType() { |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> SpringShiroFilter.<strong class="jxr_keyword">class</strong>; |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> } |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L358" href="#L358">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 class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L360" href="#L360">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 class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSingleton() { |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> } |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html">FilterChainManager</a> createFilterChainManager() { |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> |
| <a class="jxr_linenumber" name="L368" href="#L368">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 class="jxr_linenumber" name="L369" href="#L369">369</a> Map<String, Filter> defaultFilters = manager.getFilters(); |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_comment">//apply global settings if necessary:</em> |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">for</strong> (Filter filter : defaultFilters.values()) { |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> applyGlobalPropertiesIfNecessary(filter); |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> } |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_comment">//Apply the acquired and/or configured filters:</em> |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> Map<String, Filter> filters = getFilters(); |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(filters)) { |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, Filter> entry : filters.entrySet()) { |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> String name = entry.getKey(); |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> Filter filter = entry.getValue(); |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> applyGlobalPropertiesIfNecessary(filter); |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">if</strong> (filter instanceof Nameable) { |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> ((<a href="../../../../../org/apache/shiro/util/Nameable.html">Nameable</a>) filter).setName(name); |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> } |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_comment">//'init' argument is false, since Spring-configured filters should be initialized</em> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_comment">//in Spring (i.e. 'init-method=blah') or implement InitializingBean:</em> |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> manager.addFilter(name, filter, false); |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> } |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> } |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_comment">//build up the chains:</em> |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> Map<String, String> chains = getFilterChainDefinitionMap(); |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(chains)) { |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, String> entry : chains.entrySet()) { |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> String url = entry.getKey(); |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> String chainDefinition = entry.getValue(); |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> manager.createChain(url, chainDefinition); |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> } |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> } |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> manager; |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> } |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * This implementation:</em> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * <li>Ensures the required {@link #setSecurityManager(org.apache.shiro.mgt.SecurityManager) securityManager}</em> |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * property has been set</li></em> |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * <li>{@link #createFilterChainManager() Creates} a {@link FilterChainManager} instance that reflects the</em> |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * configured {@link #setFilters(java.util.Map) filters} and</em> |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> * {@link #setFilterChainDefinitionMap(java.util.Map) filter chain definitions}</li></em> |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * <li>Wraps the FilterChainManager with a suitable</em> |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.filter.mgt.FilterChainResolver FilterChainResolver} since the Shiro Filter</em> |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * implementations do not know of {@code FilterChainManager}s</li></em> |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * <li>Sets both the {@code SecurityManager} and {@code FilterChainResolver} instances on a new Shiro Filter</em> |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> * instance and returns that filter instance.</li></em> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * @return a new Shiro Filter reflecting any configured filters and filter chain definitions.</em> |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * @throws Exception if there is a problem creating the AbstractShiroFilter instance.</em> |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L422" href="#L422">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 class="jxr_linenumber" name="L423" href="#L423">423</a> |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> log.debug(<span class="jxr_string">"Creating Shiro Filter instance."</span>); |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager = getSecurityManager(); |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">if</strong> (securityManager == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> String msg = <span class="jxr_string">"SecurityManager property must be set."</span>; |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BeanInitializationException(msg); |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> } |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">if</strong> (!(securityManager instanceof WebSecurityManager)) { |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> String msg = <span class="jxr_string">"The security manager does not implement the WebSecurityManager interface."</span>; |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BeanInitializationException(msg); |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> } |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html">FilterChainManager</a> manager = createFilterChainManager(); |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_comment">//Expose the constructed FilterChainManager by first wrapping it in a</em> |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_comment">// FilterChainResolver implementation. The AbstractShiroFilter implementations</em> |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_comment">// do not know about FilterChainManagers - only resolvers:</em> |
| <a class="jxr_linenumber" name="L442" href="#L442">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 class="jxr_linenumber" name="L443" href="#L443">443</a> chainResolver.setFilterChainManager(manager); |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_comment">//Now create a concrete ShiroFilter instance and apply the acquired SecurityManager and built</em> |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_comment">//FilterChainResolver. It doesn't matter that the instance is an anonymous inner class</em> |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_comment">//here - we're just using it because it is a concrete AbstractShiroFilter instance that accepts</em> |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_comment">//injection of the SecurityManager and FilterChainResolver:</em> |
| <a class="jxr_linenumber" name="L449" href="#L449">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 class="jxr_linenumber" name="L450" href="#L450">450</a> } |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> applyLoginUrlIfNecessary(Filter filter) { |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> String loginUrl = getLoginUrl(); |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(loginUrl) && (filter instanceof AccessControlFilter)) { |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> <a href="../../../../../org/apache/shiro/web/filter/AccessControlFilter.html">AccessControlFilter</a> acFilter = (AccessControlFilter) filter; |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_comment">//only apply the login url if they haven't explicitly configured one already:</em> |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> String existingLoginUrl = acFilter.getLoginUrl(); |
| <a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">if</strong> (AccessControlFilter.DEFAULT_LOGIN_URL.equals(existingLoginUrl)) { |
| <a class="jxr_linenumber" name="L459" href="#L459">459</a> acFilter.setLoginUrl(loginUrl); |
| <a class="jxr_linenumber" name="L460" href="#L460">460</a> } |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> } |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> } |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> applySuccessUrlIfNecessary(Filter filter) { |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> String successUrl = getSuccessUrl(); |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(successUrl) && (filter instanceof AuthenticationFilter)) { |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> <a href="../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html">AuthenticationFilter</a> authcFilter = (AuthenticationFilter) filter; |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_comment">//only apply the successUrl if they haven't explicitly configured one already:</em> |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> String existingSuccessUrl = authcFilter.getSuccessUrl(); |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">if</strong> (AuthenticationFilter.DEFAULT_SUCCESS_URL.equals(existingSuccessUrl)) { |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> authcFilter.setSuccessUrl(successUrl); |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> } |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> } |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> } |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> applyUnauthorizedUrlIfNecessary(Filter filter) { |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> String unauthorizedUrl = getUnauthorizedUrl(); |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(unauthorizedUrl) && (filter instanceof AuthorizationFilter)) { |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> <a href="../../../../../org/apache/shiro/web/filter/authz/AuthorizationFilter.html">AuthorizationFilter</a> authzFilter = (AuthorizationFilter) filter; |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_comment">//only apply the unauthorizedUrl if they haven't explicitly configured one already:</em> |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> String existingUnauthorizedUrl = authzFilter.getUnauthorizedUrl(); |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> <strong class="jxr_keyword">if</strong> (existingUnauthorizedUrl == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> authzFilter.setUnauthorizedUrl(unauthorizedUrl); |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> } |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> } |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> } |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> applyGlobalPropertiesIfNecessary(Filter filter) { |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> applyLoginUrlIfNecessary(filter); |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> applySuccessUrlIfNecessary(filter); |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> applyUnauthorizedUrlIfNecessary(filter); |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> } |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> <em class="jxr_javadoccomment"> * Inspects a bean, and if it implements the {@link Filter} interface, automatically adds that filter</em> |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> <em class="jxr_javadoccomment"> * instance to the internal {@link #setFilters(java.util.Map) filters map} that will be referenced</em> |
| <a class="jxr_linenumber" name="L497" href="#L497">497</a> <em class="jxr_javadoccomment"> * later during filter chain construction.</em> |
| <a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> <strong class="jxr_keyword">public</strong> Object postProcessBeforeInitialization(Object bean, String beanName) <strong class="jxr_keyword">throws</strong> BeansException { |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> <strong class="jxr_keyword">if</strong> (bean instanceof Filter) { |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> log.debug(<span class="jxr_string">"Found filter chain candidate filter '{}'"</span>, beanName); |
| <a class="jxr_linenumber" name="L502" href="#L502">502</a> Filter filter = (Filter) bean; |
| <a class="jxr_linenumber" name="L503" href="#L503">503</a> applyGlobalPropertiesIfNecessary(filter); |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> getFilters().put(beanName, filter); |
| <a class="jxr_linenumber" name="L505" href="#L505">505</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L506" href="#L506">506</a> log.trace(<span class="jxr_string">"Ignoring non-Filter bean '{}'"</span>, beanName); |
| <a class="jxr_linenumber" name="L507" href="#L507">507</a> } |
| <a class="jxr_linenumber" name="L508" href="#L508">508</a> <strong class="jxr_keyword">return</strong> bean; |
| <a class="jxr_linenumber" name="L509" href="#L509">509</a> } |
| <a class="jxr_linenumber" name="L510" href="#L510">510</a> |
| <a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment"> * Does nothing - only exists to satisfy the BeanPostProcessor interface and immediately returns the</em> |
| <a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * {@code bean} argument.</em> |
| <a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L515" href="#L515">515</a> <strong class="jxr_keyword">public</strong> Object postProcessAfterInitialization(Object bean, String beanName) <strong class="jxr_keyword">throws</strong> BeansException { |
| <a class="jxr_linenumber" name="L516" href="#L516">516</a> <strong class="jxr_keyword">return</strong> bean; |
| <a class="jxr_linenumber" name="L517" href="#L517">517</a> } |
| <a class="jxr_linenumber" name="L518" href="#L518">518</a> |
| <a class="jxr_linenumber" name="L519" href="#L519">519</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L520" href="#L520">520</a> <em class="jxr_javadoccomment"> * Ordinarily the {@code AbstractShiroFilter} must be subclassed to additionally perform configuration</em> |
| <a class="jxr_linenumber" name="L521" href="#L521">521</a> <em class="jxr_javadoccomment"> * and initialization behavior. Because this {@code FactoryBean} implementation manually builds the</em> |
| <a class="jxr_linenumber" name="L522" href="#L522">522</a> <em class="jxr_javadoccomment"> * {@link AbstractShiroFilter}'s</em> |
| <a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_javadoccomment"> * {@link AbstractShiroFilter#setSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager) securityManager} and</em> |
| <a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment"> * {@link AbstractShiroFilter#setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver) filterChainResolver}</em> |
| <a class="jxr_linenumber" name="L525" href="#L525">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 class="jxr_linenumber" name="L526" href="#L526">526</a> <em class="jxr_javadoccomment"> * concrete subclass in the constructor.</em> |
| <a class="jxr_linenumber" name="L527" href="#L527">527</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L528" href="#L528">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 class="jxr_linenumber" name="L529" href="#L529">529</a> |
| <a class="jxr_linenumber" name="L530" href="#L530">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 class="jxr_linenumber" name="L531" href="#L531">531</a> <strong class="jxr_keyword">super</strong>(); |
| <a class="jxr_linenumber" name="L532" href="#L532">532</a> <strong class="jxr_keyword">if</strong> (webSecurityManager == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L533" href="#L533">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 class="jxr_linenumber" name="L534" href="#L534">534</a> } |
| <a class="jxr_linenumber" name="L535" href="#L535">535</a> setSecurityManager(webSecurityManager); |
| <a class="jxr_linenumber" name="L536" href="#L536">536</a> <strong class="jxr_keyword">if</strong> (resolver != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L537" href="#L537">537</a> setFilterChainResolver(resolver); |
| <a class="jxr_linenumber" name="L538" href="#L538">538</a> } |
| <a class="jxr_linenumber" name="L539" href="#L539">539</a> } |
| <a class="jxr_linenumber" name="L540" href="#L540">540</a> } |
| <a class="jxr_linenumber" name="L541" href="#L541">541</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
