blob: 5987e809e98e9fd7a59746a9a13eede063c6ab3d [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.helpers;<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.status.StatusLogger;<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import java.io.InputStream;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.InterruptedIOException;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.lang.reflect.InvocationTargetException;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.net.URL;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Load resources (or images) from various sources.<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> public final class Loader {<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> private static final String TSTR = "Caught Exception while in Loader.getResource. This may be innocuous.";<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> private static boolean ignoreTCL = false;<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> static {<a name="line.39"></a>
<FONT color="green">040</FONT> String ignoreTCLProp = OptionConverter.getSystemProperty("log4j.ignoreTCL", null);<a name="line.40"></a>
<FONT color="green">041</FONT> if (ignoreTCLProp != null) {<a name="line.41"></a>
<FONT color="green">042</FONT> ignoreTCL = OptionConverter.toBoolean(ignoreTCLProp, true);<a name="line.42"></a>
<FONT color="green">043</FONT> }<a name="line.43"></a>
<FONT color="green">044</FONT> }<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> private Loader() {<a name="line.46"></a>
<FONT color="green">047</FONT> }<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> /**<a name="line.49"></a>
<FONT color="green">050</FONT> * This method will search for &lt;code&gt;resource&lt;/code&gt; in different<a name="line.50"></a>
<FONT color="green">051</FONT> * places. The search order is as follows:<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;p/&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;ol&gt;<a name="line.53"></a>
<FONT color="green">054</FONT> * &lt;p/&gt;<a name="line.54"></a>
<FONT color="green">055</FONT> * &lt;p&gt;&lt;li&gt;Search for &lt;code&gt;resource&lt;/code&gt; using the thread context<a name="line.55"></a>
<FONT color="green">056</FONT> * class loader under Java2. If that fails, search for<a name="line.56"></a>
<FONT color="green">057</FONT> * &lt;code&gt;resource&lt;/code&gt; using the class loader that loaded this<a name="line.57"></a>
<FONT color="green">058</FONT> * class (&lt;code&gt;Loader&lt;/code&gt;). Under JDK 1.1, only the the class<a name="line.58"></a>
<FONT color="green">059</FONT> * loader that loaded this class (&lt;code&gt;Loader&lt;/code&gt;) is used.<a name="line.59"></a>
<FONT color="green">060</FONT> * &lt;p/&gt;<a name="line.60"></a>
<FONT color="green">061</FONT> * &lt;p&gt;&lt;li&gt;Try one last time with<a name="line.61"></a>
<FONT color="green">062</FONT> * &lt;code&gt;ClassLoader.getSystemResource(resource)&lt;/code&gt;, that is is<a name="line.62"></a>
<FONT color="green">063</FONT> * using the system class loader in JDK 1.2 and virtual machine's<a name="line.63"></a>
<FONT color="green">064</FONT> * built-in class loader in JDK 1.1.<a name="line.64"></a>
<FONT color="green">065</FONT> * &lt;p/&gt;<a name="line.65"></a>
<FONT color="green">066</FONT> * &lt;/ol&gt;<a name="line.66"></a>
<FONT color="green">067</FONT> * @param resource The resource to load.<a name="line.67"></a>
<FONT color="green">068</FONT> * @param defaultLoader The default ClassLoader.<a name="line.68"></a>
<FONT color="green">069</FONT> * @return A URL to the resource.<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public static URL getResource(String resource, ClassLoader defaultLoader) {<a name="line.71"></a>
<FONT color="green">072</FONT> ClassLoader classLoader;<a name="line.72"></a>
<FONT color="green">073</FONT> URL url;<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> try {<a name="line.75"></a>
<FONT color="green">076</FONT> classLoader = getTCL();<a name="line.76"></a>
<FONT color="green">077</FONT> if (classLoader != null) {<a name="line.77"></a>
<FONT color="green">078</FONT> LOGGER.trace("Trying to find [" + resource + "] using context classloader "<a name="line.78"></a>
<FONT color="green">079</FONT> + classLoader + ".");<a name="line.79"></a>
<FONT color="green">080</FONT> url = classLoader.getResource(resource);<a name="line.80"></a>
<FONT color="green">081</FONT> if (url != null) {<a name="line.81"></a>
<FONT color="green">082</FONT> return url;<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> // We could not find resource. Let us now try with the classloader that loaded this class.<a name="line.86"></a>
<FONT color="green">087</FONT> classLoader = Loader.class.getClassLoader();<a name="line.87"></a>
<FONT color="green">088</FONT> if (classLoader != null) {<a name="line.88"></a>
<FONT color="green">089</FONT> LOGGER.trace("Trying to find [" + resource + "] using " + classLoader + " class loader.");<a name="line.89"></a>
<FONT color="green">090</FONT> url = classLoader.getResource(resource);<a name="line.90"></a>
<FONT color="green">091</FONT> if (url != null) {<a name="line.91"></a>
<FONT color="green">092</FONT> return url;<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> // We could not find resource. Finally try with the default ClassLoader.<a name="line.95"></a>
<FONT color="green">096</FONT> if (defaultLoader != null) {<a name="line.96"></a>
<FONT color="green">097</FONT> LOGGER.trace("Trying to find [" + resource + "] using " + defaultLoader + " class loader.");<a name="line.97"></a>
<FONT color="green">098</FONT> url = defaultLoader.getResource(resource);<a name="line.98"></a>
<FONT color="green">099</FONT> if (url != null) {<a name="line.99"></a>
<FONT color="green">100</FONT> return url;<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> }<a name="line.102"></a>
<FONT color="green">103</FONT> } catch (IllegalAccessException t) {<a name="line.103"></a>
<FONT color="green">104</FONT> LOGGER.warn(TSTR, t);<a name="line.104"></a>
<FONT color="green">105</FONT> } catch (InvocationTargetException t) {<a name="line.105"></a>
<FONT color="green">106</FONT> if (t.getTargetException() instanceof InterruptedException<a name="line.106"></a>
<FONT color="green">107</FONT> || t.getTargetException() instanceof InterruptedIOException) {<a name="line.107"></a>
<FONT color="green">108</FONT> Thread.currentThread().interrupt();<a name="line.108"></a>
<FONT color="green">109</FONT> }<a name="line.109"></a>
<FONT color="green">110</FONT> LOGGER.warn(TSTR, t);<a name="line.110"></a>
<FONT color="green">111</FONT> } catch (Throwable t) {<a name="line.111"></a>
<FONT color="green">112</FONT> //<a name="line.112"></a>
<FONT color="green">113</FONT> // can't be InterruptedException or InterruptedIOException<a name="line.113"></a>
<FONT color="green">114</FONT> // since not declared, must be error or RuntimeError.<a name="line.114"></a>
<FONT color="green">115</FONT> LOGGER.warn(TSTR, t);<a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> // Last ditch attempt: get the resource from the class path. It<a name="line.118"></a>
<FONT color="green">119</FONT> // may be the case that clazz was loaded by the Extentsion class<a name="line.119"></a>
<FONT color="green">120</FONT> // loader which the parent of the system class loader. Hence the<a name="line.120"></a>
<FONT color="green">121</FONT> // code below.<a name="line.121"></a>
<FONT color="green">122</FONT> LOGGER.trace("Trying to find [" + resource + "] using ClassLoader.getSystemResource().");<a name="line.122"></a>
<FONT color="green">123</FONT> return ClassLoader.getSystemResource(resource);<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> /**<a name="line.126"></a>
<FONT color="green">127</FONT> * This method will search for &lt;code&gt;resource&lt;/code&gt; in different<a name="line.127"></a>
<FONT color="green">128</FONT> * places. The search order is as follows:<a name="line.128"></a>
<FONT color="green">129</FONT> * &lt;p/&gt;<a name="line.129"></a>
<FONT color="green">130</FONT> * &lt;ol&gt;<a name="line.130"></a>
<FONT color="green">131</FONT> * &lt;p/&gt;<a name="line.131"></a>
<FONT color="green">132</FONT> * &lt;p&gt;&lt;li&gt;Search for &lt;code&gt;resource&lt;/code&gt; using the thread context<a name="line.132"></a>
<FONT color="green">133</FONT> * class loader under Java2. If that fails, search for<a name="line.133"></a>
<FONT color="green">134</FONT> * &lt;code&gt;resource&lt;/code&gt; using the class loader that loaded this<a name="line.134"></a>
<FONT color="green">135</FONT> * class (&lt;code&gt;Loader&lt;/code&gt;). Under JDK 1.1, only the the class<a name="line.135"></a>
<FONT color="green">136</FONT> * loader that loaded this class (&lt;code&gt;Loader&lt;/code&gt;) is used.<a name="line.136"></a>
<FONT color="green">137</FONT> * &lt;p/&gt;<a name="line.137"></a>
<FONT color="green">138</FONT> * &lt;p&gt;&lt;li&gt;Try one last time with<a name="line.138"></a>
<FONT color="green">139</FONT> * &lt;code&gt;ClassLoader.getSystemResource(resource)&lt;/code&gt;, that is is<a name="line.139"></a>
<FONT color="green">140</FONT> * using the system class loader in JDK 1.2 and virtual machine's<a name="line.140"></a>
<FONT color="green">141</FONT> * built-in class loader in JDK 1.1.<a name="line.141"></a>
<FONT color="green">142</FONT> * &lt;p/&gt;<a name="line.142"></a>
<FONT color="green">143</FONT> * &lt;/ol&gt;<a name="line.143"></a>
<FONT color="green">144</FONT> * @param resource The resource to load.<a name="line.144"></a>
<FONT color="green">145</FONT> * @param defaultLoader The default ClassLoader.<a name="line.145"></a>
<FONT color="green">146</FONT> * @return An InputStream to read the resouce.<a name="line.146"></a>
<FONT color="green">147</FONT> */<a name="line.147"></a>
<FONT color="green">148</FONT> public static InputStream getResourceAsStream(String resource, ClassLoader defaultLoader) {<a name="line.148"></a>
<FONT color="green">149</FONT> ClassLoader classLoader;<a name="line.149"></a>
<FONT color="green">150</FONT> InputStream is;<a name="line.150"></a>
<FONT color="green">151</FONT> <a name="line.151"></a>
<FONT color="green">152</FONT> try {<a name="line.152"></a>
<FONT color="green">153</FONT> classLoader = getTCL();<a name="line.153"></a>
<FONT color="green">154</FONT> if (classLoader != null) {<a name="line.154"></a>
<FONT color="green">155</FONT> LOGGER.trace("Trying to find [" + resource + "] using context classloader " + classLoader + ".");<a name="line.155"></a>
<FONT color="green">156</FONT> is = classLoader.getResourceAsStream(resource);<a name="line.156"></a>
<FONT color="green">157</FONT> if (is != null) {<a name="line.157"></a>
<FONT color="green">158</FONT> return is;<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> }<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> // We could not find resource. Let us now try with the classloader that loaded this class.<a name="line.162"></a>
<FONT color="green">163</FONT> classLoader = Loader.class.getClassLoader();<a name="line.163"></a>
<FONT color="green">164</FONT> if (classLoader != null) {<a name="line.164"></a>
<FONT color="green">165</FONT> LOGGER.trace("Trying to find [" + resource + "] using " + classLoader + " class loader.");<a name="line.165"></a>
<FONT color="green">166</FONT> is = classLoader.getResourceAsStream(resource);<a name="line.166"></a>
<FONT color="green">167</FONT> if (is != null) {<a name="line.167"></a>
<FONT color="green">168</FONT> return is;<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> <a name="line.171"></a>
<FONT color="green">172</FONT> // We could not find resource. Finally try with the default ClassLoader.<a name="line.172"></a>
<FONT color="green">173</FONT> if (defaultLoader != null) {<a name="line.173"></a>
<FONT color="green">174</FONT> LOGGER.trace("Trying to find [" + resource + "] using " + defaultLoader + " class loader.");<a name="line.174"></a>
<FONT color="green">175</FONT> is = defaultLoader.getResourceAsStream(resource);<a name="line.175"></a>
<FONT color="green">176</FONT> if (is != null) {<a name="line.176"></a>
<FONT color="green">177</FONT> return is;<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> }<a name="line.179"></a>
<FONT color="green">180</FONT> } catch (IllegalAccessException t) {<a name="line.180"></a>
<FONT color="green">181</FONT> LOGGER.warn(TSTR, t);<a name="line.181"></a>
<FONT color="green">182</FONT> } catch (InvocationTargetException t) {<a name="line.182"></a>
<FONT color="green">183</FONT> if (t.getTargetException() instanceof InterruptedException<a name="line.183"></a>
<FONT color="green">184</FONT> || t.getTargetException() instanceof InterruptedIOException) {<a name="line.184"></a>
<FONT color="green">185</FONT> Thread.currentThread().interrupt();<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> LOGGER.warn(TSTR, t);<a name="line.187"></a>
<FONT color="green">188</FONT> } catch (Throwable t) {<a name="line.188"></a>
<FONT color="green">189</FONT> //<a name="line.189"></a>
<FONT color="green">190</FONT> // can't be InterruptedException or InterruptedIOException<a name="line.190"></a>
<FONT color="green">191</FONT> // since not declared, must be error or RuntimeError.<a name="line.191"></a>
<FONT color="green">192</FONT> LOGGER.warn(TSTR, t);<a name="line.192"></a>
<FONT color="green">193</FONT> }<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> // Last ditch attempt: get the resource from the class path. It<a name="line.195"></a>
<FONT color="green">196</FONT> // may be the case that clazz was loaded by the Extentsion class<a name="line.196"></a>
<FONT color="green">197</FONT> // loader which the parent of the system class loader. Hence the<a name="line.197"></a>
<FONT color="green">198</FONT> // code below.<a name="line.198"></a>
<FONT color="green">199</FONT> LOGGER.trace("Trying to find [" + resource + "] using ClassLoader.getSystemResource().");<a name="line.199"></a>
<FONT color="green">200</FONT> return ClassLoader.getSystemResourceAsStream(resource);<a name="line.200"></a>
<FONT color="green">201</FONT> }<a name="line.201"></a>
<FONT color="green">202</FONT> <a name="line.202"></a>
<FONT color="green">203</FONT> /**<a name="line.203"></a>
<FONT color="green">204</FONT> * Load a Class by name.<a name="line.204"></a>
<FONT color="green">205</FONT> * @param clazz The class name.<a name="line.205"></a>
<FONT color="green">206</FONT> * @return The Class.<a name="line.206"></a>
<FONT color="green">207</FONT> * @throws ClassNotFoundException if the Class could not be found.<a name="line.207"></a>
<FONT color="green">208</FONT> */<a name="line.208"></a>
<FONT color="green">209</FONT> public static Class loadClass(String clazz) throws ClassNotFoundException {<a name="line.209"></a>
<FONT color="green">210</FONT> // Just call Class.forName(clazz) if we are instructed to ignore the TCL.<a name="line.210"></a>
<FONT color="green">211</FONT> if (ignoreTCL) {<a name="line.211"></a>
<FONT color="green">212</FONT> return Class.forName(clazz);<a name="line.212"></a>
<FONT color="green">213</FONT> } else {<a name="line.213"></a>
<FONT color="green">214</FONT> try {<a name="line.214"></a>
<FONT color="green">215</FONT> return getTCL().loadClass(clazz);<a name="line.215"></a>
<FONT color="green">216</FONT> } catch (Throwable e) {<a name="line.216"></a>
<FONT color="green">217</FONT> return Class.forName(clazz);<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> <a name="line.221"></a>
<FONT color="green">222</FONT> /**<a name="line.222"></a>
<FONT color="green">223</FONT> * Return the ClassLoader to use.<a name="line.223"></a>
<FONT color="green">224</FONT> * @return the ClassLoader.<a name="line.224"></a>
<FONT color="green">225</FONT> */<a name="line.225"></a>
<FONT color="green">226</FONT> public static ClassLoader getClassLoader() {<a name="line.226"></a>
<FONT color="green">227</FONT> ClassLoader cl = null;<a name="line.227"></a>
<FONT color="green">228</FONT> <a name="line.228"></a>
<FONT color="green">229</FONT> try {<a name="line.229"></a>
<FONT color="green">230</FONT> cl = getTCL();<a name="line.230"></a>
<FONT color="green">231</FONT> } catch (Exception ex) {<a name="line.231"></a>
<FONT color="green">232</FONT> // Ignore the exception. The ClassLoader will be located.<a name="line.232"></a>
<FONT color="green">233</FONT> }<a name="line.233"></a>
<FONT color="green">234</FONT> if (cl == null) {<a name="line.234"></a>
<FONT color="green">235</FONT> cl = Loader.getClassLoader();<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> return cl;<a name="line.237"></a>
<FONT color="green">238</FONT> }<a name="line.238"></a>
<FONT color="green">239</FONT> <a name="line.239"></a>
<FONT color="green">240</FONT> private static ClassLoader getTCL() throws IllegalAccessException, InvocationTargetException {<a name="line.240"></a>
<FONT color="green">241</FONT> ClassLoader cl;<a name="line.241"></a>
<FONT color="green">242</FONT> if (System.getSecurityManager() == null) {<a name="line.242"></a>
<FONT color="green">243</FONT> cl = Thread.currentThread().getContextClassLoader();<a name="line.243"></a>
<FONT color="green">244</FONT> } else {<a name="line.244"></a>
<FONT color="green">245</FONT> cl = (ClassLoader) java.security.AccessController.doPrivileged(<a name="line.245"></a>
<FONT color="green">246</FONT> new java.security.PrivilegedAction() {<a name="line.246"></a>
<FONT color="green">247</FONT> public Object run() {<a name="line.247"></a>
<FONT color="green">248</FONT> return Thread.currentThread().getContextClassLoader();<a name="line.248"></a>
<FONT color="green">249</FONT> }<a name="line.249"></a>
<FONT color="green">250</FONT> }<a name="line.250"></a>
<FONT color="green">251</FONT> );<a name="line.251"></a>
<FONT color="green">252</FONT> }<a name="line.252"></a>
<FONT color="green">253</FONT> <a name="line.253"></a>
<FONT color="green">254</FONT> return cl;<a name="line.254"></a>
<FONT color="green">255</FONT> }<a name="line.255"></a>
<FONT color="green">256</FONT> }<a name="line.256"></a>
</PRE>
</BODY>
</HTML>