| <!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>EnvironmentLoader xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/env/EnvironmentLoader.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.ResourceConfigurable; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ClassUtils; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.LifecycleUtils; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.UnknownClassException; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * An {@code EnvironmentLoader} is responsible for loading a web application's Shiro {@link WebEnvironment}</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * (which includes the web app's {@link org.apache.shiro.web.mgt.WebSecurityManager WebSecurityManager}) into the</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * {@code ServletContext} at application startup.</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * In Shiro 1.1 and earlier, the Shiro ServletFilter was responsible for creating the {@code WebSecurityManager} and</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * any additional objects (security filters, etc). However, any component not filtered by the Shiro Filter (such</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * as other context listeners) was not able to easily acquire the these objects to perform security operations.</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Due to this, in Shiro 1.2 and later, this {@code EnvironmentLoader} (or more likely, the</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * {@link EnvironmentLoaderListener} subclass) is the preferred mechanism to initialize</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * a Shiro environment. The Shiro Filter, while still required for request filtering, will not perform this</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * initialization at startup if the {@code EnvironmentLoader} (or listener) runs first.</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <h2>Usage</h2></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * This implementation will look for two servlet context {@code context-param}s in {@code web.xml}:</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * {@code shiroEnvironmentClass} and {@code shiroConfigLocations} that customize how the {@code WebEnvironment} instance</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * will be initialized.</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <h3>shiroEnvironmentClass</h3></em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * The {@code shiroEnvironmentClass} {@code context-param}, if it exists, allows you to specify the</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * fully-qualified implementation class name of the {@link WebEnvironment} to instantiate. For example:</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &lt;context-param&gt;</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;param-name&gt;shiroEnvironmentClass&lt;/param-name&gt;</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * &lt;param-value&gt;com.foo.bar.shiro.MyWebEnvironment&lt;/param-value&gt;</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * &lt;/context-param&gt;</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"> * If not specified, the default value is the {@link IniWebEnvironment} class, which assumes Shiro's default</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</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>">INI configuration format</a></em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <h3>shiroConfigLocations</h3></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * The {@code shiroConfigLocations} {@code context-param}, if it exists, allows you to specify the config location(s)</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * (resource path(s)) that will be relayed to the instantiated {@link WebEnvironment}. For example:</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * &lt;context-param&gt;</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * &lt;param-name&gt;shiroConfigLocations&lt;/param-name&gt;</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * &lt;param-value&gt;/WEB-INF/someLocation/shiro.ini&lt;/param-value&gt;</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * &lt;/context-param&gt;</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * The {@code WebEnvironment} implementation must implement the {@link ResourceConfigurable} interface if it is to</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * acquire the {@code shiroConfigLocations} value.</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * If this {@code context-param} is not specified, the {@code WebEnvironment} instance determines default resource</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * lookup behavior. For example, the {@link IniWebEnvironment} will check the following two locations for INI config</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * by default (in order):</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * <li>/WEB-INF/shiro.ini</li></em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * <li>classpath:shiro.ini</li></em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * <h2>Web Security Enforcement</h2></em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Using this loader will only initialize Shiro's environment in a web application - it will not filter web requests or</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * perform web-specific security operations. To do this, you must ensure that you have also configured the</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} in {@code web.xml}.</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Finally, it should be noted that this implementation was based on ideas in Spring 3's</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * {@code org.springframework.web.context.ContextLoader} implementation - no need to reinvent the wheel for this common</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * behavior.</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @see EnvironmentLoaderListener</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.web.servlet.ShiroFilter ShiroFilter</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html">EnvironmentLoader</a> { |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Servlet Context config param for specifying the {@link WebEnvironment} implementation class to use:</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * {@code shiroEnvironmentClass}</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ENVIRONMENT_CLASS_PARAM = <span class="jxr_string">"shiroEnvironmentClass"</span>; |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Servlet Context config param for the resource path to use for configuring the {@link WebEnvironment} instance:</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * {@code shiroConfigLocations}</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONFIG_LOCATIONS_PARAM = <span class="jxr_string">"shiroConfigLocations"</span>; |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ENVIRONMENT_ATTRIBUTE_KEY = EnvironmentLoader.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">".ENVIRONMENT_ATTRIBUTE_KEY"</span>; |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(EnvironmentLoader.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Initializes Shiro's {@link WebEnvironment} instance for the specified {@code ServletContext} based on the</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * {@link #CONFIG_LOCATIONS_PARAM} value.</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @param servletContext current servlet context</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @return the new Shiro {@code WebEnvironment} instance.</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if an existing WebEnvironment has already been initialized and associated with</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * the specified {@code ServletContext}.</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/env/WebEnvironment.html">WebEnvironment</a> initEnvironment(ServletContext servletContext) <strong class="jxr_keyword">throws</strong> IllegalStateException { |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">if</strong> (servletContext.getAttribute(ENVIRONMENT_ATTRIBUTE_KEY) != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> String msg = <span class="jxr_string">"There is already a Shiro environment associated with the current ServletContext. "</span> + |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <span class="jxr_string">"Check if you have multiple EnvironmentLoader* definitions in your web.xml!"</span>; |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <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> servletContext.log(<span class="jxr_string">"Initializing Shiro environment"</span>); |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> log.info(<span class="jxr_string">"Starting Shiro environment initialization."</span>); |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">long</strong> startTime = System.currentTimeMillis(); |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <a href="../../../../../org/apache/shiro/web/env/WebEnvironment.html">WebEnvironment</a> environment = createEnvironment(servletContext); |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY,environment); |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> log.debug(<span class="jxr_string">"Published WebEnvironment as ServletContext attribute with name [{}]"</span>, |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> ENVIRONMENT_ATTRIBUTE_KEY); |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) { |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">long</strong> elapsed = System.currentTimeMillis() - startTime; |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> log.info(<span class="jxr_string">"Shiro environment initialized in {} ms."</span>, elapsed); |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> } |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">return</strong> environment; |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> } <strong class="jxr_keyword">catch</strong> (RuntimeException ex) { |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> log.error(<span class="jxr_string">"Shiro environment initialization failed"</span>, ex); |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, ex); |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">throw</strong> ex; |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> } <strong class="jxr_keyword">catch</strong> (Error err) { |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> log.error(<span class="jxr_string">"Shiro environment initialization failed"</span>, err); |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, err); |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">throw</strong> err; |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> } |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> } |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Return the WebEnvironment implementation class to use, either the default</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * {@link IniWebEnvironment} or a custom class if specified.</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param servletContext current servlet context</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @return the WebEnvironment implementation class to use</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @see #ENVIRONMENT_CLASS_PARAM</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @see IniWebEnvironment</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">protected</strong> Class<?> determineWebEnvironmentClass(ServletContext servletContext) { |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> String className = servletContext.getInitParameter(ENVIRONMENT_CLASS_PARAM); |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (className != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> ClassUtils.forName(className); |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> } <strong class="jxr_keyword">catch</strong> (UnknownClassException ex) { |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException( |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <span class="jxr_string">"Failed to load custom WebEnvironment class ["</span> + className + <span class="jxr_string">"]"</span>, ex); |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> } |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">return</strong> IniWebEnvironment.<strong class="jxr_keyword">class</strong>; |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> } |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> } |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> |
| <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"> * Instantiates a {@link WebEnvironment} based on the specified ServletContext.</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * This implementation {@link #determineWebEnvironmentClass(javax.servlet.ServletContext) determines} a</em> |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * {@link WebEnvironment} implementation class to use. That class is instantiated, configured, and returned.</em> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * This allows custom {@code WebEnvironment} implementations to be specified via a ServletContext init-param if</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * desired. If not specified, the default {@link IniWebEnvironment} implementation will be used.</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @param sc current servlet context</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @return the constructed Shiro WebEnvironment instance</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @see MutableWebEnvironment</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * @see ResourceConfigurable</em> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/env/WebEnvironment.html">WebEnvironment</a> createEnvironment(ServletContext sc) { |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> Class<?> clazz = determineWebEnvironmentClass(sc); |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">if</strong> (!MutableWebEnvironment.<strong class="jxr_keyword">class</strong>.isAssignableFrom(clazz)) { |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(<span class="jxr_string">"Custom WebEnvironment class ["</span> + clazz.getName() + |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <span class="jxr_string">"] is not of required type ["</span> + MutableWebEnvironment.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"]"</span>); |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> } |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> String configLocations = sc.getInitParameter(CONFIG_LOCATIONS_PARAM); |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">boolean</strong> configSpecified = StringUtils.hasText(configLocations); |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> (configSpecified && !(ResourceConfigurable.<strong class="jxr_keyword">class</strong>.isAssignableFrom(clazz))) { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> String msg = <span class="jxr_string">"WebEnvironment class ["</span> + clazz.getName() + <span class="jxr_string">"] does not implement the "</span> + |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> ResourceConfigurable.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"interface. This is required to accept any "</span> + |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <span class="jxr_string">"configured "</span> + CONFIG_LOCATIONS_PARAM + <span class="jxr_string">"value(s)."</span>; |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(msg); |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> } |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <a href="../../../../../org/apache/shiro/web/env/MutableWebEnvironment.html">MutableWebEnvironment</a> environment = (MutableWebEnvironment) ClassUtils.newInstance(clazz); |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> environment.setServletContext(sc); |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">if</strong> (configSpecified && (environment instanceof ResourceConfigurable)) { |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> ((ResourceConfigurable) environment).setConfigLocations(configLocations); |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> } |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> customizeEnvironment(environment); |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> LifecycleUtils.init(environment); |
| <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> environment; |
| <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"> * Any additional customization of the Environment can be by overriding this method. For example setup shared</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * resources, etc. By default this method does nothing.</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @param environment</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> customizeEnvironment(<a href="../../../../../org/apache/shiro/web/env/WebEnvironment.html">WebEnvironment</a> environment) { |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> } |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * Destroys the {@link WebEnvironment} for the given servlet context.</em> |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @param servletContext the ServletContext attributed to the WebSecurityManager</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroyEnvironment(ServletContext servletContext) { |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> servletContext.log(<span class="jxr_string">"Cleaning up Shiro Environment"</span>); |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> Object environment = servletContext.getAttribute(ENVIRONMENT_ATTRIBUTE_KEY); |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (environment instanceof WebEnvironment) { |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> finalizeEnvironment((WebEnvironment) environment); |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> } |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> LifecycleUtils.destroy(environment); |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> } <strong class="jxr_keyword">finally</strong> { |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> servletContext.removeAttribute(ENVIRONMENT_ATTRIBUTE_KEY); |
| <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> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * Any additional cleanup of the Environment can be done by overriding this method. For example clean up shared</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * resources, etc. By default this method does nothing.</em> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @param environment</em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @since 1.3</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> finalizeEnvironment(<a href="../../../../../org/apache/shiro/web/env/WebEnvironment.html">WebEnvironment</a> environment) { |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> } |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
