blob: 3a5f08bf781e8fc575bf632e20fc5db16a658510 [file] [log] [blame]
<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 or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.config;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import org.apache.logging.log4j.Logger;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.config.plugins.PluginManager;<a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.logging.log4j.core.config.plugins.PluginType;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.helpers.FileUtils;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.helpers.Loader;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.logging.log4j.status.StatusLogger;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.xml.sax.InputSource;<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.FileInputStream;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.io.FileNotFoundException;<a name="line.29"></a>
<FONT color="green">030</FONT> import java.io.IOException;<a name="line.30"></a>
<FONT color="green">031</FONT> import java.io.InputStream;<a name="line.31"></a>
<FONT color="green">032</FONT> import java.net.MalformedURLException;<a name="line.32"></a>
<FONT color="green">033</FONT> import java.net.URI;<a name="line.33"></a>
<FONT color="green">034</FONT> import java.net.URISyntaxException;<a name="line.34"></a>
<FONT color="green">035</FONT> import java.net.URL;<a name="line.35"></a>
<FONT color="green">036</FONT> import java.util.ArrayList;<a name="line.36"></a>
<FONT color="green">037</FONT> import java.util.List;<a name="line.37"></a>
<FONT color="green">038</FONT> import java.util.Map;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.util.Set;<a name="line.39"></a>
<FONT color="green">040</FONT> import java.util.TreeSet;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * ConfigurationFactory allows the configuration implementation to be dynamically chosen in 1<a name="line.43"></a>
<FONT color="green">044</FONT> * of 3 ways:<a name="line.44"></a>
<FONT color="green">045</FONT> * 1. A system property named "log4j.configurationFactory" can be set with the name of the<a name="line.45"></a>
<FONT color="green">046</FONT> * ConfigurationFactory to be used.<a name="line.46"></a>
<FONT color="green">047</FONT> * 2. setConfigurationFactory can be called with the instance of the ConfigurationFactory to<a name="line.47"></a>
<FONT color="green">048</FONT> * be used. This must be called before any other calls to Log4j.<a name="line.48"></a>
<FONT color="green">049</FONT> * 3. A ConfigurationFactory implementation can be added to the classpath and configured as a<a name="line.49"></a>
<FONT color="green">050</FONT> * plugin. The Order annotation should be used to configure the factory to be the first one<a name="line.50"></a>
<FONT color="green">051</FONT> * inspected. See XMLConfigurationFactory for an example.<a name="line.51"></a>
<FONT color="green">052</FONT> *<a name="line.52"></a>
<FONT color="green">053</FONT> * If the ConfigurationFactory that was added returns null on a call to getConfiguration the<a name="line.53"></a>
<FONT color="green">054</FONT> * any other ConfigurationFactories found as plugins will be called in their respective order.<a name="line.54"></a>
<FONT color="green">055</FONT> * DefaultConfiguration is always called last if no configuration has been returned.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> public abstract class ConfigurationFactory {<a name="line.57"></a>
<FONT color="green">058</FONT> /**<a name="line.58"></a>
<FONT color="green">059</FONT> * Allow the ConfigurationFactory class to be specified as a system property.<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public static final String CONFIGURATION_FACTORY_PROPERTY = "log4j.configurationFactory";<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> /**<a name="line.63"></a>
<FONT color="green">064</FONT> * Allow the location of the configuration file to be specified as a system property.<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> public static final String CONFIGURATION_FILE_PROPERTY = "log4j.configurationFile";<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> /**<a name="line.68"></a>
<FONT color="green">069</FONT> * Allow subclasses access to the status logger without creating another instance.<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> /**<a name="line.73"></a>
<FONT color="green">074</FONT> * File name prefix for test configurations.<a name="line.74"></a>
<FONT color="green">075</FONT> */<a name="line.75"></a>
<FONT color="green">076</FONT> protected static final String TEST_PREFIX = "log4j2-test";<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> /**<a name="line.78"></a>
<FONT color="green">079</FONT> * File name prefix for standard configurations.<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> protected static final String DEFAULT_PREFIX = "log4j2";<a name="line.81"></a>
<FONT color="green">082</FONT> <a name="line.82"></a>
<FONT color="green">083</FONT> private static List&lt;ConfigurationFactory&gt; factories = new ArrayList&lt;ConfigurationFactory&gt;();<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> private static ConfigurationFactory configFactory = new Factory();<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> /**<a name="line.87"></a>
<FONT color="green">088</FONT> * The configuration File.<a name="line.88"></a>
<FONT color="green">089</FONT> */<a name="line.89"></a>
<FONT color="green">090</FONT> protected File configFile = null;<a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> /**<a name="line.92"></a>
<FONT color="green">093</FONT> * Return the ConfigurationFactory.<a name="line.93"></a>
<FONT color="green">094</FONT> * @return the ConfigurationFactory.<a name="line.94"></a>
<FONT color="green">095</FONT> */<a name="line.95"></a>
<FONT color="green">096</FONT> public static ConfigurationFactory getInstance() {<a name="line.96"></a>
<FONT color="green">097</FONT> String factoryClass = System.getProperty(CONFIGURATION_FACTORY_PROPERTY);<a name="line.97"></a>
<FONT color="green">098</FONT> if (factoryClass != null) {<a name="line.98"></a>
<FONT color="green">099</FONT> addFactory(factoryClass);<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> PluginManager manager = new PluginManager("ConfigurationFactory");<a name="line.101"></a>
<FONT color="green">102</FONT> manager.collectPlugins();<a name="line.102"></a>
<FONT color="green">103</FONT> Map&lt;String, PluginType&gt; plugins = manager.getPlugins();<a name="line.103"></a>
<FONT color="green">104</FONT> Set&lt;WeightedFactory&gt; ordered = new TreeSet&lt;WeightedFactory&gt;();<a name="line.104"></a>
<FONT color="green">105</FONT> for (PluginType type : plugins.values()) {<a name="line.105"></a>
<FONT color="green">106</FONT> try {<a name="line.106"></a>
<FONT color="green">107</FONT> Class&lt;ConfigurationFactory&gt; clazz = type.getPluginClass();<a name="line.107"></a>
<FONT color="green">108</FONT> Order o = clazz.getAnnotation(Order.class);<a name="line.108"></a>
<FONT color="green">109</FONT> Integer weight = o.value();<a name="line.109"></a>
<FONT color="green">110</FONT> if (o != null) {<a name="line.110"></a>
<FONT color="green">111</FONT> ordered.add(new WeightedFactory(weight, clazz));<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> } catch (Exception ex) {<a name="line.113"></a>
<FONT color="green">114</FONT> LOGGER.warn("Unable to add class " + type.getPluginClass());<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> for (WeightedFactory wf : ordered) {<a name="line.117"></a>
<FONT color="green">118</FONT> addFactory(wf.factoryClass);<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> return configFactory;<a name="line.120"></a>
<FONT color="green">121</FONT> }<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> private static void addFactory(String factoryClass) {<a name="line.123"></a>
<FONT color="green">124</FONT> try {<a name="line.124"></a>
<FONT color="green">125</FONT> Class clazz = Class.forName(factoryClass);<a name="line.125"></a>
<FONT color="green">126</FONT> addFactory(clazz);<a name="line.126"></a>
<FONT color="green">127</FONT> } catch (ClassNotFoundException ex) {<a name="line.127"></a>
<FONT color="green">128</FONT> LOGGER.error("Unable to load class " + factoryClass, ex);<a name="line.128"></a>
<FONT color="green">129</FONT> } catch (Exception ex) {<a name="line.129"></a>
<FONT color="green">130</FONT> LOGGER.error("Unable to load class " + factoryClass, ex);<a name="line.130"></a>
<FONT color="green">131</FONT> }<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> private static void addFactory(Class factoryClass) {<a name="line.134"></a>
<FONT color="green">135</FONT> try {<a name="line.135"></a>
<FONT color="green">136</FONT> factories.add((ConfigurationFactory) factoryClass.newInstance());<a name="line.136"></a>
<FONT color="green">137</FONT> } catch (Exception ex) {<a name="line.137"></a>
<FONT color="green">138</FONT> LOGGER.error("Unable to create instance of " + factoryClass.getName(), ex);<a name="line.138"></a>
<FONT color="green">139</FONT> }<a name="line.139"></a>
<FONT color="green">140</FONT> }<a name="line.140"></a>
<FONT color="green">141</FONT> <a name="line.141"></a>
<FONT color="green">142</FONT> /**<a name="line.142"></a>
<FONT color="green">143</FONT> * Set the configuration factory.<a name="line.143"></a>
<FONT color="green">144</FONT> * @param factory the ConfigurationFactory.<a name="line.144"></a>
<FONT color="green">145</FONT> */<a name="line.145"></a>
<FONT color="green">146</FONT> public static void setConfigurationFactory(ConfigurationFactory factory) {<a name="line.146"></a>
<FONT color="green">147</FONT> configFactory = factory;<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> * Reset the ConfigurationFactory to the default.<a name="line.151"></a>
<FONT color="green">152</FONT> */<a name="line.152"></a>
<FONT color="green">153</FONT> public static void resetConfigurationFactory() {<a name="line.153"></a>
<FONT color="green">154</FONT> configFactory = new Factory();<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> <a name="line.156"></a>
<FONT color="green">157</FONT> /**<a name="line.157"></a>
<FONT color="green">158</FONT> * Remove the ConfigurationFactory.<a name="line.158"></a>
<FONT color="green">159</FONT> * @param factory The factory to remove.<a name="line.159"></a>
<FONT color="green">160</FONT> */<a name="line.160"></a>
<FONT color="green">161</FONT> public static void removeConfigurationFactory(ConfigurationFactory factory) {<a name="line.161"></a>
<FONT color="green">162</FONT> factories.remove(factory);<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> protected abstract String[] getSupportedTypes();<a name="line.165"></a>
<FONT color="green">166</FONT> <a name="line.166"></a>
<FONT color="green">167</FONT> protected boolean isActive() {<a name="line.167"></a>
<FONT color="green">168</FONT> return true;<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> public abstract Configuration getConfiguration(InputSource source);<a name="line.171"></a>
<FONT color="green">172</FONT> <a name="line.172"></a>
<FONT color="green">173</FONT> /**<a name="line.173"></a>
<FONT color="green">174</FONT> * Return the Configuration.<a name="line.174"></a>
<FONT color="green">175</FONT> * @param name The configuration name.<a name="line.175"></a>
<FONT color="green">176</FONT> * @param configLocation The configuration location.<a name="line.176"></a>
<FONT color="green">177</FONT> * @return The Configuration.<a name="line.177"></a>
<FONT color="green">178</FONT> */<a name="line.178"></a>
<FONT color="green">179</FONT> public Configuration getConfiguration(String name, URI configLocation) {<a name="line.179"></a>
<FONT color="green">180</FONT> if (!isActive()) {<a name="line.180"></a>
<FONT color="green">181</FONT> return null;<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> if (configLocation != null) {<a name="line.183"></a>
<FONT color="green">184</FONT> InputSource source = getInputFromURI(configLocation);<a name="line.184"></a>
<FONT color="green">185</FONT> if (source != null) {<a name="line.185"></a>
<FONT color="green">186</FONT> return getConfiguration(source);<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> }<a name="line.188"></a>
<FONT color="green">189</FONT> return null;<a name="line.189"></a>
<FONT color="green">190</FONT> }<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> * Load the configuration from a URI.<a name="line.193"></a>
<FONT color="green">194</FONT> * @param configLocation A URI representing the location of the configuration.<a name="line.194"></a>
<FONT color="green">195</FONT> * @return The InputSource for the configuration.<a name="line.195"></a>
<FONT color="green">196</FONT> */<a name="line.196"></a>
<FONT color="green">197</FONT> protected InputSource getInputFromURI(URI configLocation) {<a name="line.197"></a>
<FONT color="green">198</FONT> configFile = FileUtils.fileFromURI(configLocation);<a name="line.198"></a>
<FONT color="green">199</FONT> if (configFile != null &amp;&amp; configFile.exists() &amp;&amp; configFile.canRead()) {<a name="line.199"></a>
<FONT color="green">200</FONT> try {<a name="line.200"></a>
<FONT color="green">201</FONT> InputSource source = new InputSource(new FileInputStream(configFile));<a name="line.201"></a>
<FONT color="green">202</FONT> source.setSystemId(configLocation.getPath());<a name="line.202"></a>
<FONT color="green">203</FONT> return source;<a name="line.203"></a>
<FONT color="green">204</FONT> } catch (FileNotFoundException ex) {<a name="line.204"></a>
<FONT color="green">205</FONT> LOGGER.error("Cannot locate file " + configLocation.getPath(), ex);<a name="line.205"></a>
<FONT color="green">206</FONT> }<a name="line.206"></a>
<FONT color="green">207</FONT> }<a name="line.207"></a>
<FONT color="green">208</FONT> try {<a name="line.208"></a>
<FONT color="green">209</FONT> InputSource source = new InputSource(configLocation.toURL().openStream());<a name="line.209"></a>
<FONT color="green">210</FONT> source.setSystemId(configLocation.getPath());<a name="line.210"></a>
<FONT color="green">211</FONT> return source;<a name="line.211"></a>
<FONT color="green">212</FONT> } catch (MalformedURLException ex) {<a name="line.212"></a>
<FONT color="green">213</FONT> LOGGER.error("Invalid URL " + configLocation.toString(), ex);<a name="line.213"></a>
<FONT color="green">214</FONT> } catch (IOException ex) {<a name="line.214"></a>
<FONT color="green">215</FONT> LOGGER.error("Unable to access " + configLocation.toString(), ex);<a name="line.215"></a>
<FONT color="green">216</FONT> }<a name="line.216"></a>
<FONT color="green">217</FONT> return null;<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> /**<a name="line.220"></a>
<FONT color="green">221</FONT> * Load the configuration from the location represented by the String.<a name="line.221"></a>
<FONT color="green">222</FONT> * @param config The configuration location.<a name="line.222"></a>
<FONT color="green">223</FONT> * @param loader The default ClassLoader to use.<a name="line.223"></a>
<FONT color="green">224</FONT> * @return The InputSource to use to read the configuration.<a name="line.224"></a>
<FONT color="green">225</FONT> */<a name="line.225"></a>
<FONT color="green">226</FONT> protected InputSource getInputFromString(String config, ClassLoader loader) {<a name="line.226"></a>
<FONT color="green">227</FONT> InputSource source;<a name="line.227"></a>
<FONT color="green">228</FONT> try {<a name="line.228"></a>
<FONT color="green">229</FONT> URL url = new URL(config);<a name="line.229"></a>
<FONT color="green">230</FONT> source = new InputSource(url.openStream());<a name="line.230"></a>
<FONT color="green">231</FONT> if (FileUtils.isFile(url)) {<a name="line.231"></a>
<FONT color="green">232</FONT> configFile = FileUtils.fileFromURI(url.toURI());<a name="line.232"></a>
<FONT color="green">233</FONT> }<a name="line.233"></a>
<FONT color="green">234</FONT> source.setSystemId(config);<a name="line.234"></a>
<FONT color="green">235</FONT> return source;<a name="line.235"></a>
<FONT color="green">236</FONT> } catch (Exception ex) {<a name="line.236"></a>
<FONT color="green">237</FONT> source = getInputFromResource(config, loader);<a name="line.237"></a>
<FONT color="green">238</FONT> if (source == null) {<a name="line.238"></a>
<FONT color="green">239</FONT> try {<a name="line.239"></a>
<FONT color="green">240</FONT> File file = new File(config);<a name="line.240"></a>
<FONT color="green">241</FONT> FileInputStream is = new FileInputStream(file);<a name="line.241"></a>
<FONT color="green">242</FONT> configFile = file;<a name="line.242"></a>
<FONT color="green">243</FONT> source = new InputSource(is);<a name="line.243"></a>
<FONT color="green">244</FONT> source.setSystemId(config);<a name="line.244"></a>
<FONT color="green">245</FONT> } catch (FileNotFoundException fnfe) {<a name="line.245"></a>
<FONT color="green">246</FONT> // Ignore the exception<a name="line.246"></a>
<FONT color="green">247</FONT> }<a name="line.247"></a>
<FONT color="green">248</FONT> }<a name="line.248"></a>
<FONT color="green">249</FONT> }<a name="line.249"></a>
<FONT color="green">250</FONT> return source;<a name="line.250"></a>
<FONT color="green">251</FONT> }<a name="line.251"></a>
<FONT color="green">252</FONT> <a name="line.252"></a>
<FONT color="green">253</FONT> /**<a name="line.253"></a>
<FONT color="green">254</FONT> * Retrieve the configuration via the ClassLoader.<a name="line.254"></a>
<FONT color="green">255</FONT> * @param resource The resource to load.<a name="line.255"></a>
<FONT color="green">256</FONT> * @param loader The default ClassLoader to use.<a name="line.256"></a>
<FONT color="green">257</FONT> * @return The InputSource for the configuration.<a name="line.257"></a>
<FONT color="green">258</FONT> */<a name="line.258"></a>
<FONT color="green">259</FONT> protected InputSource getInputFromResource(String resource, ClassLoader loader) {<a name="line.259"></a>
<FONT color="green">260</FONT> URL url = Loader.getResource(resource, loader);<a name="line.260"></a>
<FONT color="green">261</FONT> if (url == null) {<a name="line.261"></a>
<FONT color="green">262</FONT> return null;<a name="line.262"></a>
<FONT color="green">263</FONT> }<a name="line.263"></a>
<FONT color="green">264</FONT> InputStream is = null;<a name="line.264"></a>
<FONT color="green">265</FONT> try {<a name="line.265"></a>
<FONT color="green">266</FONT> is = url.openStream();<a name="line.266"></a>
<FONT color="green">267</FONT> } catch (IOException ioe) {<a name="line.267"></a>
<FONT color="green">268</FONT> return null;<a name="line.268"></a>
<FONT color="green">269</FONT> }<a name="line.269"></a>
<FONT color="green">270</FONT> if (is == null) {<a name="line.270"></a>
<FONT color="green">271</FONT> return null;<a name="line.271"></a>
<FONT color="green">272</FONT> }<a name="line.272"></a>
<FONT color="green">273</FONT> InputSource source = new InputSource(is);<a name="line.273"></a>
<FONT color="green">274</FONT> if (FileUtils.isFile(url)) {<a name="line.274"></a>
<FONT color="green">275</FONT> try {<a name="line.275"></a>
<FONT color="green">276</FONT> configFile = FileUtils.fileFromURI(url.toURI());<a name="line.276"></a>
<FONT color="green">277</FONT> } catch (URISyntaxException ex) {<a name="line.277"></a>
<FONT color="green">278</FONT> // Just ignore the exception.<a name="line.278"></a>
<FONT color="green">279</FONT> }<a name="line.279"></a>
<FONT color="green">280</FONT> }<a name="line.280"></a>
<FONT color="green">281</FONT> source.setSystemId(resource);<a name="line.281"></a>
<FONT color="green">282</FONT> return source;<a name="line.282"></a>
<FONT color="green">283</FONT> }<a name="line.283"></a>
<FONT color="green">284</FONT> <a name="line.284"></a>
<FONT color="green">285</FONT> /**<a name="line.285"></a>
<FONT color="green">286</FONT> * Factory that chooses a ConfigurationFactory based on weighting.<a name="line.286"></a>
<FONT color="green">287</FONT> */<a name="line.287"></a>
<FONT color="green">288</FONT> private static class WeightedFactory implements Comparable&lt;WeightedFactory&gt; {<a name="line.288"></a>
<FONT color="green">289</FONT> private int weight;<a name="line.289"></a>
<FONT color="green">290</FONT> private Class&lt;ConfigurationFactory&gt; factoryClass;<a name="line.290"></a>
<FONT color="green">291</FONT> <a name="line.291"></a>
<FONT color="green">292</FONT> /**<a name="line.292"></a>
<FONT color="green">293</FONT> * Constructor.<a name="line.293"></a>
<FONT color="green">294</FONT> * @param weight The weight.<a name="line.294"></a>
<FONT color="green">295</FONT> * @param clazz The class.<a name="line.295"></a>
<FONT color="green">296</FONT> */<a name="line.296"></a>
<FONT color="green">297</FONT> public WeightedFactory(int weight, Class&lt;ConfigurationFactory&gt; clazz) {<a name="line.297"></a>
<FONT color="green">298</FONT> this.weight = weight;<a name="line.298"></a>
<FONT color="green">299</FONT> this.factoryClass = clazz;<a name="line.299"></a>
<FONT color="green">300</FONT> }<a name="line.300"></a>
<FONT color="green">301</FONT> <a name="line.301"></a>
<FONT color="green">302</FONT> public int compareTo(WeightedFactory wf) {<a name="line.302"></a>
<FONT color="green">303</FONT> int w = wf.weight;<a name="line.303"></a>
<FONT color="green">304</FONT> if (weight == w) {<a name="line.304"></a>
<FONT color="green">305</FONT> return 0;<a name="line.305"></a>
<FONT color="green">306</FONT> } else if (weight &gt; w) {<a name="line.306"></a>
<FONT color="green">307</FONT> return -1;<a name="line.307"></a>
<FONT color="green">308</FONT> } else {<a name="line.308"></a>
<FONT color="green">309</FONT> return 1;<a name="line.309"></a>
<FONT color="green">310</FONT> }<a name="line.310"></a>
<FONT color="green">311</FONT> }<a name="line.311"></a>
<FONT color="green">312</FONT> }<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> * Default Factory.<a name="line.315"></a>
<FONT color="green">316</FONT> */<a name="line.316"></a>
<FONT color="green">317</FONT> private static class Factory extends ConfigurationFactory {<a name="line.317"></a>
<FONT color="green">318</FONT> <a name="line.318"></a>
<FONT color="green">319</FONT> /**<a name="line.319"></a>
<FONT color="green">320</FONT> * Default Factory Constructor.<a name="line.320"></a>
<FONT color="green">321</FONT> * @param name The configuration name.<a name="line.321"></a>
<FONT color="green">322</FONT> * @param configLocation The configuration location.<a name="line.322"></a>
<FONT color="green">323</FONT> * @return The Configuration.<a name="line.323"></a>
<FONT color="green">324</FONT> */<a name="line.324"></a>
<FONT color="green">325</FONT> public Configuration getConfiguration(String name, URI configLocation) {<a name="line.325"></a>
<FONT color="green">326</FONT> <a name="line.326"></a>
<FONT color="green">327</FONT> if (configLocation == null) {<a name="line.327"></a>
<FONT color="green">328</FONT> String config = System.getProperty(CONFIGURATION_FILE_PROPERTY);<a name="line.328"></a>
<FONT color="green">329</FONT> if (config != null) {<a name="line.329"></a>
<FONT color="green">330</FONT> ClassLoader loader = this.getClass().getClassLoader();<a name="line.330"></a>
<FONT color="green">331</FONT> InputSource source = getInputFromString(config, loader);<a name="line.331"></a>
<FONT color="green">332</FONT> if (source != null) {<a name="line.332"></a>
<FONT color="green">333</FONT> for (ConfigurationFactory factory : factories) {<a name="line.333"></a>
<FONT color="green">334</FONT> String[] types = factory.getSupportedTypes();<a name="line.334"></a>
<FONT color="green">335</FONT> if (types != null) {<a name="line.335"></a>
<FONT color="green">336</FONT> for (String type : types) {<a name="line.336"></a>
<FONT color="green">337</FONT> if (type.equals("*") || config.endsWith(type)) {<a name="line.337"></a>
<FONT color="green">338</FONT> Configuration c = factory.getConfiguration(source);<a name="line.338"></a>
<FONT color="green">339</FONT> if (c != null) {<a name="line.339"></a>
<FONT color="green">340</FONT> return c;<a name="line.340"></a>
<FONT color="green">341</FONT> }<a name="line.341"></a>
<FONT color="green">342</FONT> }<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> }<a name="line.345"></a>
<FONT color="green">346</FONT> }<a name="line.346"></a>
<FONT color="green">347</FONT> }<a name="line.347"></a>
<FONT color="green">348</FONT> } else {<a name="line.348"></a>
<FONT color="green">349</FONT> for (ConfigurationFactory factory : factories) {<a name="line.349"></a>
<FONT color="green">350</FONT> Configuration config = factory.getConfiguration(name, configLocation);<a name="line.350"></a>
<FONT color="green">351</FONT> if (config != null) {<a name="line.351"></a>
<FONT color="green">352</FONT> return config;<a name="line.352"></a>
<FONT color="green">353</FONT> }<a name="line.353"></a>
<FONT color="green">354</FONT> }<a name="line.354"></a>
<FONT color="green">355</FONT> }<a name="line.355"></a>
<FONT color="green">356</FONT> <a name="line.356"></a>
<FONT color="green">357</FONT> Configuration config = getConfiguration(true, name);<a name="line.357"></a>
<FONT color="green">358</FONT> if (config == null) {<a name="line.358"></a>
<FONT color="green">359</FONT> config = getConfiguration(true, null);<a name="line.359"></a>
<FONT color="green">360</FONT> if (config == null) {<a name="line.360"></a>
<FONT color="green">361</FONT> config = getConfiguration(false, name);<a name="line.361"></a>
<FONT color="green">362</FONT> if (config == null) {<a name="line.362"></a>
<FONT color="green">363</FONT> config = getConfiguration(false, null);<a name="line.363"></a>
<FONT color="green">364</FONT> }<a name="line.364"></a>
<FONT color="green">365</FONT> }<a name="line.365"></a>
<FONT color="green">366</FONT> }<a name="line.366"></a>
<FONT color="green">367</FONT> return config != null ? config : new DefaultConfiguration();<a name="line.367"></a>
<FONT color="green">368</FONT> }<a name="line.368"></a>
<FONT color="green">369</FONT> <a name="line.369"></a>
<FONT color="green">370</FONT> private Configuration getConfiguration(boolean isTest, String name) {<a name="line.370"></a>
<FONT color="green">371</FONT> boolean named = (name != null &amp;&amp; name.length() &gt; 0);<a name="line.371"></a>
<FONT color="green">372</FONT> ClassLoader loader = this.getClass().getClassLoader();<a name="line.372"></a>
<FONT color="green">373</FONT> for (ConfigurationFactory factory : factories) {<a name="line.373"></a>
<FONT color="green">374</FONT> String configName;<a name="line.374"></a>
<FONT color="green">375</FONT> String prefix = isTest ? TEST_PREFIX : DEFAULT_PREFIX;<a name="line.375"></a>
<FONT color="green">376</FONT> String [] types = factory.getSupportedTypes();<a name="line.376"></a>
<FONT color="green">377</FONT> if (types == null) {<a name="line.377"></a>
<FONT color="green">378</FONT> continue;<a name="line.378"></a>
<FONT color="green">379</FONT> }<a name="line.379"></a>
<FONT color="green">380</FONT> <a name="line.380"></a>
<FONT color="green">381</FONT> for (String suffix : types) {<a name="line.381"></a>
<FONT color="green">382</FONT> if (suffix.equals("*")) {<a name="line.382"></a>
<FONT color="green">383</FONT> continue;<a name="line.383"></a>
<FONT color="green">384</FONT> }<a name="line.384"></a>
<FONT color="green">385</FONT> configName = named ? prefix + name + suffix : prefix + suffix;<a name="line.385"></a>
<FONT color="green">386</FONT> <a name="line.386"></a>
<FONT color="green">387</FONT> InputSource source = getInputFromResource(configName, loader);<a name="line.387"></a>
<FONT color="green">388</FONT> if (source != null) {<a name="line.388"></a>
<FONT color="green">389</FONT> return factory.getConfiguration(source);<a name="line.389"></a>
<FONT color="green">390</FONT> }<a name="line.390"></a>
<FONT color="green">391</FONT> }<a name="line.391"></a>
<FONT color="green">392</FONT> }<a name="line.392"></a>
<FONT color="green">393</FONT> return null;<a name="line.393"></a>
<FONT color="green">394</FONT> }<a name="line.394"></a>
<FONT color="green">395</FONT> <a name="line.395"></a>
<FONT color="green">396</FONT> public String[] getSupportedTypes() {<a name="line.396"></a>
<FONT color="green">397</FONT> return null;<a name="line.397"></a>
<FONT color="green">398</FONT> }<a name="line.398"></a>
<FONT color="green">399</FONT> <a name="line.399"></a>
<FONT color="green">400</FONT> public Configuration getConfiguration(InputSource source) {<a name="line.400"></a>
<FONT color="green">401</FONT> return null;<a name="line.401"></a>
<FONT color="green">402</FONT> }<a name="line.402"></a>
<FONT color="green">403</FONT> }<a name="line.403"></a>
<FONT color="green">404</FONT> }<a name="line.404"></a>
</PRE>
</BODY>
</HTML>