| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/* <a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.felix.ipojo;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.felix.ipojo.architecture.ComponentTypeDescription;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.osgi.framework.BundleContext;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Dictionary;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Component Type Factory Service. This service is exposed by a instance manager factory, and allows the dynamic creation of component instance.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public interface Factory {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> /**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Factory State.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * A valid factory is a factory where all required handlers are available.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> int VALID = 1;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> /**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Factory State.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * An invalid factory is a factory where at least one required handler is<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * unavailable. Creating an instance with an invalid factory failed.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> int INVALID = 0;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Instance configuration can set the instance name using this property.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> String INSTANCE_NAME_PROPERTY = "instance.name";<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Instance configuration can set the factory version they target using this property.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> String FACTORY_VERSION_PROPERTY = "factory.version";<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Creates an instance manager (i.e. component type instance).<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param configuration the configuration properties for this component.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @return the created instance manager.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @throws UnacceptableConfiguration if the given configuration is not valid.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @throws MissingHandlerException if an handler is missing.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @throws ConfigurationException if the instance configuration failed.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> ComponentInstance createComponentInstance(Dictionary configuration) throws UnacceptableConfiguration, MissingHandlerException, ConfigurationException;<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> * Creates an instance manager (i.e. component type instance).<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * The instance is created in the scope given in argument.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param configuration the configuration properties for this component.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param serviceContext the service context of the component.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @return the created instance manager.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @throws UnacceptableConfiguration if the given configuration is not valid.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @throws MissingHandlerException if an handler is missing.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @throws ConfigurationException if the instance configuration failed.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> ComponentInstance createComponentInstance(Dictionary configuration, ServiceContext serviceContext) throws UnacceptableConfiguration, MissingHandlerException, ConfigurationException;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /**<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * Gets the component type information containing provided service,<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * configuration properties ...<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> *<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @return the component type information.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> Element getDescription();<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> * Gets the component type description.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return the component type description object<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> ComponentTypeDescription getComponentDescription();<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> * Checks if the given configuration is acceptable as a configuration<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * of a component instance.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> *<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param conf the configuration to test<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @return <code>true</code> if the configuration is acceptable<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> boolean isAcceptable(Dictionary conf);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Returns the factory name.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> *<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @return the name of the factory.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> */<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> String getName();<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Reconfigures an instance already created. This configuration needs to<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * have the name property to identify the instance.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param conf the configuration to reconfigure the instance. The instance.name property must be set to identify<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * the instance to reconfigure.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @throws UnacceptableConfiguration if the given configuration is not consistent for the targeted instance.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @throws MissingHandlerException if an handler is missing.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> void reconfigure(Dictionary conf) throws UnacceptableConfiguration, MissingHandlerException;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> /**<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Adds a factory state listener on the current factory.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> *<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param listener the listener to add<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> void addFactoryStateListener(FactoryStateListener listener);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * Removes the given factory state listener from the listener list.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> *<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param listener the listener to remove<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> void removeFactoryStateListener(FactoryStateListener listener);<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> * Gets the list of missing handlers.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * The handlers are given under the form namespace:name<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> *<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @return the list containing the name of missing handlers<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> List getMissingHandlers();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Get the list of required handlers.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * The handlers are given under the form namespace:name<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> *<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @return the list containing the name of required handlers<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> */<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> List getRequiredHandlers();<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> /**<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * Returns the class name of the component type.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * For factories which does not contains a class, return "composite"<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @return the class name of the component type or "composite"<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @deprecated<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> String getClassName();<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> /**<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * Returns the state of the factory.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> *<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @return the state of the factory<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> int getState();<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> * Gets the bundle context of the factory.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> *<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return the bundle context of the factory.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> BundleContext getBundleContext();<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Gets the version of the component type.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> *<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @return the component type version or <code>null</code> if<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * not specified.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> String getVersion();<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> /**<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * Gets the component type metadata (Element - Attribute structure)<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> *<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @return the root element of the component metadata. The result must <b>not</b> be modified.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> Element getComponentMetadata();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> /**<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * Gets the list of instances created by the factory. The instances must be still alive.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> *<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return the list of created (and living) instances<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @since 1.11.0<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> List<ComponentInstance> getInstances();<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> * Gets the list of the names of the instances created by the factory. The instances must be still alive.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> *<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @return the list of the names of created (and living) instances<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @since 1.11.0<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> */<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> List<String> getInstancesNames();<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span>}<a name="line.205"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
