| <!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 static java.lang.String.format;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.felix.ipojo.architecture.ComponentTypeDescription;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.felix.ipojo.architecture.PropertyDescription;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.felix.ipojo.extender.internal.Extender;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.util.Log;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.felix.ipojo.util.Logger;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.util.SecurityHelper;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.osgi.framework.BundleContext;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.osgi.framework.Constants;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.osgi.framework.ServiceReference;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.osgi.framework.ServiceRegistration;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.osgi.service.cm.ManagedServiceFactory;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.*;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>/**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * This class defines common mechanisms of iPOJO component factories<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * (i.e. component type).<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * The factory is also tracking Factory configuration from the configuration admin to created / delete and update<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * instances from this factory.<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 abstract class IPojoFactory implements Factory {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /*<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * TODO there is potentially an issue when calling FactoryStateListener callbacks with the lock<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * It should be called by a separate thread dispatching events to listeners.<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> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * The list of the managed instance name.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * This list is shared by all factories and is used to assert name uniqueness.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> protected static final List<String> INSTANCE_NAME = Collections.synchronizedList(new ArrayList<String>());<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * The component type description exposed by the {@link Factory} service.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> protected ComponentTypeDescription m_componentDesc;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * The list of the managed instance managers.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * The key of this map is the name (i.e. instance names) of the created instance<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> protected final Map<String, ComponentInstance> m_componentInstances = new ConcurrentHashMap<String, ComponentInstance>();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * The component type metadata.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> protected final Element m_componentMetadata;<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> * The bundle context reference.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> protected final BundleContext m_context;<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> * The factory name.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Could be the component class name if the factory name is not set.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Immutable once set.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> protected String m_factoryName;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * The list of required handlers.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> protected final List<RequiredHandler> m_requiredHandlers = new ArrayList<RequiredHandler>();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /**<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * The list of factory state listeners.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @see FactoryStateListener<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> protected List<FactoryStateListener> m_listeners = new ArrayList<FactoryStateListener>(1);<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> * The logger for the factory.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> protected final Logger m_logger;<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> * Is the factory public (exposed as services).<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> */<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> protected final boolean m_isPublic;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * The version of the component type.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> protected final String m_version;<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> * The service registration of this factory (Factory & ManagedServiceFactory).<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @see ManagedServiceFactory<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @see Factory<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> protected ServiceRegistration m_sr;<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> * The factory state.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * Can be:<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <li>{@link Factory#INVALID}</li><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * <li>{@link Factory#VALID}</li><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * The factory is invalid at the beginning.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * A factory becomes valid if every required handlers<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * are available (i.e. can be created).<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> protected int m_state = Factory.INVALID;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> /**<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * The flag indicating if this factory has already a<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * computed description or not.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> */<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> private boolean m_described;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Generates a unique instance name if not provided by the configuration.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> private final NameGenerator m_generator = new RetryNameGenerator(new DefaultNameGenerator());<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Creates an iPOJO Factory.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * At the end of this method, the required set of handler is computed.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * But the result is computed by a sub-class.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @param context the bundle context of the bundle containing the factory.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param metadata the description of the component type.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @throws ConfigurationException if the element describing the factory is malformed.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> public IPojoFactory(BundleContext context, Element metadata) throws ConfigurationException {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> m_context = context;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> m_componentMetadata = metadata;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> m_factoryName = getFactoryName();<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> String fac = metadata.getAttribute("public");<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> m_isPublic = fac == null || !fac.equalsIgnoreCase("false");<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> m_logger = new Logger(m_context, m_factoryName);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> // Compute the component type version.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> String version = metadata.getAttribute("version");<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> if ("bundle".equalsIgnoreCase(version)) { // Handle the "bundle" constant: use the bundle version.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> // The cast is necessary in KF.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> m_version = (String) m_context.getBundle().getHeaders().get(Constants.BUNDLE_VERSION);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> } else {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> m_version = version;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> m_requiredHandlers.addAll(getRequiredHandlerList()); // Call sub-class to get the list of required handlers.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> m_logger.log(Logger.INFO, "New factory created : " + m_factoryName);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Gets the component type description.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @return the component type description<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> */<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> public ComponentTypeDescription getComponentTypeDescription() {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return new ComponentTypeDescription(this);<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> /**<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * Adds a factory listener.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @param listener the factory listener to add.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @see org.apache.felix.ipojo.Factory#addFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> public void addFactoryStateListener(FactoryStateListener listener) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> synchronized (this) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> m_listeners.add(listener);<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> /**<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * Gets the logger used by instances created by the current factory.<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * @return the factory logger.<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> */<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> public Logger getLogger() {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> return m_logger;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span><a name="line.200"></a> |
| <span class="sourceLineNo">201</span> /**<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * Computes the factory name.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * Each sub-type must override this method.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @return the factory name.<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> */<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> public abstract String getFactoryName();<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> /**<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * Computes the required handler list.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * Each sub-type must override this method.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @return the required handler list<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @throws ConfigurationException when the list of handler cannot be computed.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> */<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> public abstract List<RequiredHandler> getRequiredHandlerList() throws ConfigurationException;<a name="line.214"></a> |
| <span class="sourceLineNo">215</span><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> /**<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * Creates an instance.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * This method is called with the monitor lock.<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * @param config the instance configuration<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * @param context the iPOJO context to use<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @param handlers the handler array to use<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @return the new component instance.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @throws ConfigurationException if the instance creation failed during the configuration process.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> */<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> public abstract ComponentInstance createInstance(Dictionary config, IPojoContext context, HandlerManager[] handlers)<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> throws ConfigurationException;<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> * Creates an instance.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * This method creates the instance in the global context.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @param configuration the configuration of the created instance.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @return the created component instance.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @throws UnacceptableConfiguration if the given configuration is not consistent with the component type of this factory.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @throws MissingHandlerException if an handler is unavailable when the instance is created.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @throws org.apache.felix.ipojo.ConfigurationException if the instance or type configuration are not correct.<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @see org.apache.felix.ipojo.Factory#createComponentInstance(java.util.Dictionary)<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> */<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> public ComponentInstance createComponentInstance(Dictionary configuration) throws UnacceptableConfiguration, MissingHandlerException,<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> ConfigurationException {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> return createComponentInstance(configuration, null);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> /**<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * Creates an instance in the specified service context.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * This method is synchronized to assert the validity of the factory during the creation.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * Callbacks to sub-class and created instances need to be aware that they are holding the monitor lock.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * This method call the override {@link IPojoFactory#createInstance(Dictionary, IPojoContext, HandlerManager[])}<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * method.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @param configuration the configuration of the created instance.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @param serviceContext the service context to push for this instance.<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * @return the created component instance.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * @throws UnacceptableConfiguration if the given configuration is not consistent with the component type of this factory.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * @throws MissingHandlerException if an handler is unavailable when creating the instance.<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * @throws org.apache.felix.ipojo.ConfigurationException if the instance configuration failed.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * @see org.apache.felix.ipojo.Factory#createComponentInstance(java.util.Dictionary)<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> */<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> public synchronized ComponentInstance createComponentInstance(Dictionary configuration, ServiceContext serviceContext) throws UnacceptableConfiguration, // NOPMD<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> MissingHandlerException, ConfigurationException {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> if (configuration == null) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> configuration = new Properties();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> IPojoContext context;<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> if (serviceContext == null) {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> context = new IPojoContext(m_context);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> } else {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> context = new IPojoContext(m_context, serviceContext);<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> try {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> checkAcceptability(configuration);<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> } catch (UnacceptableConfiguration e) {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> m_logger.log(Logger.ERROR, "The configuration is not acceptable : " + e.getMessage());<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> throw new UnacceptableConfiguration("The configuration "<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> + configuration + " is not acceptable for " + m_factoryName<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> , e);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> }<a name="line.277"></a> |
| <span class="sourceLineNo">278</span><a name="line.278"></a> |
| <span class="sourceLineNo">279</span> // Find name in the configuration<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> String name = findInstanceName(configuration);<a name="line.280"></a> |
| <span class="sourceLineNo">281</span><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> // Execute name generation and verification in a synchronized block to ensure uniqueness<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> synchronized (INSTANCE_NAME) {<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> if (name != null) {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> // Needs to ensure name uniqueness<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> if (INSTANCE_NAME.contains(name)) {<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> // name already in use, try to append factory's version<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> if (m_version != null) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> name = name + "-" + m_version;<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> if (INSTANCE_NAME.contains(name)) {<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> // It's still not unique<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> // We've done our best: throw an Exception<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> throw new UnacceptableConfiguration(format("%s : Instance name (suffixed with factory's version) \"%s\" is already used", getFactoryName(), name));<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> } else {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> // No version provided: we cannot do more<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> throw new UnacceptableConfiguration(format("%s : Instance name (provided by the instance) \"%s\" is already used", getFactoryName(), name));<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> } else {<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> // Generated name is always unique, no verification required<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> name = m_generator.generate(this, INSTANCE_NAME);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> // Reserve name<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> INSTANCE_NAME.add(name);<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> // Update name in configuration<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> configuration.put(Factory.INSTANCE_NAME_PROPERTY, name);<a name="line.310"></a> |
| <span class="sourceLineNo">311</span><a name="line.311"></a> |
| <span class="sourceLineNo">312</span> // Here we are sure to be valid until the end of the method.<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> HandlerManager[] handlers = new HandlerManager[m_requiredHandlers.size()];<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> for (int i = 0; i < handlers.length; i++) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> handlers[i] = getHandler(m_requiredHandlers.get(i), serviceContext);<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> try {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> ComponentInstance instance = createInstance(configuration, context, handlers);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> m_componentInstances.put(name, instance);<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> m_logger.log(Logger.INFO, "Instance " + name + " from factory " + m_factoryName + " created");<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> // Register the instance on the ConfigurationTracker to be updated if needed.<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> ConfigurationTracker.get().instanceCreated(instance);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> return instance;<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> } catch (ConfigurationException e) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> INSTANCE_NAME.remove(name);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> m_logger.log(Logger.ERROR, e.getMessage());<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> throw new ConfigurationException(e.getMessage(), e, m_factoryName);<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span><a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> private String findInstanceName(final Dictionary configuration) {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> String name;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> if (configuration.get(Factory.INSTANCE_NAME_PROPERTY) == null && configuration.get("name") == null) {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> // No name provided<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> name = null;<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> } else {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> // Support both instance.name & name<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> name = (String) configuration.get(Factory.INSTANCE_NAME_PROPERTY);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> if (name == null) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> name = (String) configuration.get("name");<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> getLogger().log(Logger.WARNING, "The 'name' (" + name + ") attribute, used as the instance name, is deprecated, please use the 'instance.name' attribute");<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> }<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> return name;<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> /**<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * Gets the bundle context of the factory.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @return the bundle context of the factory.<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @see org.apache.felix.ipojo.Factory#getBundleContext()<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> */<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> public BundleContext getBundleContext() {<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> return m_context;<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> * Gets the factory class name.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * @return the factory class name.<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @see org.apache.felix.ipojo.Factory#getClassName()<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> */<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> public abstract String getClassName();<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> /**<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * Gets the component type description.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * @return the component type description object. <code>Null</code> if not already computed.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> */<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> public ComponentTypeDescription getComponentDescription() {<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> return m_componentDesc;<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> }<a name="line.372"></a> |
| <span class="sourceLineNo">373</span><a name="line.373"></a> |
| <span class="sourceLineNo">374</span> /**<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * Gets the component type description (Element-Attribute form).<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * @return the component type description.<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * @see org.apache.felix.ipojo.Factory#getDescription()<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> */<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> public Element getDescription() {<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> // Can be null, if not already computed.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> if (m_componentDesc == null) {<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> return new Element("No description available for " + m_factoryName, "");<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> }<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> return m_componentDesc.getDescription();<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> /**<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * Gets the component metadata.<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * @return the component metadata<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * @see org.apache.felix.ipojo.Factory#getComponentMetadata()<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> */<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> public Element getComponentMetadata() {<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> return m_componentMetadata;<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span><a name="line.395"></a> |
| <span class="sourceLineNo">396</span> /**<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * Gets the list of instances created by the factory. The instances must be still alive.<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> *<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * @return the list of created (and living) instances<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @since 1.11.0<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> */<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> public List<ComponentInstance> getInstances() {<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> // m_componentInstances is a concurrent hashmap, we can create retrieve values directly.<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> return new ArrayList<ComponentInstance>(m_componentInstances.values());<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> /**<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * Gets the list of the names of the instances created by the factory. The instances must be still alive.<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> *<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @return the list of the names of created (and living) instances<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * @since 1.11.0<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> */<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> public List<String> getInstancesNames() {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> // m_componentInstances is a concurrent hashmap, we can create retrieve values directly.<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> return new ArrayList<String>(m_componentInstances.keySet());<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> }<a name="line.416"></a> |
| <span class="sourceLineNo">417</span><a name="line.417"></a> |
| <span class="sourceLineNo">418</span> /**<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * Computes the list of missing handlers.<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * @return the list of missing handlers.<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * @see org.apache.felix.ipojo.Factory#getMissingHandlers()<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> */<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> public List<String> getMissingHandlers() {<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> List<String> list = new ArrayList<String>();<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> for (RequiredHandler req : m_requiredHandlers) {<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> if (req.getReference() == null) {<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> list.add(req.getFullName());<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> }<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> }<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> return list;<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> }<a name="line.431"></a> |
| <span class="sourceLineNo">432</span><a name="line.432"></a> |
| <span class="sourceLineNo">433</span> /**<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * Gets the factory name.<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * This name is immutable once set.<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> * @return the factory name.<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * @see org.apache.felix.ipojo.Factory#getName()<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> */<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> public String getName() {<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> return m_factoryName;<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> }<a name="line.441"></a> |
| <span class="sourceLineNo">442</span><a name="line.442"></a> |
| <span class="sourceLineNo">443</span> /**<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * Gets the list of required handlers.<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * The required handler list cannot change.<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * @return the list of required handlers.<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * @see org.apache.felix.ipojo.Factory#getRequiredHandlers()<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> */<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> public List<String> getRequiredHandlers() {<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> List<String> list = new ArrayList<String>();<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> for (RequiredHandler req : m_requiredHandlers) {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> list.add(req.getFullName());<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> }<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> return list;<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> /**<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> * Gets the actual factory state.<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * Must be synchronized as this state is dependent of handler availability.<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * @return the actual factory state.<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * @see org.apache.felix.ipojo.Factory#getState()<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> */<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> public synchronized int getState() {<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> return m_state;<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> }<a name="line.465"></a> |
| <span class="sourceLineNo">466</span><a name="line.466"></a> |
| <span class="sourceLineNo">467</span> /**<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * Gets a component instance created by the current factory.<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> * @param name the instance name<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> * @return the component instance, {@literal null} if not found<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> */<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> public ComponentInstance getInstanceByName(String name) {<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> return m_componentInstances.get(name);<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> }<a name="line.474"></a> |
| <span class="sourceLineNo">475</span><a name="line.475"></a> |
| <span class="sourceLineNo">476</span> /**<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * Checks if the configuration is acceptable.<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * @param conf the configuration to test.<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * @return <code>true</code> if the configuration is acceptable.<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * @see org.apache.felix.ipojo.Factory#isAcceptable(java.util.Dictionary)<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> */<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> public boolean isAcceptable(Dictionary conf) {<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> try {<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> checkAcceptability(conf);<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> } catch (MissingHandlerException e) {<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> return false;<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> } catch (UnacceptableConfiguration e) {<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> return false;<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> }<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> return true;<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> }<a name="line.491"></a> |
| <span class="sourceLineNo">492</span><a name="line.492"></a> |
| <span class="sourceLineNo">493</span> /**<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> * Checks if the configuration is acceptable.<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * This method checks the following assertions:<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * <li>All handlers can be creates</li><a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * <li>The configuration does not override immutable properties</li><a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * <li>The configuration contains a value for every unvalued property</li><a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * @param conf the configuration to test.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * @throws UnacceptableConfiguration if the configuration is unacceptable.<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * @throws MissingHandlerException if an handler is missing.<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> */<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> public void checkAcceptability(Dictionary<String, ?> conf) throws UnacceptableConfiguration,<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> MissingHandlerException {<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> PropertyDescription[] props;<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> synchronized (this) {<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> if (m_state == Factory.INVALID) {<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> throw new MissingHandlerException(getMissingHandlers());<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> }<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> props = m_componentDesc.getProperties(); // Stack confinement.<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> // The property list is up to date, as the factory is valid.<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> }<a name="line.512"></a> |
| <span class="sourceLineNo">513</span><a name="line.513"></a> |
| <span class="sourceLineNo">514</span> // Check that the configuration does not override immutable properties.<a name="line.514"></a> |
| <span class="sourceLineNo">515</span><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> for (PropertyDescription prop : props) {<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> // Is the property immutable<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> if (prop.isImmutable() && conf.get(prop.getName()) != null) {<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> throw new UnacceptableConfiguration("The property " + prop + " cannot be overridden : immutable " +<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> "property"); // The instance configuration tries to override an immutable property.<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> }<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> // Is the property required ?<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> if (prop.isMandatory() && prop.getValue() == null && conf.get(prop.getName()) == null) {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> throw new UnacceptableConfiguration("The mandatory property " + prop.getName() + " is missing"); // The property must be set.<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> }<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> }<a name="line.527"></a> |
| <span class="sourceLineNo">528</span><a name="line.528"></a> |
| <span class="sourceLineNo">529</span> /**<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> * Reconfigures an existing instance.<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * The acceptability of the configuration is checked before the reconfiguration. Moreover,<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * the configuration must contain the 'instance.name' property specifying the instance<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * to reconfigure.<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * This method is synchronized to assert the validity of the factory during the reconfiguration.<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> * @param properties the new configuration to push.<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * @throws UnacceptableConfiguration if the new configuration is not consistent with the component type.<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * @throws MissingHandlerException if the current factory is not valid.<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> * @see org.apache.felix.ipojo.Factory#reconfigure(java.util.Dictionary)<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> */<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> public synchronized void reconfigure(Dictionary properties) throws UnacceptableConfiguration, MissingHandlerException {<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> if (properties == null || (properties.get(Factory.INSTANCE_NAME_PROPERTY) == null && properties.get("name") == null)) { // Support both instance.name and name<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> throw new UnacceptableConfiguration("The configuration does not contains the \"instance.name\" property");<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> }<a name="line.543"></a> |
| <span class="sourceLineNo">544</span><a name="line.544"></a> |
| <span class="sourceLineNo">545</span> String name = (String) properties.get(Factory.INSTANCE_NAME_PROPERTY);<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> if (name == null) {<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> name = (String) properties.get("name");<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> }<a name="line.548"></a> |
| <span class="sourceLineNo">549</span><a name="line.549"></a> |
| <span class="sourceLineNo">550</span> ComponentInstance instance = m_componentInstances.get(name);<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> if (instance == null) { // The instance does not exists.<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> return;<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> }<a name="line.553"></a> |
| <span class="sourceLineNo">554</span><a name="line.554"></a> |
| <span class="sourceLineNo">555</span> checkAcceptability(properties); // Test if the configuration is acceptable<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> instance.reconfigure(properties); // re-configure the instance<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> }<a name="line.557"></a> |
| <span class="sourceLineNo">558</span><a name="line.558"></a> |
| <span class="sourceLineNo">559</span> /**<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * Removes a factory listener.<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> * @param listener the factory listener to remove.<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> * @see org.apache.felix.ipojo.Factory#removeFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> */<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> public void removeFactoryStateListener(FactoryStateListener listener) {<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> synchronized (this) {<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> m_listeners.remove(listener);<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> }<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> }<a name="line.568"></a> |
| <span class="sourceLineNo">569</span><a name="line.569"></a> |
| <span class="sourceLineNo">570</span> /**<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> * Stopping method.<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * This method is call when the factory is stopping.<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * This method is called when holding the lock on the factory.<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> */<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> public abstract void stopping();<a name="line.575"></a> |
| <span class="sourceLineNo">576</span><a name="line.576"></a> |
| <span class="sourceLineNo">577</span> /**<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * Stops all the instance managers.<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * This method calls the {@link IPojoFactory#stopping()} method,<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * notifies listeners, and disposes created instances. Moreover,<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> * if the factory is public, services are also unregistered.<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> *<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> */<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> public synchronized void stop() {<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> ComponentInstance[] instances;<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> if (m_sr != null) {<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> m_sr.unregister();<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> m_sr = null;<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> }<a name="line.589"></a> |
| <span class="sourceLineNo">590</span><a name="line.590"></a> |
| <span class="sourceLineNo">591</span> ConfigurationTracker.get().unregisterFactory(this);<a name="line.591"></a> |
| <span class="sourceLineNo">592</span><a name="line.592"></a> |
| <span class="sourceLineNo">593</span> stopping(); // Method called when holding the lock.<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> int oldState = m_state; // Create a variable to store the old state. Using a variable is important as<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> // after the next instruction, the getState() method must return INVALID.<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> m_state = INVALID; // Set here to avoid to create instances during the stops.<a name="line.596"></a> |
| <span class="sourceLineNo">597</span><a name="line.597"></a> |
| <span class="sourceLineNo">598</span> Set<String> col = m_componentInstances.keySet();<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> Iterator<String> it = col.iterator();<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> instances = new ComponentInstance[col.size()]; // Stack confinement<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> int index = 0;<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> while (it.hasNext()) {<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> instances[index] = m_componentInstances.get(it.next());<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> index++;<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> }<a name="line.605"></a> |
| <span class="sourceLineNo">606</span><a name="line.606"></a> |
| <span class="sourceLineNo">607</span> if (oldState == VALID) { // Check if the old state was valid.<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> for (FactoryStateListener listener : m_listeners) {<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> listener.stateChanged(this, INVALID);<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> }<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> }<a name="line.611"></a> |
| <span class="sourceLineNo">612</span><a name="line.612"></a> |
| <span class="sourceLineNo">613</span> // Dispose created instances.<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> for (ComponentInstance instance : instances) {<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> if (instance.getState() != ComponentInstance.DISPOSED) {<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> instance.dispose();<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> }<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> }<a name="line.618"></a> |
| <span class="sourceLineNo">619</span><a name="line.619"></a> |
| <span class="sourceLineNo">620</span> // Release each handler<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> for (RequiredHandler req : m_requiredHandlers) {<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> req.unRef();<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> }<a name="line.623"></a> |
| <span class="sourceLineNo">624</span><a name="line.624"></a> |
| <span class="sourceLineNo">625</span> m_described = false;<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> m_componentDesc = null;<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> m_componentInstances.clear();<a name="line.627"></a> |
| <span class="sourceLineNo">628</span><a name="line.628"></a> |
| <span class="sourceLineNo">629</span> m_logger.log(Logger.INFO, "Factory " + m_factoryName + " stopped");<a name="line.629"></a> |
| <span class="sourceLineNo">630</span><a name="line.630"></a> |
| <span class="sourceLineNo">631</span> }<a name="line.631"></a> |
| <span class="sourceLineNo">632</span><a name="line.632"></a> |
| <span class="sourceLineNo">633</span> /**<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * Destroys the factory.<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * The factory cannot be restarted. Only the {@link Extender} can call this method.<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> */<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> public synchronized void dispose() {<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> // Fast exit if already disposed<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> // The m_listeners field is ONLY set to null after dispose(), so if it's null, that<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> // means the factory has already be disposed. We can return safely.<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> if (m_listeners == null) {<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> return;<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> }<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> stop(); // Does not hold the lock.<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> m_requiredHandlers.clear();<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> m_listeners = null;<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> }<a name="line.647"></a> |
| <span class="sourceLineNo">648</span><a name="line.648"></a> |
| <span class="sourceLineNo">649</span> /**<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * Starting method.<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> * This method is called when the factory is starting.<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> * This method is <strong>not</strong> called when holding the lock on the factory.<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> */<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> public abstract void starting();<a name="line.654"></a> |
| <span class="sourceLineNo">655</span><a name="line.655"></a> |
| <span class="sourceLineNo">656</span> /**<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> * Starts the factory.<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> * Tries to compute the component type description,<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * calls the {@link IPojoFactory#starting()} method,<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * and published services if the factory is public.<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> */<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> public void start() {<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> synchronized (this) {<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> if (m_described) { // Already started.<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> return;<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> }<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> }<a name="line.667"></a> |
| <span class="sourceLineNo">668</span><a name="line.668"></a> |
| <span class="sourceLineNo">669</span> m_componentDesc = getComponentTypeDescription();<a name="line.669"></a> |
| <span class="sourceLineNo">670</span><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> starting();<a name="line.671"></a> |
| <span class="sourceLineNo">672</span><a name="line.672"></a> |
| <span class="sourceLineNo">673</span> synchronized (this) {<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> computeFactoryState();<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> }<a name="line.675"></a> |
| <span class="sourceLineNo">676</span><a name="line.676"></a> |
| <span class="sourceLineNo">677</span> if (m_isPublic) {<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> // Exposition of the factory service<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> if (m_componentDesc == null) {<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> m_logger.log(Logger.ERROR, "Unexpected state, the description of " + m_factoryName + " is null");<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> return;<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> }<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> BundleContext bc = SecurityHelper.selectContextToRegisterServices(m_componentDesc.getFactoryInterfacesToPublish(),<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> m_context, getIPOJOBundleContext());<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> if (SecurityHelper.canRegisterService(bc)) {<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> m_sr =<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> bc.registerService(m_componentDesc.getFactoryInterfacesToPublish(), this, m_componentDesc<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> .getPropertiesToPublish());<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> m_logger.log(Logger.INFO, "Factory " + m_factoryName + " started");<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> } else {<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> m_logger.log(Log.ERROR, "Cannot register the Factory service with the bundle context of the bundle "<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> + bc.getBundle().getBundleId() + " - the bundle is in the state " + bc.getBundle().getState()<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> );<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> }<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> }<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> }<a name="line.696"></a> |
| <span class="sourceLineNo">697</span><a name="line.697"></a> |
| <span class="sourceLineNo">698</span> /**<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> * For testing purpose <b>ONLY</b>.<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> * This method recomputes the required handler list.<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> */<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> public void restart() {<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> // Call sub-class to get the list of required handlers.<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> m_requiredHandlers.clear();<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> try {<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> m_requiredHandlers.addAll(getRequiredHandlerList());<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> } catch (ConfigurationException e) {<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> // Swallow the exception.<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> }<a name="line.709"></a> |
| <span class="sourceLineNo">710</span> }<a name="line.710"></a> |
| <span class="sourceLineNo">711</span><a name="line.711"></a> |
| <span class="sourceLineNo">712</span> /**<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> * Gets the iPOJO Bundle Context.<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> * @return the iPOJO Bundle Context<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> */<a name="line.715"></a> |
| <span class="sourceLineNo">716</span> protected final BundleContext getIPOJOBundleContext() {<a name="line.716"></a> |
| <span class="sourceLineNo">717</span> return Extender.getIPOJOBundleContext();<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> }<a name="line.718"></a> |
| <span class="sourceLineNo">719</span><a name="line.719"></a> |
| <span class="sourceLineNo">720</span> /**<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> * Creates or updates an instance.<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * This method is used from the configuration tracker.<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * @param name the name of the instance<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> * @param properties the new configuration of the instance<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> */<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> public void updated(String name, Dictionary properties) throws org.osgi.service.cm<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> .ConfigurationException {<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> ComponentInstance instance;<a name="line.728"></a> |
| <span class="sourceLineNo">729</span> synchronized (this) {<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> instance = m_componentInstances.get(name);<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> }<a name="line.731"></a> |
| <span class="sourceLineNo">732</span><a name="line.732"></a> |
| <span class="sourceLineNo">733</span> if (instance == null) {<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> try {<a name="line.734"></a> |
| <span class="sourceLineNo">735</span> properties.put(Factory.INSTANCE_NAME_PROPERTY, name); // Add the name in the configuration<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> // If an instance with this name was created before, this creation will failed.<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> createComponentInstance(properties);<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> } catch (UnacceptableConfiguration e) {<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> m_logger.log(Logger.ERROR, "The configuration is not acceptable : " + e.getMessage());<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> throw new org.osgi.service.cm.ConfigurationException(properties.toString(), e.getMessage(), e);<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> } catch (MissingHandlerException e) {<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> m_logger.log(Logger.ERROR, "Handler not available : " + e.getMessage());<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> throw new org.osgi.service.cm.ConfigurationException(properties.toString(), e.getMessage(), e);<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> } catch (ConfigurationException e) {<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> m_logger.log(Logger.ERROR, "The Component Type metadata are not correct : " + e.getMessage());<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> throw new org.osgi.service.cm.ConfigurationException(properties.toString(), e.getMessage(), e);<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> }<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> } else {<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> try {<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> properties.put(Factory.INSTANCE_NAME_PROPERTY, name); // Add the name in the configuration<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> reconfigure(properties); // re-configure the component<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> } catch (UnacceptableConfiguration e) {<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> m_logger.log(Logger.ERROR, "The configuration is not acceptable : " + e.getMessage());<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> throw new org.osgi.service.cm.ConfigurationException(properties.toString(), e.getMessage(), e);<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> } catch (MissingHandlerException e) {<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> m_logger.log(Logger.ERROR, "The factory is not valid, at least one handler is missing : " + e.getMessage());<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> throw new org.osgi.service.cm.ConfigurationException(properties.toString(), e.getMessage(), e);<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> }<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> }<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> }<a name="line.760"></a> |
| <span class="sourceLineNo">761</span><a name="line.761"></a> |
| <span class="sourceLineNo">762</span> /**<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * Deletes an instance.<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * @param name the name of the instance to delete<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> */<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> public synchronized void deleted(String name) {<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> INSTANCE_NAME.remove(name);<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> ComponentInstance instance = m_componentInstances.remove(name);<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> if (instance != null) {<a name="line.769"></a> |
| <span class="sourceLineNo">770</span> instance.dispose();<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> }<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> }<a name="line.772"></a> |
| <span class="sourceLineNo">773</span><a name="line.773"></a> |
| <span class="sourceLineNo">774</span> /**<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * Callback called by instance when disposed.<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> * @param instance the destroyed instance<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> */<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> public void disposed(ComponentInstance instance) {<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> String name = instance.getInstanceName();<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> m_componentInstances.remove(name);<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> INSTANCE_NAME.remove(name);<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> }<a name="line.782"></a> |
| <span class="sourceLineNo">783</span><a name="line.783"></a> |
| <span class="sourceLineNo">784</span> /**<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> * Computes the component type description.<a name="line.785"></a> |
| <span class="sourceLineNo">786</span> * To do this, it creates a 'ghost' instance of the handler<a name="line.786"></a> |
| <span class="sourceLineNo">787</span> * and calls the {@link Handler#initializeComponentFactory(ComponentTypeDescription, Element)}<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> * method. The handler instance is then deleted.<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> * The factory must be valid when calling this method.<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> * This method is called with the lock.<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> */<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> protected void computeDescription() {<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> for (RequiredHandler req : m_requiredHandlers) {<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> HandlerManager handlerManager = null;<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> try {<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> handlerManager = getHandler(req, null);<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> } catch (Exception e) {<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> m_logger.log(Logger.ERROR, "Cannot extract handler object from " + m_factoryName + " " + req<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> .getFullName());<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> return;<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> }<a name="line.801"></a> |
| <span class="sourceLineNo">802</span><a name="line.802"></a> |
| <span class="sourceLineNo">803</span> if (handlerManager == null) {<a name="line.803"></a> |
| <span class="sourceLineNo">804</span> m_logger.log(Logger.ERROR, "Cannot extract handler object from " + m_factoryName + " " + req<a name="line.804"></a> |
| <span class="sourceLineNo">805</span> .getFullName());<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> return;<a name="line.806"></a> |
| <span class="sourceLineNo">807</span> }<a name="line.807"></a> |
| <span class="sourceLineNo">808</span><a name="line.808"></a> |
| <span class="sourceLineNo">809</span> Handler handler = handlerManager.getHandler();<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> try {<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> handler.setFactory(this);<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> handler.initializeComponentFactory(m_componentDesc, m_componentMetadata);<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> ((Pojo) handler).getComponentInstance().dispose();<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> } catch (ConfigurationException e) {<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> ((Pojo) handler).getComponentInstance().dispose();<a name="line.815"></a> |
| <span class="sourceLineNo">816</span> m_logger.log(Logger.ERROR, e.getMessage());<a name="line.816"></a> |
| <span class="sourceLineNo">817</span> stop();<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> throw new IllegalStateException(e);<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> }<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> }<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> }<a name="line.821"></a> |
| <span class="sourceLineNo">822</span><a name="line.822"></a> |
| <span class="sourceLineNo">823</span> /**<a name="line.823"></a> |
| <span class="sourceLineNo">824</span> * Computes factory state.<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> * The factory is valid if every required handler are available.<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> * If the factory becomes valid for the first time, the component<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> * type description is computed.<a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * This method is called when holding the lock on the current factory.<a name="line.828"></a> |
| <span class="sourceLineNo">829</span> */<a name="line.829"></a> |
| <span class="sourceLineNo">830</span> protected void computeFactoryState() {<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> boolean isValid = true;<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> for (RequiredHandler req : m_requiredHandlers) {<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> if (req.getReference() == null) {<a name="line.833"></a> |
| <span class="sourceLineNo">834</span> isValid = false;<a name="line.834"></a> |
| <span class="sourceLineNo">835</span> break;<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> }<a name="line.836"></a> |
| <span class="sourceLineNo">837</span><a name="line.837"></a> |
| <span class="sourceLineNo">838</span> }<a name="line.838"></a> |
| <span class="sourceLineNo">839</span><a name="line.839"></a> |
| <span class="sourceLineNo">840</span> if (isValid) {<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> if (m_state == INVALID) {<a name="line.841"></a> |
| <span class="sourceLineNo">842</span><a name="line.842"></a> |
| <span class="sourceLineNo">843</span> if (!m_described) {<a name="line.843"></a> |
| <span class="sourceLineNo">844</span> computeDescription();<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> m_described = true;<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> }<a name="line.846"></a> |
| <span class="sourceLineNo">847</span><a name="line.847"></a> |
| <span class="sourceLineNo">848</span> m_state = VALID;<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> if (m_sr != null) {<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> if (SecurityHelper.canUpdateService(m_sr)) {<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> m_sr.setProperties(m_componentDesc.getPropertiesToPublish());<a name="line.851"></a> |
| <span class="sourceLineNo">852</span> }<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> }<a name="line.853"></a> |
| <span class="sourceLineNo">854</span><a name="line.854"></a> |
| <span class="sourceLineNo">855</span> // Register the factory on the ConfigurationTracker<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> ConfigurationTracker.get().registerFactory(this);<a name="line.856"></a> |
| <span class="sourceLineNo">857</span><a name="line.857"></a> |
| <span class="sourceLineNo">858</span> for (FactoryStateListener listener : m_listeners) {<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> listener.stateChanged(this, VALID);<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> }<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> }<a name="line.861"></a> |
| <span class="sourceLineNo">862</span> } else {<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> if (m_state == VALID) {<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> m_state = INVALID;<a name="line.864"></a> |
| <span class="sourceLineNo">865</span><a name="line.865"></a> |
| <span class="sourceLineNo">866</span> // Un-register the factory on the ConfigurationTracker<a name="line.866"></a> |
| <span class="sourceLineNo">867</span> ConfigurationTracker.get().unregisterFactory(this);<a name="line.867"></a> |
| <span class="sourceLineNo">868</span><a name="line.868"></a> |
| <span class="sourceLineNo">869</span> // Notify listeners.<a name="line.869"></a> |
| <span class="sourceLineNo">870</span> for (FactoryStateListener listener : m_listeners) {<a name="line.870"></a> |
| <span class="sourceLineNo">871</span> listener.stateChanged(this, INVALID);<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> }<a name="line.872"></a> |
| <span class="sourceLineNo">873</span><a name="line.873"></a> |
| <span class="sourceLineNo">874</span> // Dispose created instances.<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> // We must create a copy to avoid concurrent exceptions<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> Set<? extends String> keys = new HashSet<String>(m_componentInstances.keySet());<a name="line.876"></a> |
| <span class="sourceLineNo">877</span> for (String key : keys) {<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> ComponentInstance instance = m_componentInstances.get(key);<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> if (instance.getState() != ComponentInstance.DISPOSED) {<a name="line.879"></a> |
| <span class="sourceLineNo">880</span> instance.dispose();<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> }<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> INSTANCE_NAME.remove(instance.getInstanceName());<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> }<a name="line.883"></a> |
| <span class="sourceLineNo">884</span><a name="line.884"></a> |
| <span class="sourceLineNo">885</span> m_componentInstances.clear();<a name="line.885"></a> |
| <span class="sourceLineNo">886</span><a name="line.886"></a> |
| <span class="sourceLineNo">887</span> if (SecurityHelper.canUpdateService(m_sr)) {<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> // No null check required as the security helper is checking this too.<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> m_sr.setProperties(m_componentDesc.getPropertiesToPublish());<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> }<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> }<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> }<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> }<a name="line.893"></a> |
| <span class="sourceLineNo">894</span><a name="line.894"></a> |
| <span class="sourceLineNo">895</span> /**<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> * Checks if the given handler identifier and the service reference match.<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> * Does not need to be synchronized as the method does not use any fields.<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> * @param req the handler identifier.<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> * @param ref the service reference.<a name="line.899"></a> |
| <span class="sourceLineNo">900</span> * @return <code>true</code> if the service reference can fulfill the handler requirement<a name="line.900"></a> |
| <span class="sourceLineNo">901</span> */<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> protected boolean match(RequiredHandler req, ServiceReference<?> ref) {<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> String name = (String) ref.getProperty(Handler.HANDLER_NAME_PROPERTY);<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> String namespace = (String) ref.getProperty(Handler.HANDLER_NAMESPACE_PROPERTY);<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> if (HandlerFactory.IPOJO_NAMESPACE.equals(namespace)) {<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> return name.equalsIgnoreCase(req.getName()) && req.getNamespace() == null;<a name="line.906"></a> |
| <span class="sourceLineNo">907</span> }<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> return name.equalsIgnoreCase(req.getName()) && namespace.equalsIgnoreCase(req.getNamespace());<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> }<a name="line.909"></a> |
| <span class="sourceLineNo">910</span><a name="line.910"></a> |
| <span class="sourceLineNo">911</span> /**<a name="line.911"></a> |
| <span class="sourceLineNo">912</span> * Returns the handler object for the given required handler.<a name="line.912"></a> |
| <span class="sourceLineNo">913</span> * The handler is instantiated in the given service context.<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> * This method is called with the lock.<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> * @param req the handler to create.<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> * @param context the service context in which the handler is created (same as the instance context).<a name="line.916"></a> |
| <span class="sourceLineNo">917</span> * @return the handler object.<a name="line.917"></a> |
| <span class="sourceLineNo">918</span> */<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> protected HandlerManager getHandler(RequiredHandler req, ServiceContext context) throws MissingHandlerException,<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> UnacceptableConfiguration, ConfigurationException {<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> try {<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> return (HandlerManager) req.getFactory().createComponentInstance(null, context);<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> } catch (MissingHandlerException e) {<a name="line.923"></a> |
| <span class="sourceLineNo">924</span> m_logger.log(Logger.ERROR, "The creation of the handler " + req.getFullName() + " has failed: " + e.getMessage());<a name="line.924"></a> |
| <span class="sourceLineNo">925</span> stop();<a name="line.925"></a> |
| <span class="sourceLineNo">926</span> throw e;<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> } catch (UnacceptableConfiguration e) {<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> m_logger.log(Logger.ERROR, "The creation of the handler "<a name="line.928"></a> |
| <span class="sourceLineNo">929</span> + req.getFullName()<a name="line.929"></a> |
| <span class="sourceLineNo">930</span> + " has failed (UnacceptableConfiguration): "<a name="line.930"></a> |
| <span class="sourceLineNo">931</span> + e.getMessage());<a name="line.931"></a> |
| <span class="sourceLineNo">932</span> stop();<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> throw e;<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> } catch (org.apache.felix.ipojo.ConfigurationException e) {<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> m_logger.log(Logger.ERROR, "The configuration of the handler "<a name="line.935"></a> |
| <span class="sourceLineNo">936</span> + req.getFullName()<a name="line.936"></a> |
| <span class="sourceLineNo">937</span> + " has failed (ConfigurationException): "<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> + e.getMessage());<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> stop();<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> throw e;<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> }<a name="line.941"></a> |
| <span class="sourceLineNo">942</span> }<a name="line.942"></a> |
| <span class="sourceLineNo">943</span><a name="line.943"></a> |
| <span class="sourceLineNo">944</span> /**<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> * Structure storing required handlers.<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> * Access to this class must mostly be with the lock on the factory.<a name="line.946"></a> |
| <span class="sourceLineNo">947</span> * (except to access final fields)<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> */<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> protected class RequiredHandler implements Comparable {<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> /**<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> * The factory to create this handler.<a name="line.951"></a> |
| <span class="sourceLineNo">952</span> */<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> private HandlerFactory m_factory;<a name="line.953"></a> |
| <span class="sourceLineNo">954</span><a name="line.954"></a> |
| <span class="sourceLineNo">955</span> /**<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> * The handler name.<a name="line.956"></a> |
| <span class="sourceLineNo">957</span> */<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> private final String m_name;<a name="line.958"></a> |
| <span class="sourceLineNo">959</span><a name="line.959"></a> |
| <span class="sourceLineNo">960</span> /**<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> * The handler start level.<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> */<a name="line.962"></a> |
| <span class="sourceLineNo">963</span> private int m_level = Integer.MAX_VALUE;<a name="line.963"></a> |
| <span class="sourceLineNo">964</span><a name="line.964"></a> |
| <span class="sourceLineNo">965</span> /**<a name="line.965"></a> |
| <span class="sourceLineNo">966</span> * The handler namespace.<a name="line.966"></a> |
| <span class="sourceLineNo">967</span> */<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> private final String m_namespace;<a name="line.968"></a> |
| <span class="sourceLineNo">969</span><a name="line.969"></a> |
| <span class="sourceLineNo">970</span> /**<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> * The Service Reference of the handler factory.<a name="line.971"></a> |
| <span class="sourceLineNo">972</span> */<a name="line.972"></a> |
| <span class="sourceLineNo">973</span> private ServiceReference<? extends HandlerFactory> m_reference;<a name="line.973"></a> |
| <span class="sourceLineNo">974</span><a name="line.974"></a> |
| <span class="sourceLineNo">975</span> /**<a name="line.975"></a> |
| <span class="sourceLineNo">976</span> * Crates a Required Handler.<a name="line.976"></a> |
| <span class="sourceLineNo">977</span> * @param name the handler name.<a name="line.977"></a> |
| <span class="sourceLineNo">978</span> * @param namespace the handler namespace.<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> */<a name="line.979"></a> |
| <span class="sourceLineNo">980</span> public RequiredHandler(String name, String namespace) {<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> m_name = name;<a name="line.981"></a> |
| <span class="sourceLineNo">982</span> m_namespace = namespace;<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> }<a name="line.983"></a> |
| <span class="sourceLineNo">984</span><a name="line.984"></a> |
| <span class="sourceLineNo">985</span> /**<a name="line.985"></a> |
| <span class="sourceLineNo">986</span> * Equals method.<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> * Two handlers are equals if they have same name and namespace or they share the same service reference.<a name="line.987"></a> |
| <span class="sourceLineNo">988</span> * @param object the object to compare to the current object.<a name="line.988"></a> |
| <span class="sourceLineNo">989</span> * @return <code>true</code> if the two compared object are equals<a name="line.989"></a> |
| <span class="sourceLineNo">990</span> * @see java.lang.Object#equals(java.lang.Object)<a name="line.990"></a> |
| <span class="sourceLineNo">991</span> */<a name="line.991"></a> |
| <span class="sourceLineNo">992</span> public boolean equals(Object object) {<a name="line.992"></a> |
| <span class="sourceLineNo">993</span> if (object instanceof RequiredHandler) {<a name="line.993"></a> |
| <span class="sourceLineNo">994</span> RequiredHandler req = (RequiredHandler) object;<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> if (m_namespace == null) {<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> return req.m_name.equalsIgnoreCase(m_name) && req.m_namespace == null;<a name="line.996"></a> |
| <span class="sourceLineNo">997</span> } else {<a name="line.997"></a> |
| <span class="sourceLineNo">998</span> return req.m_name.equalsIgnoreCase(m_name) && m_namespace.equalsIgnoreCase(req.m_namespace);<a name="line.998"></a> |
| <span class="sourceLineNo">999</span> }<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> } else {<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span> return false;<a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> }<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span><a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> }<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span><a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> /**<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> * Hashcode method.<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> * This method delegates to the {@link Object#hashCode()}.<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> * @return the object hashcode.<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> * @see java.lang.Object#hashCode()<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> */<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> public int hashCode() {<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> return super.hashCode();<a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> }<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span><a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> /**<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> * Gets the factory object used for this handler.<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> * The object is get when used for the first time.<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> * This method is called with the lock avoiding concurrent modification and on a valid factory.<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> * @return the factory object.<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span> */<a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> public HandlerFactory getFactory() {<a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span> if (m_reference == null) {<a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> return null;<a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span> }<a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> if (m_factory == null) {<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> m_factory = m_context.getService(getReference());<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> }<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> return m_factory;<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> }<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span><a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> /**<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> * Gets the handler qualified name (<code>namespace:name</code>).<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> * @return the handler full name<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> */<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> public String getFullName() {<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span> if (m_namespace == null) {<a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> return HandlerFactory.IPOJO_NAMESPACE + ":" + m_name;<a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> } else {<a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> return m_namespace + ":" + m_name;<a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> }<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span> }<a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span><a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> public String getName() {<a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span> return m_name;<a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span> }<a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span><a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span> public String getNamespace() {<a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> return m_namespace;<a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> }<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span><a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> public ServiceReference<? extends HandlerFactory> getReference() {<a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span> return m_reference;<a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span> }<a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span><a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span> public int getLevel() {<a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span> return m_level;<a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> }<a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span><a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> /**<a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span> * Releases the reference of the used factory.<a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> * This method is called with the lock on the current factory.<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span> */<a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span> public void unRef() {<a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span> if (m_reference != null) {<a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> m_factory = null;<a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span> m_reference = null;<a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> }<a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span> }<a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span><a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> /**<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span> * Sets the service reference. If the new service reference is <code>null</code>, it ungets the used factory (if already get).<a name="line.1072"></a> |
| <span class="sourceLineNo">1073</span> * This method is called with the lock on the current factory.<a name="line.1073"></a> |
| <span class="sourceLineNo">1074</span> * @param ref the new service reference.<a name="line.1074"></a> |
| <span class="sourceLineNo">1075</span> */<a name="line.1075"></a> |
| <span class="sourceLineNo">1076</span> public void setReference(ServiceReference<? extends HandlerFactory> ref) {<a name="line.1076"></a> |
| <span class="sourceLineNo">1077</span> m_reference = ref;<a name="line.1077"></a> |
| <span class="sourceLineNo">1078</span> Integer level = (Integer) m_reference.getProperty(Handler.HANDLER_LEVEL_PROPERTY);<a name="line.1078"></a> |
| <span class="sourceLineNo">1079</span> if (level != null) {<a name="line.1079"></a> |
| <span class="sourceLineNo">1080</span> m_level = level;<a name="line.1080"></a> |
| <span class="sourceLineNo">1081</span> }<a name="line.1081"></a> |
| <span class="sourceLineNo">1082</span> }<a name="line.1082"></a> |
| <span class="sourceLineNo">1083</span><a name="line.1083"></a> |
| <span class="sourceLineNo">1084</span> /**<a name="line.1084"></a> |
| <span class="sourceLineNo">1085</span> * Start level Comparison.<a name="line.1085"></a> |
| <span class="sourceLineNo">1086</span> * This method is used to sort the handler array.<a name="line.1086"></a> |
| <span class="sourceLineNo">1087</span> * This method is called with the lock.<a name="line.1087"></a> |
| <span class="sourceLineNo">1088</span> * @param object the object on which compare.<a name="line.1088"></a> |
| <span class="sourceLineNo">1089</span> * @return <code>-1</code>, <code>0</code>, <code>+1</code> according to the comparison of their start levels.<a name="line.1089"></a> |
| <span class="sourceLineNo">1090</span> * @see java.lang.Comparable#compareTo(java.lang.Object)<a name="line.1090"></a> |
| <span class="sourceLineNo">1091</span> */<a name="line.1091"></a> |
| <span class="sourceLineNo">1092</span> public int compareTo(Object object) {<a name="line.1092"></a> |
| <span class="sourceLineNo">1093</span> if (object instanceof RequiredHandler) {<a name="line.1093"></a> |
| <span class="sourceLineNo">1094</span> RequiredHandler req = (RequiredHandler) object;<a name="line.1094"></a> |
| <span class="sourceLineNo">1095</span> if (this.m_level == req.m_level) {<a name="line.1095"></a> |
| <span class="sourceLineNo">1096</span> return 0;<a name="line.1096"></a> |
| <span class="sourceLineNo">1097</span> } else if (this.m_level < req.m_level) {<a name="line.1097"></a> |
| <span class="sourceLineNo">1098</span> return -1;<a name="line.1098"></a> |
| <span class="sourceLineNo">1099</span> } else {<a name="line.1099"></a> |
| <span class="sourceLineNo">1100</span> return +1;<a name="line.1100"></a> |
| <span class="sourceLineNo">1101</span> }<a name="line.1101"></a> |
| <span class="sourceLineNo">1102</span> }<a name="line.1102"></a> |
| <span class="sourceLineNo">1103</span> return 0;<a name="line.1103"></a> |
| <span class="sourceLineNo">1104</span> }<a name="line.1104"></a> |
| <span class="sourceLineNo">1105</span> }<a name="line.1105"></a> |
| <span class="sourceLineNo">1106</span><a name="line.1106"></a> |
| <span class="sourceLineNo">1107</span><a name="line.1107"></a> |
| <span class="sourceLineNo">1108</span> /**<a name="line.1108"></a> |
| <span class="sourceLineNo">1109</span> * This generator implements the default naming strategy.<a name="line.1109"></a> |
| <span class="sourceLineNo">1110</span> * The name is composed of the factory name suffixed with a unique number identifier (starting from 0).<a name="line.1110"></a> |
| <span class="sourceLineNo">1111</span> */<a name="line.1111"></a> |
| <span class="sourceLineNo">1112</span> public static class DefaultNameGenerator implements NameGenerator {<a name="line.1112"></a> |
| <span class="sourceLineNo">1113</span><a name="line.1113"></a> |
| <span class="sourceLineNo">1114</span> private AtomicLong m_nextId = new AtomicLong();<a name="line.1114"></a> |
| <span class="sourceLineNo">1115</span><a name="line.1115"></a> |
| <span class="sourceLineNo">1116</span> public String generate(Factory factory, List<String> reserved) throws UnacceptableConfiguration {<a name="line.1116"></a> |
| <span class="sourceLineNo">1117</span> StringBuilder sb = new StringBuilder();<a name="line.1117"></a> |
| <span class="sourceLineNo">1118</span> sb.append(factory.getName());<a name="line.1118"></a> |
| <span class="sourceLineNo">1119</span> if (factory.getVersion() != null) {<a name="line.1119"></a> |
| <span class="sourceLineNo">1120</span> sb.append("/");<a name="line.1120"></a> |
| <span class="sourceLineNo">1121</span> sb.append(factory.getVersion());<a name="line.1121"></a> |
| <span class="sourceLineNo">1122</span> }<a name="line.1122"></a> |
| <span class="sourceLineNo">1123</span> sb.append("-");<a name="line.1123"></a> |
| <span class="sourceLineNo">1124</span> sb.append(m_nextId.getAndIncrement());<a name="line.1124"></a> |
| <span class="sourceLineNo">1125</span> return sb.toString();<a name="line.1125"></a> |
| <span class="sourceLineNo">1126</span> }<a name="line.1126"></a> |
| <span class="sourceLineNo">1127</span> }<a name="line.1127"></a> |
| <span class="sourceLineNo">1128</span><a name="line.1128"></a> |
| <span class="sourceLineNo">1129</span> /**<a name="line.1129"></a> |
| <span class="sourceLineNo">1130</span> * This generator implements a retry naming strategy.<a name="line.1130"></a> |
| <span class="sourceLineNo">1131</span> * It uses a delegate {@link org.apache.felix.ipojo.IPojoFactory.NameGenerator}, and call it in sequence until an unused value is found.<a name="line.1131"></a> |
| <span class="sourceLineNo">1132</span> */<a name="line.1132"></a> |
| <span class="sourceLineNo">1133</span> public static class RetryNameGenerator implements NameGenerator {<a name="line.1133"></a> |
| <span class="sourceLineNo">1134</span><a name="line.1134"></a> |
| <span class="sourceLineNo">1135</span> private final NameGenerator m_delegate;<a name="line.1135"></a> |
| <span class="sourceLineNo">1136</span><a name="line.1136"></a> |
| <span class="sourceLineNo">1137</span> /**<a name="line.1137"></a> |
| <span class="sourceLineNo">1138</span> * Bound the loop to avoid Stack overflows<a name="line.1138"></a> |
| <span class="sourceLineNo">1139</span> */<a name="line.1139"></a> |
| <span class="sourceLineNo">1140</span> private long maximum = 8096;<a name="line.1140"></a> |
| <span class="sourceLineNo">1141</span><a name="line.1141"></a> |
| <span class="sourceLineNo">1142</span> public RetryNameGenerator(final NameGenerator delegate) {<a name="line.1142"></a> |
| <span class="sourceLineNo">1143</span> m_delegate = delegate;<a name="line.1143"></a> |
| <span class="sourceLineNo">1144</span> }<a name="line.1144"></a> |
| <span class="sourceLineNo">1145</span><a name="line.1145"></a> |
| <span class="sourceLineNo">1146</span> public void setMaximum(final long maximum) {<a name="line.1146"></a> |
| <span class="sourceLineNo">1147</span> this.maximum = maximum;<a name="line.1147"></a> |
| <span class="sourceLineNo">1148</span> }<a name="line.1148"></a> |
| <span class="sourceLineNo">1149</span><a name="line.1149"></a> |
| <span class="sourceLineNo">1150</span> public String generate(final Factory factory, final List<String> reserved) throws UnacceptableConfiguration {<a name="line.1150"></a> |
| <span class="sourceLineNo">1151</span> // Loop until we obtain a unique value (or counter overflow)<a name="line.1151"></a> |
| <span class="sourceLineNo">1152</span> long counter = 0;<a name="line.1152"></a> |
| <span class="sourceLineNo">1153</span> while (counter < maximum) {<a name="line.1153"></a> |
| <span class="sourceLineNo">1154</span> String generated = m_delegate.generate(factory, reserved);<a name="line.1154"></a> |
| <span class="sourceLineNo">1155</span> counter++;<a name="line.1155"></a> |
| <span class="sourceLineNo">1156</span> // Verify uniqueness<a name="line.1156"></a> |
| <span class="sourceLineNo">1157</span> if (!reserved.contains(generated)) {<a name="line.1157"></a> |
| <span class="sourceLineNo">1158</span> return generated;<a name="line.1158"></a> |
| <span class="sourceLineNo">1159</span> }<a name="line.1159"></a> |
| <span class="sourceLineNo">1160</span> }<a name="line.1160"></a> |
| <span class="sourceLineNo">1161</span><a name="line.1161"></a> |
| <span class="sourceLineNo">1162</span> // Should never happen (except is NameGenerator composition is broken: like a delegate that<a name="line.1162"></a> |
| <span class="sourceLineNo">1163</span> // never change its return value)<a name="line.1163"></a> |
| <span class="sourceLineNo">1164</span> throw new UnacceptableConfiguration(format("Cannot generate unique instance name for factory %s/%s from bundle %d",<a name="line.1164"></a> |
| <span class="sourceLineNo">1165</span> factory.getName(),<a name="line.1165"></a> |
| <span class="sourceLineNo">1166</span> factory.getVersion(),<a name="line.1166"></a> |
| <span class="sourceLineNo">1167</span> factory.getBundleContext().getBundle().getBundleId()));<a name="line.1167"></a> |
| <span class="sourceLineNo">1168</span> }<a name="line.1168"></a> |
| <span class="sourceLineNo">1169</span> }<a name="line.1169"></a> |
| <span class="sourceLineNo">1170</span><a name="line.1170"></a> |
| <span class="sourceLineNo">1171</span> /**<a name="line.1171"></a> |
| <span class="sourceLineNo">1172</span> * Generate a unique name for a component instance.<a name="line.1172"></a> |
| <span class="sourceLineNo">1173</span> */<a name="line.1173"></a> |
| <span class="sourceLineNo">1174</span> public static interface NameGenerator {<a name="line.1174"></a> |
| <span class="sourceLineNo">1175</span><a name="line.1175"></a> |
| <span class="sourceLineNo">1176</span> /**<a name="line.1176"></a> |
| <span class="sourceLineNo">1177</span> * @return a unique name.<a name="line.1177"></a> |
| <span class="sourceLineNo">1178</span> * @param factory Factory called to create the instance<a name="line.1178"></a> |
| <span class="sourceLineNo">1179</span> * @param reserved List of reserved (already used) instance names.<a name="line.1179"></a> |
| <span class="sourceLineNo">1180</span> * This has to be used tp ensure generated name is unique among all other instances.<a name="line.1180"></a> |
| <span class="sourceLineNo">1181</span> */<a name="line.1181"></a> |
| <span class="sourceLineNo">1182</span> String generate(Factory factory, List<String> reserved) throws UnacceptableConfiguration;<a name="line.1182"></a> |
| <span class="sourceLineNo">1183</span> }<a name="line.1183"></a> |
| <span class="sourceLineNo">1184</span>}<a name="line.1184"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
