Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / xref / org / apache / shiro / web / config / IniFilterChainResolverFactory.html
blob: cce9505a66ef5c47c8d07c9c4f59b13a13ed984d [file] [log] [blame]
<!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>IniFilterChainResolverFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/config/IniFilterChainResolverFactory.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.web.config;
<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.config.IniFactorySupport;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.IniSecurityManagerFactory;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.ReflectionBuilder;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.Factory;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainManager;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainResolver;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterConfig;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * A {@link Factory} that creates {@link FilterChainResolver} instances based on {@link Ini} configuration.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html">IniFilterChainResolverFactory</a> <strong class="jxr_keyword">extends</strong> IniFactorySupport&lt;FilterChainResolver&gt; {
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FILTERS = <span class="jxr_string">"filters"</span>;
<a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String URLS = <span class="jxr_string">"urls"</span>;
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</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(IniFilterChainResolverFactory.<strong class="jxr_keyword">class</strong>);
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> FilterConfig filterConfig;
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> Map&lt;String, ?&gt; defaultBeans;
<a name="53" href="#53">53</a>
<a name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html">IniFilterChainResolverFactory</a>() {
<a name="55" href="#55">55</a> <strong class="jxr_keyword">super</strong>();
<a name="56" href="#56">56</a> }
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html">IniFilterChainResolverFactory</a>(<a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini) {
<a name="59" href="#59">59</a> <strong class="jxr_keyword">super</strong>(ini);
<a name="60" href="#60">60</a> }
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html">IniFilterChainResolverFactory</a>(<a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini, Map&lt;String, ?&gt; defaultBeans) {
<a name="63" href="#63">63</a> <strong class="jxr_keyword">this</strong>(ini);
<a name="64" href="#64">64</a> <strong class="jxr_keyword">this</strong>.defaultBeans = defaultBeans;
<a name="65" href="#65">65</a> }
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> FilterConfig getFilterConfig() {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">return</strong> filterConfig;
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilterConfig(FilterConfig filterConfig) {
<a name="72" href="#72">72</a> <strong class="jxr_keyword">this</strong>.filterConfig = filterConfig;
<a name="73" href="#73">73</a> }
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> createInstance(<a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini) {
<a name="76" href="#76">76</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> filterChainResolver = createDefaultInstance();
<a name="77" href="#77">77</a> <strong class="jxr_keyword">if</strong> (filterChainResolver instanceof PathMatchingFilterChainResolver) {
<a name="78" href="#78">78</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html">PathMatchingFilterChainResolver</a> resolver = (PathMatchingFilterChainResolver) filterChainResolver;
<a name="79" href="#79">79</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html">FilterChainManager</a> manager = resolver.getFilterChainManager();
<a name="80" href="#80">80</a> buildChains(manager, ini);
<a name="81" href="#81">81</a> }
<a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> filterChainResolver;
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> createDefaultInstance() {
<a name="86" href="#86">86</a> FilterConfig filterConfig = getFilterConfig();
<a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (filterConfig != <strong class="jxr_keyword">null</strong>) {
<a name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html">PathMatchingFilterChainResolver</a>(filterConfig);
<a name="89" href="#89">89</a> } <strong class="jxr_keyword">else</strong> {
<a name="90" href="#90">90</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html">PathMatchingFilterChainResolver</a>();
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> buildChains(<a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html">FilterChainManager</a> manager, <a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini) {
<a name="95" href="#95">95</a> <em class="jxr_comment">//filters section:</em>
<a name="96" href="#96">96</a> Ini.Section section = ini.getSection(FILTERS);
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(section)) {
<a name="99" href="#99">99</a> String msg = <span class="jxr_string">"The [{}] section has been deprecated and will be removed in a future release! Please "</span> +
<a name="100" href="#100">100</a> <span class="jxr_string">"move all object configuration (filters and all other objects) to the [{}] section."</span>;
<a name="101" href="#101">101</a> log.warn(msg, FILTERS, IniSecurityManagerFactory.MAIN_SECTION_NAME);
<a name="102" href="#102">102</a> }
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> Map&lt;String, Object&gt; defaults = <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, Object&gt;();
<a name="105" href="#105">105</a>
<a name="106" href="#106">106</a> Map&lt;String, Filter&gt; defaultFilters = manager.getFilters();
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em class="jxr_comment">//now let's see if there are any object defaults in addition to the filters</em>
<a name="109" href="#109">109</a> <em class="jxr_comment">//these can be used to configure the filters:</em>
<a name="110" href="#110">110</a> <em class="jxr_comment">//create a Map of objects to use as the defaults:</em>
<a name="111" href="#111">111</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(defaultFilters)) {
<a name="112" href="#112">112</a> defaults.putAll(defaultFilters);
<a name="113" href="#113">113</a> }
<a name="114" href="#114">114</a> <em class="jxr_comment">//User-provided objects must come _after_ the default filters - to allow the user-provided</em>
<a name="115" href="#115">115</a> <em class="jxr_comment">//ones to override the default filters if necessary.</em>
<a name="116" href="#116">116</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(<strong class="jxr_keyword">this</strong>.defaultBeans)) {
<a name="117" href="#117">117</a> defaults.putAll(<strong class="jxr_keyword">this</strong>.defaultBeans);
<a name="118" href="#118">118</a> }
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> Map&lt;String, Filter&gt; filters = getFilters(section, defaults);
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <em class="jxr_comment">//add the filters to the manager:</em>
<a name="123" href="#123">123</a> registerFilters(filters, manager);
<a name="124" href="#124">124</a>
<a name="125" href="#125">125</a> <em class="jxr_comment">//urls section:</em>
<a name="126" href="#126">126</a> section = ini.getSection(URLS);
<a name="127" href="#127">127</a> createChains(section, manager);
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> registerFilters(Map&lt;String, Filter&gt; filters, <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html">FilterChainManager</a> manager) {
<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(filters)) {
<a name="132" href="#132">132</a> <strong class="jxr_keyword">boolean</strong> init = getFilterConfig() != <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">//only call filter.init if there is a FilterConfig available</em>
<a name="133" href="#133">133</a> <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, Filter&gt; entry : filters.entrySet()) {
<a name="134" href="#134">134</a> String name = entry.getKey();
<a name="135" href="#135">135</a> Filter filter = entry.getValue();
<a name="136" href="#136">136</a> manager.addFilter(name, filter, init);
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a> }
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a>
<a name="141" href="#141">141</a> <strong class="jxr_keyword">protected</strong> Map&lt;String, Filter&gt; getFilters(Map&lt;String, String&gt; section, Map&lt;String, ?&gt; defaults) {
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> Map&lt;String, Filter&gt; filters = extractFilters(defaults);
<a name="144" href="#144">144</a>
<a name="145" href="#145">145</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(section)) {
<a name="146" href="#146">146</a> <a href="../../../../../org/apache/shiro/config/ReflectionBuilder.html">ReflectionBuilder</a> builder = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/config/ReflectionBuilder.html">ReflectionBuilder</a>(defaults);
<a name="147" href="#147">147</a> Map&lt;String, ?&gt; built = builder.buildObjects(section);
<a name="148" href="#148">148</a> Map&lt;String,Filter&gt; sectionFilters = extractFilters(built);
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(filters)) {
<a name="151" href="#151">151</a> filters = sectionFilters;
<a name="152" href="#152">152</a> } <strong class="jxr_keyword">else</strong> {
<a name="153" href="#153">153</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(sectionFilters)) {
<a name="154" href="#154">154</a> filters.putAll(sectionFilters);
<a name="155" href="#155">155</a> }
<a name="156" href="#156">156</a> }
<a name="157" href="#157">157</a> }
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> filters;
<a name="160" href="#160">160</a> }
<a name="161" href="#161">161</a>
<a name="162" href="#162">162</a> <strong class="jxr_keyword">private</strong> Map&lt;String, Filter&gt; extractFilters(Map&lt;String, ?&gt; objects) {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(objects)) {
<a name="164" href="#164">164</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="165" href="#165">165</a> }
<a name="166" href="#166">166</a> Map&lt;String, Filter&gt; filterMap = <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, Filter&gt;();
<a name="167" href="#167">167</a> <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, ?&gt; entry : objects.entrySet()) {
<a name="168" href="#168">168</a> String key = entry.getKey();
<a name="169" href="#169">169</a> Object value = entry.getValue();
<a name="170" href="#170">170</a> <strong class="jxr_keyword">if</strong> (value instanceof Filter) {
<a name="171" href="#171">171</a> filterMap.put(key, (Filter) value);
<a name="172" href="#172">172</a> }
<a name="173" href="#173">173</a> }
<a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> filterMap;
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a>
<a name="177" href="#177">177</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> createChains(Map&lt;String, String&gt; urls, <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html">FilterChainManager</a> manager) {
<a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(urls)) {
<a name="179" href="#179">179</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="180" href="#180">180</a> log.debug(<span class="jxr_string">"No urls to process."</span>);
<a name="181" href="#181">181</a> }
<a name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong>;
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="186" href="#186">186</a> log.trace(<span class="jxr_string">"Before url processing."</span>);
<a name="187" href="#187">187</a> }
<a name="188" href="#188">188</a>
<a name="189" href="#189">189</a> <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, String&gt; entry : urls.entrySet()) {
<a name="190" href="#190">190</a> String path = entry.getKey();
<a name="191" href="#191">191</a> String value = entry.getValue();
<a name="192" href="#192">192</a> manager.createChain(path, value);
<a name="193" href="#193">193</a> }
<a name="194" href="#194">194</a> }
<a name="195" href="#195">195</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>