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