| <!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.extender.internal.processor;<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.extender.internal.BundleProcessor;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.felix.ipojo.extender.internal.declaration.DefaultInstanceDeclaration;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.felix.ipojo.extender.internal.declaration.DefaultTypeDeclaration;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.felix.ipojo.parser.ManifestMetadataParser;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.parser.ParseException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.felix.ipojo.util.Log;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.util.Logger;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.osgi.framework.Bundle;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.io.IOException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.*;<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> * Processor handling the {@link #IPOJO_HEADER} and {@link #IPOJO_HEADER_ALT}<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * header from the bundle manifest.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>public class ComponentsBundleProcessor implements BundleProcessor {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * iPOJO Component Type and Instance declaration header.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static final String IPOJO_HEADER = "iPOJO-Components";<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * iPOJO Component Type and Instance declaration header<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * (alternative).<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * This header was introduced because of BND supporting only header<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * starting with an uppercase.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static final String IPOJO_HEADER_ALT = "IPOJO-Components";<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * The attribute used in instance configuration specifying the targeted component (i.e. factory).<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public static final String COMPONENT_INSTANCE_ATTRIBUTE = "component";<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * The logger.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private final Log m_logger;<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> * Registry storing the bundle to components and instances declared within this bundle.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private final Map<Bundle, ComponentsAndInstances> m_registry = new HashMap<Bundle, ComponentsAndInstances>();<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> * Creates the component bundle processor.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> *<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param logger the logger.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public ComponentsBundleProcessor(Log logger) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> m_logger = logger;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * A bundle is starting.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> *<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param bundle the bundle<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public void activate(Bundle bundle) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> Dictionary dict = bundle.getHeaders();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> // Check bundle<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> String header = (String) dict.get(IPOJO_HEADER);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> // Check the alternative header<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> if (header == null) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> header = (String) dict.get(IPOJO_HEADER_ALT);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (header != null) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> try {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> parse(bundle, header);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> } catch (IOException e) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> m_logger.log(Logger.ERROR, "An exception occurs during the parsing of the bundle " + bundle.getBundleId(), e);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> } catch (ParseException e) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> m_logger.log(Logger.ERROR, "A parse exception occurs during the parsing of the bundle " + bundle.getBundleId(), e);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<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><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * A bundle is stopping.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> *<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param bundle the bundle<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public void deactivate(Bundle bundle) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> ComponentsAndInstances cai = m_registry.remove(bundle);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> if (cai != null) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> cai.stop();<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> /**<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * {@inheritDoc BundleProcessor#start}<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public void start() {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> // Nothing to do<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> /**<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * {@inheritDoc BundleProcessor#stop}<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <p/><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * This method cleans up all created factories and instances.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public void stop() {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> // Ignored, for a simple ordered shutdown, use ReverseBundleProcessor<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Parses the internal metadata (from the manifest<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * (in the iPOJO-Components property)). This methods<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * creates factories and add instances to the instance creator.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> *<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param bundle the owner bundle.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param components The iPOJO Header String.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @throws IOException if the manifest can not be found<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @throws ParseException if the parsing process failed<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> private void parse(Bundle bundle, String components) throws IOException, ParseException {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> ManifestMetadataParser parser = new ManifestMetadataParser();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> parser.parseHeader(components);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> // Get the component type declaration<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> Element[] metadata = parser.getComponentsMetadata();<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> for (int i = 0; i < metadata.length; i++) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> handleTypeDeclaration(bundle, metadata[i]);<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> Dictionary[] instances = parser.getInstances();<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> for (int i = 0; instances != null && i < instances.length; i++) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> handleInstanceDeclaration(bundle, instances[i]);<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> /**<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * Extracts and builds the declaration attached to an instance.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> *<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @param bundle the bundle declaring the instance<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param instance the instance configuration (parsed from the header)<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> private void handleInstanceDeclaration(Bundle bundle, Dictionary instance) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> String component = (String) instance.get(COMPONENT_INSTANCE_ATTRIBUTE);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> //String v = (String) instance.get(Factory.FACTORY_VERSION_PROPERTY); //TODO CES to GSA, why this is commented ?<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> DefaultInstanceDeclaration declaration = new DefaultInstanceDeclaration(bundle.getBundleContext(),<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> component, instance);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> declaration.start();<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> getComponentsAndInstances(bundle).m_instances.add(declaration);<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> /**<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * Adds a component factory to the factory list.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> *<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param metadata the new component metadata.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param bundle the bundle.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> private void handleTypeDeclaration(Bundle bundle, Element metadata) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> DefaultTypeDeclaration declaration = new DefaultTypeDeclaration(bundle.getBundleContext(), metadata);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> declaration.start();<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> getComponentsAndInstances(bundle).m_types.add(declaration);<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><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> /**<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * Gets the {@link ComponentsAndInstances} declared by the given bundle.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> *<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * @param bundle the bundle<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * @return the set of component and instances declared by the bundle, <code>null</code> otherwise<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> */<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> private ComponentsAndInstances getComponentsAndInstances(Bundle bundle) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> ComponentsAndInstances cai = m_registry.get(bundle);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> if (cai == null) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> cai = new ComponentsAndInstances();<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> m_registry.put(bundle, cai);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> return cai;<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> /**<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * Container storing the components and instances declared by a bundle.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * This class is not intended to be used outside from the current processor.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> */<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> private static class ComponentsAndInstances {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> List<DefaultTypeDeclaration> m_types = new ArrayList<DefaultTypeDeclaration>();<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> List<DefaultInstanceDeclaration> m_instances = new ArrayList<DefaultInstanceDeclaration>();<a name="line.213"></a> |
| <span class="sourceLineNo">214</span><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> /**<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * Stops all declarations.<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> */<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> void stop() {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> for (DefaultInstanceDeclaration instance : m_instances) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> instance.stop();<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> for (DefaultTypeDeclaration declaration : m_types) {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> declaration.stop();<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> m_instances.clear();<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> m_types.clear();<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span><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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |