blob: c87ae4fa16504e0d92ccafb7db35b13f93fec8fb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.util;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.InputStream;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.reflect.InvocationTargetException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.URL;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Load resources (or images) from various sources.<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span>public final class Loader {<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> private static final String TSTR = "Caught Exception while in Loader.getResource. This may be innocuous.";<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> private Loader() {<a name="line.37"></a>
<span class="sourceLineNo">038</span> }<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Returns the ClassLoader to use.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @return the ClassLoader.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> public static ClassLoader getClassLoader() {<a name="line.44"></a>
<span class="sourceLineNo">045</span> return getClassLoader(Loader.class, null);<a name="line.45"></a>
<span class="sourceLineNo">046</span> }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Returns the ClassLoader of current thread if possible, or falls back to the system ClassLoader if none is<a name="line.49"></a>
<span class="sourceLineNo">050</span> * available.<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @return the TCCL.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @see org.apache.logging.log4j.util.LoaderUtil#getThreadContextClassLoader()<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static ClassLoader getThreadContextClassLoader() {<a name="line.55"></a>
<span class="sourceLineNo">056</span> return LoaderUtil.getThreadContextClassLoader();<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> // TODO: this method could use some explanation<a name="line.59"></a>
<span class="sourceLineNo">060</span> public static ClassLoader getClassLoader(final Class&lt;?&gt; class1, final Class&lt;?&gt; class2) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> final ClassLoader threadContextClassLoader = getThreadContextClassLoader();<a name="line.61"></a>
<span class="sourceLineNo">062</span> final ClassLoader loader1 = class1 == null ? null : class1.getClassLoader();<a name="line.62"></a>
<span class="sourceLineNo">063</span> final ClassLoader loader2 = class2 == null ? null : class2.getClassLoader();<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> if (isChild(threadContextClassLoader, loader1)) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> return isChild(threadContextClassLoader, loader2) ? threadContextClassLoader : loader2;<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span> return isChild(loader1, loader2) ? loader1 : loader2;<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> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * This method will search for {@code resource} in different<a name="line.72"></a>
<span class="sourceLineNo">073</span> * places. The search order is as follows:<a name="line.73"></a>
<span class="sourceLineNo">074</span> *<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;ol&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;li&gt;Search for {@code resource} using the thread context<a name="line.77"></a>
<span class="sourceLineNo">078</span> * class loader under Java2. If that fails, search for<a name="line.78"></a>
<span class="sourceLineNo">079</span> * {@code resource} using the class loader that loaded this<a name="line.79"></a>
<span class="sourceLineNo">080</span> * class ({@code Loader}). Under JDK 1.1, only the the class<a name="line.80"></a>
<span class="sourceLineNo">081</span> * loader that loaded this class ({@code Loader}) is used.&lt;/li&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * &lt;li&gt;Try one last time with<a name="line.82"></a>
<span class="sourceLineNo">083</span> * {@code ClassLoader.getSystemResource(resource)}, that is is<a name="line.83"></a>
<span class="sourceLineNo">084</span> * using the system class loader in JDK 1.2 and virtual machine's<a name="line.84"></a>
<span class="sourceLineNo">085</span> * built-in class loader in JDK 1.1.&lt;/li&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;/ol&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @param resource The resource to load.<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @param defaultLoader The default ClassLoader.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @return A URL to the resource.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> public static URL getResource(final String resource, final ClassLoader defaultLoader) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> try {<a name="line.92"></a>
<span class="sourceLineNo">093</span> ClassLoader classLoader = getThreadContextClassLoader();<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (classLoader != null) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> LOGGER.trace("Trying to find [{}] using context class loader {}.", resource, classLoader);<a name="line.95"></a>
<span class="sourceLineNo">096</span> final URL url = classLoader.getResource(resource);<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (url != null) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return url;<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> // We could not find resource. Let us now try with the classloader that loaded this class.<a name="line.102"></a>
<span class="sourceLineNo">103</span> classLoader = Loader.class.getClassLoader();<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (classLoader != null) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> LOGGER.trace("Trying to find [{}] using {} class loader.", resource, classLoader);<a name="line.105"></a>
<span class="sourceLineNo">106</span> final URL url = classLoader.getResource(resource);<a name="line.106"></a>
<span class="sourceLineNo">107</span> if (url != null) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return url;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> // We could not find resource. Finally try with the default ClassLoader.<a name="line.111"></a>
<span class="sourceLineNo">112</span> if (defaultLoader != null) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> LOGGER.trace("Trying to find [{}] using {} class loader.", resource, defaultLoader);<a name="line.113"></a>
<span class="sourceLineNo">114</span> final URL url = defaultLoader.getResource(resource);<a name="line.114"></a>
<span class="sourceLineNo">115</span> if (url != null) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return url;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> } catch (final Throwable t) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> //<a name="line.120"></a>
<span class="sourceLineNo">121</span> // can't be InterruptedException or InterruptedIOException<a name="line.121"></a>
<span class="sourceLineNo">122</span> // since not declared, must be error or RuntimeError.<a name="line.122"></a>
<span class="sourceLineNo">123</span> LOGGER.warn(TSTR, t);<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> // Last ditch attempt: get the resource from the class path. It<a name="line.126"></a>
<span class="sourceLineNo">127</span> // may be the case that clazz was loaded by the Extension class<a name="line.127"></a>
<span class="sourceLineNo">128</span> // loader which the parent of the system class loader. Hence the<a name="line.128"></a>
<span class="sourceLineNo">129</span> // code below.<a name="line.129"></a>
<span class="sourceLineNo">130</span> LOGGER.trace("Trying to find [{}] using ClassLoader.getSystemResource().", resource);<a name="line.130"></a>
<span class="sourceLineNo">131</span> return ClassLoader.getSystemResource(resource);<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
<span class="sourceLineNo">135</span> * This method will search for {@code resource} in different<a name="line.135"></a>
<span class="sourceLineNo">136</span> * places. The search order is as follows:<a name="line.136"></a>
<span class="sourceLineNo">137</span> *<a name="line.137"></a>
<span class="sourceLineNo">138</span> * &lt;ol&gt;<a name="line.138"></a>
<span class="sourceLineNo">139</span> * &lt;li&gt;Search for {@code resource} using the thread context<a name="line.139"></a>
<span class="sourceLineNo">140</span> * class loader under Java2. If that fails, search for<a name="line.140"></a>
<span class="sourceLineNo">141</span> * {@code resource} using the class loader that loaded this<a name="line.141"></a>
<span class="sourceLineNo">142</span> * class ({@code Loader}). Under JDK 1.1, only the the class<a name="line.142"></a>
<span class="sourceLineNo">143</span> * loader that loaded this class ({@code Loader}) is used.&lt;/li&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span> * &lt;li&gt;Try one last time with<a name="line.144"></a>
<span class="sourceLineNo">145</span> * {@code ClassLoader.getSystemResource(resource)}, that is is<a name="line.145"></a>
<span class="sourceLineNo">146</span> * using the system class loader in JDK 1.2 and virtual machine's<a name="line.146"></a>
<span class="sourceLineNo">147</span> * built-in class loader in JDK 1.1.&lt;/li&gt;<a name="line.147"></a>
<span class="sourceLineNo">148</span> * &lt;/ol&gt;<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @param resource The resource to load.<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @param defaultLoader The default ClassLoader.<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @return An InputStream to read the resouce.<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> public static InputStream getResourceAsStream(final String resource, final ClassLoader defaultLoader) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> try {<a name="line.154"></a>
<span class="sourceLineNo">155</span> ClassLoader classLoader = getThreadContextClassLoader();<a name="line.155"></a>
<span class="sourceLineNo">156</span> InputStream is;<a name="line.156"></a>
<span class="sourceLineNo">157</span> if (classLoader != null) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> LOGGER.trace("Trying to find [{}] using context class loader {}.", resource, classLoader);<a name="line.158"></a>
<span class="sourceLineNo">159</span> is = classLoader.getResourceAsStream(resource);<a name="line.159"></a>
<span class="sourceLineNo">160</span> if (is != null) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> return is;<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<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> // We could not find resource. Let us now try with the classloader that loaded this class.<a name="line.165"></a>
<span class="sourceLineNo">166</span> classLoader = Loader.class.getClassLoader();<a name="line.166"></a>
<span class="sourceLineNo">167</span> if (classLoader != null) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> LOGGER.trace("Trying to find [{}] using {} class loader.", resource, classLoader);<a name="line.168"></a>
<span class="sourceLineNo">169</span> is = classLoader.getResourceAsStream(resource);<a name="line.169"></a>
<span class="sourceLineNo">170</span> if (is != null) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> return is;<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> // We could not find resource. Finally try with the default ClassLoader.<a name="line.175"></a>
<span class="sourceLineNo">176</span> if (defaultLoader != null) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> LOGGER.trace("Trying to find [{}] using {} class loader.", resource, defaultLoader);<a name="line.177"></a>
<span class="sourceLineNo">178</span> is = defaultLoader.getResourceAsStream(resource);<a name="line.178"></a>
<span class="sourceLineNo">179</span> if (is != null) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return is;<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> } catch (final Throwable t) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> //<a name="line.184"></a>
<span class="sourceLineNo">185</span> // can't be InterruptedException or InterruptedIOException<a name="line.185"></a>
<span class="sourceLineNo">186</span> // since not declared, must be error or RuntimeError.<a name="line.186"></a>
<span class="sourceLineNo">187</span> LOGGER.warn(TSTR, t);<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> // Last ditch attempt: get the resource from the class path. It<a name="line.190"></a>
<span class="sourceLineNo">191</span> // may be the case that clazz was loaded by the Extension class<a name="line.191"></a>
<span class="sourceLineNo">192</span> // loader which the parent of the system class loader. Hence the<a name="line.192"></a>
<span class="sourceLineNo">193</span> // code below.<a name="line.193"></a>
<span class="sourceLineNo">194</span> LOGGER.trace("Trying to find [{}] using ClassLoader.getSystemResource().", resource);<a name="line.194"></a>
<span class="sourceLineNo">195</span> return ClassLoader.getSystemResourceAsStream(resource);<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> /**<a name="line.198"></a>
<span class="sourceLineNo">199</span> * Determines if one ClassLoader is a child of another ClassLoader. Note that a {@code null} ClassLoader is<a name="line.199"></a>
<span class="sourceLineNo">200</span> * interpreted as the system ClassLoader as per convention.<a name="line.200"></a>
<span class="sourceLineNo">201</span> *<a name="line.201"></a>
<span class="sourceLineNo">202</span> * @param loader1 the ClassLoader to check for childhood.<a name="line.202"></a>
<span class="sourceLineNo">203</span> * @param loader2 the ClassLoader to check for parenthood.<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @return {@code true} if the first ClassLoader is a strict descendant of the second ClassLoader.<a name="line.204"></a>
<span class="sourceLineNo">205</span> */<a name="line.205"></a>
<span class="sourceLineNo">206</span> private static boolean isChild(final ClassLoader loader1, final ClassLoader loader2) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> if (loader1 != null &amp;&amp; loader2 != null) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> ClassLoader parent = loader1.getParent();<a name="line.208"></a>
<span class="sourceLineNo">209</span> while (parent != null &amp;&amp; parent != loader2) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> parent = parent.getParent();<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span> // once parent is null, we're at the system CL, which would indicate they have separate ancestry<a name="line.212"></a>
<span class="sourceLineNo">213</span> return parent != null;<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span> return loader1 != null;<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> /**<a name="line.218"></a>
<span class="sourceLineNo">219</span> * Loads and initializes a named Class using a given ClassLoader.<a name="line.219"></a>
<span class="sourceLineNo">220</span> *<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @param className The class name.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @param loader The class loader.<a name="line.222"></a>
<span class="sourceLineNo">223</span> * @return The class.<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @throws ClassNotFoundException if the class could not be found.<a name="line.224"></a>
<span class="sourceLineNo">225</span> */<a name="line.225"></a>
<span class="sourceLineNo">226</span> public static Class&lt;?&gt; initializeClass(final String className, final ClassLoader loader)<a name="line.226"></a>
<span class="sourceLineNo">227</span> throws ClassNotFoundException {<a name="line.227"></a>
<span class="sourceLineNo">228</span> return Class.forName(className, true, loader);<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
<span class="sourceLineNo">232</span> * Loads a named Class using a given ClassLoader.<a name="line.232"></a>
<span class="sourceLineNo">233</span> *<a name="line.233"></a>
<span class="sourceLineNo">234</span> * @param className The class name.<a name="line.234"></a>
<span class="sourceLineNo">235</span> * @param loader The class loader.<a name="line.235"></a>
<span class="sourceLineNo">236</span> * @return The class, or null if loader is null.<a name="line.236"></a>
<span class="sourceLineNo">237</span> * @throws ClassNotFoundException if the class could not be found.<a name="line.237"></a>
<span class="sourceLineNo">238</span> */<a name="line.238"></a>
<span class="sourceLineNo">239</span> public static Class&lt;?&gt; loadClass(final String className, final ClassLoader loader)<a name="line.239"></a>
<span class="sourceLineNo">240</span> throws ClassNotFoundException {<a name="line.240"></a>
<span class="sourceLineNo">241</span> return loader != null ? loader.loadClass(className) : null;<a name="line.241"></a>
<span class="sourceLineNo">242</span> }<a name="line.242"></a>
<span class="sourceLineNo">243</span><a name="line.243"></a>
<span class="sourceLineNo">244</span> /**<a name="line.244"></a>
<span class="sourceLineNo">245</span> * Load a Class in the {@code java.*} namespace by name. Useful for peculiar scenarios typically involving<a name="line.245"></a>
<span class="sourceLineNo">246</span> * Google App Engine.<a name="line.246"></a>
<span class="sourceLineNo">247</span> *<a name="line.247"></a>
<span class="sourceLineNo">248</span> * @param className The class name.<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @return The Class.<a name="line.249"></a>
<span class="sourceLineNo">250</span> * @throws ClassNotFoundException if the Class could not be found.<a name="line.250"></a>
<span class="sourceLineNo">251</span> */<a name="line.251"></a>
<span class="sourceLineNo">252</span> public static Class&lt;?&gt; loadSystemClass(final String className) throws ClassNotFoundException {<a name="line.252"></a>
<span class="sourceLineNo">253</span> try {<a name="line.253"></a>
<span class="sourceLineNo">254</span> return Class.forName(className, true, ClassLoader.getSystemClassLoader());<a name="line.254"></a>
<span class="sourceLineNo">255</span> } catch (final Throwable t) {<a name="line.255"></a>
<span class="sourceLineNo">256</span> LOGGER.trace("Couldn't use SystemClassLoader. Trying Class.forName({}).", className, t);<a name="line.256"></a>
<span class="sourceLineNo">257</span> return Class.forName(className);<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span> }<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span> /**<a name="line.261"></a>
<span class="sourceLineNo">262</span> * Loads and instantiates a Class using the default constructor.<a name="line.262"></a>
<span class="sourceLineNo">263</span> *<a name="line.263"></a>
<span class="sourceLineNo">264</span> * @param className The class name.<a name="line.264"></a>
<span class="sourceLineNo">265</span> * @return new instance of the class.<a name="line.265"></a>
<span class="sourceLineNo">266</span> * @throws ClassNotFoundException if the class isn't available to the usual ClassLoaders<a name="line.266"></a>
<span class="sourceLineNo">267</span> * @throws IllegalAccessException if the class can't be instantiated through a public constructor<a name="line.267"></a>
<span class="sourceLineNo">268</span> * @throws InstantiationException if there was an exception whilst instantiating the class<a name="line.268"></a>
<span class="sourceLineNo">269</span> * @throws NoSuchMethodException if there isn't a no-args constructor on the class<a name="line.269"></a>
<span class="sourceLineNo">270</span> * @throws InvocationTargetException if there was an exception whilst constructing the class<a name="line.270"></a>
<span class="sourceLineNo">271</span> */<a name="line.271"></a>
<span class="sourceLineNo">272</span> @SuppressWarnings("unchecked")<a name="line.272"></a>
<span class="sourceLineNo">273</span> public static &lt;T&gt; T newInstanceOf(final String className)<a name="line.273"></a>
<span class="sourceLineNo">274</span> throws ClassNotFoundException,<a name="line.274"></a>
<span class="sourceLineNo">275</span> IllegalAccessException,<a name="line.275"></a>
<span class="sourceLineNo">276</span> InstantiationException,<a name="line.276"></a>
<span class="sourceLineNo">277</span> NoSuchMethodException,<a name="line.277"></a>
<span class="sourceLineNo">278</span> InvocationTargetException {<a name="line.278"></a>
<span class="sourceLineNo">279</span> final ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();<a name="line.279"></a>
<span class="sourceLineNo">280</span> try {<a name="line.280"></a>
<span class="sourceLineNo">281</span> Thread.currentThread().setContextClassLoader(getClassLoader());<a name="line.281"></a>
<span class="sourceLineNo">282</span> return LoaderUtil.newInstanceOf(className);<a name="line.282"></a>
<span class="sourceLineNo">283</span> } finally {<a name="line.283"></a>
<span class="sourceLineNo">284</span> Thread.currentThread().setContextClassLoader(contextClassLoader);<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><a name="line.287"></a>
<span class="sourceLineNo">288</span> /**<a name="line.288"></a>
<span class="sourceLineNo">289</span> * Loads, instantiates, and casts a Class using the default constructor.<a name="line.289"></a>
<span class="sourceLineNo">290</span> *<a name="line.290"></a>
<span class="sourceLineNo">291</span> * @param className The class name.<a name="line.291"></a>
<span class="sourceLineNo">292</span> * @param clazz The class to cast it to.<a name="line.292"></a>
<span class="sourceLineNo">293</span> * @param &lt;T&gt; The type to cast it to.<a name="line.293"></a>
<span class="sourceLineNo">294</span> * @return new instance of the class cast to {@code T}<a name="line.294"></a>
<span class="sourceLineNo">295</span> * @throws ClassNotFoundException if the class isn't available to the usual ClassLoaders<a name="line.295"></a>
<span class="sourceLineNo">296</span> * @throws IllegalAccessException if the class can't be instantiated through a public constructor<a name="line.296"></a>
<span class="sourceLineNo">297</span> * @throws InstantiationException if there was an exception whilst instantiating the class<a name="line.297"></a>
<span class="sourceLineNo">298</span> * @throws NoSuchMethodException if there isn't a no-args constructor on the class<a name="line.298"></a>
<span class="sourceLineNo">299</span> * @throws InvocationTargetException if there was an exception whilst constructing the class<a name="line.299"></a>
<span class="sourceLineNo">300</span> * @throws ClassCastException if the constructed object isn't type compatible with {@code T}<a name="line.300"></a>
<span class="sourceLineNo">301</span> */<a name="line.301"></a>
<span class="sourceLineNo">302</span> public static &lt;T&gt; T newCheckedInstanceOf(final String className, final Class&lt;T&gt; clazz)<a name="line.302"></a>
<span class="sourceLineNo">303</span> throws ClassNotFoundException,<a name="line.303"></a>
<span class="sourceLineNo">304</span> NoSuchMethodException,<a name="line.304"></a>
<span class="sourceLineNo">305</span> IllegalAccessException,<a name="line.305"></a>
<span class="sourceLineNo">306</span> InvocationTargetException,<a name="line.306"></a>
<span class="sourceLineNo">307</span> InstantiationException {<a name="line.307"></a>
<span class="sourceLineNo">308</span> final ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();<a name="line.308"></a>
<span class="sourceLineNo">309</span> try {<a name="line.309"></a>
<span class="sourceLineNo">310</span> Thread.currentThread().setContextClassLoader(getClassLoader());<a name="line.310"></a>
<span class="sourceLineNo">311</span> return LoaderUtil.newCheckedInstanceOf(className, clazz);<a name="line.311"></a>
<span class="sourceLineNo">312</span> } finally {<a name="line.312"></a>
<span class="sourceLineNo">313</span> Thread.currentThread().setContextClassLoader(contextClassLoader);<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span> }<a name="line.315"></a>
<span class="sourceLineNo">316</span><a name="line.316"></a>
<span class="sourceLineNo">317</span> /**<a name="line.317"></a>
<span class="sourceLineNo">318</span> * Loads and instantiates a class given by a property name.<a name="line.318"></a>
<span class="sourceLineNo">319</span> *<a name="line.319"></a>
<span class="sourceLineNo">320</span> * @param propertyName The property name to look up a class name for.<a name="line.320"></a>
<span class="sourceLineNo">321</span> * @param clazz The class to cast it to.<a name="line.321"></a>
<span class="sourceLineNo">322</span> * @param &lt;T&gt; The type to cast it to.<a name="line.322"></a>
<span class="sourceLineNo">323</span> * @return new instance of the class given in the property or {@code null} if the property was unset.<a name="line.323"></a>
<span class="sourceLineNo">324</span> * @throws ClassNotFoundException if the class isn't available to the usual ClassLoaders<a name="line.324"></a>
<span class="sourceLineNo">325</span> * @throws IllegalAccessException if the class can't be instantiated through a public constructor<a name="line.325"></a>
<span class="sourceLineNo">326</span> * @throws InstantiationException if there was an exception whilst instantiating the class<a name="line.326"></a>
<span class="sourceLineNo">327</span> * @throws NoSuchMethodException if there isn't a no-args constructor on the class<a name="line.327"></a>
<span class="sourceLineNo">328</span> * @throws InvocationTargetException if there was an exception whilst constructing the class<a name="line.328"></a>
<span class="sourceLineNo">329</span> * @throws ClassCastException if the constructed object isn't type compatible with {@code T}<a name="line.329"></a>
<span class="sourceLineNo">330</span> */<a name="line.330"></a>
<span class="sourceLineNo">331</span> public static &lt;T&gt; T newCheckedInstanceOfProperty(final String propertyName, final Class&lt;T&gt; clazz)<a name="line.331"></a>
<span class="sourceLineNo">332</span> throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException,<a name="line.332"></a>
<span class="sourceLineNo">333</span> IllegalAccessException {<a name="line.333"></a>
<span class="sourceLineNo">334</span> final String className = PropertiesUtil.getProperties().getStringProperty(propertyName);<a name="line.334"></a>
<span class="sourceLineNo">335</span> final ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();<a name="line.335"></a>
<span class="sourceLineNo">336</span> try {<a name="line.336"></a>
<span class="sourceLineNo">337</span> Thread.currentThread().setContextClassLoader(getClassLoader());<a name="line.337"></a>
<span class="sourceLineNo">338</span> return LoaderUtil.newCheckedInstanceOfProperty(propertyName, clazz);<a name="line.338"></a>
<span class="sourceLineNo">339</span> } finally {<a name="line.339"></a>
<span class="sourceLineNo">340</span> Thread.currentThread().setContextClassLoader(contextClassLoader);<a name="line.340"></a>
<span class="sourceLineNo">341</span> }<a name="line.341"></a>
<span class="sourceLineNo">342</span> }<a name="line.342"></a>
<span class="sourceLineNo">343</span><a name="line.343"></a>
<span class="sourceLineNo">344</span> /**<a name="line.344"></a>
<span class="sourceLineNo">345</span> * Determines if a named Class can be loaded or not.<a name="line.345"></a>
<span class="sourceLineNo">346</span> *<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @param className The class name.<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @return {@code true} if the class could be found or {@code false} otherwise.<a name="line.348"></a>
<span class="sourceLineNo">349</span> */<a name="line.349"></a>
<span class="sourceLineNo">350</span> public static boolean isClassAvailable(final String className) {<a name="line.350"></a>
<span class="sourceLineNo">351</span> final ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();<a name="line.351"></a>
<span class="sourceLineNo">352</span> try {<a name="line.352"></a>
<span class="sourceLineNo">353</span> Thread.currentThread().setContextClassLoader(getClassLoader());<a name="line.353"></a>
<span class="sourceLineNo">354</span> return LoaderUtil.isClassAvailable(className);<a name="line.354"></a>
<span class="sourceLineNo">355</span> } finally {<a name="line.355"></a>
<span class="sourceLineNo">356</span> Thread.currentThread().setContextClassLoader(contextClassLoader);<a name="line.356"></a>
<span class="sourceLineNo">357</span> }<a name="line.357"></a>
<span class="sourceLineNo">358</span> }<a name="line.358"></a>
<span class="sourceLineNo">359</span><a name="line.359"></a>
<span class="sourceLineNo">360</span> public static boolean isJansiAvailable() {<a name="line.360"></a>
<span class="sourceLineNo">361</span> return isClassAvailable("org.fusesource.jansi.AnsiRenderer");<a name="line.361"></a>
<span class="sourceLineNo">362</span> }<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> /**<a name="line.364"></a>
<span class="sourceLineNo">365</span> * Loads a class by name. This method respects the {@link #IGNORE_TCCL_PROPERTY} Log4j property. If this property is<a name="line.365"></a>
<span class="sourceLineNo">366</span> * specified and set to anything besides {@code false}, then the default ClassLoader will be used.<a name="line.366"></a>
<span class="sourceLineNo">367</span> *<a name="line.367"></a>
<span class="sourceLineNo">368</span> * @param className The class name.<a name="line.368"></a>
<span class="sourceLineNo">369</span> * @return the Class for the given name.<a name="line.369"></a>
<span class="sourceLineNo">370</span> * @throws ClassNotFoundException if the specified class name could not be found<a name="line.370"></a>
<span class="sourceLineNo">371</span> */<a name="line.371"></a>
<span class="sourceLineNo">372</span> public static Class&lt;?&gt; loadClass(final String className) throws ClassNotFoundException {<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span> final ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();<a name="line.374"></a>
<span class="sourceLineNo">375</span> try {<a name="line.375"></a>
<span class="sourceLineNo">376</span> Thread.currentThread().setContextClassLoader(getClassLoader());<a name="line.376"></a>
<span class="sourceLineNo">377</span> return LoaderUtil.loadClass(className);<a name="line.377"></a>
<span class="sourceLineNo">378</span> } finally {<a name="line.378"></a>
<span class="sourceLineNo">379</span> Thread.currentThread().setContextClassLoader(contextClassLoader);<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span> }<a name="line.381"></a>
<span class="sourceLineNo">382</span>}<a name="line.382"></a>
</pre>
</div>
</body>
</html>