| <!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<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.util;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.File;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.FileNotFoundException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.FileOutputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.net.URL;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.security.AccessController;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.security.PrivilegedAction;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.Collection;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.Enumeration;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.HashSet;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.concurrent.ConcurrentMap;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.locks.Lock;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.jar.JarEntry;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.jar.JarFile;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.regex.Matcher;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.regex.Pattern;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.conf.Configuration;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.fs.FileStatus;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.fs.FileSystem;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.fs.FileUtil;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.fs.Path;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.io.IOUtils;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.slf4j.Logger;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.slf4j.LoggerFactory;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.hbase.thirdparty.com.google.common.collect.MapMaker;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span>/**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * ClassLoader used to load classes for Coprocessor instances.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * This ClassLoader always tries to load classes from the specified coprocessor<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * jar first actually using URLClassLoader logic before delegating to the parent<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * ClassLoader, thus avoiding dependency conflicts between HBase's classpath and<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * classes in the coprocessor jar.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <p><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Certain classes are exempt from being loaded by this ClassLoader because it<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * would prevent them from being cast to the equivalent classes in the region<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * server. For example, the Coprocessor interface needs to be loaded by the<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * region server's ClassLoader to prevent a ClassCastException when casting the<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * coprocessor implementation.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <p><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * A HDFS path can be used to specify the coprocessor jar. In this case, the jar<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * will be copied to local at first under some folder under ${hbase.local.dir}/jars/tmp/.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * The local copy will be removed automatically when the HBase server instance is<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * stopped.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * This ClassLoader also handles resource loading. In most cases this<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * ClassLoader will attempt to load resources from the coprocessor jar first<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * before delegating to the parent. However, like in class loading,<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * some resources need to be handled differently. For all of the Hadoop<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * default configurations (e.g. hbase-default.xml) we will check the parent<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * ClassLoader first to prevent issues such as failing the HBase default<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * configuration version check.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span>@InterfaceAudience.Private<a name="line.77"></a> |
| <span class="sourceLineNo">078</span>public class CoprocessorClassLoader extends ClassLoaderBase {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private static final Logger LOG = LoggerFactory.getLogger(CoprocessorClassLoader.class);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // A temporary place ${hbase.local.dir}/jars/tmp/ to store the local<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> // copy of the jar file and the libraries contained in the jar.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private static final String TMP_JARS_DIR = File.separator<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> + "jars" + File.separator + "tmp" + File.separator;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * External class loaders cache keyed by external jar path.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * ClassLoader instance is stored as a weak-reference<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * to allow GC'ing when it is not used<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * (@see HBASE-7205)<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private static final ConcurrentMap<Path, CoprocessorClassLoader> classLoadersCache =<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> new MapMaker().concurrencyLevel(3).weakValues().makeMap();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * If the class being loaded starts with any of these strings, we will skip<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * trying to load it from the coprocessor jar and instead delegate<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * directly to the parent ClassLoader.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> private static final String[] CLASS_PREFIX_EXEMPTIONS = new String[] {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> // Java standard library:<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> "com.sun.",<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> "java.",<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> "javax.",<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> "org.ietf",<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> "org.omg",<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> "org.w3c",<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> "org.xml",<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> "sunw.",<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> // logging<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> "org.slf4j",<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> "org.apache.log4j",<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> "com.hadoop",<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> // HBase:<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> "org.apache.hadoop.hbase",<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> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * If the resource being loaded matches any of these patterns, we will first<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * attempt to load the resource with the parent ClassLoader. Only if the<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * resource is not found by the parent do we attempt to load it from the coprocessor jar.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> private static final Pattern[] RESOURCE_LOAD_PARENT_FIRST_PATTERNS =<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> new Pattern[] {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> Pattern.compile("^[^-]+-default\\.xml$")<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> };<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> private static final Pattern libJarPattern = Pattern.compile("[/]?lib/([^/]+\\.jar)");<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * A locker used to synchronize class loader initialization per coprocessor jar file<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> private static final KeyLocker<String> locker = new KeyLocker<>();<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 set used to synchronized parent path clean up. Generally, there<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * should be only one parent path, but using a set so that we can support more.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> static final HashSet<String> parentDirLockSet = new HashSet<>();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> /**<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * Creates a JarClassLoader that loads classes from the given paths.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> private CoprocessorClassLoader(ClassLoader parent) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> super(parent);<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> private void init(Path pathPattern, String pathPrefix,<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> Configuration conf) throws IOException {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // Copy the jar to the local filesystem<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> String parentDirStr =<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> conf.get(LOCAL_DIR_KEY, DEFAULT_LOCAL_DIR) + TMP_JARS_DIR;<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> synchronized (parentDirLockSet) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> if (!parentDirLockSet.contains(parentDirStr)) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> Path parentDir = new Path(parentDirStr);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> FileSystem fs = FileSystem.getLocal(conf);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> fs.delete(parentDir, true); // it's ok if the dir doesn't exist now<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> parentDirLockSet.add(parentDirStr);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> if (!fs.mkdirs(parentDir) && !fs.getFileStatus(parentDir).isDirectory()) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> throw new RuntimeException("Failed to create local dir " + parentDirStr<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> + ", CoprocessorClassLoader failed to init");<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><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> FileSystem fs = pathPattern.getFileSystem(conf);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> Path pathPattern1 = fs.isDirectory(pathPattern) ?<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> new Path(pathPattern, "*.jar") : pathPattern; // append "*.jar" if a directory is specified<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> FileStatus[] fileStatuses = fs.globStatus(pathPattern1); // return all files that match the pattern<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (fileStatuses == null || fileStatuses.length == 0) { // if no one matches<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> throw new FileNotFoundException(pathPattern1.toString());<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> } else {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> boolean validFileEncountered = false;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> for (Path path : FileUtil.stat2Paths(fileStatuses)) { // for each file that match the pattern<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> if (fs.isFile(path)) { // only process files, skip for directories<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> File dst = new File(parentDirStr, "." + pathPrefix + "."<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> + path.getName() + "." + System.currentTimeMillis() + ".jar");<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> fs.copyToLocalFile(path, new Path(dst.toString()));<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> dst.deleteOnExit();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> addURL(dst.getCanonicalFile().toURI().toURL());<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> JarFile jarFile = new JarFile(dst.toString());<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> try {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> Enumeration<JarEntry> entries = jarFile.entries(); // get entries inside a jar file<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> while (entries.hasMoreElements()) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> JarEntry entry = entries.nextElement();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> Matcher m = libJarPattern.matcher(entry.getName());<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> if (m.matches()) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> File file = new File(parentDirStr, "." + pathPrefix + "."<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> + path.getName() + "." + System.currentTimeMillis() + "." + m.group(1));<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> try (FileOutputStream outStream = new FileOutputStream(file)) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> IOUtils.copyBytes(jarFile.getInputStream(entry),<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> outStream, conf, true);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> file.deleteOnExit();<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> addURL(file.toURI().toURL());<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> } finally {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> jarFile.close();<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> validFileEncountered = true; // Set to true when encountering a file<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> if (validFileEncountered == false) { // all items returned by globStatus() are directories<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> throw new FileNotFoundException("No file found matching " + pathPattern1.toString());<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> // This method is used in unit test<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> public static CoprocessorClassLoader getIfCached(final Path path) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> Preconditions.checkNotNull(path, "The jar path is null!");<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> return classLoadersCache.get(path);<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> // This method is used in unit test<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> public static Collection<? extends ClassLoader> getAllCached() {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> return classLoadersCache.values();<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> // This method is used in unit test<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> public static void clearCache() {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> classLoadersCache.clear();<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<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> * Get a CoprocessorClassLoader for a coprocessor jar path from cache.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * If not in cache, create one.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> *<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @param path the path to the coprocessor jar file to load classes from<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @param parent the parent class loader for exempted classes<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @param pathPrefix a prefix used in temp path name to store the jar file locally<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param conf the configuration used to create the class loader, if needed<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @return a CoprocessorClassLoader for the coprocessor jar path<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @throws IOException<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> public static CoprocessorClassLoader getClassLoader(final Path path,<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> final ClassLoader parent, final String pathPrefix,<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> final Configuration conf) throws IOException {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> CoprocessorClassLoader cl = getIfCached(path);<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> String pathStr = path.toString();<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> if (cl != null) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> LOG.debug("Found classloader "+ cl + " for "+ pathStr);<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> return cl;<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> }<a name="line.248"></a> |
| <span class="sourceLineNo">249</span><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> if (path.getFileSystem(conf).isFile(path) && !pathStr.endsWith(".jar")) {<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> throw new IOException(pathStr + ": not a jar file?");<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> }<a name="line.252"></a> |
| <span class="sourceLineNo">253</span><a name="line.253"></a> |
| <span class="sourceLineNo">254</span> Lock lock = locker.acquireLock(pathStr);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> try {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> cl = getIfCached(path);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> if (cl != null) {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> LOG.debug("Found classloader "+ cl + " for "+ pathStr);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> return cl;<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> cl = AccessController.doPrivileged(<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> new PrivilegedAction<CoprocessorClassLoader>() {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> @Override<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> public CoprocessorClassLoader run() {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> return new CoprocessorClassLoader(parent);<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> });<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> cl.init(path, pathPrefix, conf);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> // Cache class loader as a weak value, will be GC'ed when no reference left<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> CoprocessorClassLoader prev = classLoadersCache.putIfAbsent(path, cl);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> if (prev != null) {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> // Lost update race, use already added class loader<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> LOG.warn("THIS SHOULD NOT HAPPEN, a class loader"<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> +" is already cached for " + pathStr);<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> cl = prev;<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> return cl;<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> } finally {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> lock.unlock();<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span><a name="line.285"></a> |
| <span class="sourceLineNo">286</span> @Override<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> public Class<?> loadClass(String name)<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> throws ClassNotFoundException {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> return loadClass(name, null);<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span><a name="line.291"></a> |
| <span class="sourceLineNo">292</span> public Class<?> loadClass(String name, String[] includedClassPrefixes)<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> throws ClassNotFoundException {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> // Delegate to the parent immediately if this class is exempt<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> if (isClassExempt(name, includedClassPrefixes)) {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> if (LOG.isDebugEnabled()) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> LOG.debug("Skipping exempt class " + name +<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> " - delegating directly to parent");<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> return parent.loadClass(name);<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> }<a name="line.301"></a> |
| <span class="sourceLineNo">302</span><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> synchronized (getClassLoadingLock(name)) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> // Check whether the class has already been loaded:<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> Class<?> clasz = findLoadedClass(name);<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> if (clasz != null) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (LOG.isDebugEnabled()) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> LOG.debug("Class " + name + " already loaded");<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> else {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> try {<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> // Try to find this class using the URLs passed to this ClassLoader<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> if (LOG.isDebugEnabled()) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> LOG.debug("Finding class: " + name);<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> clasz = findClass(name);<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> } catch (ClassNotFoundException e) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> // Class not found using this ClassLoader, so delegate to parent<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> if (LOG.isDebugEnabled()) {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> LOG.debug("Class " + name + " not found - delegating to parent");<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> }<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> try {<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> clasz = parent.loadClass(name);<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> } catch (ClassNotFoundException e2) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> // Class not found in this ClassLoader or in the parent ClassLoader<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> // Log some debug output before re-throwing ClassNotFoundException<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> if (LOG.isDebugEnabled()) {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> LOG.debug("Class " + name + " not found in parent loader");<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> throw e2;<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> }<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> }<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return clasz;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> }<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> @Override<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public URL getResource(String name) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> URL resource = null;<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> boolean parentLoaded = false;<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> // Delegate to the parent first if necessary<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> if (loadResourceUsingParentFirst(name)) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> if (LOG.isDebugEnabled()) {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> LOG.debug("Checking parent first for resource " + name);<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> resource = super.getResource(name);<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> parentLoaded = true;<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> if (resource == null) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> synchronized (getClassLoadingLock(name)) {<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> // Try to find the resource in this jar<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> resource = findResource(name);<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> if ((resource == null) && !parentLoaded) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> // Not found in this jar and we haven't attempted to load<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> // the resource in the parent yet; fall back to the parent<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> resource = super.getResource(name);<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> return resource;<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span><a name="line.366"></a> |
| <span class="sourceLineNo">367</span> /**<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * Determines whether the given class should be exempt from being loaded<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * by this ClassLoader.<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @param name the name of the class to test.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * @return true if the class should *not* be loaded by this ClassLoader;<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * false otherwise.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> */<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> protected boolean isClassExempt(String name, String[] includedClassPrefixes) {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> if (includedClassPrefixes != null) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> for (String clsName : includedClassPrefixes) {<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> if (name.startsWith(clsName)) {<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> return false;<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> }<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> for (String exemptPrefix : CLASS_PREFIX_EXEMPTIONS) {<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> if (name.startsWith(exemptPrefix)) {<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> return true;<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> return false;<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> /**<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * Determines whether we should attempt to load the given resource using the<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * parent first before attempting to load the resource using this ClassLoader.<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * @param name the name of the resource to test.<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * @return true if we should attempt to load the resource using the parent<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * first; false if we should attempt to load the resource using this<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * ClassLoader first.<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> */<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> protected boolean loadResourceUsingParentFirst(String name) {<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> for (Pattern resourcePattern : RESOURCE_LOAD_PARENT_FIRST_PATTERNS) {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> if (resourcePattern.matcher(name).matches()) {<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> return true;<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> }<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> return false;<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span>}<a name="line.406"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
