blob: 3067487f85a03b7dfc6c5cdf9aa597861bd258b9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/* <a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<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,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.felix.ipojo.online.manipulator;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.felix.ipojo.manipulator.Pojoization;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.osgi.framework.BundleContext;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.osgi.service.url.URLStreamHandlerService;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.File;<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.io.IOException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.InputStream;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.net.MalformedURLException;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.net.URL;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.net.URLConnection;<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><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * iPOJO URL Handler allowing installation time manipulation.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * When a bundle is installed with the &lt;code&gt;ipojo:&lt;/code&gt; URL<a name="line.37"></a>
<span class="sourceLineNo">038</span> * prefix, the bundle is downloaded and manipulated by this<a name="line.38"></a>
<span class="sourceLineNo">039</span> * handler.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * The metadata.xml file can either be provided inside the bundle (root,<a name="line.40"></a>
<span class="sourceLineNo">041</span> * or in META-INF) or given in the URL:<a name="line.41"></a>
<span class="sourceLineNo">042</span> * ipojo:URL_BUNDLE!URL_METADATA.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class IPOJOURLHandler<a name="line.46"></a>
<span class="sourceLineNo">047</span> extends org.osgi.service.url.AbstractURLStreamHandlerService implements URLStreamHandlerService {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * The bundle context.<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> private BundleContext m_context;<a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * The directory storing bundles.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> private File m_temp;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Creates a IPOJOURLHandler.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Gets the bundle context and create the working<a name="line.60"></a>
<span class="sourceLineNo">061</span> * directory.<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param bc the bundle context<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public IPOJOURLHandler(BundleContext bc) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> m_context = bc;<a name="line.66"></a>
<span class="sourceLineNo">067</span> m_temp = m_context.getDataFile("temp");<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (!m_temp.exists()) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> m_temp.mkdir();<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><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Stops the URL handler:<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Deletes the working directory.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public void stop() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> File[] files = m_temp.listFiles();<a name="line.78"></a>
<span class="sourceLineNo">079</span> if (files != null) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> for (int i = 0; i &lt; files.length; i++) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> files[i].delete();<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> m_temp.delete();<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> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Opens a connection using the ipojo url handler.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * This methods parses the URL and manipulate the given bundle.<a name="line.89"></a>
<span class="sourceLineNo">090</span> *<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @param url the url.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @return the URL connection on the manipulated bundle<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @throws java.io.IOException occurs when the bundle cannot be either downloaded, or manipulated or<a name="line.93"></a>
<span class="sourceLineNo">094</span> * installed correctly.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @see org.osgi.service.url.AbstractURLStreamHandlerService#openConnection(java.net.URL)<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> public URLConnection openConnection(URL url) throws IOException {<a name="line.97"></a>
<span class="sourceLineNo">098</span> System.out.println("Processing URL : " + url);<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> // Parse the url:<a name="line.100"></a>
<span class="sourceLineNo">101</span> String full = url.toExternalForm();<a name="line.101"></a>
<span class="sourceLineNo">102</span> // Remote ipojo://<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (full.startsWith("ipojo:")) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> full = full.substring(6);<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> // Remove '/' or '//'<a name="line.106"></a>
<span class="sourceLineNo">107</span> while (full.startsWith("/")) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> full = full.substring(1);<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> full = full.trim();<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> // Now full is like : URL,URL or URL<a name="line.113"></a>
<span class="sourceLineNo">114</span> String[] urls = full.split("!");<a name="line.114"></a>
<span class="sourceLineNo">115</span> URL bundleURL = null;<a name="line.115"></a>
<span class="sourceLineNo">116</span> URL metadataURL = null;<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (urls.length == 1) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> // URL form<a name="line.118"></a>
<span class="sourceLineNo">119</span> System.out.println("Extracted URL : " + urls[0]);<a name="line.119"></a>
<span class="sourceLineNo">120</span> bundleURL = new URL(urls[0]);<a name="line.120"></a>
<span class="sourceLineNo">121</span> } else if (urls.length == 2) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> // URL,URL form<a name="line.122"></a>
<span class="sourceLineNo">123</span> bundleURL = new URL(urls[0]);<a name="line.123"></a>
<span class="sourceLineNo">124</span> metadataURL = new URL(urls[1]);<a name="line.124"></a>
<span class="sourceLineNo">125</span> } else {<a name="line.125"></a>
<span class="sourceLineNo">126</span> throw new MalformedURLException("The iPOJO url is not formatted correctly, ipojo:bundle_url[!metadata_url] expected");<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> File bundle = File.createTempFile("ipojo_", ".jar", m_temp);<a name="line.129"></a>
<span class="sourceLineNo">130</span> save(bundleURL, bundle);<a name="line.130"></a>
<span class="sourceLineNo">131</span> File metadata = null;<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (metadataURL != null) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> metadata = File.createTempFile("ipojo_", ".xml", m_temp);<a name="line.133"></a>
<span class="sourceLineNo">134</span> save(metadataURL, metadata);<a name="line.134"></a>
<span class="sourceLineNo">135</span> } else {<a name="line.135"></a>
<span class="sourceLineNo">136</span> // Check that the metadata are in the jar file<a name="line.136"></a>
<span class="sourceLineNo">137</span> JarFile jar = new JarFile(bundle);<a name="line.137"></a>
<span class="sourceLineNo">138</span> metadata = findMetadata(jar);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> // Pojoization<a name="line.141"></a>
<span class="sourceLineNo">142</span> Pojoization pojoizator = new Pojoization();<a name="line.142"></a>
<span class="sourceLineNo">143</span> File out = new File(m_temp, bundle.getName() + "-ipojo.jar");<a name="line.143"></a>
<span class="sourceLineNo">144</span> System.out.println("Pojoization " + bundle.exists() + " - " + metadata.exists());<a name="line.144"></a>
<span class="sourceLineNo">145</span> try {<a name="line.145"></a>
<span class="sourceLineNo">146</span> pojoizator.pojoization(bundle, out, metadata);<a name="line.146"></a>
<span class="sourceLineNo">147</span> } catch (Exception e) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (!pojoizator.getErrors().isEmpty()) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> throw new IOException("Errors occured during the manipulation : " + pojoizator.getErrors());<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> e.printStackTrace();<a name="line.151"></a>
<span class="sourceLineNo">152</span> throw new RuntimeException(e.getMessage());<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> if (!pojoizator.getErrors().isEmpty()) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> throw new IOException("Errors occured during the manipulation : " + pojoizator.getErrors());<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (!pojoizator.getWarnings().isEmpty()) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> System.err.println("Warnings occured during the manipulation : " + pojoizator.getWarnings());<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> System.out.println("Manipulation done : " + out.exists());<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> // Cleanup<a name="line.164"></a>
<span class="sourceLineNo">165</span> bundle.delete();<a name="line.165"></a>
<span class="sourceLineNo">166</span> if (metadata != null) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> metadata.delete();<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> out.deleteOnExit();<a name="line.169"></a>
<span class="sourceLineNo">170</span> // Returns the URL Connection<a name="line.170"></a>
<span class="sourceLineNo">171</span> return out.toURI().toURL().openConnection();<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> /**<a name="line.176"></a>
<span class="sourceLineNo">177</span> * Downloads the content pointed by the given url to<a name="line.177"></a>
<span class="sourceLineNo">178</span> * the given file.<a name="line.178"></a>
<span class="sourceLineNo">179</span> *<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @param url the url<a name="line.180"></a>
<span class="sourceLineNo">181</span> * @param file the file<a name="line.181"></a>
<span class="sourceLineNo">182</span> * @throws java.io.IOException occurs if the content cannot be read<a name="line.182"></a>
<span class="sourceLineNo">183</span> * and save inside the file<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> private void save(URL url, File file) throws IOException {<a name="line.185"></a>
<span class="sourceLineNo">186</span> InputStream is = url.openStream();<a name="line.186"></a>
<span class="sourceLineNo">187</span> save(is, file);<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Saves the content of the input stream to the given file.<a name="line.191"></a>
<span class="sourceLineNo">192</span> *<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @param is the input stream to read<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param file the file<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @throws java.io.IOException occurs if the content cannot be read<a name="line.195"></a>
<span class="sourceLineNo">196</span> * and save inside the file<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> private void save(InputStream is, File file) throws IOException {<a name="line.198"></a>
<span class="sourceLineNo">199</span> FileOutputStream writer = new FileOutputStream(file);<a name="line.199"></a>
<span class="sourceLineNo">200</span> int cc = 0;<a name="line.200"></a>
<span class="sourceLineNo">201</span> do {<a name="line.201"></a>
<span class="sourceLineNo">202</span> int i = is.read();<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (i == -1) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> break;<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span> cc++;<a name="line.206"></a>
<span class="sourceLineNo">207</span> writer.write(i);<a name="line.207"></a>
<span class="sourceLineNo">208</span> } while (true);<a name="line.208"></a>
<span class="sourceLineNo">209</span> System.out.println(cc + " bytes copied");<a name="line.209"></a>
<span class="sourceLineNo">210</span> is.close();<a name="line.210"></a>
<span class="sourceLineNo">211</span> writer.close();<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> /**<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Looks for the metadata.xml file in the jar file.<a name="line.215"></a>
<span class="sourceLineNo">216</span> * Two locations are checked:<a name="line.216"></a>
<span class="sourceLineNo">217</span> * &lt;ol&gt;<a name="line.217"></a>
<span class="sourceLineNo">218</span> * &lt;li&gt;the root of the jar file&lt;/li&gt;<a name="line.218"></a>
<span class="sourceLineNo">219</span> * &lt;li&gt;the META-INF directory&lt;/li&gt;<a name="line.219"></a>
<span class="sourceLineNo">220</span> * &lt;/ol&gt;<a name="line.220"></a>
<span class="sourceLineNo">221</span> *<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @param jar the jar file<a name="line.222"></a>
<span class="sourceLineNo">223</span> * @return the founded file or &lt;code&gt;null&lt;/code&gt; if not found.<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @throws java.io.IOException occurs when the Jar file cannot be read.<a name="line.224"></a>
<span class="sourceLineNo">225</span> */<a name="line.225"></a>
<span class="sourceLineNo">226</span> private File findMetadata(JarFile jar) throws IOException {<a name="line.226"></a>
<span class="sourceLineNo">227</span> JarEntry je = jar.getJarEntry("metadata.xml");<a name="line.227"></a>
<span class="sourceLineNo">228</span> if (je == null) {<a name="line.228"></a>
<span class="sourceLineNo">229</span> je = jar.getJarEntry("META-INF/metadata.xml");<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> if (je == null) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> System.out.println("Metadata file not found, use annotations only.");<a name="line.233"></a>
<span class="sourceLineNo">234</span> return null; // Not Found, use annotation only<a name="line.234"></a>
<span class="sourceLineNo">235</span> } else {<a name="line.235"></a>
<span class="sourceLineNo">236</span> System.out.println("Metadata file found: " + je.getName());<a name="line.236"></a>
<span class="sourceLineNo">237</span> File metadata = File.createTempFile("ipojo_", ".xml", m_temp);<a name="line.237"></a>
<span class="sourceLineNo">238</span> save(jar.getInputStream(je), metadata);<a name="line.238"></a>
<span class="sourceLineNo">239</span> System.out.println("Metadata file saved to " + metadata.getAbsolutePath());<a name="line.239"></a>
<span class="sourceLineNo">240</span> return metadata;<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span>}<a name="line.245"></a>
</pre>
</div>
</body>
</html>