Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.3.0 / xref / org / apache / shiro / realm / text / PropertiesRealm.html
blob: ce748071d8c52a0a478ae439639b3e110d2dd266 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>PropertiesRealm xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/text/PropertiesRealm.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.text;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.ShiroException;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.ResourceUtils;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.Destroyable;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ExecutorService;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.Executors;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ScheduledExecutorService;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.TimeUnit;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * A {@link TextConfigurationRealm} that defers all logic to the parent class, but just enables</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * {@link java.util.Properties Properties} based configuration in addition to the parent class's String configuration.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * This class allows processing of a single .properties file for user, role, and</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * permission configuration.</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * The {@link #setResourcePath resourcePath} &lt;em&gt;MUST&lt;/em&gt; be set before this realm can be initialized. You</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * can specify any resource path supported by</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@link ResourceUtils#getInputStreamForPath(String) ResourceUtils.getInputStreamForPath} method.</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * The Properties format understood by this implementation must be written as follows:</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Each line's key/value pair represents either a user-to-role(s) mapping &lt;em&gt;or&lt;/em&gt; a role-to-permission(s)</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * mapping.</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * The user-to-role(s) lines have this format:&lt;/p&gt;</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * &lt;code&gt;&lt;b&gt;user.&lt;/b&gt;&lt;em&gt;username&lt;/em&gt; = &lt;em&gt;password&lt;/em&gt;,role1,role2,...&lt;/code&gt;&lt;/p&gt;</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Note that each key is prefixed with the token &lt;b&gt;{@code user.}&lt;/b&gt; Each value must adhere to the</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * the {@link #setUserDefinitions(String) setUserDefinitions(String)} JavaDoc.</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * The role-to-permission(s) lines have this format:&lt;/p&gt;</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * &lt;code&gt;&lt;b&gt;role.&lt;/b&gt;&lt;em&gt;rolename&lt;/em&gt; = &lt;em&gt;permissionDefinition1&lt;/em&gt;, &lt;em&gt;permissionDefinition2&lt;/em&gt;, ...&lt;/code&gt;</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * where each key is prefixed with the token &lt;b&gt;{@code role.}&lt;/b&gt; and the value adheres to the format specified in</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * the {@link #setRoleDefinitions(String) setRoleDefinitions(String)} JavaDoc.</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Here is an example of a very simple properties definition that conforms to the above format rules and corresponding</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * method JavaDocs:</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * &lt;code&gt;user.root = &lt;em&gt;rootPassword&lt;/em&gt;,administrator&lt;br/&gt;</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * user.jsmith = &lt;em&gt;jsmithPassword&lt;/em&gt;,manager,engineer,employee&lt;br/&gt;</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * user.abrown = &lt;em&gt;abrownPassword&lt;/em&gt;,qa,employee&lt;br/&gt;</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * user.djones = &lt;em&gt;djonesPassword&lt;/em&gt;,qa,contractor&lt;br/&gt;</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * &lt;br/&gt;</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * role.administrator = *&lt;br/&gt;</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * role.manager = &amp;quot;user:read,write&amp;quot;, file:execute:/usr/local/emailManagers.sh&lt;br/&gt;</em>
<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * role.engineer = &amp;quot;file:read,execute:/usr/local/tomcat/bin/startup.sh&amp;quot;&lt;br/&gt;</em>
<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * role.employee = application:use:wiki&lt;br/&gt;</em>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * role.qa = &amp;quot;server:view,start,shutdown,restart:someQaServer&amp;quot;, server:view:someProductionServer&lt;br/&gt;</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * role.contractor = application:use:timesheet&lt;/code&gt;</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> *</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em>
<a name="84" href="#84">84</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/text/PropertiesRealm.html">PropertiesRealm</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/realm/text/TextConfigurationRealm.html">TextConfigurationRealm</a> implements Destroyable, Runnable {
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> <em class="jxr_comment">/*<em class="jxr_comment">-------------------------------------------</em></em>
<a name="89" href="#89">89</a> <em class="jxr_comment"> | C O N S T A N T S |</em>
<a name="90" href="#90">90</a> <em class="jxr_comment"> ============================================*/</em>
<a name="91" href="#91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_RELOAD_INTERVAL_SECONDS = 10;
<a name="92" href="#92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String USERNAME_PREFIX = <span class="jxr_string">"user."</span>;
<a name="93" href="#93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ROLENAME_PREFIX = <span class="jxr_string">"role."</span>;
<a name="94" href="#94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_RESOURCE_PATH = <span class="jxr_string">"classpath:shiro-users.properties"</span>;
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <em class="jxr_comment">/*<em class="jxr_comment">-------------------------------------------</em></em>
<a name="97" href="#97">97</a> <em class="jxr_comment"> | I N S T A N C E V A R I A B L E S |</em>
<a name="98" href="#98">98</a> <em class="jxr_comment"> ============================================*/</em>
<a name="99" href="#99">99</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(PropertiesRealm.<strong class="jxr_keyword">class</strong>);
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> <strong class="jxr_keyword">protected</strong> ExecutorService scheduler = <strong class="jxr_keyword">null</strong>;
<a name="102" href="#102">102</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> useXmlFormat = false;
<a name="103" href="#103">103</a> <strong class="jxr_keyword">protected</strong> String resourcePath = DEFAULT_RESOURCE_PATH;
<a name="104" href="#104">104</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> fileLastModified;
<a name="105" href="#105">105</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> reloadIntervalSeconds = DEFAULT_RELOAD_INTERVAL_SECONDS;
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/realm/text/PropertiesRealm.html">PropertiesRealm</a>() {
<a name="108" href="#108">108</a> <strong class="jxr_keyword">super</strong>();
<a name="109" href="#109">109</a> }
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em>
<a name="112" href="#112">112</a> <em class="jxr_comment"> | A C C E S S O R S / M O D I F I E R S |</em>
<a name="113" href="#113">113</a> <em class="jxr_comment"> ============================================*/</em>
<a name="114" href="#114">114</a>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Determines whether or not the properties XML format should be used. For more information, see</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * {@link Properties#loadFromXML(java.io.InputStream)}</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param useXmlFormat true to use XML or false to use the normal format. Defaults to false.</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
<a name="121" href="#121">121</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUseXmlFormat(<strong class="jxr_keyword">boolean</strong> useXmlFormat) {
<a name="122" href="#122">122</a> <strong class="jxr_keyword">this</strong>.useXmlFormat = useXmlFormat;
<a name="123" href="#123">123</a> }
<a name="124" href="#124">124</a>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Sets the path of the properties file to load user, role, and permission information from. The properties</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * file will be loaded using {@link ResourceUtils#getInputStreamForPath(String)} so any convention recongized</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * by that method is accepted here. For example, to load a file from the classpath use</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * {@code classpath:myfile.properties}; to load a file from disk simply specify the full path; to load</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * a file from a URL use {@code url:www.mysite.com/myfile.properties}.</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> *</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @param resourcePath the path to load the properties file from. This is a required property.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em>
<a name="134" href="#134">134</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setResourcePath(String resourcePath) {
<a name="135" href="#135">135</a> <strong class="jxr_keyword">this</strong>.resourcePath = resourcePath;
<a name="136" href="#136">136</a> }
<a name="137" href="#137">137</a>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * Sets the interval in seconds at which the property file will be checked for changes and reloaded. If this is</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * set to zero or less, property file reloading will be disabled. If it is set to 1 or greater, then a</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * separate thread will be created to monitor the propery file for changes and reload the file if it is updated.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> *</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @param reloadIntervalSeconds the interval in seconds at which the property file should be examined for changes.</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * If set to zero or less, reloading is disabled.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a name="146" href="#146">146</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReloadIntervalSeconds(<strong class="jxr_keyword">int</strong> reloadIntervalSeconds) {
<a name="147" href="#147">147</a> <strong class="jxr_keyword">this</strong>.reloadIntervalSeconds = reloadIntervalSeconds;
<a name="148" href="#148">148</a> }
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em>
<a name="151" href="#151">151</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a name="152" href="#152">152</a> <em class="jxr_comment"> ============================================*/</em>
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> @Override
<a name="155" href="#155">155</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onInit() {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">super</strong>.onInit();
<a name="157" href="#157">157</a> <em class="jxr_comment">//TODO - cleanup - this method shouldn't be necessary</em>
<a name="158" href="#158">158</a> afterRoleCacheSet();
<a name="159" href="#159">159</a> }
<a name="160" href="#160">160</a>
<a name="161" href="#161">161</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> afterRoleCacheSet() {
<a name="162" href="#162">162</a> loadProperties();
<a name="163" href="#163">163</a> <em class="jxr_comment">//we can only determine if files have been modified at runtime (not classpath entries or urls), so only</em>
<a name="164" href="#164">164</a> <em class="jxr_comment">//start the thread in this case:</em>
<a name="165" href="#165">165</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.resourcePath.startsWith(ResourceUtils.FILE_PREFIX) &amp;&amp; scheduler == <strong class="jxr_keyword">null</strong>) {
<a name="166" href="#166">166</a> startReloadThread();
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a> }
<a name="169" href="#169">169</a>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Destroy reload scheduler if one exists.</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> */</em>
<a name="173" href="#173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() {
<a name="174" href="#174">174</a> <strong class="jxr_keyword">try</strong> {
<a name="175" href="#175">175</a> <strong class="jxr_keyword">if</strong> (scheduler != <strong class="jxr_keyword">null</strong>) {
<a name="176" href="#176">176</a> scheduler.shutdown();
<a name="177" href="#177">177</a> }
<a name="178" href="#178">178</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="179" href="#179">179</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a name="180" href="#180">180</a> log.info(<span class="jxr_string">"Unable to cleanly shutdown Scheduler. Ignoring (shutting down)..."</span>, e);
<a name="181" href="#181">181</a> }
<a name="182" href="#182">182</a> } <strong class="jxr_keyword">finally</strong> {
<a name="183" href="#183">183</a> scheduler = <strong class="jxr_keyword">null</strong>;
<a name="184" href="#184">184</a> }
<a name="185" href="#185">185</a> }
<a name="186" href="#186">186</a>
<a name="187" href="#187">187</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> startReloadThread() {
<a name="188" href="#188">188</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.reloadIntervalSeconds &gt; 0) {
<a name="189" href="#189">189</a> <strong class="jxr_keyword">this</strong>.scheduler = Executors.newSingleThreadScheduledExecutor();
<a name="190" href="#190">190</a> ((ScheduledExecutorService) <strong class="jxr_keyword">this</strong>.scheduler).scheduleAtFixedRate(<strong class="jxr_keyword">this</strong>, reloadIntervalSeconds, reloadIntervalSeconds, TimeUnit.SECONDS);
<a name="191" href="#191">191</a> }
<a name="192" href="#192">192</a> }
<a name="193" href="#193">193</a>
<a name="194" href="#194">194</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() {
<a name="195" href="#195">195</a> <strong class="jxr_keyword">try</strong> {
<a name="196" href="#196">196</a> reloadPropertiesIfNecessary();
<a name="197" href="#197">197</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="198" href="#198">198</a> <strong class="jxr_keyword">if</strong> (log.isErrorEnabled()) {
<a name="199" href="#199">199</a> log.error(<span class="jxr_string">"Error while reloading property files for realm."</span>, e);
<a name="200" href="#200">200</a> }
<a name="201" href="#201">201</a> }
<a name="202" href="#202">202</a> }
<a name="203" href="#203">203</a>
<a name="204" href="#204">204</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> loadProperties() {
<a name="205" href="#205">205</a> <strong class="jxr_keyword">if</strong> (resourcePath == <strong class="jxr_keyword">null</strong> || resourcePath.length() == 0) {
<a name="206" href="#206">206</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"The resourcePath property is not set. "</span> +
<a name="207" href="#207">207</a> <span class="jxr_string">"It must be set prior to this realm being initialized."</span>);
<a name="208" href="#208">208</a> }
<a name="209" href="#209">209</a>
<a name="210" href="#210">210</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="211" href="#211">211</a> log.debug(<span class="jxr_string">"Loading user security information from file ["</span> + resourcePath + <span class="jxr_string">"]..."</span>);
<a name="212" href="#212">212</a> }
<a name="213" href="#213">213</a>
<a name="214" href="#214">214</a> Properties properties = loadProperties(resourcePath);
<a name="215" href="#215">215</a> createRealmEntitiesFromProperties(properties);
<a name="216" href="#216">216</a> }
<a name="217" href="#217">217</a>
<a name="218" href="#218">218</a> <strong class="jxr_keyword">private</strong> Properties loadProperties(String resourcePath) {
<a name="219" href="#219">219</a> Properties props = <strong class="jxr_keyword">new</strong> Properties();
<a name="220" href="#220">220</a>
<a name="221" href="#221">221</a> InputStream is = <strong class="jxr_keyword">null</strong>;
<a name="222" href="#222">222</a> <strong class="jxr_keyword">try</strong> {
<a name="223" href="#223">223</a>
<a name="224" href="#224">224</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="225" href="#225">225</a> log.debug(<span class="jxr_string">"Opening input stream for path ["</span> + resourcePath + <span class="jxr_string">"]..."</span>);
<a name="226" href="#226">226</a> }
<a name="227" href="#227">227</a>
<a name="228" href="#228">228</a> is = ResourceUtils.getInputStreamForPath(resourcePath);
<a name="229" href="#229">229</a> <strong class="jxr_keyword">if</strong> (useXmlFormat) {
<a name="230" href="#230">230</a>
<a name="231" href="#231">231</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="232" href="#232">232</a> log.debug(<span class="jxr_string">"Loading properties from path ["</span> + resourcePath + <span class="jxr_string">"] in XML format..."</span>);
<a name="233" href="#233">233</a> }
<a name="234" href="#234">234</a>
<a name="235" href="#235">235</a> props.loadFromXML(is);
<a name="236" href="#236">236</a> } <strong class="jxr_keyword">else</strong> {
<a name="237" href="#237">237</a>
<a name="238" href="#238">238</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="239" href="#239">239</a> log.debug(<span class="jxr_string">"Loading properties from path ["</span> + resourcePath + <span class="jxr_string">"]..."</span>);
<a name="240" href="#240">240</a> }
<a name="241" href="#241">241</a>
<a name="242" href="#242">242</a> props.load(is);
<a name="243" href="#243">243</a> }
<a name="244" href="#244">244</a>
<a name="245" href="#245">245</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a name="246" href="#246">246</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/ShiroException.html">ShiroException</a>(<span class="jxr_string">"Error reading properties path ["</span> + resourcePath + <span class="jxr_string">"]. "</span> +
<a name="247" href="#247">247</a> <span class="jxr_string">"Initializing of the realm from this file failed."</span>, e);
<a name="248" href="#248">248</a> } <strong class="jxr_keyword">finally</strong> {
<a name="249" href="#249">249</a> ResourceUtils.close(is);
<a name="250" href="#250">250</a> }
<a name="251" href="#251">251</a>
<a name="252" href="#252">252</a> <strong class="jxr_keyword">return</strong> props;
<a name="253" href="#253">253</a> }
<a name="254" href="#254">254</a>
<a name="255" href="#255">255</a>
<a name="256" href="#256">256</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> reloadPropertiesIfNecessary() {
<a name="257" href="#257">257</a> <strong class="jxr_keyword">if</strong> (isSourceModified()) {
<a name="258" href="#258">258</a> restart();
<a name="259" href="#259">259</a> }
<a name="260" href="#260">260</a> }
<a name="261" href="#261">261</a>
<a name="262" href="#262">262</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isSourceModified() {
<a name="263" href="#263">263</a> <em class="jxr_comment">//we can only check last modified times on files - classpath and URL entries can't tell us modification times</em>
<a name="264" href="#264">264</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.resourcePath.startsWith(ResourceUtils.FILE_PREFIX) &amp;&amp; isFileModified();
<a name="265" href="#265">265</a> }
<a name="266" href="#266">266</a>
<a name="267" href="#267">267</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isFileModified() {
<a name="268" href="#268">268</a> <em class="jxr_comment">//SHIRO-394: strip file prefix before constructing the File instance:</em>
<a name="269" href="#269">269</a> String fileNameWithoutPrefix = <strong class="jxr_keyword">this</strong>.resourcePath.substring(<strong class="jxr_keyword">this</strong>.resourcePath.indexOf(<span class="jxr_string">":"</span>) + 1);
<a name="270" href="#270">270</a> File propertyFile = <strong class="jxr_keyword">new</strong> File(fileNameWithoutPrefix);
<a name="271" href="#271">271</a> <strong class="jxr_keyword">long</strong> currentLastModified = propertyFile.lastModified();
<a name="272" href="#272">272</a> <strong class="jxr_keyword">if</strong> (currentLastModified &gt; <strong class="jxr_keyword">this</strong>.fileLastModified) {
<a name="273" href="#273">273</a> <strong class="jxr_keyword">this</strong>.fileLastModified = currentLastModified;
<a name="274" href="#274">274</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="275" href="#275">275</a> } <strong class="jxr_keyword">else</strong> {
<a name="276" href="#276">276</a> <strong class="jxr_keyword">return</strong> false;
<a name="277" href="#277">277</a> }
<a name="278" href="#278">278</a> }
<a name="279" href="#279">279</a>
<a name="280" href="#280">280</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a name="281" href="#281">281</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> restart() {
<a name="282" href="#282">282</a> <strong class="jxr_keyword">if</strong> (resourcePath == <strong class="jxr_keyword">null</strong> || resourcePath.length() == 0) {
<a name="283" href="#283">283</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"The resourcePath property is not set. "</span> +
<a name="284" href="#284">284</a> <span class="jxr_string">"It must be set prior to this realm being initialized."</span>);
<a name="285" href="#285">285</a> }
<a name="286" href="#286">286</a>
<a name="287" href="#287">287</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="288" href="#288">288</a> log.debug(<span class="jxr_string">"Loading user security information from file ["</span> + resourcePath + <span class="jxr_string">"]..."</span>);
<a name="289" href="#289">289</a> }
<a name="290" href="#290">290</a>
<a name="291" href="#291">291</a> <strong class="jxr_keyword">try</strong> {
<a name="292" href="#292">292</a> destroy();
<a name="293" href="#293">293</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="294" href="#294">294</a> <em class="jxr_comment">//ignored</em>
<a name="295" href="#295">295</a> }
<a name="296" href="#296">296</a> init();
<a name="297" href="#297">297</a> }
<a name="298" href="#298">298</a>
<a name="299" href="#299">299</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a name="300" href="#300">300</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> createRealmEntitiesFromProperties(Properties properties) {
<a name="301" href="#301">301</a>
<a name="302" href="#302">302</a> StringBuilder userDefs = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="303" href="#303">303</a> StringBuilder roleDefs = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="304" href="#304">304</a>
<a name="305" href="#305">305</a> Enumeration&lt;String&gt; propNames = (Enumeration&lt;String&gt;) properties.propertyNames();
<a name="306" href="#306">306</a>
<a name="307" href="#307">307</a> <strong class="jxr_keyword">while</strong> (propNames.hasMoreElements()) {
<a name="308" href="#308">308</a>
<a name="309" href="#309">309</a> String key = propNames.nextElement().trim();
<a name="310" href="#310">310</a> String value = properties.getProperty(key).trim();
<a name="311" href="#311">311</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="312" href="#312">312</a> log.trace(<span class="jxr_string">"Processing properties line - key: ["</span> + key + <span class="jxr_string">"], value: ["</span> + value + <span class="jxr_string">"]."</span>);
<a name="313" href="#313">313</a> }
<a name="314" href="#314">314</a>
<a name="315" href="#315">315</a> <strong class="jxr_keyword">if</strong> (isUsername(key)) {
<a name="316" href="#316">316</a> String username = getUsername(key);
<a name="317" href="#317">317</a> userDefs.append(username).append(<span class="jxr_string">" = "</span>).append(value).append(<span class="jxr_string">"\n"</span>);
<a name="318" href="#318">318</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (isRolename(key)) {
<a name="319" href="#319">319</a> String rolename = getRolename(key);
<a name="320" href="#320">320</a> roleDefs.append(rolename).append(<span class="jxr_string">" = "</span>).append(value).append(<span class="jxr_string">"\n"</span>);
<a name="321" href="#321">321</a> } <strong class="jxr_keyword">else</strong> {
<a name="322" href="#322">322</a> String msg = <span class="jxr_string">"Encountered unexpected key/value pair. All keys must be prefixed with either '"</span> +
<a name="323" href="#323">323</a> USERNAME_PREFIX + <span class="jxr_string">"' or '"</span> + ROLENAME_PREFIX + <span class="jxr_string">"'."</span>;
<a name="324" href="#324">324</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg);
<a name="325" href="#325">325</a> }
<a name="326" href="#326">326</a> }
<a name="327" href="#327">327</a>
<a name="328" href="#328">328</a> setUserDefinitions(userDefs.toString());
<a name="329" href="#329">329</a> setRoleDefinitions(roleDefs.toString());
<a name="330" href="#330">330</a> processDefinitions();
<a name="331" href="#331">331</a> }
<a name="332" href="#332">332</a>
<a name="333" href="#333">333</a> <strong class="jxr_keyword">protected</strong> String getName(String key, String prefix) {
<a name="334" href="#334">334</a> <strong class="jxr_keyword">return</strong> key.substring(prefix.length(), key.length());
<a name="335" href="#335">335</a> }
<a name="336" href="#336">336</a>
<a name="337" href="#337">337</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isUsername(String key) {
<a name="338" href="#338">338</a> <strong class="jxr_keyword">return</strong> key != <strong class="jxr_keyword">null</strong> &amp;&amp; key.startsWith(USERNAME_PREFIX);
<a name="339" href="#339">339</a> }
<a name="340" href="#340">340</a>
<a name="341" href="#341">341</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isRolename(String key) {
<a name="342" href="#342">342</a> <strong class="jxr_keyword">return</strong> key != <strong class="jxr_keyword">null</strong> &amp;&amp; key.startsWith(ROLENAME_PREFIX);
<a name="343" href="#343">343</a> }
<a name="344" href="#344">344</a>
<a name="345" href="#345">345</a> <strong class="jxr_keyword">protected</strong> String getUsername(String key) {
<a name="346" href="#346">346</a> <strong class="jxr_keyword">return</strong> getName(key, USERNAME_PREFIX);
<a name="347" href="#347">347</a> }
<a name="348" href="#348">348</a>
<a name="349" href="#349">349</a> <strong class="jxr_keyword">protected</strong> String getRolename(String key) {
<a name="350" href="#350">350</a> <strong class="jxr_keyword">return</strong> getName(key, ROLENAME_PREFIX);
<a name="351" href="#351">351</a> }
<a name="352" href="#352">352</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>