Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.2 / shiro-web / xref / org / apache / shiro / web / env / IniWebEnvironment.html
blob: 25e6f7fb2cd2f8916b50007340e36d86d087eb3b [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=UTF-8" />
<title>IniWebEnvironment xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/env/IniWebEnvironment.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.web.env;
<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.util.*;
<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.config.WebIniSecurityManagerFactory;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainResolver;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.WebSecurityManager;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<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.HashMap;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L39" href="#L39">39</a>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * {@link WebEnvironment} implementation configured by an {@link Ini} instance or {@code Ini} resource locations.</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 1.2</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/env/IniWebEnvironment.html">IniWebEnvironment</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/web/env/ResourceBasedWebEnvironment.html">ResourceBasedWebEnvironment</a> <strong class="jxr_keyword">implements</strong> Initializable, Destroyable {
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</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="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FILTER_CHAIN_RESOLVER_NAME = <span class="jxr_string">"filterChainResolver"</span>;
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(IniWebEnvironment.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * The Ini that configures this WebEnvironment instance.</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> Ini ini;
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html">WebIniSecurityManagerFactory</a> factory;
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/env/IniWebEnvironment.html">IniWebEnvironment</a>() {
<a class="jxr_linenumber" name="L60" href="#L60">60</a> factory = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html">WebIniSecurityManagerFactory</a>();
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Initializes this instance by resolving any potential (explicit or resource-configured) {@link Ini}</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * configuration and calling {@link #configure() configure} for actual instance configuration.</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() {
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> setIni(parseConfig());
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> configure();
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
<a class="jxr_linenumber" name="L73" href="#L73">73</a>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Loads configuration {@link Ini} from {@link #getConfigLocations()} if set, otherwise falling back</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * to the {@link #getDefaultConfigLocations()}. Finally any Ini objects will be merged with the value returned</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * from {@link #getFrameworkIni()}</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @return Ini configuration to be used by this Environment.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @since 1.4</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">protected</strong> Ini parseConfig() {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> Ini ini = getIni();
<a class="jxr_linenumber" name="L83" href="#L83">83</a>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> String[] configLocations = getConfigLocations();
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled() &amp;&amp; !CollectionUtils.isEmpty(ini) &amp;&amp;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> configLocations != <strong class="jxr_keyword">null</strong> &amp;&amp; configLocations.length &gt; 0) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> log.warn(<span class="jxr_string">"Explicit INI instance has been provided, but configuration locations have also been "</span> +
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <span class="jxr_string">"specified. The {} implementation does not currently support multiple Ini config, but this may "</span> +
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <span class="jxr_string">"be supported in the future. Only the INI instance will be used for configuration."</span>,
<a class="jxr_linenumber" name="L91" href="#L91">91</a> IniWebEnvironment.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> log.debug(<span class="jxr_string">"Checking any specified config locations."</span>);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> ini = getSpecifiedIni(configLocations);
<a class="jxr_linenumber" name="L97" href="#L97">97</a> }
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L100" href="#L100">100</a> log.debug(<span class="jxr_string">"No INI instance or config locations specified. Trying default config locations."</span>);
<a class="jxr_linenumber" name="L101" href="#L101">101</a> ini = getDefaultIni();
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
<a class="jxr_linenumber" name="L103" href="#L103">103</a>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment">// Allow for integrations to provide default that will be merged other configuration.</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment">// to retain backwards compatibility this must be a different method then 'getDefaultIni()'</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> ini = mergeIni(getFrameworkIni(), ini);
<a class="jxr_linenumber" name="L107" href="#L107">107</a>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> String msg = <span class="jxr_string">"Shiro INI configuration was either not found or discovered to be empty/unconfigured."</span>;
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(msg);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> ini;
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configure() {
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">this</strong>.objects.clear();
<a class="jxr_linenumber" name="L118" href="#L118">118</a>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> securityManager = createWebSecurityManager();
<a class="jxr_linenumber" name="L120" href="#L120">120</a> setWebSecurityManager(securityManager);
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> resolver = createFilterChainResolver();
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (resolver != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> setFilterChainResolver(resolver);
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Extension point to allow subclasses to provide an {@link Ini} configuration that will be merged into the</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * users configuration. The users configuration will override anything set here.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * &lt;strong&gt;NOTE:&lt;/strong&gt; Framework developers should use with caution. It is possible a user could provide</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * configuration that would conflict with the frameworks configuration. For example: if this method returns an</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Ini object with the following configuration:</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;&lt;code&gt;</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * [main]</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * realm = com.myco.FoobarRealm</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * realm.foobarSpecificField = A string</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * &lt;/code&gt;&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * And the user provides a similar configuration:</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;&lt;code&gt;</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * [main]</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * realm = net.differentco.MyCustomRealm</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * &lt;/code&gt;&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * This would merge into:</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;&lt;code&gt;</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * [main]</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * realm = net.differentco.MyCustomRealm</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * realm.foobarSpecificField = A string</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * &lt;/code&gt;&lt;/pre&gt;</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> <em class="jxr_javadoccomment"> * This may cause a configuration error if &lt;code&gt;MyCustomRealm&lt;/code&gt; does not contain the field &lt;code&gt;foobarSpecificField&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * This can be avoided if the Framework Ini uses more unique names, such as &lt;code&gt;foobarRealm&lt;/code&gt;. which would result</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * in a merged configuration that looks like:</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;&lt;code&gt;</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * [main]</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * foobarRealm = com.myco.FoobarRealm</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * foobarRealm.foobarSpecificField = A string</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * realm = net.differentco.MyCustomRealm</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * &lt;/code&gt;&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @return Ini configuration used by the framework integrations.</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @since 1.4</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">protected</strong> Ini getFrameworkIni() {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
<a class="jxr_linenumber" name="L171" href="#L171">171</a>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">protected</strong> Ini getSpecifiedIni(String[] configLocations) <strong class="jxr_keyword">throws</strong> ConfigurationException {
<a class="jxr_linenumber" name="L173" href="#L173">173</a>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> Ini ini = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L175" href="#L175">175</a>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (configLocations != <strong class="jxr_keyword">null</strong> &amp;&amp; configLocations.length &gt; 0) {
<a class="jxr_linenumber" name="L177" href="#L177">177</a>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (configLocations.length &gt; 1) {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> log.warn(<span class="jxr_string">"More than one Shiro .ini config location has been specified. Only the first will be "</span> +
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <span class="jxr_string">"used for configuration as the {} implementation does not currently support multiple "</span> +
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <span class="jxr_string">"files. This may be supported in the future however."</span>, IniWebEnvironment.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_comment">//required, as it is user specified:</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> ini = createIni(configLocations[0], <strong class="jxr_keyword">true</strong>);
<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">return</strong> ini;
<a class="jxr_linenumber" name="L189" href="#L189">189</a> }
<a class="jxr_linenumber" name="L190" href="#L190">190</a>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">protected</strong> Ini mergeIni(Ini ini1, Ini ini2) {
<a class="jxr_linenumber" name="L192" href="#L192">192</a>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (ini1 == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">return</strong> ini2;
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">if</strong> (ini2 == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">return</strong> ini1;
<a class="jxr_linenumber" name="L199" href="#L199">199</a> }
<a class="jxr_linenumber" name="L200" href="#L200">200</a>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_comment">// at this point we have two valid ini objects, create a new one and merge the contents of 2 into 1</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> Ini iniResult = <strong class="jxr_keyword">new</strong> Ini(ini1);
<a class="jxr_linenumber" name="L203" href="#L203">203</a> iniResult.merge(ini2);
<a class="jxr_linenumber" name="L204" href="#L204">204</a>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> iniResult;
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">protected</strong> Ini getDefaultIni() {
<a class="jxr_linenumber" name="L209" href="#L209">209</a>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> Ini ini = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L211" href="#L211">211</a>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> String[] configLocations = getDefaultConfigLocations();
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (configLocations != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">for</strong> (String location : configLocations) {
<a class="jxr_linenumber" name="L215" href="#L215">215</a> ini = createIni(location, false);
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L217" href="#L217">217</a> log.debug(<span class="jxr_string">"Discovered non-empty INI configuration at location '{}'. Using for configuration."</span>,
<a class="jxr_linenumber" name="L218" href="#L218">218</a> location);
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L220" href="#L220">220</a> }
<a class="jxr_linenumber" name="L221" href="#L221">221</a> }
<a class="jxr_linenumber" name="L222" href="#L222">222</a> }
<a class="jxr_linenumber" name="L223" href="#L223">223</a>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">return</strong> ini;
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * Creates an {@link Ini} instance reflecting the specified path, or {@code null} if the path does not exist and</em>
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * is not required.</em>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * If the path is required and does not exist or is empty, a {@link ConfigurationException} will be thrown.</em>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @param configLocation the resource path to load into an {@code Ini} instance.</em>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param required if the path must exist and be converted to a non-empty {@link Ini} instance.</em>
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @return an {@link Ini} instance reflecting the specified path, or {@code null} if the path does not exist and</em>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * is not required.</em>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @throws ConfigurationException if the path is required but results in a null or empty Ini instance.</em>
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">protected</strong> Ini createIni(String configLocation, <strong class="jxr_keyword">boolean</strong> required) <strong class="jxr_keyword">throws</strong> ConfigurationException {
<a class="jxr_linenumber" name="L240" href="#L240">240</a>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> Ini ini = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> (configLocation != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L244" href="#L244">244</a> ini = convertPathToIni(configLocation, required);
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (required &amp;&amp; CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> String msg = <span class="jxr_string">"Required configuration location '"</span> + configLocation + <span class="jxr_string">"' does not exist or did not "</span> +
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <span class="jxr_string">"contain any INI configuration."</span>;
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(msg);
<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
<a class="jxr_linenumber" name="L251" href="#L251">251</a>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">return</strong> ini;
<a class="jxr_linenumber" name="L253" href="#L253">253</a> }
<a class="jxr_linenumber" name="L254" href="#L254">254</a>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> createFilterChainResolver() {
<a class="jxr_linenumber" name="L256" href="#L256">256</a>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> resolver = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L258" href="#L258">258</a>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> Ini ini = getIni();
<a class="jxr_linenumber" name="L260" href="#L260">260</a>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_comment">//only create a resolver if the 'filters' or 'urls' sections are defined:</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> Ini.Section urls = ini.getSection(IniFilterChainResolverFactory.URLS);
<a class="jxr_linenumber" name="L264" href="#L264">264</a> Ini.Section filters = ini.getSection(IniFilterChainResolverFactory.FILTERS);
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(urls) || !CollectionUtils.isEmpty(filters)) {
<a class="jxr_linenumber" name="L266" href="#L266">266</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="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> Factory&lt;FilterChainResolver&gt; factory = (Factory&lt;FilterChainResolver&gt;) <strong class="jxr_keyword">this</strong>.objects.get(FILTER_CHAIN_RESOLVER_NAME);
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">if</strong> (factory instanceof IniFactorySupport) {
<a class="jxr_linenumber" name="L270" href="#L270">270</a> IniFactorySupport iniFactory = (IniFactorySupport) factory;
<a class="jxr_linenumber" name="L271" href="#L271">271</a> iniFactory.setIni(ini);
<a class="jxr_linenumber" name="L272" href="#L272">272</a> iniFactory.setDefaults(<strong class="jxr_keyword">this</strong>.objects);
<a class="jxr_linenumber" name="L273" href="#L273">273</a> }
<a class="jxr_linenumber" name="L274" href="#L274">274</a> resolver = factory.getInstance();
<a class="jxr_linenumber" name="L275" href="#L275">275</a> }
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
<a class="jxr_linenumber" name="L277" href="#L277">277</a>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">return</strong> resolver;
<a class="jxr_linenumber" name="L279" href="#L279">279</a> }
<a class="jxr_linenumber" name="L280" href="#L280">280</a>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> createWebSecurityManager() {
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> Ini ini = getIni();
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(ini)) {
<a class="jxr_linenumber" name="L285" href="#L285">285</a> factory.setIni(ini);
<a class="jxr_linenumber" name="L286" href="#L286">286</a> }
<a class="jxr_linenumber" name="L287" href="#L287">287</a>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> Map&lt;String, Object&gt; defaults = getDefaults();
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(defaults)) {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> factory.setDefaults(defaults);
<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> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> wsm = (WebSecurityManager)factory.getInstance();
<a class="jxr_linenumber" name="L294" href="#L294">294</a>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_comment">//SHIRO-306 - get beans after they've been created (the call was before the factory.getInstance() call,</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_comment">//which always returned null.</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> Map&lt;String, ?&gt; beans = factory.getBeans();
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(beans)) {
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">this</strong>.objects.putAll(beans);
<a class="jxr_linenumber" name="L300" href="#L300">300</a> }
<a class="jxr_linenumber" name="L301" href="#L301">301</a>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">return</strong> wsm;
<a class="jxr_linenumber" name="L303" href="#L303">303</a> }
<a class="jxr_linenumber" name="L304" href="#L304">304</a>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * Returns an array with two elements, {@code /WEB-INF/shiro.ini} and {@code classpath:shiro.ini}.</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> <em class="jxr_javadoccomment"> * @return an array with two elements, {@code /WEB-INF/shiro.ini} and {@code classpath:shiro.ini}.</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">protected</strong> String[] getDefaultConfigLocations() {
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String[]{
<a class="jxr_linenumber" name="L312" href="#L312">312</a> DEFAULT_WEB_INI_RESOURCE_PATH,
<a class="jxr_linenumber" name="L313" href="#L313">313</a> IniFactorySupport.DEFAULT_INI_RESOURCE_PATH
<a class="jxr_linenumber" name="L314" href="#L314">314</a> };
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
<a class="jxr_linenumber" name="L316" href="#L316">316</a>
<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"> * Converts the specified file path to an {@link Ini} instance.</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * If the path does not have a resource prefix as defined by {@link org.apache.shiro.io.ResourceUtils#hasResourcePrefix(String)}, the</em>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * path is expected to be resolvable by the {@code ServletContext} via</em>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * {@link javax.servlet.ServletContext#getResourceAsStream(String)}.</em>
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L324" href="#L324">324</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="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * @param required if the specified path must exist</em>
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * @return an INI instance populated based on the given INI resource path.</em>
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">private</strong> Ini convertPathToIni(String path, <strong class="jxr_keyword">boolean</strong> required) {
<a class="jxr_linenumber" name="L329" href="#L329">329</a>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_comment">//TODO - this logic is ugly - it'd be ideal if we had a Resource API to polymorphically encaspulate this behavior</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> Ini ini = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L333" href="#L333">333</a>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(path)) {
<a class="jxr_linenumber" name="L335" href="#L335">335</a> InputStream is = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L336" href="#L336">336</a>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_comment">//SHIRO-178: Check for servlet context resource and not only resource paths:</em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">if</strong> (!ResourceUtils.hasResourcePrefix(path)) {
<a class="jxr_linenumber" name="L339" href="#L339">339</a> is = getServletContextResourceStream(path);
<a class="jxr_linenumber" name="L340" href="#L340">340</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L342" href="#L342">342</a> is = ResourceUtils.getInputStreamForPath(path);
<a class="jxr_linenumber" name="L343" href="#L343">343</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (required) {
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(e);
<a class="jxr_linenumber" name="L346" href="#L346">346</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L348" href="#L348">348</a> log.debug(<span class="jxr_string">"Unable to load optional path '"</span> + path + <span class="jxr_string">"'."</span>, e);
<a class="jxr_linenumber" name="L349" href="#L349">349</a> }
<a class="jxr_linenumber" name="L350" href="#L350">350</a> }
<a class="jxr_linenumber" name="L351" href="#L351">351</a> }
<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong class="jxr_keyword">if</strong> (is != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L354" href="#L354">354</a> ini = <strong class="jxr_keyword">new</strong> Ini();
<a class="jxr_linenumber" name="L355" href="#L355">355</a> ini.load(is);
<a class="jxr_linenumber" name="L356" href="#L356">356</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">if</strong> (required) {
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(<span class="jxr_string">"Unable to load resource path '"</span> + path + <span class="jxr_string">"'"</span>);
<a class="jxr_linenumber" name="L359" href="#L359">359</a> }
<a class="jxr_linenumber" name="L360" href="#L360">360</a> }
<a class="jxr_linenumber" name="L361" href="#L361">361</a> }
<a class="jxr_linenumber" name="L362" href="#L362">362</a>
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">return</strong> ini;
<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> <em class="jxr_comment">//TODO - this logic is ugly - it'd be ideal if we had a Resource API to polymorphically encaspulate this behavior</em>
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">private</strong> InputStream getServletContextResourceStream(String path) {
<a class="jxr_linenumber" name="L368" href="#L368">368</a> InputStream is = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L369" href="#L369">369</a>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> path = WebUtils.normalize(path);
<a class="jxr_linenumber" name="L371" href="#L371">371</a> ServletContext sc = getServletContext();
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">if</strong> (sc != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L373" href="#L373">373</a> is = sc.getResourceAsStream(path);
<a class="jxr_linenumber" name="L374" href="#L374">374</a> }
<a class="jxr_linenumber" name="L375" href="#L375">375</a>
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">return</strong> is;
<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
<a class="jxr_linenumber" name="L378" href="#L378">378</a>
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * Returns the {@code Ini} instance reflecting this WebEnvironment's configuration.</em>
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @return the {@code Ini} instance reflecting this WebEnvironment's configuration.</em>
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">public</strong> Ini getIni() {
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.ini;
<a class="jxr_linenumber" name="L386" href="#L386">386</a> }
<a class="jxr_linenumber" name="L387" href="#L387">387</a>
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * Allows for configuration via a direct {@link Ini} instance instead of via</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * {@link #getConfigLocations() config locations}.</em>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * If the specified instance is null or empty, the fallback/default resource-based configuration will be used.</em>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @param ini the ini instance to use for creation.</em>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIni(Ini ini) {
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">this</strong>.ini = ini;
<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> <strong class="jxr_keyword">protected</strong> Map&lt;String, Object&gt; getDefaults() {
<a class="jxr_linenumber" name="L401" href="#L401">401</a> Map&lt;String, Object&gt; defaults = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Object&gt;();
<a class="jxr_linenumber" name="L402" href="#L402">402</a> defaults.put(FILTER_CHAIN_RESOLVER_NAME, <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/config/IniFilterChainResolverFactory.html">IniFilterChainResolverFactory</a>());
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">return</strong> defaults;
<a class="jxr_linenumber" name="L404" href="#L404">404</a> }
<a class="jxr_linenumber" name="L405" href="#L405">405</a>
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * Returns the SecurityManager factory used by this WebEnvironment.</em>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * @return the SecurityManager factory used by this WebEnvironment.</em>
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * @since 1.4</em>
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L412" href="#L412">412</a> @SuppressWarnings(<span class="jxr_string">"unused"</span>)
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html">WebIniSecurityManagerFactory</a> getSecurityManagerFactory() {
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">return</strong> factory;
<a class="jxr_linenumber" name="L415" href="#L415">415</a> }
<a class="jxr_linenumber" name="L416" href="#L416">416</a>
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * Allows for setting the SecurityManager factory which will be used to create the SecurityManager.</em>
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * @param factory the SecurityManager factory to used.</em>
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @since 1.4</em>
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setSecurityManagerFactory(<a href="../../../../../org/apache/shiro/web/config/WebIniSecurityManagerFactory.html">WebIniSecurityManagerFactory</a> factory) {
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">this</strong>.factory = factory;
<a class="jxr_linenumber" name="L425" href="#L425">425</a> }
<a class="jxr_linenumber" name="L426" href="#L426">426</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>