blob: 9f16befa170b6e1839df64f9e8314f4b583455a5 [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><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.felix.ipojo.bnd;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import static java.lang.String.format;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.InputStream;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.ArrayList;<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.HashSet;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Set;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.jar.Attributes;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.jar.Manifest;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.felix.ipojo.manipulator.ResourceStore;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.felix.ipojo.manipulator.ResourceVisitor;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.felix.ipojo.manipulator.render.MetadataRenderer;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.felix.ipojo.manipulator.util.Constants;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.felix.ipojo.manipulator.util.Metadatas;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.felix.ipojo.manipulator.util.Streams;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>import aQute.bnd.header.Attrs;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import aQute.bnd.osgi.Analyzer;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import aQute.bnd.osgi.Clazz;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import aQute.bnd.osgi.Jar;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import aQute.bnd.osgi.Resource;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import aQute.service.reporter.Reporter;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>public class BndJarResourceStore implements ResourceStore {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private Analyzer m_analyzer;<a name="line.51"></a>
<span class="sourceLineNo">052</span> private Reporter m_reporter;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private MetadataRenderer m_renderer = new MetadataRenderer();<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private List&lt;Element&gt; m_metadata;<a name="line.56"></a>
<span class="sourceLineNo">057</span> private boolean m_includeEmbedComponents;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> public BndJarResourceStore(Analyzer analyzer, Reporter reporter) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> m_metadata = new ArrayList&lt;Element&gt;();<a name="line.60"></a>
<span class="sourceLineNo">061</span> m_analyzer = analyzer;<a name="line.61"></a>
<span class="sourceLineNo">062</span> m_reporter = reporter;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> public byte[] read(String path) throws IOException {<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> // Find the resource either in the global jar or in one of the embed dependencies<a name="line.67"></a>
<span class="sourceLineNo">068</span> Resource resource = m_analyzer.getJar().getResource(path);<a name="line.68"></a>
<span class="sourceLineNo">069</span> if (resource == null) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> Jar embed = findJar(path);<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (embed == null) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> throw new IOException(format("Cannot find resource %s in jar and classpath", path));<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> resource = embed.getResource(path);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> InputStream is = null;<a name="line.76"></a>
<span class="sourceLineNo">077</span> try {<a name="line.77"></a>
<span class="sourceLineNo">078</span> is = resource.openInputStream();<a name="line.78"></a>
<span class="sourceLineNo">079</span> } catch (Exception e) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> throw new IOException("Cannot read " + path);<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span> return Streams.readBytes(is);<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> public void accept(ResourceVisitor visitor) {<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> try {<a name="line.87"></a>
<span class="sourceLineNo">088</span> // Collect all annotated classes<a name="line.88"></a>
<span class="sourceLineNo">089</span> Collection&lt;Clazz&gt; classes = m_analyzer.getClasses("",<a name="line.89"></a>
<span class="sourceLineNo">090</span> Clazz.QUERY.CLASSANNOTATIONS.name());<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> classes = filter(classes);<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> // Iterates over discovered resources<a name="line.94"></a>
<span class="sourceLineNo">095</span> for (Clazz clazz : classes) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> visitor.visit(clazz.getAbsolutePath());<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span> } catch (Exception e) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> m_reporter.error("Cannot find iPOJO annotated types: " + e.getMessage());<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> private Collection&lt;Clazz&gt; filter(Collection&lt;Clazz&gt; classes) throws Exception {<a name="line.103"></a>
<span class="sourceLineNo">104</span> Set&lt;Clazz&gt; manipulable = new HashSet&lt;Clazz&gt;();<a name="line.104"></a>
<span class="sourceLineNo">105</span> for (Clazz clazz : classes) {<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> // If it is in the main jar, simply use it<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (m_analyzer.getJar().getResource(clazz.getAbsolutePath()) != null) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> manipulable.add(clazz);<a name="line.109"></a>
<span class="sourceLineNo">110</span> continue;<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> if (m_includeEmbedComponents) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> // Otherwise ...<a name="line.114"></a>
<span class="sourceLineNo">115</span> // Try to see if it is in an embed dependencies<a name="line.115"></a>
<span class="sourceLineNo">116</span> Jar jar = findJar(clazz.getAbsolutePath());<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (jar == null) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> m_reporter.error("Resource for class %s not found in classpath", clazz.getFQN());<a name="line.118"></a>
<span class="sourceLineNo">119</span> continue;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> // Is it a Bundle ?<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (jar.getBsn() != null) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> // OSGi Bundle case<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> // Check if the bundle was manipulated before<a name="line.126"></a>
<span class="sourceLineNo">127</span> Attributes attr = jar.getManifest().getMainAttributes();<a name="line.127"></a>
<span class="sourceLineNo">128</span> if (Manifests.getComponents(attr) != null) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> // Bundle has been previously manipulated<a name="line.129"></a>
<span class="sourceLineNo">130</span> // TODO We should ignore the resource since it was already manipulated<a name="line.130"></a>
<span class="sourceLineNo">131</span> // TODO But we should also merge its IPOJO-Components header<a name="line.131"></a>
<span class="sourceLineNo">132</span> } else {<a name="line.132"></a>
<span class="sourceLineNo">133</span> // Bundle was not manipulated<a name="line.133"></a>
<span class="sourceLineNo">134</span> manipulable.add(clazz);<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> } else {<a name="line.137"></a>
<span class="sourceLineNo">138</span> // Simple Jar file with iPOJO annotations<a name="line.138"></a>
<span class="sourceLineNo">139</span> m_reporter.warning("Class %s found in a non-Bundle archive %s", clazz.getFQN(), jar.getName());<a name="line.139"></a>
<span class="sourceLineNo">140</span> continue;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> } else {<a name="line.142"></a>
<span class="sourceLineNo">143</span> m_reporter.warning("Embed components are excluded, Component %s will not be manipulated", clazz.getFQN());<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> return manipulable;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> private Jar findJar(String path) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> for (Jar jar : m_analyzer.getClasspath()) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> if (jar.getResource(path) != null) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> return jar;<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> return null;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> public void open() throws IOException {<a name="line.158"></a>
<span class="sourceLineNo">159</span> // nothing to do<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> public void writeMetadata(Element metadata) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> m_metadata.add(metadata);<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> // Find referred packages and add them into Bnd<a name="line.165"></a>
<span class="sourceLineNo">166</span> for (String referred : Metadatas.findReferredPackages(metadata)) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> if (!m_analyzer.getReferred().containsFQN(referred)) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> // The given package is not referred ATM<a name="line.168"></a>
<span class="sourceLineNo">169</span> m_analyzer.getReferred().put(m_analyzer.getPackageRef(referred),<a name="line.169"></a>
<span class="sourceLineNo">170</span> new Attrs());<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<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> // IPOJO-Components will be written during the close method.<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> public void write(String resourcePath, byte[] resource) throws IOException {<a name="line.177"></a>
<span class="sourceLineNo">178</span> Jar jar = m_analyzer.getJar();<a name="line.178"></a>
<span class="sourceLineNo">179</span> jar.putResource(resourcePath, new ByteArrayResource(resource));<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> public void close() throws IOException {<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> // Write the iPOJO header (including manipulation metadata)<a name="line.184"></a>
<span class="sourceLineNo">185</span> StringBuilder builder = new StringBuilder();<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> if (m_includeEmbedComponents) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> // Incorporate metadata of embed dependencies (if any)<a name="line.188"></a>
<span class="sourceLineNo">189</span> for (Jar jar : m_analyzer.getClasspath()) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> try {<a name="line.190"></a>
<span class="sourceLineNo">191</span> Manifest manifest = jar.getManifest();<a name="line.191"></a>
<span class="sourceLineNo">192</span> Attributes main = manifest.getMainAttributes();<a name="line.192"></a>
<span class="sourceLineNo">193</span> String components = Manifests.getComponents(main);<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (components != null) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> m_reporter.trace("Merging components from %s", jar.getName());<a name="line.195"></a>
<span class="sourceLineNo">196</span> builder.append(components);<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span> } catch (Exception e) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> m_reporter.warning("Cannot open MANIFEST of %s", jar.getName());<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<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> for (Element metadata : m_metadata) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> builder.append(m_renderer.render(metadata));<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>
<span class="sourceLineNo">208</span> if (builder.length() != 0) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> m_analyzer.setProperty("IPOJO-Components", builder.toString());<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> // Add some mandatory imported packages<a name="line.212"></a>
<span class="sourceLineNo">213</span> Attrs version = new Attrs();<a name="line.213"></a>
<span class="sourceLineNo">214</span> version.put("version:Version", Constants.getPackageImportClause());<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> if (!m_analyzer.getReferred().containsFQN("org.apache.felix.ipojo")) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> m_analyzer.getReferred().put(m_analyzer.getPackageRef("org.apache.felix.ipojo"),<a name="line.217"></a>
<span class="sourceLineNo">218</span> version);<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span> if (!m_analyzer.getReferred().containsFQN("org.apache.felix.ipojo.architecture")) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> m_analyzer.getReferred().put(m_analyzer.getPackageRef("org.apache.felix.ipojo.architecture"),<a name="line.221"></a>
<span class="sourceLineNo">222</span> version);<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span> if (!m_analyzer.getReferred().containsFQN("org.osgi.service.cm")) {<a name="line.224"></a>
<span class="sourceLineNo">225</span> Attrs cm = new Attrs();<a name="line.225"></a>
<span class="sourceLineNo">226</span> cm.put("version:Version", "1.2");<a name="line.226"></a>
<span class="sourceLineNo">227</span> m_analyzer.getReferred().put(m_analyzer.getPackageRef("org.osgi.service.cm"),<a name="line.227"></a>
<span class="sourceLineNo">228</span> cm);<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span> if (!m_analyzer.getReferred().containsFQN("org.osgi.service.log")) {<a name="line.230"></a>
<span class="sourceLineNo">231</span> Attrs log = new Attrs();<a name="line.231"></a>
<span class="sourceLineNo">232</span> log.put("version:Version", "1.3");<a name="line.232"></a>
<span class="sourceLineNo">233</span> m_analyzer.getReferred().put(m_analyzer.getPackageRef("org.osgi.service.log"),<a name="line.233"></a>
<span class="sourceLineNo">234</span> log);<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> public void setIncludeEmbedComponents(boolean excludeEmbedComponents) {<a name="line.240"></a>
<span class="sourceLineNo">241</span> m_includeEmbedComponents = excludeEmbedComponents;<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>
</pre>
</div>
</body>
</html>