| <!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>package org.apache.felix.ipojo;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.felix.ipojo.architecture.ComponentTypeDescription;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.felix.ipojo.parser.ParseUtils;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.felix.ipojo.parser.PojoMetadata;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.felix.ipojo.util.Log;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.util.Logger;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.felix.ipojo.util.Tracker;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.util.TrackerCustomizer;<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>import org.osgi.framework.BundleContext;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.osgi.framework.InvalidSyntaxException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.osgi.framework.ServiceReference;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.security.ProtectionDomain;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.*;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span>/**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * The component factory manages component instance objects. This management<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * consists to create and manage component instances build with the current<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * component factory. If the factory is public a {@link Factory} service is exposed.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @see org.apache.felix.ipojo.Factory<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @see org.apache.felix.ipojo.IPojoFactory<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>public class ComponentFactory extends IPojoFactory implements TrackerCustomizer {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * System property set to automatically attach primitive handlers to primitive<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * component types.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * The value is a String parsed as a list (comma separated). Each element is<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * the fully qualified name of the handler <code>namespace:name</code>.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public static final String HANDLER_AUTO_PRIMITIVE = "org.apache.felix.ipojo.handler.auto.primitive";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * The tracker used to track required handler factories.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Immutable once set.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> protected Tracker m_tracker;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * The class loader to delegate classloading.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Immutable once set.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private FactoryClassloader m_classLoader;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * The component implementation class.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * (manipulated byte array)<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private byte[] m_clazz;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * The component implementation qualified class name.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Immutable once set.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * This attribute is set during the creation of the factory.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private String m_classname;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * The manipulation metadata of the implementation class.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * Immutable once set.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * This attribute is set during the creation of the factory.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private PojoMetadata m_manipulation;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * A flag enabling / disabling the use of the Factory classloader to define the class.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * This flag must be enabled if the component class was manipulated on the fly.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private boolean m_useFactoryClassloader = false;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Creates a instance manager factory.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * The class is given in parameter. The component type is not a composite.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> *<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param context the bundle context<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param clazz the component class<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param element the metadata of the component<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @throws ConfigurationException if the element describing the factory is malformed.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public ComponentFactory(BundleContext context, byte[] clazz, Element element) throws ConfigurationException {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> this(context, element);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> m_clazz = clazz;<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> * Creates a instance manager factory.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> *<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param context the bundle context<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param element the metadata of the component to create<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @throws ConfigurationException if element describing the factory is malformed.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public ComponentFactory(BundleContext context, Element element) throws ConfigurationException {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> super(context, element);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> check(element); // NOPMD. This invocation is normal.<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> * Sets the flag enabling / disabling the factory classloader.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> *<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param use <code>true</code> enables the factory classloader.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public void setUseFactoryClassloader(boolean use) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> m_useFactoryClassloader = use;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<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> * Gets the component type description of the current factory.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> *<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @return the description of the component type attached to this factory.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @see org.apache.felix.ipojo.IPojoFactory#getComponentTypeDescription()<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public ComponentTypeDescription getComponentTypeDescription() {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return new PrimitiveTypeDescription(this);<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> * Allows a factory to check if the given element is well-formed.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * A component factory metadata is correct if they contain the 'classname' attribute.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * As this method is called from the (single-threaded) constructor, no synchronization is needed.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> *<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @param element the metadata describing the component<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @throws ConfigurationException if the element describing the factory is malformed.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public void check(Element element) throws ConfigurationException {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> m_classname = element.getAttribute("classname");<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> if (m_classname == null) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> throw new ConfigurationException("A component needs a class name : " + element);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> m_manipulation = new PojoMetadata(m_componentMetadata);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<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> * Gets the class name.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * No synchronization needed, the classname is immutable.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @return the class name.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @see org.apache.felix.ipojo.IPojoFactory#getClassName()<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public String getClassName() {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return m_classname;<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> /**<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * Creates a primitive instance.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * This method is called when holding the lock.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> *<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param config the instance configuration<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @param context the service context (null if the instance has to be created in the global space).<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @param handlers the handlers to attach to the instance<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return the created instance<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @throws org.apache.felix.ipojo.ConfigurationException<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * if the configuration process failed.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @see org.apache.felix.ipojo.IPojoFactory#createInstance(java.util.Dictionary, org.apache.felix.ipojo.IPojoContext, org.apache.felix.ipojo.HandlerManager[])<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> */<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> public ComponentInstance createInstance(Dictionary config, IPojoContext context, HandlerManager[] handlers) throws org.apache.felix.ipojo.ConfigurationException {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> InstanceManager instance = new InstanceManager(this, context, handlers);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> try {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> instance.configure(m_componentMetadata, config);<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> instance.start();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> return instance;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> } catch (ConfigurationException e) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> // An exception occurs while executing the configure or start<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> // methods, the instance is stopped so the architecture service is still published and so we can debug<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> // the issue.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> instance.stop();<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> throw e;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> } catch (Throwable e) { // All others exception are handled here.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> // As for the previous case, the instance is stopped.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> instance.stop();<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> m_logger.log(Logger.INFO, "An error occurred when creating an instance of " + getFactoryName(), e);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> throw new ConfigurationException(e.getMessage(), e);<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<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> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * Defines a class.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * This method needs to be synchronized to avoid that the classloader<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * is created twice.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * This method delegates the <code>define</code> method invocation to the<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * factory classloader.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> *<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @param name the qualified name of the class<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @param clazz the byte array of the class<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * @param domain the protection domain of the class<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @return the defined class object<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> */<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> public synchronized Class<? extends Object> defineClass(String name, byte[] clazz, ProtectionDomain domain) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (!m_useFactoryClassloader) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> m_logger.log(Log.WARNING, "A class definition was required even without the factory classloader enabled");<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> if (m_classLoader == null) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> m_classLoader = new FactoryClassloader(this);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> return m_classLoader.defineClass(name, clazz, domain);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> /**<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Loads a class. This method checks if the class<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * to load is the implementation class or not.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * If it is, the factory classloader is used, else<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * the {@link Bundle#loadClass(String)} is called.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> *<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * The implementation class is loaded using the factory classloader only if the factory classloader was enabled<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> *<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @param className the name of the class to load<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @return the resulting Class object<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @throws ClassNotFoundException if the class is not found<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * @see #setUseFactoryClassloader(boolean)<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> */<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> public Class loadClass(String className) throws ClassNotFoundException {<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> if (m_useFactoryClassloader && m_clazz != null && m_classname.equals(className)) { // Immutable fields.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return defineClass(className, m_clazz, null);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> return m_context.getBundle().loadClass(className);<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> * Starts the factory.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * This method is not called when holding the monitor lock.<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> */<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> public void starting() {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> if (m_tracker == null) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> if (m_requiredHandlers.size() != 0) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> try {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> String filter = "(&(" + Handler.HANDLER_TYPE_PROPERTY + "=" + PrimitiveHandler.HANDLER_TYPE + ")" + "(factory.state=1)" + ")";<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> m_tracker = new Tracker(m_context, m_context.createFilter(filter), this);<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> m_tracker.open();<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> } catch (InvalidSyntaxException e) {<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> m_logger.log(Logger.ERROR, "A factory filter is not valid: " + e.getMessage()); //Holding the lock should not be an issue here.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> stop();<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> }<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> // Else, the tracking has already started.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> /**<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * Stops all the instance managers.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * This method is called when holding the lock.<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> */<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> public void stopping() {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> if (m_tracker != null) {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> m_tracker.close();<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> m_tracker = null;<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> /**<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * Computes the factory name. The factory name is computed from<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * the 'name' and 'classname' attributes.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * This method does not manipulate any non-immutable fields,<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * so does not need to be synchronized.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> *<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * @return the factory name.<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> */<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> public String getFactoryName() {<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> String name = m_componentMetadata.getAttribute("name");<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> if (name == null) {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> // No factory name, use the classname (mandatory attribute)<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> name = m_componentMetadata.getAttribute("classname");<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return name;<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> }<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> /**<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * Computes required handlers.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * This method does not manipulate any non-immutable fields,<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * so does not need to be synchronized.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * This method checks the {@link ComponentFactory#HANDLER_AUTO_PRIMITIVE}<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * system property to add the listed handlers to the required handler set.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> *<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @return the required handler list.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> */<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> public List<RequiredHandler> getRequiredHandlerList() {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> List<RequiredHandler> list = new ArrayList<RequiredHandler>();<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> Element[] elems = m_componentMetadata.getElements();<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> for (Element current : elems) {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> if (!"manipulation".equals(current.getName())) { // Remove the manipulation element<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> RequiredHandler req = new RequiredHandler(current.getName(), current.getNameSpace());<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> if (!list.contains(req)) {<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> list.add(req);<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> }<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> }<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> }<a name="line.306"></a> |
| <span class="sourceLineNo">307</span><a name="line.307"></a> |
| <span class="sourceLineNo">308</span> // Add architecture if architecture != 'false'<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> String arch = m_componentMetadata.getAttribute("architecture");<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> if (arch == null || arch.equalsIgnoreCase("true")) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> list.add(new RequiredHandler("architecture", null));<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span><a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> // Determine if the component must be immediate.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> // A component becomes immediate if it doesn't provide a service,<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> // and does not specified that the component is not immediate.<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> if (m_componentMetadata.getElements("provides") == null) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> String imm = m_componentMetadata.getAttribute("immediate");<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> if (imm == null) { // immediate not specified, set the immediate attribute to true<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> getLogger().log(<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> Logger.INFO,<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> "The component type " + getFactoryName()<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> + " becomes immediate");<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> m_componentMetadata.addAttribute(new Attribute("immediate",<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> "true"));<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> // Add lifecycle callback if immediate = true<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> RequiredHandler reqCallback = new RequiredHandler("callback", null);<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> String imm = m_componentMetadata.getAttribute("immediate");<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> if (!list.contains(reqCallback) && imm != null && imm.equalsIgnoreCase("true")) {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> list.add(reqCallback);<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> }<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> // Manage auto attached handler.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> String v = System.getProperty(HANDLER_AUTO_PRIMITIVE);<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> if (v != null && v.length() != 0) {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> String[] hs = ParseUtils.split(v, ",");<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> for (String h1 : hs) {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> String h = h1.trim();<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> String[] segments = ParseUtils.split(h, ":");<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> RequiredHandler rq = null;<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> if (segments.length == 2) { // External handler<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> rq = new RequiredHandler(segments[1], segments[0]);<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> } else if (segments.length == 1) { // Core handler<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> rq = new RequiredHandler(segments[1], null);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> } // Others case are ignored.<a name="line.349"></a> |
| <span class="sourceLineNo">350</span><a name="line.350"></a> |
| <span class="sourceLineNo">351</span> if (rq != null) {<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> // Check it's not already contained<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> if (!list.contains(rq)) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> list.add(rq);<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> }<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> }<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> }<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> }<a name="line.358"></a> |
| <span class="sourceLineNo">359</span><a name="line.359"></a> |
| <span class="sourceLineNo">360</span> return list;<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> /**<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * This method is called when a new handler factory is detected.<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * Test if the factory can be used or not.<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * This method need to be synchronized as it accesses to the content<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * of required handlers.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> *<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @param reference the new service reference.<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @return <code>true</code> if the given factory reference matches with a required handler.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#addingService(org.osgi.framework.ServiceReference)<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> */<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> public synchronized boolean addingService(ServiceReference reference) {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> for (int i = 0; i < m_requiredHandlers.size(); i++) {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> RequiredHandler req = (RequiredHandler) m_requiredHandlers.get(i);<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> if (req.getReference() == null && match(req, reference)) {<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> int oldP = req.getLevel();<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> req.setReference(reference);<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> // If the priority has changed, sort the list.<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> if (oldP != req.getLevel()) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> // Manipulate the list.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> Collections.sort(m_requiredHandlers);<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> }<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> return true;<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> }<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> }<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> return false;<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> /**<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * This method is called when a matching service has been added to the tracker,<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * we can no compute the factory state. This method is synchronized to avoid<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * concurrent calls to method modifying the factory state.<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> *<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * @param reference the added service reference.<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#addedService(org.osgi.framework.ServiceReference)<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> */<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> public synchronized void addedService(ServiceReference reference) {<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> if (m_state == INVALID) {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> computeFactoryState();<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> }<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> /**<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * This method is called when a used handler factory disappears.<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * This method is synchronized to avoid concurrent calls to method modifying<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * the factory state.<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> *<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * @param reference the leaving service reference.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @param service the handler factory object.<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#removedService(org.osgi.framework.ServiceReference, java.lang.Object)<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> */<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> public synchronized void removedService(ServiceReference reference, Object service) {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> // Look for the implied reference and invalid the handler identifier<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> for (Object m_requiredHandler : m_requiredHandlers) {<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> RequiredHandler req = (RequiredHandler) m_requiredHandler;<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> if (reference.equals(req.getReference())) {<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> req.unRef(); // This method will unget the service.<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> computeFactoryState();<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> return; // The factory can be used only once.<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> }<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> }<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> }<a name="line.423"></a> |
| <span class="sourceLineNo">424</span><a name="line.424"></a> |
| <span class="sourceLineNo">425</span> /**<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * This method is called when a used handler factory is modified.<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * However, handler factory modification is not possible, so this method<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * is never called.<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> *<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * @param reference the service reference<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * @param service the Factory object (if already get)<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#modifiedService(org.osgi.framework.ServiceReference, java.lang.Object)<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> */<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> public void modifiedService(ServiceReference reference, Object service) {<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> // Noting to do<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> }<a name="line.436"></a> |
| <span class="sourceLineNo">437</span><a name="line.437"></a> |
| <span class="sourceLineNo">438</span> /**<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * Returns manipulation metadata of this component type.<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> *<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> * @return manipulation metadata of this component type.<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> */<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> public PojoMetadata getPojoMetadata() {<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> return m_manipulation;<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> }<a name="line.445"></a> |
| <span class="sourceLineNo">446</span><a name="line.446"></a> |
| <span class="sourceLineNo">447</span> /**<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * Gets the version of the component type.<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> *<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> * @return the version of <code>null</code> if not set.<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> * @see org.apache.felix.ipojo.Factory#getVersion()<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> */<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> public String getVersion() {<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> return m_version;<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> }<a name="line.455"></a> |
| <span class="sourceLineNo">456</span><a name="line.456"></a> |
| <span class="sourceLineNo">457</span> public ClassLoader getBundleClassLoader() {<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> return m_classLoader;<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> }<a name="line.459"></a> |
| <span class="sourceLineNo">460</span><a name="line.460"></a> |
| <span class="sourceLineNo">461</span>}<a name="line.461"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
