| <!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;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Dictionary;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.felix.ipojo.ComponentFactory;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.felix.ipojo.ComponentInstance;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.ConfigurationException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.felix.ipojo.Handler;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.HandlerFactory;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.felix.ipojo.HandlerManager;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.felix.ipojo.IPojoContext;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.felix.ipojo.MissingHandlerException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.felix.ipojo.UnacceptableConfiguration;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.felix.ipojo.util.Logger;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.felix.ipojo.util.Tracker;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.felix.ipojo.util.TrackerCustomizer;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.osgi.framework.BundleContext;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.osgi.framework.Constants;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.osgi.framework.InvalidSyntaxException;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span>/**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * The component factory manages component instance objects. This management<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * consist in creating and managing component instance build with the component<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * factory. This class could export Factory and ManagedServiceFactory services.<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 class CompositeFactory extends ComponentFactory implements TrackerCustomizer {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Tracker used to track required handler factories.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> protected Tracker m_tracker;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Create a composite factory.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param context : bundle context<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param metadata : metadata of the component to create<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @throws ConfigurationException occurs when the element describing the factory is malformed.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public CompositeFactory(BundleContext context, Element metadata) throws ConfigurationException {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> super(context, metadata);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> }<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> * Check if the metadata are well formed.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param metadata : metadata<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @throws ConfigurationException occurs when the element describing the factory is malformed.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @see org.apache.felix.ipojo.ComponentFactory#check(org.apache.felix.ipojo.metadata.Element)<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public void check(Element metadata) throws ConfigurationException {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> String name = metadata.getAttribute("name");<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> if (name == null) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> throw new ConfigurationException("A composite needs a name : " + metadata);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> <a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public String getClassName() { return null; }<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * Compute required handlers.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @return the list of required handler.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public List<RequiredHandler> getRequiredHandlerList() {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> List<RequiredHandler> list = new ArrayList<RequiredHandler>();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> Element[] elems = m_componentMetadata.getElements();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> for (Element current : elems) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> RequiredHandler req = new RequiredHandler(current.getName(), current.getNameSpace());<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> if (!list.contains(req)) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> list.add(req);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<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> // Add architecture if architecture != 'false'<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> String arch = m_componentMetadata.getAttribute("architecture");<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> if (arch == null || arch.equalsIgnoreCase("true")) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> RequiredHandler req = new RequiredHandler("architecture", null);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (! list.contains(req)) { list.add(req); }<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> return list;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> <a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Stop all the instance managers.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> */<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> public synchronized void stopping() {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if (m_tracker != null) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> m_tracker.close();<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> m_tracker = null;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Start all the instance managers.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public synchronized void starting() {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> if (m_requiredHandlers.size() != 0) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> try {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> String filter = "(&(" + Constants.OBJECTCLASS + "=" + HandlerFactory.class.getName() + ")"<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> + "(" + Handler.HANDLER_TYPE_PROPERTY + "=" + CompositeHandler.HANDLER_TYPE + ")" <a name="line.122"></a> |
| <span class="sourceLineNo">123</span> + "(factory.state=1)"<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> + ")";<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> m_tracker = new Tracker(m_context, m_context.createFilter(filter), this);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> m_tracker.open();<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> } catch (InvalidSyntaxException e) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> m_logger.log(Logger.ERROR, "A factory filter is not valid: " + e.getMessage());<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> stop();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> <a name="line.133"></a> |
| <span class="sourceLineNo">134</span> /**<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * Create an instance from the current factory.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @param configuration : instance configuration<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param context : bundle context to inject in the instance manager<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param handlers : array of handler object to attached on the instance <a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @return the created instance<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @throws ConfigurationException either the instance configuration or the instance starting has failed <a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @see org.apache.felix.ipojo.ComponentFactory#createInstance(java.util.Dictionary, org.apache.felix.ipojo.IPojoContext, org.apache.felix.ipojo.HandlerManager[])<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public ComponentInstance createInstance(Dictionary configuration, IPojoContext context, HandlerManager[] handlers) throws ConfigurationException {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> CompositeManager inst = new CompositeManager(this, context, handlers);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> inst.configure(m_componentMetadata, configuration);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> inst.start();<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return inst;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> /**<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Reconfigure an existing instance.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @param properties : the new configuration to push.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @throws UnacceptableConfiguration : occurs if the new configuration is<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * not consistent with the component type.<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @throws MissingHandlerException : occurs when an handler is unavailable when creating the instance.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @see org.apache.felix.ipojo.Factory#reconfigure(java.util.Dictionary)<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public synchronized void reconfigure(Dictionary properties) throws UnacceptableConfiguration, MissingHandlerException {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> if (properties == null || (properties.get("instance.name") == null && properties.get("name") == null)) { // Support both instance.name and name<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> throw new UnacceptableConfiguration("The configuration does not contains the \"instance.name\" property");<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> String name = (String) properties.get("instance.name");<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> if (name == null) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> name = (String) properties.get("name");<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> ComponentInstance instance = m_componentInstances.get(name);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> if (instance == null) { // The instance does not exists.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> return;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> instance.reconfigure(properties); // re-configure the component<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> public String getFactoryName() {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return m_componentMetadata.getAttribute("name"); // Mandatory attribute.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span>}<a name="line.180"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
