Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.10.1 / src-html / org / apache / felix / ipojo / manipulator / store / JarFileResourceStore.html
blob: 3e0d79be164e51b6c21a7b42c8e34f6e51119b9c [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.manipulator.store;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.felix.ipojo.manipulator.ResourceStore;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.manipulator.ResourceVisitor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.manipulator.store.mapper.IdentityResourceMapper;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.manipulator.util.Metadatas;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.manipulator.util.Streams;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.io.File;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.io.FileOutputStream;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.io.IOException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.io.InputStream;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.Collections;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.List;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.Map;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import java.util.TreeMap;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import java.util.jar.JarEntry;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.util.jar.JarFile;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import java.util.jar.JarOutputStream;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import java.util.jar.Manifest;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import java.util.zip.ZipEntry;<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> * A {@link JarFileResourceStore} knows how to read and write<a name="line.44"></a>
<span class="sourceLineNo">045</span> * resources from (to respectively) a Jar File.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>public class JarFileResourceStore implements ResourceStore {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Source Jar.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> private JarFile m_source;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Target File.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> private File m_target;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Modified resources.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> private Map&lt;String, byte[]&gt; m_content;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Resource Mapper.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> private ResourceMapper m_mapper = new IdentityResourceMapper();<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> * The builder of the updated manifest.<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> private ManifestBuilder m_manifestBuilder;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Original manifest to be updated.<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> private Manifest m_manifest;<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * Construct a {@link JarFileResourceStore} wrapping the given original bundle,<a name="line.82"></a>
<span class="sourceLineNo">083</span> * and configured to output in the given target file.<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param source original Bundle<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @param target File where the updated Bundle will be outputted<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @throws IOException if there is an error retrieving the Manifest from the original JarFile<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public JarFileResourceStore(JarFile source, File target) throws IOException {<a name="line.88"></a>
<span class="sourceLineNo">089</span> m_source = source;<a name="line.89"></a>
<span class="sourceLineNo">090</span> m_target = target;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> // TODO ensure File is not null and not an existing file/directory<a name="line.92"></a>
<span class="sourceLineNo">093</span> this.m_target = target;<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (source != null) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> m_manifest = source.getManifest();<a name="line.95"></a>
<span class="sourceLineNo">096</span> } else {<a name="line.96"></a>
<span class="sourceLineNo">097</span> m_manifest = new Manifest();<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> m_content = new TreeMap&lt;String, byte[]&gt;();<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> public void setResourceMapper(ResourceMapper mapper) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.m_mapper = mapper;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> public void setManifestBuilder(ManifestBuilder manifestBuilder) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> this.m_manifestBuilder = manifestBuilder;<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public void setManifest(Manifest manifest) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.m_manifest = manifest;<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> public byte[] read(String path) throws IOException {<a name="line.114"></a>
<span class="sourceLineNo">115</span> ZipEntry entry = m_source.getEntry(getInternalPath(path));<a name="line.115"></a>
<span class="sourceLineNo">116</span> if (entry == null) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> throw new IOException("Jar Entry is not found for class " + path + ".");<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> return Streams.readBytes(m_source.getInputStream(entry));<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> private String getInternalPath(String path) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return m_mapper.internalize(path);<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> public void accept(ResourceVisitor visitor) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> List&lt;JarEntry&gt; entries = Collections.list(m_source.entries());<a name="line.127"></a>
<span class="sourceLineNo">128</span> for (JarEntry entry : entries) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> String name = entry.getName();<a name="line.129"></a>
<span class="sourceLineNo">130</span> if (!name.endsWith("/")) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> // Do not visit directories<a name="line.131"></a>
<span class="sourceLineNo">132</span> visitor.visit(getExternalName(entry.getName()));<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> private String getExternalName(String path) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return m_mapper.externalize(path);<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> public void open() throws IOException {<a name="line.141"></a>
<span class="sourceLineNo">142</span> // Nothing to do<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> public void writeMetadata(Element metadata) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> m_manifestBuilder.addMetada(Collections.singletonList(metadata));<a name="line.146"></a>
<span class="sourceLineNo">147</span> m_manifestBuilder.addReferredPackage(Metadatas.findReferredPackages(metadata));<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> public void write(String resourcePath, byte[] resource) throws IOException {<a name="line.150"></a>
<span class="sourceLineNo">151</span> this.m_content.put(resourcePath, resource);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> public void close() throws IOException {<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> // Update the manifest<a name="line.156"></a>
<span class="sourceLineNo">157</span> Manifest updated = m_manifestBuilder.build(m_manifest);<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> // Create a new Jar file<a name="line.159"></a>
<span class="sourceLineNo">160</span> FileOutputStream fos = new FileOutputStream(m_target);<a name="line.160"></a>
<span class="sourceLineNo">161</span> JarOutputStream jos = new JarOutputStream(fos, updated);<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> try {<a name="line.163"></a>
<span class="sourceLineNo">164</span> // Copy classes and resources<a name="line.164"></a>
<span class="sourceLineNo">165</span> List&lt;JarEntry&gt; entries = Collections.list(m_source.entries());<a name="line.165"></a>
<span class="sourceLineNo">166</span> for (JarEntry entry : entries) {<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> // Ignore some entries (MANIFEST, ...)<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (isIgnored(entry)) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> continue;<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> if (isUpdated(entry)) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> // Write newer/updated resource (manipulated classes, ...)<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> JarEntry je = new JarEntry(entry.getName());<a name="line.176"></a>
<span class="sourceLineNo">177</span> byte[] data = m_content.get(getInternalPath(entry.getName()));<a name="line.177"></a>
<span class="sourceLineNo">178</span> jos.putNextEntry(je);<a name="line.178"></a>
<span class="sourceLineNo">179</span> jos.write(data);<a name="line.179"></a>
<span class="sourceLineNo">180</span> jos.closeEntry();<a name="line.180"></a>
<span class="sourceLineNo">181</span> } else {<a name="line.181"></a>
<span class="sourceLineNo">182</span> // Copy the resource as-is<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> jos.putNextEntry(entry);<a name="line.184"></a>
<span class="sourceLineNo">185</span> InputStream is = m_source.getInputStream(entry);<a name="line.185"></a>
<span class="sourceLineNo">186</span> try {<a name="line.186"></a>
<span class="sourceLineNo">187</span> Streams.transfer(is, jos);<a name="line.187"></a>
<span class="sourceLineNo">188</span> } finally {<a name="line.188"></a>
<span class="sourceLineNo">189</span> Streams.close(is);<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> jos.closeEntry();<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> }<a name="line.195"></a>
<span class="sourceLineNo">196</span> } finally {<a name="line.196"></a>
<span class="sourceLineNo">197</span> try {<a name="line.197"></a>
<span class="sourceLineNo">198</span> m_source.close();<a name="line.198"></a>
<span class="sourceLineNo">199</span> } catch (IOException e) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> // Ignored<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> Streams.close(jos, fos);<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> private boolean isUpdated(JarEntry entry) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> // Check if that class was manipulated<a name="line.208"></a>
<span class="sourceLineNo">209</span> if (entry.getName().endsWith(".class")) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> // Need to map this into an external+normalized path<a name="line.210"></a>
<span class="sourceLineNo">211</span> String cleaned = getExternalName(entry.getName());<a name="line.211"></a>
<span class="sourceLineNo">212</span> return m_content.containsKey(cleaned);<a name="line.212"></a>
<span class="sourceLineNo">213</span> } else {<a name="line.213"></a>
<span class="sourceLineNo">214</span> return false;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> private boolean isIgnored(JarEntry entry) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> return "META-INF/MANIFEST.MF".equals(entry.getName());<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span>}<a name="line.221"></a>
</pre>
</div>
</body>
</html>