| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <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.config;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.io.ResourceUtils;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.util.StringUtils;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.io.IOException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.io.InputStream;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.io.InputStreamReader;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.io.Reader;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.io.UnsupportedEncodingException;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.Collection;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.Collections;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.LinkedHashMap;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.Map;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.Scanner;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.Set;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span>/**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * A class representing the <a href="http://en.wikipedia.org/wiki/INI_file">INI</a> text configuration format.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p/><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * An Ini instance is a map of {@link Ini.Section Section}s, keyed by section name. Each<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * {@code Section} is itself a map of {@code String} name/value pairs. Name/value pairs are guaranteed to be unique<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * within each {@code Section} only - not across the entire {@code Ini} instance.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @since 1.0<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public class Ini implements Map<String, Ini.Section> {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static transient final Logger log = LoggerFactory.getLogger(Ini.class);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> public static final String DEFAULT_SECTION_NAME = ""; //empty string means the first unnamed section<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static final String DEFAULT_CHARSET_NAME = "UTF-8";<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public static final String COMMENT_POUND = "#";<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public static final String COMMENT_SEMICOLON = ";";<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public static final String SECTION_PREFIX = "[";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public static final String SECTION_SUFFIX = "]";<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> protected static final char ESCAPE_TOKEN = '\\';<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private final Map<String, Section> sections;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Creates a new empty {@code Ini} instance.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public Ini() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> this.sections = new LinkedHashMap<String, Section>();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Creates a new {@code Ini} instance with the specified defaults.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @param defaults the default sections and/or key-value pairs to copy into the new instance.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> public Ini(Ini defaults) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> this();<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> if (defaults == null) {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> throw new NullPointerException("Defaults cannot be null.");<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> }<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> for (Section section : defaults.getSections()) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> Section copy = new Section(section);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> this.sections.put(section.getName(), copy);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Returns {@code true} if no sections have been configured, or if there are sections, but the sections themselves<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * are all empty, {@code false} otherwise.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return {@code true} if no sections have been configured, or if there are sections, but the sections themselves<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * are all empty, {@code false} otherwise.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public boolean isEmpty() {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> Collection<Section> sections = this.sections.values();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> if (!sections.isEmpty()) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> for (Section section : sections) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> if (!section.isEmpty()) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return false;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return true;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Returns the names of all sections managed by this {@code Ini} instance or an empty collection if there are<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * no sections.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return the names of all sections managed by this {@code Ini} instance or an empty collection if there are<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * no sections.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> public Set<String> getSectionNames() {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return Collections.unmodifiableSet(sections.keySet());<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> /**<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * Returns the sections managed by this {@code Ini} instance or an empty collection if there are<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * no sections.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> *<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @return the sections managed by this {@code Ini} instance or an empty collection if there are<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * no sections.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public Collection<Section> getSections() {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return Collections.unmodifiableCollection(sections.values());<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Returns the {@link Section} with the given name or {@code null} if no section with that name exists.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param sectionName the name of the section to retrieve.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @return the {@link Section} with the given name or {@code null} if no section with that name exists.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> public Section getSection(String sectionName) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> String name = cleanName(sectionName);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> return sections.get(name);<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> * Ensures a section with the specified name exists, adding a new one if it does not yet exist.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> *<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param sectionName the name of the section to ensure existence<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @return the section created if it did not yet exist, or the existing Section that already existed.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public Section addSection(String sectionName) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> String name = cleanName(sectionName);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> Section section = getSection(name);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> if (section == null) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> section = new Section(name);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> this.sections.put(name, section);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return section;<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> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Removes the section with the specified name and returns it, or {@code null} if the section did not exist.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param sectionName the name of the section to remove.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @return the section with the specified name or {@code null} if the section did not exist.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public Section removeSection(String sectionName) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> String name = cleanName(sectionName);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> return this.sections.remove(name);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> private static String cleanName(String sectionName) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> String name = StringUtils.clean(sectionName);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> if (name == null) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> log.trace("Specified name was null or empty. Defaulting to the default section (name = \"\")");<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> name = DEFAULT_SECTION_NAME;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return name;<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Sets a name/value pair for the section with the given {@code sectionName}. If the section does not yet exist,<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * it will be created. If the {@code sectionName} is null or empty, the name/value pair will be placed in the<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * default (unnamed, empty string) section.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> *<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @param sectionName the name of the section to add the name/value pair<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param propertyName the name of the property to add<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param propertyValue the property value<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public void setSectionProperty(String sectionName, String propertyName, String propertyValue) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> String name = cleanName(sectionName);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> Section section = getSection(name);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> if (section == null) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> section = addSection(name);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> section.put(propertyName, propertyValue);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<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> * Returns the value of the specified section property, or {@code null} if the section or property do not exist.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> *<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * @param sectionName the name of the section to retrieve to acquire the property value<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * @param propertyName the name of the section property for which to return the value<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @return the value of the specified section property, or {@code null} if the section or property do not exist.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> */<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> public String getSectionProperty(String sectionName, String propertyName) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> Section section = getSection(sectionName);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> return section != null ? section.get(propertyName) : null;<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> /**<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * Returns the value of the specified section property, or the {@code defaultValue} if the section or<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * property do not exist.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> *<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @param sectionName the name of the section to add the name/value pair<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * @param propertyName the name of the property to add<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * @param defaultValue the default value to return if the section or property do not exist.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @return the value of the specified section property, or the {@code defaultValue} if the section or<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * property do not exist.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> */<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> public String getSectionProperty(String sectionName, String propertyName, String defaultValue) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> String value = getSectionProperty(sectionName, propertyName);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> return value != null ? value : defaultValue;<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> /**<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Creates a new {@code Ini} instance loaded with the INI-formatted data in the resource at the given path. The<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * resource path may be any value interpretable by the<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * {@link ResourceUtils#getInputStreamForPath(String) ResourceUtils.getInputStreamForPath} method.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> *<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @param resourcePath the resource location of the INI data to load when creating the {@code Ini} instance.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @return a new {@code Ini} instance loaded with the INI-formatted data in the resource at the given path.<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @throws ConfigurationException if the path cannot be loaded into an {@code Ini} instance.<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> */<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> public static Ini fromResourcePath(String resourcePath) throws ConfigurationException {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> if (!StringUtils.hasLength(resourcePath)) {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> throw new IllegalArgumentException("Resource Path argument cannot be null or empty.");<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> Ini ini = new Ini();<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> ini.loadFromPath(resourcePath);<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return ini;<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> /**<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * Loads data from the specified resource path into this current {@code Ini} instance. The<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * resource path may be any value interpretable by the<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * {@link ResourceUtils#getInputStreamForPath(String) ResourceUtils.getInputStreamForPath} method.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> *<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * @param resourcePath the resource location of the INI data to load into this instance.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @throws ConfigurationException if the path cannot be loaded<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> */<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> public void loadFromPath(String resourcePath) throws ConfigurationException {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> InputStream is;<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> try {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> is = ResourceUtils.getInputStreamForPath(resourcePath);<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> } catch (IOException e) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> throw new ConfigurationException(e);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> load(is);<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> * Loads the specified raw INI-formatted text into this instance.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> *<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @param iniConfig the raw INI-formatted text to load into this instance.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * @throws ConfigurationException if the text cannot be loaded<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> */<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> public void load(String iniConfig) throws ConfigurationException {<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> load(new Scanner(iniConfig));<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> }<a name="line.263"></a> |
| <span class="sourceLineNo">264</span><a name="line.264"></a> |
| <span class="sourceLineNo">265</span> /**<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * Loads the INI-formatted text backed by the given InputStream into this instance. This implementation will<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * close the input stream after it has finished loading. It is expected that the stream's contents are<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * UTF-8 encoded.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> *<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * @param is the {@code InputStream} from which to read the INI-formatted text<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @throws ConfigurationException if unable<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> */<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> public void load(InputStream is) throws ConfigurationException {<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> if (is == null) {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> throw new NullPointerException("InputStream argument cannot be null.");<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> InputStreamReader isr;<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> try {<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> isr = new InputStreamReader(is, DEFAULT_CHARSET_NAME);<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> } catch (UnsupportedEncodingException e) {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> throw new ConfigurationException(e);<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> load(isr);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<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> * Loads the INI-formatted text backed by the given Reader into this instance. This implementation will close the<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * reader after it has finished loading.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> *<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * @param reader the {@code Reader} from which to read the INI-formatted text<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> */<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> public void load(Reader reader) {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> Scanner scanner = new Scanner(reader);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> try {<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> load(scanner);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> } finally {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> try {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> scanner.close();<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> } catch (Exception e) {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> log.debug("Unable to cleanly close the InputStream scanner. Non-critical - ignoring.", e);<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> }<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> /**<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * Merges the contents of <code>m</code>'s {@link Section} objects into self.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * This differs from {@link Ini#putAll(Map)}, in that each section is merged with the existing one.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * For example the following two ini blocks are merged and the result is the third<BR/><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * <p><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * Initial:<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * <pre><a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * <code>[section1]<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * key1 = value1<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> *<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * [section2]<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * key2 = value2<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * </code> </pre><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> *<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * To be merged:<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * <pre><a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * <code>[section1]<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * foo = bar<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> *<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * [section2]<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * key2 = new value<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * </code> </pre><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> *<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * Result:<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * <pre><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * <code>[section1]<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * key1 = value1<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * foo = bar<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> *<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * [section2]<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * key2 = new value<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * </code> </pre><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> *<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * </p><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> *<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @param m map to be merged<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @since 1.4<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> */<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> public void merge(Map<String, Section> m) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span><a name="line.344"></a> |
| <span class="sourceLineNo">345</span> if (m != null) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> for (Entry<String, Section> entry : m.entrySet()) {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> Section section = this.getSection(entry.getKey());<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> if (section == null) {<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> section = addSection(entry.getKey());<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> }<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> section.putAll(entry.getValue());<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> }<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> private void addSection(String name, StringBuilder content) {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> if (content.length() > 0) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> String contentString = content.toString();<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> String cleaned = StringUtils.clean(contentString);<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> if (cleaned != null) {<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> Section section = new Section(name, contentString);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> if (!section.isEmpty()) {<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> sections.put(name, section);<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> }<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> }<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span><a name="line.368"></a> |
| <span class="sourceLineNo">369</span> /**<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * Loads the INI-formatted text backed by the given Scanner. This implementation will close the<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * scanner after it has finished loading.<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> *<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * @param scanner the {@code Scanner} from which to read the INI-formatted text<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> */<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> public void load(Scanner scanner) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> String sectionName = DEFAULT_SECTION_NAME;<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> StringBuilder sectionContent = new StringBuilder();<a name="line.378"></a> |
| <span class="sourceLineNo">379</span><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> while (scanner.hasNextLine()) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span><a name="line.381"></a> |
| <span class="sourceLineNo">382</span> String rawLine = scanner.nextLine();<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> String line = StringUtils.clean(rawLine);<a name="line.383"></a> |
| <span class="sourceLineNo">384</span><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> if (line == null || line.startsWith(COMMENT_POUND) || line.startsWith(COMMENT_SEMICOLON)) {<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> //skip empty lines and comments:<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> continue;<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> String newSectionName = getSectionName(line);<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> if (newSectionName != null) {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> //found a new section - convert the currently buffered one into a Section object<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> addSection(sectionName, sectionContent);<a name="line.393"></a> |
| <span class="sourceLineNo">394</span><a name="line.394"></a> |
| <span class="sourceLineNo">395</span> //reset the buffer for the new section:<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> sectionContent = new StringBuilder();<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> sectionName = newSectionName;<a name="line.398"></a> |
| <span class="sourceLineNo">399</span><a name="line.399"></a> |
| <span class="sourceLineNo">400</span> if (log.isDebugEnabled()) {<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> log.debug("Parsing " + SECTION_PREFIX + sectionName + SECTION_SUFFIX);<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> } else {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> //normal line - add it to the existing content buffer:<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> sectionContent.append(rawLine).append("\n");<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> }<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> //finish any remaining buffered content:<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> addSection(sectionName, sectionContent);<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> }<a name="line.411"></a> |
| <span class="sourceLineNo">412</span><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> protected static boolean isSectionHeader(String line) {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> String s = StringUtils.clean(line);<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> return s != null && s.startsWith(SECTION_PREFIX) && s.endsWith(SECTION_SUFFIX);<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> }<a name="line.416"></a> |
| <span class="sourceLineNo">417</span><a name="line.417"></a> |
| <span class="sourceLineNo">418</span> protected static String getSectionName(String line) {<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> String s = StringUtils.clean(line);<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> if (isSectionHeader(s)) {<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> return cleanName(s.substring(1, s.length() - 1));<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> }<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> return null;<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> public boolean equals(Object obj) {<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> if (obj instanceof Ini) {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> Ini ini = (Ini) obj;<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> return this.sections.equals(ini.sections);<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> }<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> return false;<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> }<a name="line.432"></a> |
| <span class="sourceLineNo">433</span><a name="line.433"></a> |
| <span class="sourceLineNo">434</span> @Override<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> public int hashCode() {<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> return this.sections.hashCode();<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span><a name="line.438"></a> |
| <span class="sourceLineNo">439</span> public String toString() {<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> if (this.sections == null || this.sections.isEmpty()) {<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> return "<empty INI>";<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> } else {<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> StringBuilder sb = new StringBuilder("sections=");<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> int i = 0;<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> for (Ini.Section section : this.sections.values()) {<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> if (i > 0) {<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> sb.append(",");<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> }<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> sb.append(section.toString());<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> i++;<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> }<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> return sb.toString();<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> }<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> }<a name="line.454"></a> |
| <span class="sourceLineNo">455</span><a name="line.455"></a> |
| <span class="sourceLineNo">456</span> public int size() {<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> return this.sections.size();<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> }<a name="line.458"></a> |
| <span class="sourceLineNo">459</span><a name="line.459"></a> |
| <span class="sourceLineNo">460</span> public boolean containsKey(Object key) {<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> return this.sections.containsKey(key);<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> }<a name="line.462"></a> |
| <span class="sourceLineNo">463</span><a name="line.463"></a> |
| <span class="sourceLineNo">464</span> public boolean containsValue(Object value) {<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> return this.sections.containsValue(value);<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> }<a name="line.466"></a> |
| <span class="sourceLineNo">467</span><a name="line.467"></a> |
| <span class="sourceLineNo">468</span> public Section get(Object key) {<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> return this.sections.get(key);<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> }<a name="line.470"></a> |
| <span class="sourceLineNo">471</span><a name="line.471"></a> |
| <span class="sourceLineNo">472</span> public Section put(String key, Section value) {<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> return this.sections.put(key, value);<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> }<a name="line.474"></a> |
| <span class="sourceLineNo">475</span><a name="line.475"></a> |
| <span class="sourceLineNo">476</span> public Section remove(Object key) {<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> return this.sections.remove(key);<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> }<a name="line.478"></a> |
| <span class="sourceLineNo">479</span><a name="line.479"></a> |
| <span class="sourceLineNo">480</span> public void putAll(Map<? extends String, ? extends Section> m) {<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> this.sections.putAll(m);<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> }<a name="line.482"></a> |
| <span class="sourceLineNo">483</span><a name="line.483"></a> |
| <span class="sourceLineNo">484</span> public void clear() {<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> this.sections.clear();<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> }<a name="line.486"></a> |
| <span class="sourceLineNo">487</span><a name="line.487"></a> |
| <span class="sourceLineNo">488</span> public Set<String> keySet() {<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> return Collections.unmodifiableSet(this.sections.keySet());<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> }<a name="line.490"></a> |
| <span class="sourceLineNo">491</span><a name="line.491"></a> |
| <span class="sourceLineNo">492</span> public Collection<Section> values() {<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> return Collections.unmodifiableCollection(this.sections.values());<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> }<a name="line.494"></a> |
| <span class="sourceLineNo">495</span><a name="line.495"></a> |
| <span class="sourceLineNo">496</span> public Set<Entry<String, Section>> entrySet() {<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> return Collections.unmodifiableSet(this.sections.entrySet());<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> }<a name="line.498"></a> |
| <span class="sourceLineNo">499</span><a name="line.499"></a> |
| <span class="sourceLineNo">500</span> /**<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * An {@code Ini.Section} is String-key-to-String-value Map, identifiable by a<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * {@link #getName() name} unique within an {@link Ini} instance.<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> */<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> public static class Section implements Map<String, String> {<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> private final String name;<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> private final Map<String, String> props;<a name="line.506"></a> |
| <span class="sourceLineNo">507</span><a name="line.507"></a> |
| <span class="sourceLineNo">508</span> private Section(String name) {<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> if (name == null) {<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> throw new NullPointerException("name");<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> }<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> this.name = name;<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> this.props = new LinkedHashMap<String, String>();<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> }<a name="line.514"></a> |
| <span class="sourceLineNo">515</span><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> private Section(String name, String sectionContent) {<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> if (name == null) {<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> throw new NullPointerException("name");<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> }<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> this.name = name;<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> Map<String,String> props;<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> if (StringUtils.hasText(sectionContent) ) {<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> props = toMapProps(sectionContent);<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> } else {<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> props = new LinkedHashMap<String,String>();<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> if ( props != null ) {<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> this.props = props;<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> } else {<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> this.props = new LinkedHashMap<String,String>();<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> }<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> }<a name="line.532"></a> |
| <span class="sourceLineNo">533</span><a name="line.533"></a> |
| <span class="sourceLineNo">534</span> private Section(Section defaults) {<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> this(defaults.getName());<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> putAll(defaults.props);<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> }<a name="line.537"></a> |
| <span class="sourceLineNo">538</span><a name="line.538"></a> |
| <span class="sourceLineNo">539</span> //Protected to access in a test case - NOT considered part of Shiro's public API<a name="line.539"></a> |
| <span class="sourceLineNo">540</span><a name="line.540"></a> |
| <span class="sourceLineNo">541</span> protected static boolean isContinued(String line) {<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> if (!StringUtils.hasText(line)) {<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> return false;<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> }<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> int length = line.length();<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> //find the number of backslashes at the end of the line. If an even number, the<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> //backslashes are considered escaped. If an odd number, the line is considered continued on the next line<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> int backslashCount = 0;<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> for (int i = length - 1; i > 0; i--) {<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> if (line.charAt(i) == ESCAPE_TOKEN) {<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> backslashCount++;<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> } else {<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> break;<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> }<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> }<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> return backslashCount % 2 != 0;<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> }<a name="line.557"></a> |
| <span class="sourceLineNo">558</span><a name="line.558"></a> |
| <span class="sourceLineNo">559</span> private static boolean isKeyValueSeparatorChar(char c) {<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> return Character.isWhitespace(c) || c == ':' || c == '=';<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> }<a name="line.561"></a> |
| <span class="sourceLineNo">562</span><a name="line.562"></a> |
| <span class="sourceLineNo">563</span> private static boolean isCharEscaped(CharSequence s, int index) {<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> return index > 0 && s.charAt(index - 1) == ESCAPE_TOKEN;<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> }<a name="line.565"></a> |
| <span class="sourceLineNo">566</span><a name="line.566"></a> |
| <span class="sourceLineNo">567</span> //Protected to access in a test case - NOT considered part of Shiro's public API<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> protected static String[] splitKeyValue(String keyValueLine) {<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> String line = StringUtils.clean(keyValueLine);<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> if (line == null) {<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> return null;<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> }<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> StringBuilder keyBuffer = new StringBuilder();<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> StringBuilder valueBuffer = new StringBuilder();<a name="line.574"></a> |
| <span class="sourceLineNo">575</span><a name="line.575"></a> |
| <span class="sourceLineNo">576</span> boolean buildingKey = true; //we'll build the value next:<a name="line.576"></a> |
| <span class="sourceLineNo">577</span><a name="line.577"></a> |
| <span class="sourceLineNo">578</span> for (int i = 0; i < line.length(); i++) {<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> char c = line.charAt(i);<a name="line.579"></a> |
| <span class="sourceLineNo">580</span><a name="line.580"></a> |
| <span class="sourceLineNo">581</span> if (buildingKey) {<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> if (isKeyValueSeparatorChar(c) && !isCharEscaped(line, i)) {<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> buildingKey = false;//now start building the value<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> } else {<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> keyBuffer.append(c);<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> }<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> } else {<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> if (valueBuffer.length() == 0 && isKeyValueSeparatorChar(c) && !isCharEscaped(line, i)) {<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> //swallow the separator chars before we start building the value<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> } else {<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> valueBuffer.append(c);<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> }<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> }<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> }<a name="line.594"></a> |
| <span class="sourceLineNo">595</span><a name="line.595"></a> |
| <span class="sourceLineNo">596</span> String key = StringUtils.clean(keyBuffer.toString());<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> String value = StringUtils.clean(valueBuffer.toString());<a name="line.597"></a> |
| <span class="sourceLineNo">598</span><a name="line.598"></a> |
| <span class="sourceLineNo">599</span> if (key == null || value == null) {<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> String msg = "Line argument must contain a key and a value. Only one string token was found.";<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> throw new IllegalArgumentException(msg);<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> }<a name="line.602"></a> |
| <span class="sourceLineNo">603</span><a name="line.603"></a> |
| <span class="sourceLineNo">604</span> log.trace("Discovered key/value pair: {} = {}", key, value);<a name="line.604"></a> |
| <span class="sourceLineNo">605</span><a name="line.605"></a> |
| <span class="sourceLineNo">606</span> return new String[]{key, value};<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> }<a name="line.607"></a> |
| <span class="sourceLineNo">608</span><a name="line.608"></a> |
| <span class="sourceLineNo">609</span> private static Map<String, String> toMapProps(String content) {<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> Map<String, String> props = new LinkedHashMap<String, String>();<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> String line;<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> StringBuilder lineBuffer = new StringBuilder();<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> Scanner scanner = new Scanner(content);<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> while (scanner.hasNextLine()) {<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> line = StringUtils.clean(scanner.nextLine());<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> if (isContinued(line)) {<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> //strip off the last continuation backslash:<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> line = line.substring(0, line.length() - 1);<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> lineBuffer.append(line);<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> continue;<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> } else {<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> lineBuffer.append(line);<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> }<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> line = lineBuffer.toString();<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> lineBuffer = new StringBuilder();<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> String[] kvPair = splitKeyValue(line);<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> props.put(kvPair[0], kvPair[1]);<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> }<a name="line.628"></a> |
| <span class="sourceLineNo">629</span><a name="line.629"></a> |
| <span class="sourceLineNo">630</span> return props;<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> }<a name="line.631"></a> |
| <span class="sourceLineNo">632</span><a name="line.632"></a> |
| <span class="sourceLineNo">633</span> public String getName() {<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> return this.name;<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> }<a name="line.635"></a> |
| <span class="sourceLineNo">636</span><a name="line.636"></a> |
| <span class="sourceLineNo">637</span> public void clear() {<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> this.props.clear();<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> }<a name="line.639"></a> |
| <span class="sourceLineNo">640</span><a name="line.640"></a> |
| <span class="sourceLineNo">641</span> public boolean containsKey(Object key) {<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> return this.props.containsKey(key);<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> }<a name="line.643"></a> |
| <span class="sourceLineNo">644</span><a name="line.644"></a> |
| <span class="sourceLineNo">645</span> public boolean containsValue(Object value) {<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> return this.props.containsValue(value);<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> }<a name="line.647"></a> |
| <span class="sourceLineNo">648</span><a name="line.648"></a> |
| <span class="sourceLineNo">649</span> public Set<Entry<String, String>> entrySet() {<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> return this.props.entrySet();<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> }<a name="line.651"></a> |
| <span class="sourceLineNo">652</span><a name="line.652"></a> |
| <span class="sourceLineNo">653</span> public String get(Object key) {<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> return this.props.get(key);<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> }<a name="line.655"></a> |
| <span class="sourceLineNo">656</span><a name="line.656"></a> |
| <span class="sourceLineNo">657</span> public boolean isEmpty() {<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> return this.props.isEmpty();<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> }<a name="line.659"></a> |
| <span class="sourceLineNo">660</span><a name="line.660"></a> |
| <span class="sourceLineNo">661</span> public Set<String> keySet() {<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> return this.props.keySet();<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> }<a name="line.663"></a> |
| <span class="sourceLineNo">664</span><a name="line.664"></a> |
| <span class="sourceLineNo">665</span> public String put(String key, String value) {<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> return this.props.put(key, value);<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> }<a name="line.667"></a> |
| <span class="sourceLineNo">668</span><a name="line.668"></a> |
| <span class="sourceLineNo">669</span> public void putAll(Map<? extends String, ? extends String> m) {<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> this.props.putAll(m);<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> }<a name="line.671"></a> |
| <span class="sourceLineNo">672</span><a name="line.672"></a> |
| <span class="sourceLineNo">673</span> public String remove(Object key) {<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> return this.props.remove(key);<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> }<a name="line.675"></a> |
| <span class="sourceLineNo">676</span><a name="line.676"></a> |
| <span class="sourceLineNo">677</span> public int size() {<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> return this.props.size();<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> }<a name="line.679"></a> |
| <span class="sourceLineNo">680</span><a name="line.680"></a> |
| <span class="sourceLineNo">681</span> public Collection<String> values() {<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> return this.props.values();<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> }<a name="line.683"></a> |
| <span class="sourceLineNo">684</span><a name="line.684"></a> |
| <span class="sourceLineNo">685</span> public String toString() {<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> String name = getName();<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> if (DEFAULT_SECTION_NAME.equals(name)) {<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> return "<default>";<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> }<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> return name;<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> }<a name="line.691"></a> |
| <span class="sourceLineNo">692</span><a name="line.692"></a> |
| <span class="sourceLineNo">693</span> @Override<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> public boolean equals(Object obj) {<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> if (obj instanceof Section) {<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> Section other = (Section) obj;<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> return getName().equals(other.getName()) && this.props.equals(other.props);<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> }<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> return false;<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> }<a name="line.700"></a> |
| <span class="sourceLineNo">701</span><a name="line.701"></a> |
| <span class="sourceLineNo">702</span> @Override<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> public int hashCode() {<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> return this.name.hashCode() * 31 + this.props.hashCode();<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> }<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> }<a name="line.706"></a> |
| <span class="sourceLineNo">707</span><a name="line.707"></a> |
| <span class="sourceLineNo">708</span>}<a name="line.708"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
