| <!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;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.felix.ipojo.manipulation.InnerClassManipulator;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.manipulation.Manipulator;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * A {@code ManipulationEngine} is responsible to drive the component's<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * classes manipulation.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> */<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public class ManipulationEngine {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> /**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * List of component types.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private List<ManipulationUnit> m_manipulationUnits = new ArrayList<ManipulationUnit>();<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Error reporting.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private Reporter m_reporter;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Bytecode store.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private ResourceStore m_store;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * The visitor handling output result.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private ManipulationVisitor m_manipulationVisitor;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Add information related to a discovered component that will be manipulated.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param component additional component<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> public void addManipulationUnit(ManipulationUnit component) {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> m_manipulationUnits.add(component);<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 void setManipulationVisitor(ManipulationVisitor manipulationVisitor) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> m_manipulationVisitor = manipulationVisitor;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param reporter Feedback reporter.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public void setReporter(Reporter reporter) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> m_reporter = reporter;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<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> * Provides the bytecode store that allows to retrieve bytecode of the<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * component's related resources (inner classes for example).<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param store Helps to locate bytecode for classes.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public void setResourceStore(ResourceStore store) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> m_store = store;<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> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Manipulates classes of all the given component's.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> public void generate() {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> // Iterates over the list of discovered components<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> // Note that this list includes components from metadata.xml AND from annotations<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> for (ManipulationUnit info : m_manipulationUnits) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> byte[] bytecode;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> try {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> bytecode = m_store.read(info.getResourcePath());<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> } catch (IOException e) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> m_reporter.error("Cannot find bytecode for class '" + info.getClassName() + "': no bytecode found.");<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> return;<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> // Is the visitor interested in this component ?<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> ManipulationResultVisitor result = m_manipulationVisitor.visitManipulationResult(info.getComponentMetadata());<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> if (result != null) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> // Should always be the case<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> // Manipulate the original bytecode and store the modified one<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> Manipulator manipulator = new Manipulator();<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> try {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> byte[] out = manipulator.manipulate(bytecode);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> // Call the visitor<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> result.visitClassStructure(manipulator.getManipulationMetadata());<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> result.visitManipulatedResource(info.getResourcePath(), out);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> } catch (IOException e) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> m_reporter.error("Cannot manipulate the class " + info.getClassName() + " : " + e.getMessage());<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> return;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<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> // Visit inner classes<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> for (String inner : manipulator.getInnerClasses()) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> // Get the bytecode and start manipulation<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> String resourcePath = inner + ".class";<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> String outerClassInternalName = info.getClassName().replace('.', '/');<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> byte[] innerClassBytecode;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> try {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> innerClassBytecode = m_store.read(resourcePath);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> } catch (IOException e) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> m_reporter.error("Cannot find inner class '" + resourcePath + "'");<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return;<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> // Manipulate inner class<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> // Notice that (for performance reason) re-use the class version information<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> // discovered in the main class instead of re-parsing the inner class to find<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> // its own class version<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> try {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> InnerClassManipulator innerManipulator = new InnerClassManipulator(outerClassInternalName, manipulator.getFields().keySet());<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> byte[] manipulated = innerManipulator.manipulate(innerClassBytecode, manipulator.getClassVersion());<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> // Propagate manipulated resource<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> result.visitManipulatedResource(resourcePath, manipulated);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> } catch (IOException e) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> m_reporter.error("Cannot manipulate inner class '" + resourcePath + "'");<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> return;<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><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // All resources have been manipulated for this component<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> result.visitEnd();<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> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span>}<a name="line.155"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
