blob: 90695c1f657279ccd96e6291c2761a9b692ca500 [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.composite.service.provides;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Properties;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.ComponentFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.ComponentInstance;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.ConfigurationException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.felix.ipojo.MissingHandlerException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.felix.ipojo.ServiceContext;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.felix.ipojo.UnacceptableConfiguration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.felix.ipojo.composite.CompositeManager;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.felix.ipojo.composite.instance.InstanceHandler;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.felix.ipojo.util.DependencyMetadataHelper;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.felix.ipojo.util.DependencyModel;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.felix.ipojo.util.DependencyStateListener;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.felix.ipojo.util.Logger;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.osgi.framework.BundleContext;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.osgi.framework.Filter;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.osgi.framework.InvalidSyntaxException;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>/**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Composite Provided Service.<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 ProvidedService implements DependencyStateListener {<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> * Composite Manager.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> private CompositeManager m_manager;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
<span class="sourceLineNo">053</span> * Composition Model.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> private CompositionMetadata m_composition;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Internal context.<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> private ServiceContext m_scope;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * External context.<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> private BundleContext m_context;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Created Factory.<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> private ComponentFactory m_factory;<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> * Created Instance.<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> private ComponentInstance m_instance;<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> * Exporter.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> private ServiceExporter m_exports;<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> * Created instance name.<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> private String m_instanceName;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Constructor.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * The delegation mapping is infers in this method.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @param handler : the handler.<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @param element : 'provides' element.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @param name : name of this provided service.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> public ProvidedService(ProvidedServiceHandler handler, Element element, String name) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> m_manager = handler.getCompositeManager();<a name="line.95"></a>
<span class="sourceLineNo">096</span> m_scope = m_manager.getServiceContext();<a name="line.96"></a>
<span class="sourceLineNo">097</span> m_context = m_manager.getContext();<a name="line.97"></a>
<span class="sourceLineNo">098</span> m_composition = new CompositionMetadata(m_manager.getContext(), element, handler, name);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> * Start method.<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Build service implementation type, factory and instance.<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @throws CompositionException if a consistent mapping cannot be discovered.<a name="line.104"></a>
<span class="sourceLineNo">105</span> */<a name="line.105"></a>
<span class="sourceLineNo">106</span> public void start() throws CompositionException {<a name="line.106"></a>
<span class="sourceLineNo">107</span> m_composition.buildMapping();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> m_instanceName = m_composition.getSpecificationMetadata().getName() + "Provider-Gen";<a name="line.109"></a>
<span class="sourceLineNo">110</span> byte[] clazz = m_composition.buildPOJO();<a name="line.110"></a>
<span class="sourceLineNo">111</span> Element metadata = m_composition.buildMetadata(m_instanceName);<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> // Create the factory<a name="line.113"></a>
<span class="sourceLineNo">114</span> try {<a name="line.114"></a>
<span class="sourceLineNo">115</span> m_factory = new ComponentFactory(m_context, clazz, metadata);<a name="line.115"></a>
<span class="sourceLineNo">116</span> m_factory.setUseFactoryClassloader(true);<a name="line.116"></a>
<span class="sourceLineNo">117</span> m_factory.start();<a name="line.117"></a>
<span class="sourceLineNo">118</span> } catch (ConfigurationException e) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> // Should not happen.<a name="line.119"></a>
<span class="sourceLineNo">120</span> m_manager.getFactory().getLogger().log(Logger.ERROR, "A factory cannot be created", e);<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> try {<a name="line.123"></a>
<span class="sourceLineNo">124</span> Class spec = DependencyMetadataHelper.loadSpecification(m_composition.getSpecificationMetadata().getName(), m_context);<a name="line.124"></a>
<span class="sourceLineNo">125</span> Filter filter = m_context.createFilter("(instance.name=" + m_instanceName + ")");<a name="line.125"></a>
<span class="sourceLineNo">126</span> // Create the exports<a name="line.126"></a>
<span class="sourceLineNo">127</span> m_exports = new ServiceExporter(spec, filter, false, false, null, DependencyModel.DYNAMIC_BINDING_POLICY, m_scope, m_context, this, m_manager);<a name="line.127"></a>
<span class="sourceLineNo">128</span> } catch (InvalidSyntaxException e) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> throw new CompositionException("A provided service filter is invalid", e);<a name="line.129"></a>
<span class="sourceLineNo">130</span> } catch (ConfigurationException e) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> throw new CompositionException("The class " + m_composition.getSpecificationMetadata().getName() + " cannot be loaded", e);<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><a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Stop the provided service.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Kill the exporter, the instance and the factory.<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public void stop() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (m_exports != null) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> m_exports.stop();<a name="line.141"></a>
<span class="sourceLineNo">142</span> m_exports = null;<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> if (m_instance != null) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> m_instance.dispose();<a name="line.145"></a>
<span class="sourceLineNo">146</span> m_instance = null;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (m_factory != null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> m_factory.stop();<a name="line.149"></a>
<span class="sourceLineNo">150</span> m_factory = null;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> protected CompositeManager getManager() {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return m_manager;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> /**<a name="line.158"></a>
<span class="sourceLineNo">159</span> * The exporter becomes valid.<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @param exporter : the exporter<a name="line.160"></a>
<span class="sourceLineNo">161</span> */<a name="line.161"></a>
<span class="sourceLineNo">162</span> public void validate(DependencyModel exporter) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> // Nothing to do.<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * The exporter becomes invalid.<a name="line.167"></a>
<span class="sourceLineNo">168</span> * @param exporter : the exporter<a name="line.168"></a>
<span class="sourceLineNo">169</span> */<a name="line.169"></a>
<span class="sourceLineNo">170</span> public void invalidate(DependencyModel exporter) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> // Nothing to do.<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> * Get an object from the given type.<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @param type : type<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @return an object from an instance of this type or null<a name="line.177"></a>
<span class="sourceLineNo">178</span> */<a name="line.178"></a>
<span class="sourceLineNo">179</span> private Object getObjectByType(String type) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> InstanceHandler handler = (InstanceHandler) m_manager.getCompositeHandler("org.apache.felix.ipojo.composite.instance.InstanceHandler");<a name="line.180"></a>
<span class="sourceLineNo">181</span> Object pojo = handler.getObjectFromInstance(type);<a name="line.181"></a>
<span class="sourceLineNo">182</span> if (pojo == null) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> m_manager.getFactory().getLogger().log(Logger.ERROR, "An instance object cannot be found for the type : " + type);<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> return pojo;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> public String getSpecification() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> return m_composition.getSpecificationMetadata().getName();<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> * Unregister the exposed service.<a name="line.193"></a>
<span class="sourceLineNo">194</span> */<a name="line.194"></a>
<span class="sourceLineNo">195</span> public void unregister() {<a name="line.195"></a>
<span class="sourceLineNo">196</span> m_exports.stop();<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> /**<a name="line.199"></a>
<span class="sourceLineNo">200</span> * Register the exposed service.<a name="line.200"></a>
<span class="sourceLineNo">201</span> */<a name="line.201"></a>
<span class="sourceLineNo">202</span> public void register() {<a name="line.202"></a>
<span class="sourceLineNo">203</span> Properties props = new Properties();<a name="line.203"></a>
<span class="sourceLineNo">204</span> props.put("instance.name", m_instanceName);<a name="line.204"></a>
<span class="sourceLineNo">205</span> List fields = m_composition.getFieldList();<a name="line.205"></a>
<span class="sourceLineNo">206</span> for (int i = 0; i &lt; fields.size(); i++) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> FieldMetadata field = (FieldMetadata) fields.get(i);<a name="line.207"></a>
<span class="sourceLineNo">208</span> if (field.isUseful() &amp;&amp; !field.getSpecification().isInterface()) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> String type = field.getSpecification().getComponentType();<a name="line.209"></a>
<span class="sourceLineNo">210</span> Object pojo = getObjectByType(type);<a name="line.210"></a>
<span class="sourceLineNo">211</span> props.put(field.getName(), pojo);<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> if (m_instance == null) {<a name="line.215"></a>
<span class="sourceLineNo">216</span> // Else we have to create the instance <a name="line.216"></a>
<span class="sourceLineNo">217</span> try {<a name="line.217"></a>
<span class="sourceLineNo">218</span> m_instance = m_factory.createComponentInstance(props, m_manager.getServiceContext());<a name="line.218"></a>
<span class="sourceLineNo">219</span> } catch (UnacceptableConfiguration e) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> throw new IllegalStateException("Cannot create the service implementation", e);<a name="line.220"></a>
<span class="sourceLineNo">221</span> } catch (MissingHandlerException e) {<a name="line.221"></a>
<span class="sourceLineNo">222</span> throw new IllegalStateException("Cannot create the service implementation", e);<a name="line.222"></a>
<span class="sourceLineNo">223</span> } catch (ConfigurationException e) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> throw new IllegalStateException("Cannot create the service implementation", e);<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> } else {<a name="line.226"></a>
<span class="sourceLineNo">227</span> // We have to reconfigure the instance in order to inject up to date glue component instance.<a name="line.227"></a>
<span class="sourceLineNo">228</span> m_instance.reconfigure(props);<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span> <a name="line.230"></a>
<span class="sourceLineNo">231</span> m_exports.start();<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> public boolean isRegistered() {<a name="line.234"></a>
<span class="sourceLineNo">235</span> return m_exports.getState() == DependencyModel.RESOLVED;<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span>}<a name="line.238"></a>
</pre>
</div>
</body>
</html>