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