blob: 55e9732b44f51b77d00d24acbb706fccd7ef290c [file] [log] [blame]
<!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.handlers.configuration;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.felix.ipojo.*;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.felix.ipojo.architecture.ComponentTypeDescription;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.architecture.HandlerDescription;<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.handlers.providedservice.ProvidedServiceHandler;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.felix.ipojo.parser.FieldMetadata;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.felix.ipojo.parser.MethodMetadata;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.felix.ipojo.parser.PojoMetadata;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.felix.ipojo.util.Callback;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.felix.ipojo.util.Property;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.felix.ipojo.util.SecurityHelper;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.osgi.framework.Constants;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.osgi.framework.ServiceRegistration;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.osgi.service.cm.ManagedService;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.util.*;<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> * Handler managing the Configuration Admin.<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class ConfigurationHandler extends PrimitiveHandler implements ManagedService {<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * List of the configurable fields.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> private List&lt;Property&gt; m_configurableProperties = new ArrayList&lt;Property&gt;(1);<a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * ProvidedServiceHandler of the component. It is useful to propagate<a name="line.52"></a>
<span class="sourceLineNo">053</span> * properties to service registrations.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> private ProvidedServiceHandler m_providedServiceHandler;<a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Properties propagated during the last instance "update".<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> private Dictionary m_propagatedFromInstance = new Properties();<a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Properties to propagate.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> private Dictionary&lt;String, Object&gt; m_toPropagate = new Hashtable&lt;String, Object&gt;();<a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Properties propagated from the configuration admin.<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> private Dictionary m_propagatedFromCA;<a name="line.67"></a>
<span class="sourceLineNo">068</span> /**<a name="line.68"></a>
<span class="sourceLineNo">069</span> * Check if the instance was already reconfigured by the configuration admin.<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> private boolean m_configurationAlreadyPushed;<a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * should the component propagate configuration ?<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> private boolean m_mustPropagate;<a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Service Registration to publish the service registration.<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> private ServiceRegistration m_sr;<a name="line.79"></a>
<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> * Managed Service PID.<a name="line.81"></a>
<span class="sourceLineNo">082</span> * This PID must be different from the instance name if the instance was created<a name="line.82"></a>
<span class="sourceLineNo">083</span> * with the Configuration Admin.<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> private String m_managedServicePID;<a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * the handler description.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> private ConfigurationHandlerDescription m_description;<a name="line.89"></a>
<span class="sourceLineNo">090</span> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * Updated method.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * This method is called when a reconfiguration is completed.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> private Callback m_updated;<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * The configuration listeners.<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> private List&lt;ConfigurationListener&gt; m_listeners = new ArrayList&lt;ConfigurationListener&gt;();<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> * Initialize the component type.<a name="line.102"></a>
<span class="sourceLineNo">103</span> *<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @param desc : component type description to populate.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param metadata : component type metadata.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @throws ConfigurationException : metadata are incorrect.<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @see org.apache.felix.ipojo.Handler#initializeComponentFactory(org.apache.felix.ipojo.architecture.ComponentTypeDescription, org.apache.felix.ipojo.metadata.Element)<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public void initializeComponentFactory(ComponentTypeDescription desc, Element metadata) throws ConfigurationException {<a name="line.109"></a>
<span class="sourceLineNo">110</span> Element[] confs = metadata.getElements("Properties", "");<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (confs == null) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> return;<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> Element[] configurables = confs[0].getElements("Property");<a name="line.114"></a>
<span class="sourceLineNo">115</span> for (int i = 0; configurables != null &amp;&amp; i &lt; configurables.length; i++) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> String fieldName = configurables[i].getAttribute("field");<a name="line.116"></a>
<span class="sourceLineNo">117</span> String methodName = configurables[i].getAttribute("method");<a name="line.117"></a>
<span class="sourceLineNo">118</span> String paramIndex = configurables[i].getAttribute("constructor-parameter");<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> if (fieldName == null &amp;&amp; methodName == null &amp;&amp; paramIndex == null) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> throw new ConfigurationException("Malformed property : The property needs to contain" +<a name="line.121"></a>
<span class="sourceLineNo">122</span> " at least a field, a method or a constructor-parameter");<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> String name = configurables[i].getAttribute("name");<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (name == null) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> if (fieldName == null &amp;&amp; methodName != null) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> name = methodName;<a name="line.128"></a>
<span class="sourceLineNo">129</span> } else if (fieldName == null &amp;&amp; paramIndex != null) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> name = paramIndex;<a name="line.130"></a>
<span class="sourceLineNo">131</span> } else {<a name="line.131"></a>
<span class="sourceLineNo">132</span> name = fieldName;<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> configurables[i].addAttribute(new Attribute("name", name)); // Add the type to avoid configure checking<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> String value = configurables[i].getAttribute("value");<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> // Detect the type of the property<a name="line.139"></a>
<span class="sourceLineNo">140</span> PojoMetadata manipulation = getFactory().getPojoMetadata();<a name="line.140"></a>
<span class="sourceLineNo">141</span> String type = null;<a name="line.141"></a>
<span class="sourceLineNo">142</span> if (methodName != null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> MethodMetadata[] method = manipulation.getMethods(methodName);<a name="line.143"></a>
<span class="sourceLineNo">144</span> if (method.length == 0) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> type = configurables[i].getAttribute("type");<a name="line.145"></a>
<span class="sourceLineNo">146</span> if (type == null) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> throw new ConfigurationException("Malformed property : The type of the property cannot be discovered, add a 'type' attribute");<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span> } else {<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (method[0].getMethodArguments().length != 1) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> throw new ConfigurationException("Malformed property : The method " + methodName + " does not have one argument");<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> type = method[0].getMethodArguments()[0];<a name="line.153"></a>
<span class="sourceLineNo">154</span> configurables[i].addAttribute(new Attribute("type", type)); // Add the type to avoid configure checking<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span> } else if (fieldName != null) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> FieldMetadata field = manipulation.getField(fieldName);<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (field == null) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> throw new ConfigurationException("Malformed property : The field " + fieldName + " does not exist in the implementation class");<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> type = field.getFieldType();<a name="line.161"></a>
<span class="sourceLineNo">162</span> configurables[i].addAttribute(new Attribute("type", type)); // Add the type to avoid configure checking<a name="line.162"></a>
<span class="sourceLineNo">163</span> } else if (paramIndex != null) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> int index = Integer.parseInt(paramIndex);<a name="line.164"></a>
<span class="sourceLineNo">165</span> type = configurables[i].getAttribute("type");<a name="line.165"></a>
<span class="sourceLineNo">166</span> MethodMetadata[] cts = manipulation.getConstructors();<a name="line.166"></a>
<span class="sourceLineNo">167</span> // If we don't have a type, try to get the first constructor and get the type of the parameter<a name="line.167"></a>
<span class="sourceLineNo">168</span> // we the index 'index'.<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (type == null &amp;&amp; cts.length &gt; 0 &amp;&amp; cts[0].getMethodArguments().length &gt; index) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> type = cts[0].getMethodArguments()[index];<a name="line.170"></a>
<span class="sourceLineNo">171</span> } else if (type == null) { // Applied only if type was not determined.<a name="line.171"></a>
<span class="sourceLineNo">172</span> throw new ConfigurationException("Cannot determine the type of the property " + index +<a name="line.172"></a>
<span class="sourceLineNo">173</span> ", please use the type attribute");<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> configurables[i].addAttribute(new Attribute("type", type));<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> // Is the property set to immutable<a name="line.178"></a>
<span class="sourceLineNo">179</span> boolean immutable = false;<a name="line.179"></a>
<span class="sourceLineNo">180</span> String imm = configurables[i].getAttribute("immutable");<a name="line.180"></a>
<span class="sourceLineNo">181</span> immutable = imm != null &amp;&amp; imm.equalsIgnoreCase("true");<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> boolean mandatory = false;<a name="line.183"></a>
<span class="sourceLineNo">184</span> String man = configurables[i].getAttribute("mandatory");<a name="line.184"></a>
<span class="sourceLineNo">185</span> mandatory = man != null &amp;&amp; man.equalsIgnoreCase("true");<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> PropertyDescription pd = null;<a name="line.187"></a>
<span class="sourceLineNo">188</span> if (value == null) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> pd = new PropertyDescription(name, type, null, false); // Cannot be immutable if we have no value.<a name="line.189"></a>
<span class="sourceLineNo">190</span> } else {<a name="line.190"></a>
<span class="sourceLineNo">191</span> pd = new PropertyDescription(name, type, value, immutable);<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> if (mandatory) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> pd.setMandatory();<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> desc.addProperty(pd);<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><a name="line.202"></a>
<span class="sourceLineNo">203</span> /**<a name="line.203"></a>
<span class="sourceLineNo">204</span> * Configures the handler.<a name="line.204"></a>
<span class="sourceLineNo">205</span> * Access to field does not require synchronization as this method is executed<a name="line.205"></a>
<span class="sourceLineNo">206</span> * before any thread access to this object.<a name="line.206"></a>
<span class="sourceLineNo">207</span> *<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @param metadata the metadata of the component<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @param configuration the instance configuration<a name="line.209"></a>
<span class="sourceLineNo">210</span> * @throws ConfigurationException one property metadata is not correct<a name="line.210"></a>
<span class="sourceLineNo">211</span> * @see org.apache.felix.ipojo.Handler#configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)<a name="line.211"></a>
<span class="sourceLineNo">212</span> */<a name="line.212"></a>
<span class="sourceLineNo">213</span> public void configure(Element metadata, Dictionary configuration) throws ConfigurationException {<a name="line.213"></a>
<span class="sourceLineNo">214</span> // Build the map<a name="line.214"></a>
<span class="sourceLineNo">215</span> Element[] confs = metadata.getElements("Properties", "");<a name="line.215"></a>
<span class="sourceLineNo">216</span> Element[] configurables = confs[0].getElements("Property");<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> // Check if the component is dynamically configurable<a name="line.218"></a>
<span class="sourceLineNo">219</span> // Propagation enabled by default.<a name="line.219"></a>
<span class="sourceLineNo">220</span> m_mustPropagate = true;<a name="line.220"></a>
<span class="sourceLineNo">221</span> // We must create a copy as the Config Admin dictionary has some limitations<a name="line.221"></a>
<span class="sourceLineNo">222</span> m_toPropagate = new Hashtable&lt;String, Object&gt;();<a name="line.222"></a>
<span class="sourceLineNo">223</span> if (configuration != null) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> Enumeration keys = configuration.keys();<a name="line.224"></a>
<span class="sourceLineNo">225</span> while (keys.hasMoreElements()) {<a name="line.225"></a>
<span class="sourceLineNo">226</span> String key = (String) keys.nextElement();<a name="line.226"></a>
<span class="sourceLineNo">227</span> // To conform with 'Property Propagation 104.4.4 (Config Admin spec)',<a name="line.227"></a>
<span class="sourceLineNo">228</span> // we don't propagate properties starting with .<a name="line.228"></a>
<span class="sourceLineNo">229</span> if (!key.startsWith(".")) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> m_toPropagate.put(key, configuration.get(key));<a name="line.230"></a>
<span class="sourceLineNo">231</span> }<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span> }<a name="line.233"></a>
<span class="sourceLineNo">234</span><a name="line.234"></a>
<span class="sourceLineNo">235</span> String propa = confs[0].getAttribute("propagation");<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (propa != null &amp;&amp; propa.equalsIgnoreCase("false")) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> m_mustPropagate = false;<a name="line.237"></a>
<span class="sourceLineNo">238</span> m_toPropagate = null;<a name="line.238"></a>
<span class="sourceLineNo">239</span> }<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span> // Check if the component support ConfigurationADmin reconfiguration<a name="line.241"></a>
<span class="sourceLineNo">242</span> m_managedServicePID = confs[0].getAttribute("pid"); // Look inside the component type description<a name="line.242"></a>
<span class="sourceLineNo">243</span> String instanceMSPID = (String) configuration.get("managed.service.pid"); // Look inside the instance configuration.<a name="line.243"></a>
<span class="sourceLineNo">244</span> if (instanceMSPID != null) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> m_managedServicePID = instanceMSPID;<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> // updated method<a name="line.248"></a>
<span class="sourceLineNo">249</span> String upd = confs[0].getAttribute("updated");<a name="line.249"></a>
<span class="sourceLineNo">250</span> if (upd != null) {<a name="line.250"></a>
<span class="sourceLineNo">251</span> MethodMetadata method = getPojoMetadata().getMethod(upd);<a name="line.251"></a>
<span class="sourceLineNo">252</span> if (method == null) {<a name="line.252"></a>
<span class="sourceLineNo">253</span> throw new ConfigurationException("The updated method is not found in the class "<a name="line.253"></a>
<span class="sourceLineNo">254</span> + getInstanceManager().getClassName());<a name="line.254"></a>
<span class="sourceLineNo">255</span> } else if (method.getMethodArguments().length == 0) {<a name="line.255"></a>
<span class="sourceLineNo">256</span> m_updated = new Callback(upd, new Class[0], false, getInstanceManager());<a name="line.256"></a>
<span class="sourceLineNo">257</span> } else if (method.getMethodArguments().length == 1<a name="line.257"></a>
<span class="sourceLineNo">258</span> &amp;&amp; method.getMethodArguments()[0].equals(Dictionary.class.getName())) {<a name="line.258"></a>
<span class="sourceLineNo">259</span> m_updated = new Callback(upd, new Class[]{Dictionary.class}, false, getInstanceManager());<a name="line.259"></a>
<span class="sourceLineNo">260</span> } else {<a name="line.260"></a>
<span class="sourceLineNo">261</span> throw new ConfigurationException("The updated method is found in the class "<a name="line.261"></a>
<span class="sourceLineNo">262</span> + getInstanceManager().getClassName() + " must have either no argument or a Dictionary");<a name="line.262"></a>
<span class="sourceLineNo">263</span> }<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span><a name="line.265"></a>
<span class="sourceLineNo">266</span> for (int i = 0; configurables != null &amp;&amp; i &lt; configurables.length; i++) {<a name="line.266"></a>
<span class="sourceLineNo">267</span> String fieldName = configurables[i].getAttribute("field");<a name="line.267"></a>
<span class="sourceLineNo">268</span> String methodName = configurables[i].getAttribute("method");<a name="line.268"></a>
<span class="sourceLineNo">269</span> String paramIndex = configurables[i].getAttribute("constructor-parameter");<a name="line.269"></a>
<span class="sourceLineNo">270</span> int index = -1;<a name="line.270"></a>
<span class="sourceLineNo">271</span><a name="line.271"></a>
<span class="sourceLineNo">272</span> String name = configurables[i].getAttribute("name"); // The initialize method has fixed the property name.<a name="line.272"></a>
<span class="sourceLineNo">273</span> String value = configurables[i].getAttribute("value");<a name="line.273"></a>
<span class="sourceLineNo">274</span><a name="line.274"></a>
<span class="sourceLineNo">275</span> String type = configurables[i].getAttribute("type"); // The initialize method has fixed the property name.<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span> Property prop;<a name="line.277"></a>
<span class="sourceLineNo">278</span> if (paramIndex == null) {<a name="line.278"></a>
<span class="sourceLineNo">279</span> prop = new Property(name, fieldName, methodName, value, type, getInstanceManager(), this);<a name="line.279"></a>
<span class="sourceLineNo">280</span> } else {<a name="line.280"></a>
<span class="sourceLineNo">281</span> index = Integer.parseInt(paramIndex);<a name="line.281"></a>
<span class="sourceLineNo">282</span> prop = new Property(name, fieldName, methodName, index,<a name="line.282"></a>
<span class="sourceLineNo">283</span> value, type, getInstanceManager(), this);<a name="line.283"></a>
<span class="sourceLineNo">284</span> }<a name="line.284"></a>
<span class="sourceLineNo">285</span> addProperty(prop);<a name="line.285"></a>
<span class="sourceLineNo">286</span><a name="line.286"></a>
<span class="sourceLineNo">287</span> // Check if the instance configuration contains value for the current property :<a name="line.287"></a>
<span class="sourceLineNo">288</span> if (configuration.get(name) == null) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> if (fieldName != null &amp;&amp; configuration.get(fieldName) != null) {<a name="line.289"></a>
<span class="sourceLineNo">290</span> prop.setValue(configuration.get(fieldName));<a name="line.290"></a>
<span class="sourceLineNo">291</span> }<a name="line.291"></a>
<span class="sourceLineNo">292</span> } else {<a name="line.292"></a>
<span class="sourceLineNo">293</span> prop.setValue(configuration.get(name));<a name="line.293"></a>
<span class="sourceLineNo">294</span> }<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span> if (fieldName != null) {<a name="line.296"></a>
<span class="sourceLineNo">297</span> FieldMetadata field = new FieldMetadata(fieldName, type);<a name="line.297"></a>
<span class="sourceLineNo">298</span> getInstanceManager().register(field, prop);<a name="line.298"></a>
<span class="sourceLineNo">299</span> }<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span> if (index != -1) {<a name="line.301"></a>
<span class="sourceLineNo">302</span> getInstanceManager().register(index, prop);<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><a name="line.305"></a>
<span class="sourceLineNo">306</span> m_description = new ConfigurationHandlerDescription(this, m_configurableProperties, m_managedServicePID);<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><a name="line.309"></a>
<span class="sourceLineNo">310</span> /**<a name="line.310"></a>
<span class="sourceLineNo">311</span> * Stop method.<a name="line.311"></a>
<span class="sourceLineNo">312</span> * This method is synchronized to avoid the configuration admin pushing a configuration during the un-registration.<a name="line.312"></a>
<span class="sourceLineNo">313</span> * Do nothing.<a name="line.313"></a>
<span class="sourceLineNo">314</span> *<a name="line.314"></a>
<span class="sourceLineNo">315</span> * @see org.apache.felix.ipojo.Handler#stop()<a name="line.315"></a>
<span class="sourceLineNo">316</span> */<a name="line.316"></a>
<span class="sourceLineNo">317</span> public synchronized void stop() {<a name="line.317"></a>
<span class="sourceLineNo">318</span> if (m_sr != null) {<a name="line.318"></a>
<span class="sourceLineNo">319</span> m_sr.unregister();<a name="line.319"></a>
<span class="sourceLineNo">320</span> m_sr = null;<a name="line.320"></a>
<span class="sourceLineNo">321</span> }<a name="line.321"></a>
<span class="sourceLineNo">322</span> }<a name="line.322"></a>
<span class="sourceLineNo">323</span><a name="line.323"></a>
<span class="sourceLineNo">324</span> /**<a name="line.324"></a>
<span class="sourceLineNo">325</span> * Start method.<a name="line.325"></a>
<span class="sourceLineNo">326</span> * This method is synchronized to avoid the config admin pushing a configuration before ending the method.<a name="line.326"></a>
<span class="sourceLineNo">327</span> * Propagate properties if the propagation is activated.<a name="line.327"></a>
<span class="sourceLineNo">328</span> *<a name="line.328"></a>
<span class="sourceLineNo">329</span> * @see org.apache.felix.ipojo.Handler#start()<a name="line.329"></a>
<span class="sourceLineNo">330</span> */<a name="line.330"></a>
<span class="sourceLineNo">331</span> public synchronized void start() {<a name="line.331"></a>
<span class="sourceLineNo">332</span> // Get the provided service handler :<a name="line.332"></a>
<span class="sourceLineNo">333</span> m_providedServiceHandler = (ProvidedServiceHandler) getHandler(HandlerFactory.IPOJO_NAMESPACE + ":provides");<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span><a name="line.335"></a>
<span class="sourceLineNo">336</span> // Propagation<a name="line.336"></a>
<span class="sourceLineNo">337</span> if (m_mustPropagate) {<a name="line.337"></a>
<span class="sourceLineNo">338</span> for (Property prop : m_configurableProperties) {<a name="line.338"></a>
<span class="sourceLineNo">339</span> if (prop.getValue() != Property.NO_VALUE &amp;&amp; prop.getValue() != null) { // No injected value, or null<a name="line.339"></a>
<span class="sourceLineNo">340</span> m_toPropagate.put(prop.getName(), prop.getValue());<a name="line.340"></a>
<span class="sourceLineNo">341</span> }<a name="line.341"></a>
<span class="sourceLineNo">342</span> }<a name="line.342"></a>
<span class="sourceLineNo">343</span> reconfigure(m_toPropagate);<a name="line.343"></a>
<span class="sourceLineNo">344</span> }<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> // Give initial values and reset the 'invoked' flag.<a name="line.347"></a>
<span class="sourceLineNo">348</span> for (Property prop : m_configurableProperties) {<a name="line.348"></a>
<span class="sourceLineNo">349</span> prop.reset(); // Clear the invoked flag.<a name="line.349"></a>
<span class="sourceLineNo">350</span> if (prop.hasField() &amp;&amp; prop.getValue() != Property.NO_VALUE &amp;&amp; prop.getValue() != null) {<a name="line.350"></a>
<span class="sourceLineNo">351</span> getInstanceManager().onSet(null, prop.getField(), prop.getValue());<a name="line.351"></a>
<span class="sourceLineNo">352</span> }<a name="line.352"></a>
<span class="sourceLineNo">353</span> }<a name="line.353"></a>
<span class="sourceLineNo">354</span><a name="line.354"></a>
<span class="sourceLineNo">355</span> if (m_managedServicePID != null &amp;&amp; m_sr == null) {<a name="line.355"></a>
<span class="sourceLineNo">356</span> Hashtable&lt;String, Object&gt; props = new Hashtable&lt;String, Object&gt;();<a name="line.356"></a>
<span class="sourceLineNo">357</span> props.put(Constants.SERVICE_PID, m_managedServicePID);<a name="line.357"></a>
<span class="sourceLineNo">358</span> props.put(Factory.INSTANCE_NAME_PROPERTY, getInstanceManager().getInstanceName());<a name="line.358"></a>
<span class="sourceLineNo">359</span> props.put("factory.name", getInstanceManager().getFactory().getFactoryName());<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span> // Security Check<a name="line.361"></a>
<span class="sourceLineNo">362</span> if (SecurityHelper.hasPermissionToRegisterService(ManagedService.class.getName(),<a name="line.362"></a>
<span class="sourceLineNo">363</span> getInstanceManager().getContext()) &amp;&amp; SecurityHelper.canRegisterService<a name="line.363"></a>
<span class="sourceLineNo">364</span> (getInstanceManager().getContext())) {<a name="line.364"></a>
<span class="sourceLineNo">365</span> m_sr = getInstanceManager().getContext().registerService(ManagedService.class.getName(), this, props);<a name="line.365"></a>
<span class="sourceLineNo">366</span> } else {<a name="line.366"></a>
<span class="sourceLineNo">367</span> error("Cannot register the ManagedService - The bundle "<a name="line.367"></a>
<span class="sourceLineNo">368</span> + getInstanceManager().getContext().getBundle().getBundleId()<a name="line.368"></a>
<span class="sourceLineNo">369</span> + " does not have the permission to register the service");<a name="line.369"></a>
<span class="sourceLineNo">370</span> }<a name="line.370"></a>
<span class="sourceLineNo">371</span> }<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> * Adds the given property metadata to the property metadata list.<a name="line.375"></a>
<span class="sourceLineNo">376</span> *<a name="line.376"></a>
<span class="sourceLineNo">377</span> * @param prop : property metadata to add<a name="line.377"></a>
<span class="sourceLineNo">378</span> */<a name="line.378"></a>
<span class="sourceLineNo">379</span> protected void addProperty(Property prop) {<a name="line.379"></a>
<span class="sourceLineNo">380</span> m_configurableProperties.add(prop);<a name="line.380"></a>
<span class="sourceLineNo">381</span> }<a name="line.381"></a>
<span class="sourceLineNo">382</span><a name="line.382"></a>
<span class="sourceLineNo">383</span> /**<a name="line.383"></a>
<span class="sourceLineNo">384</span> * Reconfigure the component instance.<a name="line.384"></a>
<span class="sourceLineNo">385</span> * Check if the new configuration modifies the current configuration.<a name="line.385"></a>
<span class="sourceLineNo">386</span> * Invokes the updated method is needed.<a name="line.386"></a>
<span class="sourceLineNo">387</span> *<a name="line.387"></a>
<span class="sourceLineNo">388</span> * @param configuration : the new configuration<a name="line.388"></a>
<span class="sourceLineNo">389</span> * @see org.apache.felix.ipojo.Handler#reconfigure(java.util.Dictionary)<a name="line.389"></a>
<span class="sourceLineNo">390</span> */<a name="line.390"></a>
<span class="sourceLineNo">391</span> public void reconfigure(Dictionary configuration) {<a name="line.391"></a>
<span class="sourceLineNo">392</span> Map&lt;String, Object&gt; map = new LinkedHashMap&lt;String, Object&gt;();<a name="line.392"></a>
<span class="sourceLineNo">393</span> synchronized (this) {<a name="line.393"></a>
<span class="sourceLineNo">394</span> info(getInstanceManager().getInstanceName() + " is reconfiguring the properties : " + configuration);<a name="line.394"></a>
<span class="sourceLineNo">395</span> Properties props = reconfigureProperties(configuration);<a name="line.395"></a>
<span class="sourceLineNo">396</span> propagate(props, m_propagatedFromInstance);<a name="line.396"></a>
<span class="sourceLineNo">397</span> m_propagatedFromInstance = props;<a name="line.397"></a>
<span class="sourceLineNo">398</span><a name="line.398"></a>
<span class="sourceLineNo">399</span> if (getInstanceManager().getPojoObjects() != null) {<a name="line.399"></a>
<span class="sourceLineNo">400</span> try {<a name="line.400"></a>
<span class="sourceLineNo">401</span> notifyUpdated(null);<a name="line.401"></a>
<span class="sourceLineNo">402</span> } catch (Throwable e) {<a name="line.402"></a>
<span class="sourceLineNo">403</span> error("Cannot call the updated method : " + e.getMessage(), e);<a name="line.403"></a>
<span class="sourceLineNo">404</span> }<a name="line.404"></a>
<span class="sourceLineNo">405</span> }<a name="line.405"></a>
<span class="sourceLineNo">406</span> // Make a snapshot of the current configuration<a name="line.406"></a>
<span class="sourceLineNo">407</span> for (Property p : m_configurableProperties) {<a name="line.407"></a>
<span class="sourceLineNo">408</span> map.put(p.getName(), p.getValue());<a name="line.408"></a>
<span class="sourceLineNo">409</span> }<a name="line.409"></a>
<span class="sourceLineNo">410</span> }<a name="line.410"></a>
<span class="sourceLineNo">411</span> notifyListeners(map);<a name="line.411"></a>
<span class="sourceLineNo">412</span> }<a name="line.412"></a>
<span class="sourceLineNo">413</span><a name="line.413"></a>
<span class="sourceLineNo">414</span> /**<a name="line.414"></a>
<span class="sourceLineNo">415</span> * Reconfigured configuration properties and returns non matching properties.<a name="line.415"></a>
<span class="sourceLineNo">416</span> * When called, it must hold the monitor lock.<a name="line.416"></a>
<span class="sourceLineNo">417</span> *<a name="line.417"></a>
<span class="sourceLineNo">418</span> * @param configuration : new configuration<a name="line.418"></a>
<span class="sourceLineNo">419</span> * @return the properties that does not match with configuration properties<a name="line.419"></a>
<span class="sourceLineNo">420</span> */<a name="line.420"></a>
<span class="sourceLineNo">421</span> private Properties reconfigureProperties(Dictionary configuration) {<a name="line.421"></a>
<span class="sourceLineNo">422</span> Properties toPropagate = new Properties();<a name="line.422"></a>
<span class="sourceLineNo">423</span> Enumeration keysEnumeration = configuration.keys();<a name="line.423"></a>
<span class="sourceLineNo">424</span> while (keysEnumeration.hasMoreElements()) {<a name="line.424"></a>
<span class="sourceLineNo">425</span> String name = (String) keysEnumeration.nextElement();<a name="line.425"></a>
<span class="sourceLineNo">426</span> Object value = configuration.get(name);<a name="line.426"></a>
<span class="sourceLineNo">427</span> boolean found = false;<a name="line.427"></a>
<span class="sourceLineNo">428</span> // Check if the name is a configurable property<a name="line.428"></a>
<span class="sourceLineNo">429</span> for (Property prop : m_configurableProperties) {<a name="line.429"></a>
<span class="sourceLineNo">430</span> if (prop.getName().equals(name)) {<a name="line.430"></a>
<span class="sourceLineNo">431</span> reconfigureProperty(prop, value);<a name="line.431"></a>
<span class="sourceLineNo">432</span> found = true;<a name="line.432"></a>
<span class="sourceLineNo">433</span> break; // Exit the search loop<a name="line.433"></a>
<span class="sourceLineNo">434</span> }<a name="line.434"></a>
<span class="sourceLineNo">435</span> }<a name="line.435"></a>
<span class="sourceLineNo">436</span> if (!found) {<a name="line.436"></a>
<span class="sourceLineNo">437</span> // The property is not a configurable property, add it to the toPropagate list.<a name="line.437"></a>
<span class="sourceLineNo">438</span> toPropagate.put(name, value);<a name="line.438"></a>
<span class="sourceLineNo">439</span> }<a name="line.439"></a>
<span class="sourceLineNo">440</span> }<a name="line.440"></a>
<span class="sourceLineNo">441</span><a name="line.441"></a>
<span class="sourceLineNo">442</span> // Every removed configurable property gets reset to its default value<a name="line.442"></a>
<span class="sourceLineNo">443</span> for (Property prop : m_configurableProperties) {<a name="line.443"></a>
<span class="sourceLineNo">444</span> if (configuration.get(prop.getName()) == null) {<a name="line.444"></a>
<span class="sourceLineNo">445</span> reconfigureProperty(prop, prop.getDefaultValue());<a name="line.445"></a>
<span class="sourceLineNo">446</span> }<a name="line.446"></a>
<span class="sourceLineNo">447</span> }<a name="line.447"></a>
<span class="sourceLineNo">448</span> return toPropagate;<a name="line.448"></a>
<span class="sourceLineNo">449</span><a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span> /**<a name="line.452"></a>
<span class="sourceLineNo">453</span> * Reconfigures the given property with the given value.<a name="line.453"></a>
<span class="sourceLineNo">454</span> * This methods handles {@link org.apache.felix.ipojo.InstanceManager#onSet(Object, String, Object)}<a name="line.454"></a>
<span class="sourceLineNo">455</span> * call and the callback invocation.<a name="line.455"></a>
<span class="sourceLineNo">456</span> * The reconfiguration occurs only if the value changes.<a name="line.456"></a>
<span class="sourceLineNo">457</span> *<a name="line.457"></a>
<span class="sourceLineNo">458</span> * @param prop the property object to reconfigure<a name="line.458"></a>
<span class="sourceLineNo">459</span> * @param value the new value.<a name="line.459"></a>
<span class="sourceLineNo">460</span> */<a name="line.460"></a>
<span class="sourceLineNo">461</span> public void reconfigureProperty(Property prop, Object value) {<a name="line.461"></a>
<span class="sourceLineNo">462</span> if (prop.getValue() == null || !prop.getValue().equals(value)) {<a name="line.462"></a>
<span class="sourceLineNo">463</span> prop.setValue(value);<a name="line.463"></a>
<span class="sourceLineNo">464</span> if (prop.hasField()) {<a name="line.464"></a>
<span class="sourceLineNo">465</span> getInstanceManager().onSet(null, prop.getField(), prop.getValue()); // Notify other handler of the field value change.<a name="line.465"></a>
<span class="sourceLineNo">466</span> }<a name="line.466"></a>
<span class="sourceLineNo">467</span> if (prop.hasMethod()) {<a name="line.467"></a>
<span class="sourceLineNo">468</span> if (getInstanceManager().getPojoObjects() != null) {<a name="line.468"></a>
<span class="sourceLineNo">469</span> prop.invoke(null); // Call on all created pojo objects.<a name="line.469"></a>
<span class="sourceLineNo">470</span> }<a name="line.470"></a>
<span class="sourceLineNo">471</span> }<a name="line.471"></a>
<span class="sourceLineNo">472</span> }<a name="line.472"></a>
<span class="sourceLineNo">473</span> }<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> * Removes the old properties from the provided services and propagate new properties.<a name="line.476"></a>
<span class="sourceLineNo">477</span> *<a name="line.477"></a>
<span class="sourceLineNo">478</span> * @param newProps : new properties to propagate<a name="line.478"></a>
<span class="sourceLineNo">479</span> * @param oldProps : old properties to remove<a name="line.479"></a>
<span class="sourceLineNo">480</span> */<a name="line.480"></a>
<span class="sourceLineNo">481</span> private void propagate(Dictionary newProps, Dictionary oldProps) {<a name="line.481"></a>
<span class="sourceLineNo">482</span> if (m_mustPropagate &amp;&amp; m_providedServiceHandler != null) {<a name="line.482"></a>
<span class="sourceLineNo">483</span> if (oldProps != null) {<a name="line.483"></a>
<span class="sourceLineNo">484</span> m_providedServiceHandler.removeProperties(oldProps);<a name="line.484"></a>
<span class="sourceLineNo">485</span> }<a name="line.485"></a>
<span class="sourceLineNo">486</span><a name="line.486"></a>
<span class="sourceLineNo">487</span> if (newProps != null) {<a name="line.487"></a>
<span class="sourceLineNo">488</span> // Remove the name, the pid and the managed service pid props<a name="line.488"></a>
<span class="sourceLineNo">489</span> newProps.remove("name");<a name="line.489"></a>
<span class="sourceLineNo">490</span> newProps.remove("managed.service.pid");<a name="line.490"></a>
<span class="sourceLineNo">491</span> newProps.remove(Constants.SERVICE_PID);<a name="line.491"></a>
<span class="sourceLineNo">492</span><a name="line.492"></a>
<span class="sourceLineNo">493</span> // Remove all properties starting with . (config admin specification)<a name="line.493"></a>
<span class="sourceLineNo">494</span> Enumeration&lt;String&gt; keys = newProps.keys();<a name="line.494"></a>
<span class="sourceLineNo">495</span> List&lt;String&gt; propertiesStartingWithDot = new ArrayList&lt;String&gt;();<a name="line.495"></a>
<span class="sourceLineNo">496</span> while (keys.hasMoreElements()) {<a name="line.496"></a>
<span class="sourceLineNo">497</span> String key = keys.nextElement();<a name="line.497"></a>
<span class="sourceLineNo">498</span> if (key.startsWith(".")) {<a name="line.498"></a>
<span class="sourceLineNo">499</span> propertiesStartingWithDot.add(key);<a name="line.499"></a>
<span class="sourceLineNo">500</span> }<a name="line.500"></a>
<span class="sourceLineNo">501</span> }<a name="line.501"></a>
<span class="sourceLineNo">502</span> for (String k : propertiesStartingWithDot) {<a name="line.502"></a>
<span class="sourceLineNo">503</span> newProps.remove(k);<a name="line.503"></a>
<span class="sourceLineNo">504</span> }<a name="line.504"></a>
<span class="sourceLineNo">505</span><a name="line.505"></a>
<span class="sourceLineNo">506</span> // Propagation of the properties to service registrations :<a name="line.506"></a>
<span class="sourceLineNo">507</span> m_providedServiceHandler.addProperties(newProps);<a name="line.507"></a>
<span class="sourceLineNo">508</span> }<a name="line.508"></a>
<span class="sourceLineNo">509</span> }<a name="line.509"></a>
<span class="sourceLineNo">510</span> }<a name="line.510"></a>
<span class="sourceLineNo">511</span><a name="line.511"></a>
<span class="sourceLineNo">512</span> /**<a name="line.512"></a>
<span class="sourceLineNo">513</span> * Handler createInstance method.<a name="line.513"></a>
<span class="sourceLineNo">514</span> * This method is override to allow delayed callback invocation.<a name="line.514"></a>
<span class="sourceLineNo">515</span> * Invokes the updated method is needed.<a name="line.515"></a>
<span class="sourceLineNo">516</span> *<a name="line.516"></a>
<span class="sourceLineNo">517</span> * @param instance : the created object<a name="line.517"></a>
<span class="sourceLineNo">518</span> * @see org.apache.felix.ipojo.PrimitiveHandler#onCreation(Object)<a name="line.518"></a>
<span class="sourceLineNo">519</span> */<a name="line.519"></a>
<span class="sourceLineNo">520</span> public void onCreation(Object instance) {<a name="line.520"></a>
<span class="sourceLineNo">521</span> Map&lt;String, Object&gt; map = new LinkedHashMap&lt;String, Object&gt;();<a name="line.521"></a>
<span class="sourceLineNo">522</span> for (Property prop : m_configurableProperties) {<a name="line.522"></a>
<span class="sourceLineNo">523</span> if (prop.hasMethod()) {<a name="line.523"></a>
<span class="sourceLineNo">524</span> prop.invoke(instance);<a name="line.524"></a>
<span class="sourceLineNo">525</span> }<a name="line.525"></a>
<span class="sourceLineNo">526</span> // Fill the snapshot copy while calling callbacks<a name="line.526"></a>
<span class="sourceLineNo">527</span> map.put(prop.getName(), prop.getValue());<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> try {<a name="line.530"></a>
<span class="sourceLineNo">531</span> notifyUpdated(instance);<a name="line.531"></a>
<span class="sourceLineNo">532</span> } catch (Throwable e) {<a name="line.532"></a>
<span class="sourceLineNo">533</span> error("Cannot call the updated method : " + e.getMessage(), e);<a name="line.533"></a>
<span class="sourceLineNo">534</span> }<a name="line.534"></a>
<span class="sourceLineNo">535</span> notifyListeners(map);<a name="line.535"></a>
<span class="sourceLineNo">536</span> }<a name="line.536"></a>
<span class="sourceLineNo">537</span><a name="line.537"></a>
<span class="sourceLineNo">538</span> /**<a name="line.538"></a>
<span class="sourceLineNo">539</span> * Invokes the updated method.<a name="line.539"></a>
<span class="sourceLineNo">540</span> * This method build the dictionary containing all valued properties,<a name="line.540"></a>
<span class="sourceLineNo">541</span> * as well as properties propagated to the provided service handler (<a name="line.541"></a>
<span class="sourceLineNo">542</span> * only if the propagation is enabled).<a name="line.542"></a>
<span class="sourceLineNo">543</span> *<a name="line.543"></a>
<span class="sourceLineNo">544</span> * @param instance the instance on which the callback must be called.<a name="line.544"></a>
<span class="sourceLineNo">545</span> * If &lt;code&gt;null&lt;/code&gt; the callback is called on all the existing<a name="line.545"></a>
<span class="sourceLineNo">546</span> * object.<a name="line.546"></a>
<span class="sourceLineNo">547</span> */<a name="line.547"></a>
<span class="sourceLineNo">548</span> private void notifyUpdated(Object instance) {<a name="line.548"></a>
<span class="sourceLineNo">549</span> if (m_updated == null) {<a name="line.549"></a>
<span class="sourceLineNo">550</span> return;<a name="line.550"></a>
<span class="sourceLineNo">551</span> }<a name="line.551"></a>
<span class="sourceLineNo">552</span><a name="line.552"></a>
<span class="sourceLineNo">553</span> if (m_updated.getArguments().length == 0) {<a name="line.553"></a>
<span class="sourceLineNo">554</span> // We don't have to compute the properties,<a name="line.554"></a>
<span class="sourceLineNo">555</span> // we just call the callback.<a name="line.555"></a>
<span class="sourceLineNo">556</span> try {<a name="line.556"></a>
<span class="sourceLineNo">557</span> if (instance == null) {<a name="line.557"></a>
<span class="sourceLineNo">558</span> m_updated.call(new Object[0]);<a name="line.558"></a>
<span class="sourceLineNo">559</span> } else {<a name="line.559"></a>
<span class="sourceLineNo">560</span> m_updated.call(instance, new Object[0]);<a name="line.560"></a>
<span class="sourceLineNo">561</span> }<a name="line.561"></a>
<span class="sourceLineNo">562</span> } catch (Exception e) {<a name="line.562"></a>
<span class="sourceLineNo">563</span> error("Cannot call the updated method " + m_updated.getMethod() + " : " + e.getMessage());<a name="line.563"></a>
<span class="sourceLineNo">564</span> }<a name="line.564"></a>
<span class="sourceLineNo">565</span> return;<a name="line.565"></a>
<span class="sourceLineNo">566</span> }<a name="line.566"></a>
<span class="sourceLineNo">567</span><a name="line.567"></a>
<span class="sourceLineNo">568</span> // Else we must compute the properties.<a name="line.568"></a>
<span class="sourceLineNo">569</span> Properties props = new Properties();<a name="line.569"></a>
<span class="sourceLineNo">570</span> for (Property property : m_configurableProperties) {<a name="line.570"></a>
<span class="sourceLineNo">571</span> String n = property.getName();<a name="line.571"></a>
<span class="sourceLineNo">572</span> Object v = property.getValue();<a name="line.572"></a>
<span class="sourceLineNo">573</span> if (v != Property.NO_VALUE) {<a name="line.573"></a>
<span class="sourceLineNo">574</span> props.put(n, v);<a name="line.574"></a>
<span class="sourceLineNo">575</span> }<a name="line.575"></a>
<span class="sourceLineNo">576</span> }<a name="line.576"></a>
<span class="sourceLineNo">577</span> // add propagate properties to the list if propagation is enabled<a name="line.577"></a>
<span class="sourceLineNo">578</span> if (m_mustPropagate) {<a name="line.578"></a>
<span class="sourceLineNo">579</span> // Start by properties from the configuration admin,<a name="line.579"></a>
<span class="sourceLineNo">580</span> if (m_propagatedFromCA != null) {<a name="line.580"></a>
<span class="sourceLineNo">581</span><a name="line.581"></a>
<span class="sourceLineNo">582</span> Enumeration e = m_propagatedFromCA.keys();<a name="line.582"></a>
<span class="sourceLineNo">583</span> while (e.hasMoreElements()) {<a name="line.583"></a>
<span class="sourceLineNo">584</span> String k = (String) e.nextElement();<a name="line.584"></a>
<span class="sourceLineNo">585</span> if (!k.equals(Factory.INSTANCE_NAME_PROPERTY)) {<a name="line.585"></a>
<span class="sourceLineNo">586</span> props.put(k, m_propagatedFromCA.get(k));<a name="line.586"></a>
<span class="sourceLineNo">587</span> }<a name="line.587"></a>
<span class="sourceLineNo">588</span> }<a name="line.588"></a>
<span class="sourceLineNo">589</span> }<a name="line.589"></a>
<span class="sourceLineNo">590</span> // Do also the one from the instance configuration<a name="line.590"></a>
<span class="sourceLineNo">591</span> if (m_propagatedFromInstance != null) {<a name="line.591"></a>
<span class="sourceLineNo">592</span> Enumeration e = m_propagatedFromInstance.keys();<a name="line.592"></a>
<span class="sourceLineNo">593</span> while (e.hasMoreElements()) {<a name="line.593"></a>
<span class="sourceLineNo">594</span> String k = (String) e.nextElement();<a name="line.594"></a>
<span class="sourceLineNo">595</span> if (!k.equals(Factory.INSTANCE_NAME_PROPERTY)) { // Skip instance.name<a name="line.595"></a>
<span class="sourceLineNo">596</span> props.put(k, m_propagatedFromInstance.get(k));<a name="line.596"></a>
<span class="sourceLineNo">597</span> }<a name="line.597"></a>
<span class="sourceLineNo">598</span> }<a name="line.598"></a>
<span class="sourceLineNo">599</span> }<a name="line.599"></a>
<span class="sourceLineNo">600</span> }<a name="line.600"></a>
<span class="sourceLineNo">601</span><a name="line.601"></a>
<span class="sourceLineNo">602</span> try {<a name="line.602"></a>
<span class="sourceLineNo">603</span> if (instance == null) {<a name="line.603"></a>
<span class="sourceLineNo">604</span> m_updated.call(new Object[]{props});<a name="line.604"></a>
<span class="sourceLineNo">605</span> } else {<a name="line.605"></a>
<span class="sourceLineNo">606</span> m_updated.call(instance, new Object[]{props});<a name="line.606"></a>
<span class="sourceLineNo">607</span> }<a name="line.607"></a>
<span class="sourceLineNo">608</span> } catch (Exception e) {<a name="line.608"></a>
<span class="sourceLineNo">609</span> error("Cannot call the updated method " + m_updated.getMethod() + " : " + e.getMessage());<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> /**<a name="line.613"></a>
<span class="sourceLineNo">614</span> * Managed Service method.<a name="line.614"></a>
<span class="sourceLineNo">615</span> * This method is called when the instance is reconfigured by the ConfigurationAdmin.<a name="line.615"></a>
<span class="sourceLineNo">616</span> * When called, it must hold the monitor lock.<a name="line.616"></a>
<span class="sourceLineNo">617</span> *<a name="line.617"></a>
<span class="sourceLineNo">618</span> * @param conf : pushed configuration.<a name="line.618"></a>
<span class="sourceLineNo">619</span> * @throws org.osgi.service.cm.ConfigurationException<a name="line.619"></a>
<span class="sourceLineNo">620</span> * the reconfiguration failed.<a name="line.620"></a>
<span class="sourceLineNo">621</span> * @see org.osgi.service.cm.ManagedService#updated(java.util.Dictionary)<a name="line.621"></a>
<span class="sourceLineNo">622</span> */<a name="line.622"></a>
<span class="sourceLineNo">623</span> public void updated(Dictionary conf) throws org.osgi.service.cm.ConfigurationException {<a name="line.623"></a>
<span class="sourceLineNo">624</span> Map&lt;String, Object&gt; map = new LinkedHashMap&lt;String, Object&gt;();<a name="line.624"></a>
<span class="sourceLineNo">625</span> synchronized (this) {<a name="line.625"></a>
<span class="sourceLineNo">626</span> if (conf == null &amp;&amp; !m_configurationAlreadyPushed) {<a name="line.626"></a>
<span class="sourceLineNo">627</span> return; // First call<a name="line.627"></a>
<span class="sourceLineNo">628</span> } else if (conf != null) { // Configuration push<a name="line.628"></a>
<span class="sourceLineNo">629</span> Properties props = reconfigureProperties(conf);<a name="line.629"></a>
<span class="sourceLineNo">630</span> propagate(props, m_propagatedFromCA);<a name="line.630"></a>
<span class="sourceLineNo">631</span> m_propagatedFromCA = props;<a name="line.631"></a>
<span class="sourceLineNo">632</span> m_configurationAlreadyPushed = true;<a name="line.632"></a>
<span class="sourceLineNo">633</span> } else if (m_configurationAlreadyPushed) { // Configuration deletion<a name="line.633"></a>
<span class="sourceLineNo">634</span> propagate(null, m_propagatedFromCA);<a name="line.634"></a>
<span class="sourceLineNo">635</span> m_propagatedFromCA = null;<a name="line.635"></a>
<span class="sourceLineNo">636</span> m_configurationAlreadyPushed = false;<a name="line.636"></a>
<span class="sourceLineNo">637</span> }<a name="line.637"></a>
<span class="sourceLineNo">638</span><a name="line.638"></a>
<span class="sourceLineNo">639</span> if (getInstanceManager().getPojoObjects() != null) {<a name="line.639"></a>
<span class="sourceLineNo">640</span> try {<a name="line.640"></a>
<span class="sourceLineNo">641</span> notifyUpdated(null);<a name="line.641"></a>
<span class="sourceLineNo">642</span> } catch (Throwable e) {<a name="line.642"></a>
<span class="sourceLineNo">643</span> error("Cannot call the updated method : " + e.getMessage(), e);<a name="line.643"></a>
<span class="sourceLineNo">644</span> }<a name="line.644"></a>
<span class="sourceLineNo">645</span> }<a name="line.645"></a>
<span class="sourceLineNo">646</span> // Make a snapshot of the current configuration<a name="line.646"></a>
<span class="sourceLineNo">647</span> for (Property p : m_configurableProperties) {<a name="line.647"></a>
<span class="sourceLineNo">648</span> map.put(p.getName(), p.getValue());<a name="line.648"></a>
<span class="sourceLineNo">649</span> }<a name="line.649"></a>
<span class="sourceLineNo">650</span> }<a name="line.650"></a>
<span class="sourceLineNo">651</span> notifyListeners(map);<a name="line.651"></a>
<span class="sourceLineNo">652</span> }<a name="line.652"></a>
<span class="sourceLineNo">653</span><a name="line.653"></a>
<span class="sourceLineNo">654</span> /**<a name="line.654"></a>
<span class="sourceLineNo">655</span> * Gets the configuration handler description.<a name="line.655"></a>
<span class="sourceLineNo">656</span> *<a name="line.656"></a>
<span class="sourceLineNo">657</span> * @return the configuration handler description.<a name="line.657"></a>
<span class="sourceLineNo">658</span> * @see org.apache.felix.ipojo.Handler#getDescription()<a name="line.658"></a>
<span class="sourceLineNo">659</span> */<a name="line.659"></a>
<span class="sourceLineNo">660</span> public HandlerDescription getDescription() {<a name="line.660"></a>
<span class="sourceLineNo">661</span> return m_description;<a name="line.661"></a>
<span class="sourceLineNo">662</span> }<a name="line.662"></a>
<span class="sourceLineNo">663</span><a name="line.663"></a>
<span class="sourceLineNo">664</span> /**<a name="line.664"></a>
<span class="sourceLineNo">665</span> * Add the given listener to the configuration handler's list of listeners.<a name="line.665"></a>
<span class="sourceLineNo">666</span> *<a name="line.666"></a>
<span class="sourceLineNo">667</span> * @param listener the {@code ConfigurationListener} object to be added<a name="line.667"></a>
<span class="sourceLineNo">668</span> * @throws NullPointerException if {@code listener} is {@code null}<a name="line.668"></a>
<span class="sourceLineNo">669</span> */<a name="line.669"></a>
<span class="sourceLineNo">670</span> public void addListener(ConfigurationListener listener) {<a name="line.670"></a>
<span class="sourceLineNo">671</span> if (listener == null) {<a name="line.671"></a>
<span class="sourceLineNo">672</span> throw new NullPointerException("null listener");<a name="line.672"></a>
<span class="sourceLineNo">673</span> }<a name="line.673"></a>
<span class="sourceLineNo">674</span> synchronized (m_listeners) {<a name="line.674"></a>
<span class="sourceLineNo">675</span> m_listeners.add(listener);<a name="line.675"></a>
<span class="sourceLineNo">676</span> }<a name="line.676"></a>
<span class="sourceLineNo">677</span> }<a name="line.677"></a>
<span class="sourceLineNo">678</span><a name="line.678"></a>
<span class="sourceLineNo">679</span> /**<a name="line.679"></a>
<span class="sourceLineNo">680</span> * Remove the given listener from the configuration handler's list of listeners.<a name="line.680"></a>
<span class="sourceLineNo">681</span> *<a name="line.681"></a>
<span class="sourceLineNo">682</span> * @param listener the {@code ConfigurationListener} object to be removed<a name="line.682"></a>
<span class="sourceLineNo">683</span> * @throws NullPointerException if {@code listener} is {@code null}<a name="line.683"></a>
<span class="sourceLineNo">684</span> * @throws NoSuchElementException if {@code listener} wasn't present the in configuration handler's list of listeners<a name="line.684"></a>
<span class="sourceLineNo">685</span> */<a name="line.685"></a>
<span class="sourceLineNo">686</span> public void removeListener(ConfigurationListener listener) {<a name="line.686"></a>
<span class="sourceLineNo">687</span> if (listener == null) {<a name="line.687"></a>
<span class="sourceLineNo">688</span> throw new NullPointerException("null listener");<a name="line.688"></a>
<span class="sourceLineNo">689</span> }<a name="line.689"></a>
<span class="sourceLineNo">690</span> synchronized (m_listeners) {<a name="line.690"></a>
<span class="sourceLineNo">691</span> // We definitely cannot rely on listener's equals method...<a name="line.691"></a>
<span class="sourceLineNo">692</span> // ...so we need to manually search for the listener, using ==.<a name="line.692"></a>
<span class="sourceLineNo">693</span> int i = -1;<a name="line.693"></a>
<span class="sourceLineNo">694</span> for(int j = m_listeners.size() -1; j&gt;=0 ; j--) {<a name="line.694"></a>
<span class="sourceLineNo">695</span> if (m_listeners.get(j) == listener) {<a name="line.695"></a>
<span class="sourceLineNo">696</span> // Found!<a name="line.696"></a>
<span class="sourceLineNo">697</span> i = j;<a name="line.697"></a>
<span class="sourceLineNo">698</span> break;<a name="line.698"></a>
<span class="sourceLineNo">699</span> }<a name="line.699"></a>
<span class="sourceLineNo">700</span> }<a name="line.700"></a>
<span class="sourceLineNo">701</span> if (i != -1) {<a name="line.701"></a>
<span class="sourceLineNo">702</span> m_listeners.remove(i);<a name="line.702"></a>
<span class="sourceLineNo">703</span> } else {<a name="line.703"></a>
<span class="sourceLineNo">704</span> throw new NoSuchElementException("no such listener");<a name="line.704"></a>
<span class="sourceLineNo">705</span> }<a name="line.705"></a>
<span class="sourceLineNo">706</span> }<a name="line.706"></a>
<span class="sourceLineNo">707</span> }<a name="line.707"></a>
<span class="sourceLineNo">708</span><a name="line.708"></a>
<span class="sourceLineNo">709</span> /**<a name="line.709"></a>
<span class="sourceLineNo">710</span> * Notify all listeners that a reconfiguration has occurred.<a name="line.710"></a>
<span class="sourceLineNo">711</span> *<a name="line.711"></a>
<span class="sourceLineNo">712</span> * @param map the new configuration of the component instance.<a name="line.712"></a>
<span class="sourceLineNo">713</span> */<a name="line.713"></a>
<span class="sourceLineNo">714</span> private void notifyListeners(Map&lt;String, Object&gt; map) {<a name="line.714"></a>
<span class="sourceLineNo">715</span> // Get a snapshot of the listeners<a name="line.715"></a>
<span class="sourceLineNo">716</span> List&lt;ConfigurationListener&gt; tmp;<a name="line.716"></a>
<span class="sourceLineNo">717</span> synchronized (m_listeners) {<a name="line.717"></a>
<span class="sourceLineNo">718</span> tmp = new ArrayList&lt;ConfigurationListener&gt;(m_listeners);<a name="line.718"></a>
<span class="sourceLineNo">719</span> }<a name="line.719"></a>
<span class="sourceLineNo">720</span> // Protect the map.<a name="line.720"></a>
<span class="sourceLineNo">721</span> map = Collections.unmodifiableMap(map);<a name="line.721"></a>
<span class="sourceLineNo">722</span> // Do notify, outside any lock<a name="line.722"></a>
<span class="sourceLineNo">723</span> for (ConfigurationListener l : tmp) {<a name="line.723"></a>
<span class="sourceLineNo">724</span> try {<a name="line.724"></a>
<span class="sourceLineNo">725</span> l.configurationChanged(getInstanceManager(), map);<a name="line.725"></a>
<span class="sourceLineNo">726</span> } catch (Throwable e) {<a name="line.726"></a>
<span class="sourceLineNo">727</span> // Failure inside a listener: put a warning on the logger, and continue<a name="line.727"></a>
<span class="sourceLineNo">728</span> warn(String.format(<a name="line.728"></a>
<span class="sourceLineNo">729</span> "[%s] A ConfigurationListener has failed: %s",<a name="line.729"></a>
<span class="sourceLineNo">730</span> getInstanceManager().getInstanceName(),<a name="line.730"></a>
<span class="sourceLineNo">731</span> e.getMessage())<a name="line.731"></a>
<span class="sourceLineNo">732</span> , e);<a name="line.732"></a>
<span class="sourceLineNo">733</span> }<a name="line.733"></a>
<span class="sourceLineNo">734</span> }<a name="line.734"></a>
<span class="sourceLineNo">735</span> }<a name="line.735"></a>
<span class="sourceLineNo">736</span><a name="line.736"></a>
<span class="sourceLineNo">737</span> @Override<a name="line.737"></a>
<span class="sourceLineNo">738</span> public void stateChanged(int state) {<a name="line.738"></a>
<span class="sourceLineNo">739</span> if (state == ComponentInstance.DISPOSED) {<a name="line.739"></a>
<span class="sourceLineNo">740</span> // Clean up the list of listeners<a name="line.740"></a>
<span class="sourceLineNo">741</span> synchronized (m_listeners) {<a name="line.741"></a>
<span class="sourceLineNo">742</span> m_listeners.clear();<a name="line.742"></a>
<span class="sourceLineNo">743</span> }<a name="line.743"></a>
<span class="sourceLineNo">744</span> }<a name="line.744"></a>
<span class="sourceLineNo">745</span> super.stateChanged(state);<a name="line.745"></a>
<span class="sourceLineNo">746</span> }<a name="line.746"></a>
<span class="sourceLineNo">747</span>}<a name="line.747"></a>
</pre>
</div>
</body>
</html>