| <!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>IniShiroFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/servlet/IniShiroFilter.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.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.web.servlet; |
| <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.ConfigurationException; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.Ini; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.IniFactorySupport; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.ResourceUtils; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.config.IniFilterChainResolverFactory; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.config.WebIniSecurityManagerFactory; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainResolver; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.WebSecurityManager; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <h1>Deprecated</h1></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * This filter has been deprecated as of Shiro 1.2 in favor of using the {@link ShiroFilter} in {@code web.xml} instead.</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * See the {@link ShiroFilter} JavaDoc for usage.</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * ======================</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Servlet Filter that configures and enables all Shiro functions within a web application by using the</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/INI_file" target="alexandria_uri">http://en.wikipedia.org/wiki/INI_file</a>">INI</a> configuration format.</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * The actual INI configuration contents are not covered here, but instead in Shiro's</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://shiro.apache.org/configuration.html" target="alexandria_uri">http://shiro.apache.org/configuration.html</a>">Configuration Documentation</a> and additional web-specific</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://shiro.apache.org/web.html" target="alexandria_uri">http://shiro.apache.org/web.html</a>">Web Documentation</a>.</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <h2>Usage</h2></em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <h3>Default</h3></em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * By default, the simplest filter declaration expects a {@code shiro.ini} resource to be located at</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * {@code /WEB-INF/shiro.ini}, or, if not there, falls back to checking the root of the classpath</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * (i.e. {@code classpath:shiro.ini}):</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * &lt;filter&gt;</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * &lt;filter-name&gt;ShiroFilter&lt;/filter-name&gt;</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * &lt;filter-class&gt;org.apache.shiro.web.servlet.IniShiroFilter&lt;/filter-class&gt;</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * &lt;/filter&gt;</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <h3>Custom Path</h3></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * If you want the INI configuration to be somewhere other than {@code /WEB-INF/shiro.ini} or</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * {@code classpath:shiro.ini}, you may specify an alternate location via the {@code configPath init-param}:</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * &lt;filter&gt;</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * &lt;filter-name&gt;ShiroFilter&lt;/filter-name&gt;</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * &lt;filter-class&gt;org.apache.shiro.web.servlet.IniShiroFilter&lt;/filter-class&gt;</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * &lt;init-param&gt;</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * &lt;param-name&gt;configPath&lt;/param-name&gt;</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * &lt;param-value&gt;/WEB-INF/someFile.ini&lt;/param-value&gt;</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * &lt;/init-param&gt;</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * &lt;/filter&gt;</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Unqualified (schemeless or 'non-prefixed') paths are assumed to be {@code ServletContext} resource paths, resolvable</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * via {@link javax.servlet.ServletContext#getResourceAsStream(String) ServletContext#getResourceAsStream}.</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * Non-ServletContext resources may be loaded from qualified locations by specifying prefixes indicating the source,</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * e.g. {@code file:}, {@code url:}, and {@code classpath:}. See the</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * {@link ResourceUtils#getInputStreamForPath(String)} JavaDoc for more.</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * <h3>Inline</h3></em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * For relatively simple environments, you can embed the INI config directly inside the filter declaration with</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * the {@code config init-param}:</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * &lt;filter&gt;</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * &lt;filter-name&gt;ShiroFilter&lt;/filter-name&gt;</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * &lt;filter-class&gt;org.apache.shiro.web.servlet.IniShiroFilter&lt;/filter-class&gt;</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * &lt;init-param&gt;</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * &lt;param-name&gt;config&lt;/param-name&gt;</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * &lt;param-value&gt;</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * #INI config goes here...</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * &lt;/param-value&gt;</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * &lt;/init-param&gt;</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * &lt;/filter&gt;</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Although this is typically not recommended because any Shiro configuration changes would contribute to version control</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * 'noise' in the web.xml file.</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"> * When creating the shiro.ini configuration itself, please see Shiro's</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://shiro.apache.org/configuration.html" target="alexandria_uri">http://shiro.apache.org/configuration.html</a>">Configuration Documentation</a> and</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://shiro.apache.org/web.html" target="alexandria_uri">http://shiro.apache.org/web.html</a>">Web Documentation</a>.</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://shiro.apache.org/configuration.html" target="alexandria_uri">http://shiro.apache.org/configuration.html</a>">Apache Shiro INI Configuration</a></em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://shiro.apache.org/web.html" target="alexandria_uri">http://shiro.apache.org/web.html</a>">Apache Shiro Web Documentation</a></em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @deprecated in 1.2 in favor of using the {@link ShiroFilter}</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> @Deprecated |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="IniShiroFilter" href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#IniShiroFilter">IniShiroFilter</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractShiroFilter" href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#AbstractShiroFilter">AbstractShiroFilter</a> { |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONFIG_INIT_PARAM_NAME = <span class="jxr_string">"config"</span>; |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONFIG_PATH_INIT_PARAM_NAME = <span class="jxr_string">"configPath"</span>; |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_WEB_INI_RESOURCE_PATH = <span class="jxr_string">"/WEB-INF/shiro.ini"</span>; |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(IniShiroFilter.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">private</strong> String config; |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">private</strong> String configPath; |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <a name="IniShiroFilter" href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#IniShiroFilter">IniShiroFilter</a>() { |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> } |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Returns the actual INI configuration text to use to build the {@link SecurityManager} and</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * {@link FilterChainResolver} used by the web application or {@code null} if the</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * {@link #getConfigPath() configPath} should be used to load a fallback INI source.</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * This value is {@code null} by default, but it will be automatically set to the value of the</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * '{@code config}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * container at startup.</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @return the actual INI configuration text to use to build the {@link SecurityManager} and</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * {@link FilterChainResolver} used by the web application or {@code null} if the</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * {@link #getConfigPath() configPath} should be used to load a fallback INI source.</em> |
| <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> <strong class="jxr_keyword">public</strong> String getConfig() { |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.config; |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> } |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> |
| <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> <em class="jxr_javadoccomment"> * Sets the actual INI configuration text to use to build the {@link SecurityManager} and</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * {@link FilterChainResolver} used by the web application. If this value is {@code null}, the</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * {@link #getConfigPath() configPath} will be checked to see if a .ini file should be loaded instead.</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * This value is {@code null} by default, but it will be automatically set to the value of the</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * '{@code config}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * container at startup.</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 config the actual INI configuration text to use to build the {@link SecurityManager} and</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * {@link FilterChainResolver} used by the web application.</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setConfig(String config) { |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">this</strong>.config = config; |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> } |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * Returns the config path to be used to load a .ini file for configuration if a configuration is</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * not specified via the {@link #getConfig() config} attribute.</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * This value is {@code null} by default, but it will be automatically set to the value of the</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * '{@code configPath}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * container at startup.</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> <em class="jxr_javadoccomment"> * @return the config path to be used to load a .ini file for configuration if a configuration is</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * not specified via the {@link #getConfig() config} attribute.</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">public</strong> String getConfigPath() { |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> configPath; |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> } |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Sets the config path to be used to load a .ini file for configuration if a configuration is</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * not specified via the {@link #getConfig() config} attribute.</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * This value is {@code null} by default, but it will be automatically set to the value of the</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * '{@code configPath}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * container at startup.</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 configPath the config path to be used to load a .ini file for configuration if a configuration is</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * not specified via the {@link #getConfig() config} attribute.</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setConfigPath(String configPath) { |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">this</strong>.configPath = StringUtils.clean(configPath); |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> } |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> Exception { |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> applyInitParams(); |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> configure(); |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> } |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> applyInitParams() <strong class="jxr_keyword">throws</strong> Exception { |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> String config = getInitParam(CONFIG_INIT_PARAM_NAME); |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> (config != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> setConfig(config); |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> } |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> String configPath = getInitParam(CONFIG_PATH_INIT_PARAM_NAME); |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> (configPath != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> setConfigPath(configPath); |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> } |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> } |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configure() <strong class="jxr_keyword">throws</strong> Exception { |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> ini = loadIniFromConfig(); |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> log.info(<span class="jxr_string">"Null or empty configuration specified via 'config' init-param. "</span> + |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <span class="jxr_string">"Checking path-based configuration."</span>); |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> ini = loadIniFromPath(); |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> } |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_comment">//added for SHIRO-178:</em> |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> log.info(<span class="jxr_string">"Null or empty configuration specified via '"</span> + CONFIG_INIT_PARAM_NAME + <span class="jxr_string">"' or '"</span> + |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> CONFIG_PATH_INIT_PARAM_NAME + <span class="jxr_string">"' filter parameters. Trying the default "</span> + |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> DEFAULT_WEB_INI_RESOURCE_PATH + <span class="jxr_string">" file."</span>); |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> ini = getServletContextIniResource(DEFAULT_WEB_INI_RESOURCE_PATH); |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> } |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_comment">//although the preferred default is /WEB-INF/shiro.ini per SHIRO-178, keep this</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">//for backwards compatibility:</em> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> log.info(<span class="jxr_string">"Null or empty configuration specified via '"</span> + CONFIG_INIT_PARAM_NAME + <span class="jxr_string">"' or '"</span> + |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> CONFIG_PATH_INIT_PARAM_NAME + <span class="jxr_string">"' filter parameters. Trying the default "</span> + |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> IniFactorySupport.DEFAULT_INI_RESOURCE_PATH + <span class="jxr_string">" file."</span>); |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> ini = IniFactorySupport.loadDefaultClassPathIni(); |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> } |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> Map<String, ?> objects = applySecurityManager(ini); |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> applyFilterChainResolver(ini, objects); |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> } |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">protected</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> loadIniFromConfig() { |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> ini = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> String config = getConfig(); |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">if</strong> (config != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> ini = convertConfigToIni(config); |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> } |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">return</strong> ini; |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> } |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">protected</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> loadIniFromPath() { |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> ini = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> String path = getConfigPath(); |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (path != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> ini = convertPathToIni(path); |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> } |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">return</strong> ini; |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> } |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">protected</strong> Map<String, ?> applySecurityManager(<a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> ini) { |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <a name="WebIniSecurityManagerFactory" href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html#WebIniSecurityManagerFactory">WebIniSecurityManagerFactory</a> factory; |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> factory = <strong class="jxr_keyword">new</strong> <a name="WebIniSecurityManagerFactory" href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html#WebIniSecurityManagerFactory">WebIniSecurityManagerFactory</a>(); |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> factory = <strong class="jxr_keyword">new</strong> <a name="WebIniSecurityManagerFactory" href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html#WebIniSecurityManagerFactory">WebIniSecurityManagerFactory</a>(ini); |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> } |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_comment">// Create the security manager and check that it implements WebSecurityManager.</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment">// Otherwise, it can't be used with the filter.</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <a name="SecurityManager" href="../../../../../org/apache/shiro/mgt/SecurityManager.html#SecurityManager">SecurityManager</a> securityManager = factory.getInstance(); |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">if</strong> (!(securityManager instanceof <a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a>)) { |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> String msg = <span class="jxr_string">"The configured security manager is not an instance of WebSecurityManager, so "</span> + |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <span class="jxr_string">"it can not be used with the Shiro servlet filter."</span>; |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../../org/apache/shiro/config/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(msg); |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> } |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> setSecurityManager((<a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a>) securityManager); |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">return</strong> factory.getBeans(); |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> } |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> applyFilterChainResolver(<a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> ini, Map<String, ?> defaults) { |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> (ini == <strong class="jxr_keyword">null</strong> || ini.isEmpty()) { |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_comment">//nothing to use to create the resolver, just return</em> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_comment">//(the AbstractShiroFilter allows a null resolver, in which case the original FilterChain is</em> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_comment">// always used).</em> |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">return</strong>; |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> } |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_comment">//only create a resolver if the 'filters' or 'urls' sections are defined:</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> Ini.Section urls = ini.getSection(IniFilterChainResolverFactory.URLS); |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> Ini.Section filters = ini.getSection(IniFilterChainResolverFactory.FILTERS); |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">if</strong> ((urls != <strong class="jxr_keyword">null</strong> && !urls.isEmpty()) || (filters != <strong class="jxr_keyword">null</strong> && !filters.isEmpty())) { |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_comment">//either the urls section or the filters section was defined. Go ahead and create the resolver</em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_comment">//and set it:</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <a name="IniFilterChainResolverFactory" href="../../../../../org/apache/shiro/web/config/IniFilterCh<a name="IniFilterChainResolverFactory" href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html#IniFilterChainResolverFactory">IniFilterChainResolverFactory</a>lterChainResolverFactory">IniFilterChainResolverFactory</a> filterChainResolverFactory = <strong class="jxr_keyword">new</strong> <a name="IniFilterChainResolverFactory" href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html#IniFilterChainResolverFactory">IniFilterChainResolverFactory</a>(ini, defaults); |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> filterChainResolverFactory.setFilterConfig(getFilterConfig()); |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <a name="FilterChainResolver" href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#FilterChainResolver">FilterChainResolver</a> resolver = filterChainResolverFactory.getInstance(); |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> setFilterChainResolver(resolver); |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> } |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> } |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">protected</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> convertConfigToIni(String config) { |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <a name="Ini" href="../../../../../org/apache/shiro<a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a>nfig/Ini.html#Ini">Ini</a> ini = <strong class="jxr_keyword">new</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a>(); |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> ini.load(config); |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">return</strong> ini; |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> } |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * Returns the INI instance reflecting the specified servlet context resource path or {@code null} if no</em> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * resource was found.</em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @param servletContextPath the servlet context resource path of the INI file to load</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @return the INI instance reflecting the specified servlet context resource path or {@code null} if no</em> |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * resource was found.</em> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">protected</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> getServletContextIniResource(String servletContextPath) { |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> String path = WebUtils.normalize(servletContextPath); |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">if</strong> (getServletContext() != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> InputStream is = getServletContext().getResourceAsStream(path); |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">if</strong> (is != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <a name="Ini" href="../../../../../org/apache/shiro<a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a>nfig/Ini.html#Ini">Ini</a> ini = <strong class="jxr_keyword">new</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a>(); |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> ini.load(is); |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> log.warn(<span class="jxr_string">"ServletContext INI resource '"</span> + servletContextPath + <span class="jxr_string">"' exists, but it did not contain "</span> + |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> <span class="jxr_string">"any data."</span>); |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> } |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">return</strong> ini; |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> } |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> } |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> } |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * Converts the specified file path to an {@link Ini} instance.</em> |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * If the path does not have a resource prefix as defined by {@link ResourceUtils#hasResourcePrefix(String)}, the</em> |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * path is expected to be resolvable by the {@code ServletContext} via</em> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * {@link javax.servlet.ServletContext#getResourceAsStream(String)}.</em> |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * @param path the path of the INI resource to load into an INI instance.</em> |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * @return an INI instance populated based on the given INI resource path.</em> |
| <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> <strong class="jxr_keyword">protected</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a> convertPathToIni(String path) { |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <a name="Ini" href="../../../../../org/apache/shiro<a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a>nfig/Ini.html#Ini">Ini</a> ini = <strong class="jxr_keyword">new</strong> <a name="Ini" href="../../../../../org/apache/shiro/config/Ini.html#Ini">Ini</a>(); |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_comment">//SHIRO-178: Check for servlet context resource and not</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_comment">//only resource paths:</em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">if</strong> (!ResourceUtils.hasResourcePrefix(path)) { |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> ini = getServletContextIniResource(path); |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">if</strong> (ini == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> String msg = <span class="jxr_string">"There is no servlet context resource corresponding to configPath '"</span> + path + <span class="jxr_string">"' If "</span> + |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <span class="jxr_string">"the resource is located elsewhere (not immediately resolveable in the servlet context), "</span> + |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <span class="jxr_string">"specify an appropriate classpath:, url:, or file: resource prefix accordingly."</span>; |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../../org/apache/shiro/config/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(msg); |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> } |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_comment">//normal resource path - load as usual:</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> ini.loadFromPath(path); |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> } |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> ini; |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> } |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
