blob: e3958cb9ee74b9ec7a7206c951e3ad510d8290c6 [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<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.util;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.slf4j.Logger;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.slf4j.LoggerFactory;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.InputStream;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.lang.reflect.Constructor;<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> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * Utility method library used to conveniently interact with &lt;code&gt;Class&lt;/code&gt;es, such as acquiring them from the<a name="line.29"></a>
<FONT color="green">030</FONT> * application &lt;code&gt;ClassLoader&lt;/code&gt;s and instantiating Objects from them.<a name="line.30"></a>
<FONT color="green">031</FONT> *<a name="line.31"></a>
<FONT color="green">032</FONT> * @since 0.1<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public class ClassUtils {<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> //TODO - complete JavaDoc<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /**<a name="line.38"></a>
<FONT color="green">039</FONT> * Private internal log instance.<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> private static final Logger log = LoggerFactory.getLogger(ClassUtils.class);<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * @since 1.0<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> private static final ClassLoaderAccessor THREAD_CL_ACCESSOR = new ExceptionIgnoringAccessor() {<a name="line.46"></a>
<FONT color="green">047</FONT> @Override<a name="line.47"></a>
<FONT color="green">048</FONT> protected ClassLoader doGetClassLoader() throws Throwable {<a name="line.48"></a>
<FONT color="green">049</FONT> return Thread.currentThread().getContextClassLoader();<a name="line.49"></a>
<FONT color="green">050</FONT> }<a name="line.50"></a>
<FONT color="green">051</FONT> };<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /**<a name="line.53"></a>
<FONT color="green">054</FONT> * @since 1.0<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> private static final ClassLoaderAccessor CLASS_CL_ACCESSOR = new ExceptionIgnoringAccessor() {<a name="line.56"></a>
<FONT color="green">057</FONT> @Override<a name="line.57"></a>
<FONT color="green">058</FONT> protected ClassLoader doGetClassLoader() throws Throwable {<a name="line.58"></a>
<FONT color="green">059</FONT> return ClassUtils.class.getClassLoader();<a name="line.59"></a>
<FONT color="green">060</FONT> }<a name="line.60"></a>
<FONT color="green">061</FONT> };<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> * @since 1.0<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> private static final ClassLoaderAccessor SYSTEM_CL_ACCESSOR = new ExceptionIgnoringAccessor() {<a name="line.66"></a>
<FONT color="green">067</FONT> @Override<a name="line.67"></a>
<FONT color="green">068</FONT> protected ClassLoader doGetClassLoader() throws Throwable {<a name="line.68"></a>
<FONT color="green">069</FONT> return ClassLoader.getSystemClassLoader();<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> };<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> * Returns the specified resource by checking the current thread's<a name="line.74"></a>
<FONT color="green">075</FONT> * {@link Thread#getContextClassLoader() context class loader}, then the<a name="line.75"></a>
<FONT color="green">076</FONT> * current ClassLoader (&lt;code&gt;ClassUtils.class.getClassLoader()&lt;/code&gt;), then the system/application<a name="line.76"></a>
<FONT color="green">077</FONT> * ClassLoader (&lt;code&gt;ClassLoader.getSystemClassLoader()&lt;/code&gt;, in that order, using<a name="line.77"></a>
<FONT color="green">078</FONT> * {@link ClassLoader#getResourceAsStream(String) getResourceAsStream(name)}.<a name="line.78"></a>
<FONT color="green">079</FONT> *<a name="line.79"></a>
<FONT color="green">080</FONT> * @param name the name of the resource to acquire from the classloader(s).<a name="line.80"></a>
<FONT color="green">081</FONT> * @return the InputStream of the resource found, or &lt;code&gt;null&lt;/code&gt; if the resource cannot be found from any<a name="line.81"></a>
<FONT color="green">082</FONT> * of the three mentioned ClassLoaders.<a name="line.82"></a>
<FONT color="green">083</FONT> * @since 0.9<a name="line.83"></a>
<FONT color="green">084</FONT> */<a name="line.84"></a>
<FONT color="green">085</FONT> public static InputStream getResourceAsStream(String name) {<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> InputStream is = THREAD_CL_ACCESSOR.getResourceStream(name);<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> if (is == null) {<a name="line.89"></a>
<FONT color="green">090</FONT> if (log.isTraceEnabled()) {<a name="line.90"></a>
<FONT color="green">091</FONT> log.trace("Resource [" + name + "] was not found via the thread context ClassLoader. Trying the " +<a name="line.91"></a>
<FONT color="green">092</FONT> "current ClassLoader...");<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> is = CLASS_CL_ACCESSOR.getResourceStream(name);<a name="line.94"></a>
<FONT color="green">095</FONT> }<a name="line.95"></a>
<FONT color="green">096</FONT> <a name="line.96"></a>
<FONT color="green">097</FONT> if (is == null) {<a name="line.97"></a>
<FONT color="green">098</FONT> if (log.isTraceEnabled()) {<a name="line.98"></a>
<FONT color="green">099</FONT> log.trace("Resource [" + name + "] was not found via the current class loader. Trying the " +<a name="line.99"></a>
<FONT color="green">100</FONT> "system/application ClassLoader...");<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> is = SYSTEM_CL_ACCESSOR.getResourceStream(name);<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> if (is == null &amp;&amp; log.isTraceEnabled()) {<a name="line.105"></a>
<FONT color="green">106</FONT> log.trace("Resource [" + name + "] was not found via the thread context, current, or " +<a name="line.106"></a>
<FONT color="green">107</FONT> "system/application ClassLoaders. All heuristics have been exhausted. Returning null.");<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> return is;<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> /**<a name="line.113"></a>
<FONT color="green">114</FONT> * Attempts to load the specified class name from the current thread's<a name="line.114"></a>
<FONT color="green">115</FONT> * {@link Thread#getContextClassLoader() context class loader}, then the<a name="line.115"></a>
<FONT color="green">116</FONT> * current ClassLoader (&lt;code&gt;ClassUtils.class.getClassLoader()&lt;/code&gt;), then the system/application<a name="line.116"></a>
<FONT color="green">117</FONT> * ClassLoader (&lt;code&gt;ClassLoader.getSystemClassLoader()&lt;/code&gt;, in that order. If any of them cannot locate<a name="line.117"></a>
<FONT color="green">118</FONT> * the specified class, an &lt;code&gt;UnknownClassException&lt;/code&gt; is thrown (our RuntimeException equivalent of<a name="line.118"></a>
<FONT color="green">119</FONT> * the JRE's &lt;code&gt;ClassNotFoundException&lt;/code&gt;.<a name="line.119"></a>
<FONT color="green">120</FONT> *<a name="line.120"></a>
<FONT color="green">121</FONT> * @param fqcn the fully qualified class name to load<a name="line.121"></a>
<FONT color="green">122</FONT> * @return the located class<a name="line.122"></a>
<FONT color="green">123</FONT> * @throws UnknownClassException if the class cannot be found.<a name="line.123"></a>
<FONT color="green">124</FONT> */<a name="line.124"></a>
<FONT color="green">125</FONT> public static Class forName(String fqcn) throws UnknownClassException {<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> Class clazz = THREAD_CL_ACCESSOR.loadClass(fqcn);<a name="line.127"></a>
<FONT color="green">128</FONT> <a name="line.128"></a>
<FONT color="green">129</FONT> if (clazz == null) {<a name="line.129"></a>
<FONT color="green">130</FONT> if (log.isTraceEnabled()) {<a name="line.130"></a>
<FONT color="green">131</FONT> log.trace("Unable to load class named [" + fqcn +<a name="line.131"></a>
<FONT color="green">132</FONT> "] from the thread context ClassLoader. Trying the current ClassLoader...");<a name="line.132"></a>
<FONT color="green">133</FONT> }<a name="line.133"></a>
<FONT color="green">134</FONT> clazz = CLASS_CL_ACCESSOR.loadClass(fqcn);<a name="line.134"></a>
<FONT color="green">135</FONT> }<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> if (clazz == null) {<a name="line.137"></a>
<FONT color="green">138</FONT> if (log.isTraceEnabled()) {<a name="line.138"></a>
<FONT color="green">139</FONT> log.trace("Unable to load class named [" + fqcn + "] from the current ClassLoader. " +<a name="line.139"></a>
<FONT color="green">140</FONT> "Trying the system/application ClassLoader...");<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> clazz = SYSTEM_CL_ACCESSOR.loadClass(fqcn);<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> <a name="line.144"></a>
<FONT color="green">145</FONT> if (clazz == null) {<a name="line.145"></a>
<FONT color="green">146</FONT> String msg = "Unable to load class named [" + fqcn + "] from the thread context, current, or " +<a name="line.146"></a>
<FONT color="green">147</FONT> "system/application ClassLoaders. All heuristics have been exhausted. Class could not be found.";<a name="line.147"></a>
<FONT color="green">148</FONT> throw new UnknownClassException(msg);<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> return clazz;<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> public static boolean isAvailable(String fullyQualifiedClassName) {<a name="line.154"></a>
<FONT color="green">155</FONT> try {<a name="line.155"></a>
<FONT color="green">156</FONT> forName(fullyQualifiedClassName);<a name="line.156"></a>
<FONT color="green">157</FONT> return true;<a name="line.157"></a>
<FONT color="green">158</FONT> } catch (UnknownClassException e) {<a name="line.158"></a>
<FONT color="green">159</FONT> return false;<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> <a name="line.162"></a>
<FONT color="green">163</FONT> public static Object newInstance(String fqcn) {<a name="line.163"></a>
<FONT color="green">164</FONT> return newInstance(forName(fqcn));<a name="line.164"></a>
<FONT color="green">165</FONT> }<a name="line.165"></a>
<FONT color="green">166</FONT> <a name="line.166"></a>
<FONT color="green">167</FONT> public static Object newInstance(String fqcn, Object... args) {<a name="line.167"></a>
<FONT color="green">168</FONT> return newInstance(forName(fqcn), args);<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 static Object newInstance(Class clazz) {<a name="line.171"></a>
<FONT color="green">172</FONT> if (clazz == null) {<a name="line.172"></a>
<FONT color="green">173</FONT> String msg = "Class method parameter cannot be null.";<a name="line.173"></a>
<FONT color="green">174</FONT> throw new IllegalArgumentException(msg);<a name="line.174"></a>
<FONT color="green">175</FONT> }<a name="line.175"></a>
<FONT color="green">176</FONT> try {<a name="line.176"></a>
<FONT color="green">177</FONT> return clazz.newInstance();<a name="line.177"></a>
<FONT color="green">178</FONT> } catch (Exception e) {<a name="line.178"></a>
<FONT color="green">179</FONT> throw new InstantiationException("Unable to instantiate class [" + clazz.getName() + "]", e);<a name="line.179"></a>
<FONT color="green">180</FONT> }<a name="line.180"></a>
<FONT color="green">181</FONT> }<a name="line.181"></a>
<FONT color="green">182</FONT> <a name="line.182"></a>
<FONT color="green">183</FONT> public static Object newInstance(Class clazz, Object... args) {<a name="line.183"></a>
<FONT color="green">184</FONT> Class[] argTypes = new Class[args.length];<a name="line.184"></a>
<FONT color="green">185</FONT> for (int i = 0; i &lt; args.length; i++) {<a name="line.185"></a>
<FONT color="green">186</FONT> argTypes[i] = args[i].getClass();<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> Constructor ctor = getConstructor(clazz, argTypes);<a name="line.188"></a>
<FONT color="green">189</FONT> return instantiate(ctor, args);<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> public static Constructor getConstructor(Class clazz, Class... argTypes) {<a name="line.192"></a>
<FONT color="green">193</FONT> try {<a name="line.193"></a>
<FONT color="green">194</FONT> return clazz.getConstructor(argTypes);<a name="line.194"></a>
<FONT color="green">195</FONT> } catch (NoSuchMethodException e) {<a name="line.195"></a>
<FONT color="green">196</FONT> throw new IllegalStateException(e);<a name="line.196"></a>
<FONT color="green">197</FONT> }<a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> <a name="line.200"></a>
<FONT color="green">201</FONT> public static Object instantiate(Constructor ctor, Object... args) {<a name="line.201"></a>
<FONT color="green">202</FONT> try {<a name="line.202"></a>
<FONT color="green">203</FONT> return ctor.newInstance(args);<a name="line.203"></a>
<FONT color="green">204</FONT> } catch (Exception e) {<a name="line.204"></a>
<FONT color="green">205</FONT> String msg = "Unable to instantiate Permission instance with constructor [" + ctor + "]";<a name="line.205"></a>
<FONT color="green">206</FONT> throw new InstantiationException(msg, e);<a name="line.206"></a>
<FONT color="green">207</FONT> }<a name="line.207"></a>
<FONT color="green">208</FONT> }<a name="line.208"></a>
<FONT color="green">209</FONT> <a name="line.209"></a>
<FONT color="green">210</FONT> /**<a name="line.210"></a>
<FONT color="green">211</FONT> * @since 1.0<a name="line.211"></a>
<FONT color="green">212</FONT> */<a name="line.212"></a>
<FONT color="green">213</FONT> private static interface ClassLoaderAccessor {<a name="line.213"></a>
<FONT color="green">214</FONT> Class loadClass(String fqcn);<a name="line.214"></a>
<FONT color="green">215</FONT> InputStream getResourceStream(String name);<a name="line.215"></a>
<FONT color="green">216</FONT> }<a name="line.216"></a>
<FONT color="green">217</FONT> <a name="line.217"></a>
<FONT color="green">218</FONT> /**<a name="line.218"></a>
<FONT color="green">219</FONT> * @since 1.0<a name="line.219"></a>
<FONT color="green">220</FONT> */<a name="line.220"></a>
<FONT color="green">221</FONT> private static abstract class ExceptionIgnoringAccessor implements ClassLoaderAccessor {<a name="line.221"></a>
<FONT color="green">222</FONT> <a name="line.222"></a>
<FONT color="green">223</FONT> public Class loadClass(String fqcn) {<a name="line.223"></a>
<FONT color="green">224</FONT> Class clazz = null;<a name="line.224"></a>
<FONT color="green">225</FONT> ClassLoader cl = getClassLoader();<a name="line.225"></a>
<FONT color="green">226</FONT> if (cl != null) {<a name="line.226"></a>
<FONT color="green">227</FONT> try {<a name="line.227"></a>
<FONT color="green">228</FONT> clazz = cl.loadClass(fqcn);<a name="line.228"></a>
<FONT color="green">229</FONT> } catch (ClassNotFoundException e) {<a name="line.229"></a>
<FONT color="green">230</FONT> if (log.isTraceEnabled()) {<a name="line.230"></a>
<FONT color="green">231</FONT> log.trace("Unable to load clazz named [" + fqcn + "] from class loader [" + cl + "]");<a name="line.231"></a>
<FONT color="green">232</FONT> }<a name="line.232"></a>
<FONT color="green">233</FONT> }<a name="line.233"></a>
<FONT color="green">234</FONT> }<a name="line.234"></a>
<FONT color="green">235</FONT> return clazz;<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> <a name="line.237"></a>
<FONT color="green">238</FONT> public InputStream getResourceStream(String name) {<a name="line.238"></a>
<FONT color="green">239</FONT> InputStream is = null;<a name="line.239"></a>
<FONT color="green">240</FONT> ClassLoader cl = getClassLoader();<a name="line.240"></a>
<FONT color="green">241</FONT> if (cl != null) {<a name="line.241"></a>
<FONT color="green">242</FONT> is = cl.getResourceAsStream(name);<a name="line.242"></a>
<FONT color="green">243</FONT> }<a name="line.243"></a>
<FONT color="green">244</FONT> return is;<a name="line.244"></a>
<FONT color="green">245</FONT> }<a name="line.245"></a>
<FONT color="green">246</FONT> <a name="line.246"></a>
<FONT color="green">247</FONT> protected final ClassLoader getClassLoader() {<a name="line.247"></a>
<FONT color="green">248</FONT> try {<a name="line.248"></a>
<FONT color="green">249</FONT> return doGetClassLoader();<a name="line.249"></a>
<FONT color="green">250</FONT> } catch (Throwable t) {<a name="line.250"></a>
<FONT color="green">251</FONT> if (log.isDebugEnabled()) {<a name="line.251"></a>
<FONT color="green">252</FONT> log.debug("Unable to acquire ClassLoader.", t);<a name="line.252"></a>
<FONT color="green">253</FONT> }<a name="line.253"></a>
<FONT color="green">254</FONT> }<a name="line.254"></a>
<FONT color="green">255</FONT> return null;<a name="line.255"></a>
<FONT color="green">256</FONT> }<a name="line.256"></a>
<FONT color="green">257</FONT> <a name="line.257"></a>
<FONT color="green">258</FONT> protected abstract ClassLoader doGetClassLoader() throws Throwable;<a name="line.258"></a>
<FONT color="green">259</FONT> }<a name="line.259"></a>
<FONT color="green">260</FONT> }<a name="line.260"></a>
</PRE>
</BODY>
</HTML>