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