blob: c38027c26b4884d48e82446c3017c0ff74467e6c [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.config.plugins.util;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.FileInputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.InputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.UnsupportedEncodingException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.JarURLConnection;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.URI;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.net.URISyntaxException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.net.URL;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.net.URLDecoder;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.nio.charset.StandardCharsets;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Arrays;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.Collection;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.Enumeration;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.HashSet;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.List;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.Set;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import java.util.jar.JarEntry;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import java.util.jar.JarFile;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.util.jar.JarInputStream;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.logging.log4j.Logger;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.osgi.framework.FrameworkUtil;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.osgi.framework.wiring.BundleWiring;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>/**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * ResolverUtil is used to locate classes that are available in the/a class path and meet arbitrary conditions. The two<a name="line.48"></a>
<span class="sourceLineNo">049</span> * most common conditions are that a class implements/extends another class, or that is it annotated with a specific<a name="line.49"></a>
<span class="sourceLineNo">050</span> * annotation. However, through the use of the {@link Test} class it is possible to search using arbitrary conditions.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;/p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> *<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * A ClassLoader is used to locate all locations (directories and jar files) in the class path that contain classes<a name="line.54"></a>
<span class="sourceLineNo">055</span> * within certain packages, and then to load those classes and check them. By default the ClassLoader returned by<a name="line.55"></a>
<span class="sourceLineNo">056</span> * {@code Thread.currentThread().getContextClassLoader()} is used, but this can be overridden by calling<a name="line.56"></a>
<span class="sourceLineNo">057</span> * {@link #setClassLoader(ClassLoader)} prior to invoking any of the {@code find()} methods.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;/p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> *<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * General searches are initiated by calling the {@link #find(ResolverUtil.Test, String...)} method and supplying a<a name="line.61"></a>
<span class="sourceLineNo">062</span> * package name and a Test instance. This will cause the named package &lt;b&gt;and all sub-packages&lt;/b&gt; to be scanned for<a name="line.62"></a>
<span class="sourceLineNo">063</span> * classes that meet the test. There are also utility methods for the common use cases of scanning multiple packages for<a name="line.63"></a>
<span class="sourceLineNo">064</span> * extensions of particular classes, or classes annotated with a specific annotation.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;/p&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> *<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;p&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * The standard usage pattern for the ResolverUtil class is as follows:<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;/p&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;pre&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * ResolverUtil resolver = new ResolverUtil();<a name="line.72"></a>
<span class="sourceLineNo">073</span> * resolver.findInPackage(new CustomTest(), pkg1);<a name="line.73"></a>
<span class="sourceLineNo">074</span> * resolver.find(new CustomTest(), pkg1);<a name="line.74"></a>
<span class="sourceLineNo">075</span> * resolver.find(new CustomTest(), pkg1, pkg2);<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Set&amp;lt;Class&amp;lt;?&amp;gt;&amp;gt; beans = resolver.getClasses();<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;/pre&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;p&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * This class was copied and modified from Stripes - http://stripes.mc4j.org/confluence/display/stripes/Home<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;/p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span>public class ResolverUtil {<a name="line.83"></a>
<span class="sourceLineNo">084</span> /** An instance of Log to use for logging in this class. */<a name="line.84"></a>
<span class="sourceLineNo">085</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> private static final String VFSZIP = "vfszip";<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> private static final String VFS = "vfs";<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> private static final String JAR = "jar";<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> private static final String BUNDLE_RESOURCE = "bundleresource";<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /** The set of matches being accumulated. */<a name="line.95"></a>
<span class="sourceLineNo">096</span> private final Set&lt;Class&lt;?&gt;&gt; classMatches = new HashSet&lt;&gt;();<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /** The set of matches being accumulated. */<a name="line.98"></a>
<span class="sourceLineNo">099</span> private final Set&lt;URI&gt; resourceMatches = new HashSet&lt;&gt;();<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> * The ClassLoader to use when looking for classes. If null then the ClassLoader returned by<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Thread.currentThread().getContextClassLoader() will be used.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> private ClassLoader classloader;<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> /**<a name="line.107"></a>
<span class="sourceLineNo">108</span> * Provides access to the classes discovered so far. If no calls have been made to any of the {@code find()}<a name="line.108"></a>
<span class="sourceLineNo">109</span> * methods, this set will be empty.<a name="line.109"></a>
<span class="sourceLineNo">110</span> *<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @return the set of classes that have been discovered.<a name="line.111"></a>
<span class="sourceLineNo">112</span> */<a name="line.112"></a>
<span class="sourceLineNo">113</span> public Set&lt;Class&lt;?&gt;&gt; getClasses() {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return classMatches;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> /**<a name="line.117"></a>
<span class="sourceLineNo">118</span> * Returns the matching resources.<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @return A Set of URIs that match the criteria.<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> public Set&lt;URI&gt; getResources() {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return resourceMatches;<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> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Returns the ClassLoader that will be used for scanning for classes. If no explicit ClassLoader has been set by<a name="line.127"></a>
<span class="sourceLineNo">128</span> * the calling, the context class loader will be used.<a name="line.128"></a>
<span class="sourceLineNo">129</span> *<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @return the ClassLoader that will be used to scan for classes<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> public ClassLoader getClassLoader() {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return classloader != null ? classloader : (classloader = Loader.getClassLoader(ResolverUtil.class, null));<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Sets an explicit ClassLoader that should be used when scanning for classes. If none is set then the context<a name="line.137"></a>
<span class="sourceLineNo">138</span> * ClassLoader will be used.<a name="line.138"></a>
<span class="sourceLineNo">139</span> *<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @param aClassloader<a name="line.140"></a>
<span class="sourceLineNo">141</span> * a ClassLoader to use when scanning for classes<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> public void setClassLoader(final ClassLoader aClassloader) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> this.classloader = aClassloader;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
<span class="sourceLineNo">148</span> * Attempts to discover classes that pass the test. Accumulated classes can be accessed by calling<a name="line.148"></a>
<span class="sourceLineNo">149</span> * {@link #getClasses()}.<a name="line.149"></a>
<span class="sourceLineNo">150</span> *<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @param test<a name="line.151"></a>
<span class="sourceLineNo">152</span> * the test to determine matching classes<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @param packageNames<a name="line.153"></a>
<span class="sourceLineNo">154</span> * one or more package names to scan (including subpackages) for classes<a name="line.154"></a>
<span class="sourceLineNo">155</span> */<a name="line.155"></a>
<span class="sourceLineNo">156</span> public void find(final Test test, final String... packageNames) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> if (packageNames == null) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> return;<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> for (final String pkg : packageNames) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> findInPackage(test, pkg);<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><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * Scans for classes starting at the package provided and descending into subpackages. Each class is offered up to<a name="line.167"></a>
<span class="sourceLineNo">168</span> * the Test as it is discovered, and if the Test returns true the class is retained. Accumulated classes can be<a name="line.168"></a>
<span class="sourceLineNo">169</span> * fetched by calling {@link #getClasses()}.<a name="line.169"></a>
<span class="sourceLineNo">170</span> *<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param test<a name="line.171"></a>
<span class="sourceLineNo">172</span> * an instance of {@link Test} that will be used to filter classes<a name="line.172"></a>
<span class="sourceLineNo">173</span> * @param packageName<a name="line.173"></a>
<span class="sourceLineNo">174</span> * the name of the package from which to start scanning for classes, e.g. {@code net.sourceforge.stripes}<a name="line.174"></a>
<span class="sourceLineNo">175</span> */<a name="line.175"></a>
<span class="sourceLineNo">176</span> public void findInPackage(final Test test, String packageName) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> packageName = packageName.replace('.', '/');<a name="line.177"></a>
<span class="sourceLineNo">178</span> final ClassLoader loader = getClassLoader();<a name="line.178"></a>
<span class="sourceLineNo">179</span> Enumeration&lt;URL&gt; urls;<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> try {<a name="line.181"></a>
<span class="sourceLineNo">182</span> urls = loader.getResources(packageName);<a name="line.182"></a>
<span class="sourceLineNo">183</span> } catch (final IOException ioe) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> LOGGER.warn("Could not read package: {}", packageName, ioe);<a name="line.184"></a>
<span class="sourceLineNo">185</span> return;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> while (urls.hasMoreElements()) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> try {<a name="line.189"></a>
<span class="sourceLineNo">190</span> final URL url = urls.nextElement();<a name="line.190"></a>
<span class="sourceLineNo">191</span> final String urlPath = extractPath(url);<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span> LOGGER.info("Scanning for classes in '{}' matching criteria {}", urlPath , test);<a name="line.193"></a>
<span class="sourceLineNo">194</span> // Check for a jar in a war in JBoss<a name="line.194"></a>
<span class="sourceLineNo">195</span> if (VFSZIP.equals(url.getProtocol())) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> final String path = urlPath.substring(0, urlPath.length() - packageName.length() - 2);<a name="line.196"></a>
<span class="sourceLineNo">197</span> final URL newURL = new URL(url.getProtocol(), url.getHost(), path);<a name="line.197"></a>
<span class="sourceLineNo">198</span> @SuppressWarnings("resource")<a name="line.198"></a>
<span class="sourceLineNo">199</span> final JarInputStream stream = new JarInputStream(newURL.openStream());<a name="line.199"></a>
<span class="sourceLineNo">200</span> try {<a name="line.200"></a>
<span class="sourceLineNo">201</span> loadImplementationsInJar(test, packageName, path, stream);<a name="line.201"></a>
<span class="sourceLineNo">202</span> } finally {<a name="line.202"></a>
<span class="sourceLineNo">203</span> close(stream, newURL);<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> } else if (VFS.equals(url.getProtocol())) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> final String containerPath = urlPath.substring(1, urlPath.length() - packageName.length() - 2);<a name="line.206"></a>
<span class="sourceLineNo">207</span> final File containerFile = new File(containerPath);<a name="line.207"></a>
<span class="sourceLineNo">208</span> if (containerFile.exists()) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> if (containerFile.isDirectory()) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> loadImplementationsInDirectory(test, packageName, new File(containerFile, packageName));<a name="line.210"></a>
<span class="sourceLineNo">211</span> } else {<a name="line.211"></a>
<span class="sourceLineNo">212</span> loadImplementationsInJar(test, packageName, containerFile);<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> } else {<a name="line.214"></a>
<span class="sourceLineNo">215</span> // fallback code for Jboss/Wildfly, if the file couldn't be found<a name="line.215"></a>
<span class="sourceLineNo">216</span> // by loading the path as a file, try to read the jar as a stream<a name="line.216"></a>
<span class="sourceLineNo">217</span> final String path = urlPath.substring(0, urlPath.length() - packageName.length() - 2);<a name="line.217"></a>
<span class="sourceLineNo">218</span> final URL newURL = new URL(url.getProtocol(), url.getHost(), path);<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> try (final InputStream is = newURL.openStream()) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> final JarInputStream jarStream;<a name="line.221"></a>
<span class="sourceLineNo">222</span> if (is instanceof JarInputStream) {<a name="line.222"></a>
<span class="sourceLineNo">223</span> jarStream = (JarInputStream) is;<a name="line.223"></a>
<span class="sourceLineNo">224</span> } else {<a name="line.224"></a>
<span class="sourceLineNo">225</span> jarStream = new JarInputStream(is);<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span> loadImplementationsInJar(test, packageName, path, jarStream);<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span> } else if (BUNDLE_RESOURCE.equals(url.getProtocol())) {<a name="line.230"></a>
<span class="sourceLineNo">231</span> loadImplementationsInBundle(test, packageName);<a name="line.231"></a>
<span class="sourceLineNo">232</span> } else if (JAR.equals(url.getProtocol())) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> loadImplementationsInJar(test, packageName, url);<a name="line.233"></a>
<span class="sourceLineNo">234</span> } else {<a name="line.234"></a>
<span class="sourceLineNo">235</span> final File file = new File(urlPath);<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (file.isDirectory()) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> loadImplementationsInDirectory(test, packageName, file);<a name="line.237"></a>
<span class="sourceLineNo">238</span> } else {<a name="line.238"></a>
<span class="sourceLineNo">239</span> loadImplementationsInJar(test, packageName, file);<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span> } catch (final IOException | URISyntaxException ioe) {<a name="line.242"></a>
<span class="sourceLineNo">243</span> LOGGER.warn("Could not read entries", ioe);<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span> }<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> String extractPath(final URL url) throws UnsupportedEncodingException, URISyntaxException {<a name="line.248"></a>
<span class="sourceLineNo">249</span> String urlPath = url.getPath(); // same as getFile but without the Query portion<a name="line.249"></a>
<span class="sourceLineNo">250</span> // System.out.println(url.getProtocol() + "-&gt;" + urlPath);<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span> // I would be surprised if URL.getPath() ever starts with "jar:" but no harm in checking<a name="line.252"></a>
<span class="sourceLineNo">253</span> if (urlPath.startsWith("jar:")) {<a name="line.253"></a>
<span class="sourceLineNo">254</span> urlPath = urlPath.substring(4);<a name="line.254"></a>
<span class="sourceLineNo">255</span> }<a name="line.255"></a>
<span class="sourceLineNo">256</span> // For jar: URLs, the path part starts with "file:"<a name="line.256"></a>
<span class="sourceLineNo">257</span> if (urlPath.startsWith("file:")) {<a name="line.257"></a>
<span class="sourceLineNo">258</span> urlPath = urlPath.substring(5);<a name="line.258"></a>
<span class="sourceLineNo">259</span> }<a name="line.259"></a>
<span class="sourceLineNo">260</span> // If it was in a JAR, grab the path to the jar<a name="line.260"></a>
<span class="sourceLineNo">261</span> final int bangIndex = urlPath.indexOf('!');<a name="line.261"></a>
<span class="sourceLineNo">262</span> if (bangIndex &gt; 0) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> urlPath = urlPath.substring(0, bangIndex);<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span><a name="line.265"></a>
<span class="sourceLineNo">266</span> // LOG4J2-445<a name="line.266"></a>
<span class="sourceLineNo">267</span> // Finally, decide whether to URL-decode the file name or not...<a name="line.267"></a>
<span class="sourceLineNo">268</span> final String protocol = url.getProtocol();<a name="line.268"></a>
<span class="sourceLineNo">269</span> final List&lt;String&gt; neverDecode = Arrays.asList(VFS, VFSZIP, BUNDLE_RESOURCE);<a name="line.269"></a>
<span class="sourceLineNo">270</span> if (neverDecode.contains(protocol)) {<a name="line.270"></a>
<span class="sourceLineNo">271</span> return urlPath;<a name="line.271"></a>
<span class="sourceLineNo">272</span> }<a name="line.272"></a>
<span class="sourceLineNo">273</span> final String cleanPath = new URI(urlPath).getPath();<a name="line.273"></a>
<span class="sourceLineNo">274</span> if (new File(cleanPath).exists()) {<a name="line.274"></a>
<span class="sourceLineNo">275</span> // if URL-encoded file exists, don't decode it<a name="line.275"></a>
<span class="sourceLineNo">276</span> return cleanPath;<a name="line.276"></a>
<span class="sourceLineNo">277</span> }<a name="line.277"></a>
<span class="sourceLineNo">278</span> return URLDecoder.decode(urlPath, StandardCharsets.UTF_8.name());<a name="line.278"></a>
<span class="sourceLineNo">279</span> }<a name="line.279"></a>
<span class="sourceLineNo">280</span><a name="line.280"></a>
<span class="sourceLineNo">281</span> private void loadImplementationsInBundle(final Test test, final String packageName) {<a name="line.281"></a>
<span class="sourceLineNo">282</span> final BundleWiring wiring = FrameworkUtil.getBundle(ResolverUtil.class).adapt(BundleWiring.class);<a name="line.282"></a>
<span class="sourceLineNo">283</span> final Collection&lt;String&gt; list = wiring.listResources(packageName, "*.class",<a name="line.283"></a>
<span class="sourceLineNo">284</span> BundleWiring.LISTRESOURCES_RECURSE);<a name="line.284"></a>
<span class="sourceLineNo">285</span> for (final String name : list) {<a name="line.285"></a>
<span class="sourceLineNo">286</span> addIfMatching(test, name);<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><a name="line.289"></a>
<span class="sourceLineNo">290</span> /**<a name="line.290"></a>
<span class="sourceLineNo">291</span> * Finds matches in a physical directory on a file system. Examines all files within a directory - if the File object<a name="line.291"></a>
<span class="sourceLineNo">292</span> * is not a directory, and ends with &lt;i&gt;.class&lt;/i&gt; the file is loaded and tested to see if it is acceptable<a name="line.292"></a>
<span class="sourceLineNo">293</span> * according to the Test. Operates recursively to find classes within a folder structure matching the package<a name="line.293"></a>
<span class="sourceLineNo">294</span> * structure.<a name="line.294"></a>
<span class="sourceLineNo">295</span> *<a name="line.295"></a>
<span class="sourceLineNo">296</span> * @param test<a name="line.296"></a>
<span class="sourceLineNo">297</span> * a Test used to filter the classes that are discovered<a name="line.297"></a>
<span class="sourceLineNo">298</span> * @param parent<a name="line.298"></a>
<span class="sourceLineNo">299</span> * the package name up to this directory in the package hierarchy. E.g. if /classes is in the classpath and<a name="line.299"></a>
<span class="sourceLineNo">300</span> * we wish to examine files in /classes/org/apache then the values of &lt;i&gt;parent&lt;/i&gt; would be<a name="line.300"></a>
<span class="sourceLineNo">301</span> * &lt;i&gt;org/apache&lt;/i&gt;<a name="line.301"></a>
<span class="sourceLineNo">302</span> * @param location<a name="line.302"></a>
<span class="sourceLineNo">303</span> * a File object representing a directory<a name="line.303"></a>
<span class="sourceLineNo">304</span> */<a name="line.304"></a>
<span class="sourceLineNo">305</span> private void loadImplementationsInDirectory(final Test test, final String parent, final File location) {<a name="line.305"></a>
<span class="sourceLineNo">306</span> final File[] files = location.listFiles();<a name="line.306"></a>
<span class="sourceLineNo">307</span> if (files == null) {<a name="line.307"></a>
<span class="sourceLineNo">308</span> return;<a name="line.308"></a>
<span class="sourceLineNo">309</span> }<a name="line.309"></a>
<span class="sourceLineNo">310</span><a name="line.310"></a>
<span class="sourceLineNo">311</span> StringBuilder builder;<a name="line.311"></a>
<span class="sourceLineNo">312</span> for (final File file : files) {<a name="line.312"></a>
<span class="sourceLineNo">313</span> builder = new StringBuilder();<a name="line.313"></a>
<span class="sourceLineNo">314</span> builder.append(parent).append('/').append(file.getName());<a name="line.314"></a>
<span class="sourceLineNo">315</span> final String packageOrClass = parent == null ? file.getName() : builder.toString();<a name="line.315"></a>
<span class="sourceLineNo">316</span><a name="line.316"></a>
<span class="sourceLineNo">317</span> if (file.isDirectory()) {<a name="line.317"></a>
<span class="sourceLineNo">318</span> loadImplementationsInDirectory(test, packageOrClass, file);<a name="line.318"></a>
<span class="sourceLineNo">319</span> } else if (isTestApplicable(test, file.getName())) {<a name="line.319"></a>
<span class="sourceLineNo">320</span> addIfMatching(test, packageOrClass);<a name="line.320"></a>
<span class="sourceLineNo">321</span> }<a name="line.321"></a>
<span class="sourceLineNo">322</span> }<a name="line.322"></a>
<span class="sourceLineNo">323</span> }<a name="line.323"></a>
<span class="sourceLineNo">324</span><a name="line.324"></a>
<span class="sourceLineNo">325</span> private boolean isTestApplicable(final Test test, final String path) {<a name="line.325"></a>
<span class="sourceLineNo">326</span> return test.doesMatchResource() || path.endsWith(".class") &amp;&amp; test.doesMatchClass();<a name="line.326"></a>
<span class="sourceLineNo">327</span> }<a name="line.327"></a>
<span class="sourceLineNo">328</span><a name="line.328"></a>
<span class="sourceLineNo">329</span> /**<a name="line.329"></a>
<span class="sourceLineNo">330</span> * Finds matching classes within a jar files that contains a folder structure matching the package structure. If the<a name="line.330"></a>
<span class="sourceLineNo">331</span> * File is not a JarFile or does not exist a warning will be logged, but no error will be raised.<a name="line.331"></a>
<span class="sourceLineNo">332</span> *<a name="line.332"></a>
<span class="sourceLineNo">333</span> * @param test<a name="line.333"></a>
<span class="sourceLineNo">334</span> * a Test used to filter the classes that are discovered<a name="line.334"></a>
<span class="sourceLineNo">335</span> * @param parent<a name="line.335"></a>
<span class="sourceLineNo">336</span> * the parent package under which classes must be in order to be considered<a name="line.336"></a>
<span class="sourceLineNo">337</span> * @param url<a name="line.337"></a>
<span class="sourceLineNo">338</span> * the url that identifies the jar containing the resource.<a name="line.338"></a>
<span class="sourceLineNo">339</span> */<a name="line.339"></a>
<span class="sourceLineNo">340</span> private void loadImplementationsInJar(final Test test, final String parent, final URL url) {<a name="line.340"></a>
<span class="sourceLineNo">341</span> JarURLConnection connection = null;<a name="line.341"></a>
<span class="sourceLineNo">342</span> try {<a name="line.342"></a>
<span class="sourceLineNo">343</span> connection = (JarURLConnection) url.openConnection();<a name="line.343"></a>
<span class="sourceLineNo">344</span> if (connection != null) {<a name="line.344"></a>
<span class="sourceLineNo">345</span> try (JarFile jarFile = connection.getJarFile()) {<a name="line.345"></a>
<span class="sourceLineNo">346</span> Enumeration&lt;JarEntry&gt; entries = jarFile.entries();<a name="line.346"></a>
<span class="sourceLineNo">347</span> while (entries.hasMoreElements()) {<a name="line.347"></a>
<span class="sourceLineNo">348</span> JarEntry entry = entries.nextElement();<a name="line.348"></a>
<span class="sourceLineNo">349</span> final String name = entry.getName();<a name="line.349"></a>
<span class="sourceLineNo">350</span> if (!entry.isDirectory() &amp;&amp; name.startsWith(parent) &amp;&amp; isTestApplicable(test, name)) {<a name="line.350"></a>
<span class="sourceLineNo">351</span> addIfMatching(test, name);<a name="line.351"></a>
<span class="sourceLineNo">352</span> }<a name="line.352"></a>
<span class="sourceLineNo">353</span> }<a name="line.353"></a>
<span class="sourceLineNo">354</span> }<a name="line.354"></a>
<span class="sourceLineNo">355</span> } else {<a name="line.355"></a>
<span class="sourceLineNo">356</span> LOGGER.error("Could not establish connection to {}", url.toString());<a name="line.356"></a>
<span class="sourceLineNo">357</span> }<a name="line.357"></a>
<span class="sourceLineNo">358</span> } catch (final IOException ex) {<a name="line.358"></a>
<span class="sourceLineNo">359</span> LOGGER.error("Could not search JAR file '{}' for classes matching criteria {}, file not found",<a name="line.359"></a>
<span class="sourceLineNo">360</span> url.toString(), test, ex);<a name="line.360"></a>
<span class="sourceLineNo">361</span> }<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> * Finds matching classes within a jar files that contains a folder structure matching the package structure. If the<a name="line.365"></a>
<span class="sourceLineNo">366</span> * File is not a JarFile or does not exist a warning will be logged, but no error will be raised.<a name="line.366"></a>
<span class="sourceLineNo">367</span> *<a name="line.367"></a>
<span class="sourceLineNo">368</span> * @param test<a name="line.368"></a>
<span class="sourceLineNo">369</span> * a Test used to filter the classes that are discovered<a name="line.369"></a>
<span class="sourceLineNo">370</span> * @param parent<a name="line.370"></a>
<span class="sourceLineNo">371</span> * the parent package under which classes must be in order to be considered<a name="line.371"></a>
<span class="sourceLineNo">372</span> * @param jarFile<a name="line.372"></a>
<span class="sourceLineNo">373</span> * the jar file to be examined for classes<a name="line.373"></a>
<span class="sourceLineNo">374</span> */<a name="line.374"></a>
<span class="sourceLineNo">375</span> private void loadImplementationsInJar(final Test test, final String parent, final File jarFile) {<a name="line.375"></a>
<span class="sourceLineNo">376</span> JarInputStream jarStream = null;<a name="line.376"></a>
<span class="sourceLineNo">377</span> try {<a name="line.377"></a>
<span class="sourceLineNo">378</span> jarStream = new JarInputStream(new FileInputStream(jarFile));<a name="line.378"></a>
<span class="sourceLineNo">379</span> loadImplementationsInJar(test, parent, jarFile.getPath(), jarStream);<a name="line.379"></a>
<span class="sourceLineNo">380</span> } catch (final IOException ex) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> LOGGER.error("Could not search JAR file '{}' for classes matching criteria {}, file not found", jarFile,<a name="line.381"></a>
<span class="sourceLineNo">382</span> test, ex);<a name="line.382"></a>
<span class="sourceLineNo">383</span> } finally {<a name="line.383"></a>
<span class="sourceLineNo">384</span> close(jarStream, jarFile);<a name="line.384"></a>
<span class="sourceLineNo">385</span> }<a name="line.385"></a>
<span class="sourceLineNo">386</span> }<a name="line.386"></a>
<span class="sourceLineNo">387</span><a name="line.387"></a>
<span class="sourceLineNo">388</span> /**<a name="line.388"></a>
<span class="sourceLineNo">389</span> * @param jarStream<a name="line.389"></a>
<span class="sourceLineNo">390</span> * @param source<a name="line.390"></a>
<span class="sourceLineNo">391</span> */<a name="line.391"></a>
<span class="sourceLineNo">392</span> private void close(final JarInputStream jarStream, final Object source) {<a name="line.392"></a>
<span class="sourceLineNo">393</span> if (jarStream != null) {<a name="line.393"></a>
<span class="sourceLineNo">394</span> try {<a name="line.394"></a>
<span class="sourceLineNo">395</span> jarStream.close();<a name="line.395"></a>
<span class="sourceLineNo">396</span> } catch (final IOException e) {<a name="line.396"></a>
<span class="sourceLineNo">397</span> LOGGER.error("Error closing JAR file stream for {}", source, e);<a name="line.397"></a>
<span class="sourceLineNo">398</span> }<a name="line.398"></a>
<span class="sourceLineNo">399</span> }<a name="line.399"></a>
<span class="sourceLineNo">400</span> }<a name="line.400"></a>
<span class="sourceLineNo">401</span><a name="line.401"></a>
<span class="sourceLineNo">402</span> /**<a name="line.402"></a>
<span class="sourceLineNo">403</span> * Finds matching classes within a jar files that contains a folder structure matching the package structure. If the<a name="line.403"></a>
<span class="sourceLineNo">404</span> * File is not a JarFile or does not exist a warning will be logged, but no error will be raised.<a name="line.404"></a>
<span class="sourceLineNo">405</span> *<a name="line.405"></a>
<span class="sourceLineNo">406</span> * @param test<a name="line.406"></a>
<span class="sourceLineNo">407</span> * a Test used to filter the classes that are discovered<a name="line.407"></a>
<span class="sourceLineNo">408</span> * @param parent<a name="line.408"></a>
<span class="sourceLineNo">409</span> * the parent package under which classes must be in order to be considered<a name="line.409"></a>
<span class="sourceLineNo">410</span> * @param stream<a name="line.410"></a>
<span class="sourceLineNo">411</span> * The jar InputStream<a name="line.411"></a>
<span class="sourceLineNo">412</span> */<a name="line.412"></a>
<span class="sourceLineNo">413</span> private void loadImplementationsInJar(final Test test, final String parent, final String path,<a name="line.413"></a>
<span class="sourceLineNo">414</span> final JarInputStream stream) {<a name="line.414"></a>
<span class="sourceLineNo">415</span><a name="line.415"></a>
<span class="sourceLineNo">416</span> try {<a name="line.416"></a>
<span class="sourceLineNo">417</span> JarEntry entry;<a name="line.417"></a>
<span class="sourceLineNo">418</span><a name="line.418"></a>
<span class="sourceLineNo">419</span> while ((entry = stream.getNextJarEntry()) != null) {<a name="line.419"></a>
<span class="sourceLineNo">420</span> final String name = entry.getName();<a name="line.420"></a>
<span class="sourceLineNo">421</span> if (!entry.isDirectory() &amp;&amp; name.startsWith(parent) &amp;&amp; isTestApplicable(test, name)) {<a name="line.421"></a>
<span class="sourceLineNo">422</span> addIfMatching(test, name);<a name="line.422"></a>
<span class="sourceLineNo">423</span> }<a name="line.423"></a>
<span class="sourceLineNo">424</span> }<a name="line.424"></a>
<span class="sourceLineNo">425</span> } catch (final IOException ioe) {<a name="line.425"></a>
<span class="sourceLineNo">426</span> LOGGER.error("Could not search JAR file '{}' for classes matching criteria {} due to an IOException", path,<a name="line.426"></a>
<span class="sourceLineNo">427</span> test, ioe);<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> /**<a name="line.431"></a>
<span class="sourceLineNo">432</span> * Add the class designated by the fully qualified class name provided to the set of resolved classes if and only if<a name="line.432"></a>
<span class="sourceLineNo">433</span> * it is approved by the Test supplied.<a name="line.433"></a>
<span class="sourceLineNo">434</span> *<a name="line.434"></a>
<span class="sourceLineNo">435</span> * @param test<a name="line.435"></a>
<span class="sourceLineNo">436</span> * the test used to determine if the class matches<a name="line.436"></a>
<span class="sourceLineNo">437</span> * @param fqn<a name="line.437"></a>
<span class="sourceLineNo">438</span> * the fully qualified name of a class<a name="line.438"></a>
<span class="sourceLineNo">439</span> */<a name="line.439"></a>
<span class="sourceLineNo">440</span> protected void addIfMatching(final Test test, final String fqn) {<a name="line.440"></a>
<span class="sourceLineNo">441</span> try {<a name="line.441"></a>
<span class="sourceLineNo">442</span> final ClassLoader loader = getClassLoader();<a name="line.442"></a>
<span class="sourceLineNo">443</span> if (test.doesMatchClass()) {<a name="line.443"></a>
<span class="sourceLineNo">444</span> final String externalName = fqn.substring(0, fqn.indexOf('.')).replace('/', '.');<a name="line.444"></a>
<span class="sourceLineNo">445</span> if (LOGGER.isDebugEnabled()) {<a name="line.445"></a>
<span class="sourceLineNo">446</span> LOGGER.debug("Checking to see if class {} matches criteria {}", externalName, test);<a name="line.446"></a>
<span class="sourceLineNo">447</span> }<a name="line.447"></a>
<span class="sourceLineNo">448</span><a name="line.448"></a>
<span class="sourceLineNo">449</span> final Class&lt;?&gt; type = loader.loadClass(externalName);<a name="line.449"></a>
<span class="sourceLineNo">450</span> if (test.matches(type)) {<a name="line.450"></a>
<span class="sourceLineNo">451</span> classMatches.add(type);<a name="line.451"></a>
<span class="sourceLineNo">452</span> }<a name="line.452"></a>
<span class="sourceLineNo">453</span> }<a name="line.453"></a>
<span class="sourceLineNo">454</span> if (test.doesMatchResource()) {<a name="line.454"></a>
<span class="sourceLineNo">455</span> URL url = loader.getResource(fqn);<a name="line.455"></a>
<span class="sourceLineNo">456</span> if (url == null) {<a name="line.456"></a>
<span class="sourceLineNo">457</span> url = loader.getResource(fqn.substring(1));<a name="line.457"></a>
<span class="sourceLineNo">458</span> }<a name="line.458"></a>
<span class="sourceLineNo">459</span> if (url != null &amp;&amp; test.matches(url.toURI())) {<a name="line.459"></a>
<span class="sourceLineNo">460</span> resourceMatches.add(url.toURI());<a name="line.460"></a>
<span class="sourceLineNo">461</span> }<a name="line.461"></a>
<span class="sourceLineNo">462</span> }<a name="line.462"></a>
<span class="sourceLineNo">463</span> } catch (final Throwable t) {<a name="line.463"></a>
<span class="sourceLineNo">464</span> LOGGER.warn("Could not examine class {}", fqn, t);<a name="line.464"></a>
<span class="sourceLineNo">465</span> }<a name="line.465"></a>
<span class="sourceLineNo">466</span> }<a name="line.466"></a>
<span class="sourceLineNo">467</span><a name="line.467"></a>
<span class="sourceLineNo">468</span> /**<a name="line.468"></a>
<span class="sourceLineNo">469</span> * A simple interface that specifies how to test classes to determine if they are to be included in the results<a name="line.469"></a>
<span class="sourceLineNo">470</span> * produced by the ResolverUtil.<a name="line.470"></a>
<span class="sourceLineNo">471</span> */<a name="line.471"></a>
<span class="sourceLineNo">472</span> public interface Test {<a name="line.472"></a>
<span class="sourceLineNo">473</span> /**<a name="line.473"></a>
<span class="sourceLineNo">474</span> * Will be called repeatedly with candidate classes. Must return True if a class is to be included in the<a name="line.474"></a>
<span class="sourceLineNo">475</span> * results, false otherwise.<a name="line.475"></a>
<span class="sourceLineNo">476</span> *<a name="line.476"></a>
<span class="sourceLineNo">477</span> * @param type<a name="line.477"></a>
<span class="sourceLineNo">478</span> * The Class to match against.<a name="line.478"></a>
<span class="sourceLineNo">479</span> * @return true if the Class matches.<a name="line.479"></a>
<span class="sourceLineNo">480</span> */<a name="line.480"></a>
<span class="sourceLineNo">481</span> boolean matches(Class&lt;?&gt; type);<a name="line.481"></a>
<span class="sourceLineNo">482</span><a name="line.482"></a>
<span class="sourceLineNo">483</span> /**<a name="line.483"></a>
<span class="sourceLineNo">484</span> * Test for a resource.<a name="line.484"></a>
<span class="sourceLineNo">485</span> *<a name="line.485"></a>
<span class="sourceLineNo">486</span> * @param resource<a name="line.486"></a>
<span class="sourceLineNo">487</span> * The URI to the resource.<a name="line.487"></a>
<span class="sourceLineNo">488</span> * @return true if the resource matches.<a name="line.488"></a>
<span class="sourceLineNo">489</span> */<a name="line.489"></a>
<span class="sourceLineNo">490</span> boolean matches(URI resource);<a name="line.490"></a>
<span class="sourceLineNo">491</span><a name="line.491"></a>
<span class="sourceLineNo">492</span> boolean doesMatchClass();<a name="line.492"></a>
<span class="sourceLineNo">493</span><a name="line.493"></a>
<span class="sourceLineNo">494</span> boolean doesMatchResource();<a name="line.494"></a>
<span class="sourceLineNo">495</span> }<a name="line.495"></a>
<span class="sourceLineNo">496</span><a name="line.496"></a>
<span class="sourceLineNo">497</span>}<a name="line.497"></a>
</pre>
</div>
</body>
</html>