| <!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 static org.junit.Assert.assertTrue;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import static org.junit.Assert.fail;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.BufferedWriter;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.File;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.io.FileInputStream;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.io.FileOutputStream;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.nio.charset.StandardCharsets;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.nio.file.Files;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.ArrayList;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.List;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.jar.JarEntry;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.jar.JarOutputStream;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.jar.Manifest;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import javax.tools.JavaCompiler;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import javax.tools.JavaFileObject;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import javax.tools.StandardJavaFileManager;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import javax.tools.ToolProvider;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.conf.Configuration;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.fs.Path;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.slf4j.Logger;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.slf4j.LoggerFactory;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span>/**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Some utilities to help class loader testing<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public final class ClassLoaderTestHelper {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private static final Logger LOG = LoggerFactory.getLogger(ClassLoaderTestHelper.class);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static final int BUFFER_SIZE = 4096;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private ClassLoaderTestHelper() {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> }<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Jar a list of files into a jar archive.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param archiveFile the target jar archive<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param tobeJared a list of files to be jared<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @return true if a jar archive is build, false otherwise<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private static boolean createJarArchive(File archiveFile, File[] tobeJared) {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> try {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> byte[] buffer = new byte[BUFFER_SIZE];<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> // Open archive file<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> FileOutputStream stream = new FileOutputStream(archiveFile);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> JarOutputStream out = new JarOutputStream(stream, new Manifest());<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> for (File file : tobeJared) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> if (file == null || !file.exists() || file.isDirectory()) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> continue;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> // Add archive entry<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> JarEntry jarAdd = new JarEntry(file.getName());<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> jarAdd.setTime(file.lastModified());<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> out.putNextEntry(jarAdd);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> // Write file to archive<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> FileInputStream in = new FileInputStream(file);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> while (true) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> int nRead = in.read(buffer, 0, buffer.length);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> if (nRead <= 0) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> break;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> out.write(buffer, 0, nRead);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> in.close();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> out.close();<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> stream.close();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> LOG.info("Adding classes to jar file completed");<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return true;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> } catch (Exception ex) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> LOG.error("Error: " + ex.getMessage());<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return false;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Create a test jar for testing purpose for a given class name with specified code string: save<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * the class to a file, compile it, and jar it up. If the code string passed in is null, a bare<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * empty class will be created and used.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @param testDir the folder under which to store the test class and jar<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param className the test class name<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param code the optional test class code, which can be null. If null, a bare empty class<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * will be used<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return the test jar file generated<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static File buildJar(String testDir, String className, String code) throws Exception {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return buildJar(testDir, className, code, testDir);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> /**<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * Create a test jar for testing purpose for a given class name with specified code string.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param testDir the folder under which to store the test class<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param className the test class name<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param code the optional test class code, which can be null. If null, an empty class will<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * be used<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param folder the folder under which to store the generated jar<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @return the test jar file generated<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> */<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> public static File buildJar(String testDir, String className, String code, String folder)<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> throws Exception {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> String javaCode = code != null ? code : "public class " + className + " {}";<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> Path srcDir = new Path(testDir, "src");<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> File srcDirPath = new File(srcDir.toString());<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> srcDirPath.mkdirs();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> File sourceCodeFile = new File(srcDir.toString(), className + ".java");<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> BufferedWriter bw = Files.newBufferedWriter(sourceCodeFile.toPath(), StandardCharsets.UTF_8);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> bw.write(javaCode);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> bw.close();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> // compile it by JavaCompiler<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> ArrayList<String> srcFileNames = new ArrayList<>(1);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> srcFileNames.add(sourceCodeFile.toString());<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> StandardJavaFileManager fm = compiler.getStandardFileManager(null, null, null);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> Iterable<? extends JavaFileObject> cu = fm.getJavaFileObjects(sourceCodeFile);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> List<String> options = new ArrayList<>(2);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> options.add("-classpath");<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> // only add hbase classes to classpath. This is a little bit tricky: assume<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> // the classpath is {hbaseSrc}/target/classes.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> String currentDir = new File(".").getAbsolutePath();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> String classpath = currentDir + File.separator + "target" + File.separator + "classes"<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> + System.getProperty("path.separator") + System.getProperty("java.class.path")<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> + System.getProperty("path.separator") + System.getProperty("surefire.test.class.path");<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> options.add(classpath);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> LOG.debug("Setting classpath to: " + classpath);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> JavaCompiler.CompilationTask task = compiler.getTask(null, fm, null, options, null, cu);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> assertTrue("Compile file " + sourceCodeFile + " failed.", task.call());<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> // build a jar file by the classes files<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> String jarFileName = className + ".jar";<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> File jarFile = new File(folder, jarFileName);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> jarFile.getParentFile().mkdirs();<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> if (<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> !createJarArchive(jarFile, new File[] { new File(srcDir.toString(), className + ".class") })<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> ) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> fail("Build jar file failed.");<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return jarFile;<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> * Add a list of jar files to another jar file under a specific folder. It is used to generated<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * coprocessor jar files which can be loaded by the coprocessor class loader. It is for testing<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * usage only so we don't be so careful about stream closing in case any exception.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @param targetJar the target jar file<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @param libPrefix the folder where to put inner jar files<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param srcJars the source inner jar files to be added<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @throws Exception if anything doesn't work as expected<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> public static void addJarFilesToJar(File targetJar, String libPrefix, File... srcJars)<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> throws Exception {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> FileOutputStream stream = new FileOutputStream(targetJar);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> JarOutputStream out = new JarOutputStream(stream, new Manifest());<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> byte[] buffer = new byte[BUFFER_SIZE];<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> for (File jarFile : srcJars) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> // Add archive entry<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> JarEntry jarAdd = new JarEntry(libPrefix + jarFile.getName());<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> jarAdd.setTime(jarFile.lastModified());<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> out.putNextEntry(jarAdd);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> // Write file to archive<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> FileInputStream in = new FileInputStream(jarFile);<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> while (true) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> int nRead = in.read(buffer, 0, buffer.length);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> if (nRead <= 0) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> break;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> out.write(buffer, 0, nRead);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> in.close();<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> out.close();<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> stream.close();<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> LOG.info("Adding jar file to outer jar file completed");<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> public static String localDirPath(Configuration conf) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return conf.get(ClassLoaderBase.LOCAL_DIR_KEY) + File.separator + "jars" + File.separator;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span>}<a name="line.207"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
