| <!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 java.io.File;<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>import java.util.Map;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.manipulator.ManipulationVisitor;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.felix.ipojo.manipulator.Pojoization;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.manipulator.ResourceStore;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.felix.ipojo.manipulator.metadata.AnnotationMetadataProvider;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.felix.ipojo.manipulator.metadata.CacheableMetadataProvider;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.felix.ipojo.manipulator.metadata.CompositeMetadataProvider;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.felix.ipojo.manipulator.metadata.FileMetadataProvider;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.felix.ipojo.manipulator.visitor.check.CheckFieldConsistencyVisitor;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.felix.ipojo.manipulator.visitor.writer.ManipulatedResourcesWriter;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import aQute.bnd.osgi.Analyzer;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import aQute.bnd.osgi.Resource;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import aQute.bnd.service.AnalyzerPlugin;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import aQute.bnd.service.Plugin;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import aQute.service.reporter.Reporter;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span>/**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * A {@code BndIpojoPlugin} is ...<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> *<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>public class PojoizationPlugin implements Plugin, AnalyzerPlugin {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private static final String PROPERTY_METADATA = "metadata";<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private static final String PROPERTY_USE_LOCAL_SCHEMAS = "use-local-schemas";<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private static final String PROPERTY_INCLUDE_EMBED_BUNDLES = "include-embed-bundles";<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private static final String DEFAULT_METADATA = "META-INF/metadata.xml";<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> private static final boolean DEFAULT_USE_LOCAL_SCHEMAS = false;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private static final boolean DEFAULT_INCLUDE_EMBED_BUNDLES = false;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private String m_metadata = DEFAULT_METADATA;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private boolean m_useLocalSchemas = DEFAULT_USE_LOCAL_SCHEMAS;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private boolean m_includeEmbedBundles = DEFAULT_INCLUDE_EMBED_BUNDLES;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private Reporter m_reporter;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public void setProperties(Map<String, String> configuration) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> // Use metadata file if any<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> if (configuration.containsKey(PROPERTY_METADATA)) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> m_metadata = configuration.get(PROPERTY_METADATA);<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> // Use local schemas ?<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> if (configuration.containsKey(PROPERTY_USE_LOCAL_SCHEMAS)) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> m_useLocalSchemas = true;<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> // Process embed bundles ?<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> if (configuration.containsKey(PROPERTY_INCLUDE_EMBED_BUNDLES)) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> m_includeEmbedBundles = true;<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><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public void setReporter(Reporter reporter) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> m_reporter = reporter;<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> public boolean analyzeJar(Analyzer analyzer) throws Exception {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> long start = System.currentTimeMillis();<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> // Wraps the Bnd Reporter<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> BndReporter reporter = new BndReporter(this.m_reporter);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> // Build ResourceStore<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> BndJarResourceStore store = new BndJarResourceStore(analyzer, this.m_reporter);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> store.setIncludeEmbedComponents(m_includeEmbedBundles);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> CompositeMetadataProvider provider = buildMetadataProvider(analyzer, reporter, store);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> // Quick exit<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> CacheableMetadataProvider cache = new CacheableMetadataProvider(provider);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (cache.getMetadatas().isEmpty() && !hasEmbedComponents(analyzer)) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return false;<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> manipulateComponents(reporter, store, cache);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> int nbComponents = findElements(cache.getMetadatas(), "component").size();<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> int nbHandlers = findElements(cache.getMetadatas(), "handler").size();<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this.m_reporter.trace("iPOJO manipulation performed performed in %s ms (%d components, %d handlers).",<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> (System.currentTimeMillis() - start),<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> nbComponents,<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> nbHandlers);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> // Return true if a new run should be performed after the analyze<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return false;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> protected void manipulateComponents(BndReporter reporter, BndJarResourceStore store, CacheableMetadataProvider cache) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> Pojoization pojoization = new Pojoization(reporter);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> pojoization.disableAnnotationProcessing();<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> if (m_useLocalSchemas) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> pojoization.setUseLocalXSD();<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> pojoization.pojoization(store, cache, createVisitor(store, reporter));<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> protected CompositeMetadataProvider buildMetadataProvider(Analyzer analyzer, BndReporter reporter, BndJarResourceStore store) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> // Build MetadataProvider<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> CompositeMetadataProvider provider = new CompositeMetadataProvider(reporter);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> File file = new File(m_metadata);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> if (file.exists()) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> // Absolute file system resource<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> FileMetadataProvider fmp = new FileMetadataProvider(file, reporter);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> fmp.setValidateUsingLocalSchemas(m_useLocalSchemas);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> provider.addMetadataProvider(fmp);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> } else {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> // In archive resource<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> Resource resource = analyzer.getJar().getResource(m_metadata);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> if (resource != null) {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> ResourceMetadataProvider rmp = new ResourceMetadataProvider(resource, reporter);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> rmp.setValidateUsingLocalSchemas(m_useLocalSchemas);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> provider.addMetadataProvider(rmp);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> provider.addMetadataProvider(new AnnotationMetadataProvider(store, reporter));<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return provider;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> private boolean hasEmbedComponents(Analyzer analyzer) throws Exception {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> // We want to process components from embed jars ?<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return m_includeEmbedBundles && Manifests.hasEmbedComponents(analyzer);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><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> private List<Element> findElements(List<Element> metadatas, String name) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> List<Element> found = new ArrayList<Element>();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> for (Element element : metadatas) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> if (name.equalsIgnoreCase(element.getName())) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> found.add(element);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return found;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> protected ManipulationVisitor createVisitor(ResourceStore store, BndReporter reporter) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> ManipulatedResourcesWriter writer = new ManipulatedResourcesWriter();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> writer.setReporter(reporter);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> writer.setResourceStore(store);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> CheckFieldConsistencyVisitor checkFieldConsistencyVisitor = new CheckFieldConsistencyVisitor(writer);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> checkFieldConsistencyVisitor.setReporter(reporter);<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return checkFieldConsistencyVisitor;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span>}<a name="line.178"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
