blob: fc042694b6f29e276a0e6ccda2ea2ee6ff2b6a6c [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;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Dictionary;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<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.ComponentInstance;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.ConfigurationException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.Factory;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.felix.ipojo.FactoryStateListener;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.felix.ipojo.MissingHandlerException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.felix.ipojo.ServiceContext;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.felix.ipojo.UnacceptableConfiguration;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.felix.ipojo.architecture.ComponentTypeDescription;<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.osgi.framework.BundleContext;<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> * Bridge representing a Factory inside a composition.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>public class FactoryProxy implements Factory {<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> * Delegated factory.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> private Factory m_delegate;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Destination context.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> private ServiceContext m_context;<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> * Constructor.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @param fact : the targeted factory.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param svcContext : the service context to target.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> public FactoryProxy(Factory fact, ServiceContext svcContext) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> m_delegate = fact;<a name="line.57"></a>
<span class="sourceLineNo">058</span> m_context = svcContext;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Create an instance manager (i.e. component type instance).<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param configuration : the configuration properties for this component.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @return the created instance manager.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @throws UnacceptableConfiguration : when a given configuration is not valid.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @throws MissingHandlerException : occurs when the creation failed due to a missing handler (the factory should be invalid)<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @throws ConfigurationException : occurs when the creation failed due to a configuration issue<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @see org.apache.felix.ipojo.Factory#createComponentInstance(java.util.Dictionary)<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public ComponentInstance createComponentInstance(Dictionary configuration) throws UnacceptableConfiguration, MissingHandlerException,<a name="line.70"></a>
<span class="sourceLineNo">071</span> ConfigurationException {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return m_delegate.createComponentInstance(configuration, m_context);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Create an instance manager (i.e. component type instance). This has these service interaction in the scope given in argument.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param configuration : the configuration properties for this component.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param serviceContext : the service context of the component.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @return the created instance manager.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @throws UnacceptableConfiguration : when the given configuration is not valid.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @throws MissingHandlerException : when at least one handler is missing.<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @throws ConfigurationException : when an issue occurs during the oconfiguration of the instance.<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @see org.apache.felix.ipojo.Factory#createComponentInstance(java.util.Dictionary, org.apache.felix.ipojo.ServiceContext)<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> public ComponentInstance createComponentInstance(Dictionary configuration, ServiceContext serviceContext) throws UnacceptableConfiguration,<a name="line.85"></a>
<span class="sourceLineNo">086</span> MissingHandlerException, ConfigurationException {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return m_delegate.createComponentInstance(configuration, serviceContext);<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * Get the component type information containing provided service, configuration properties ...<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @return the component type information.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @see org.apache.felix.ipojo.Factory#getDescription()<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> public Element getDescription() {<a name="line.95"></a>
<span class="sourceLineNo">096</span> return m_delegate.getDescription();<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> /**<a name="line.99"></a>
<span class="sourceLineNo">100</span> * Return the factory name.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @return the name of the factory.<a name="line.101"></a>
<span class="sourceLineNo">102</span> * @see org.apache.felix.ipojo.Factory#getName()<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> public String getName() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return m_delegate.getName();<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Check if the given configuration is acceptable as a configuration of a component instance.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @param conf : the configuration to test<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @return true if the configuration is acceptable<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @see org.apache.felix.ipojo.Factory#isAcceptable(java.util.Dictionary)<a name="line.112"></a>
<span class="sourceLineNo">113</span> */<a name="line.113"></a>
<span class="sourceLineNo">114</span> public boolean isAcceptable(Dictionary conf) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> return m_delegate.isAcceptable(conf);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
<span class="sourceLineNo">119</span> * Reconfigure an instance already created. This configuration need to have the name property to identify the instance.<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @param conf : the configuration to reconfigure the instance.<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @throws UnacceptableConfiguration : if the given configuration is not consistent for the targeted instance.<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @throws MissingHandlerException : when at least one handler is missing<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @see org.apache.felix.ipojo.Factory#reconfigure(java.util.Dictionary)<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> public void reconfigure(Dictionary conf) throws UnacceptableConfiguration, MissingHandlerException {<a name="line.125"></a>
<span class="sourceLineNo">126</span> m_delegate.reconfigure(conf);<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> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Add a factory listener.<a name="line.130"></a>
<span class="sourceLineNo">131</span> * @param listener : the listener to add.<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @see org.apache.felix.ipojo.Factory#addFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> public void addFactoryStateListener(FactoryStateListener listener) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> m_delegate.addFactoryStateListener(listener);<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> public List getMissingHandlers() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return m_delegate.getMissingHandlers();<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> public List getRequiredHandlers() {<a name="line.143"></a>
<span class="sourceLineNo">144</span> return m_delegate.getRequiredHandlers();<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
<span class="sourceLineNo">148</span> * Remove a service listener.<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @param listener : the listener to remove<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @see org.apache.felix.ipojo.Factory#removeFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> public void removeFactoryStateListener(FactoryStateListener listener) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> m_delegate.removeFactoryStateListener(listener);<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> public ComponentTypeDescription getComponentDescription() {<a name="line.157"></a>
<span class="sourceLineNo">158</span> return m_delegate.getComponentDescription();<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> public String getClassName() {<a name="line.161"></a>
<span class="sourceLineNo">162</span> return m_delegate.getClassName();<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> public int getState() {<a name="line.165"></a>
<span class="sourceLineNo">166</span> return m_delegate.getState();<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> public BundleContext getBundleContext() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return m_delegate.getBundleContext();<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> public String getVersion() {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return m_delegate.getVersion();<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> public Element getComponentMetadata() {<a name="line.177"></a>
<span class="sourceLineNo">178</span> return m_delegate.getComponentMetadata();<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>
<span class="sourceLineNo">181</span> public List&lt;ComponentInstance&gt; getInstances() {<a name="line.181"></a>
<span class="sourceLineNo">182</span> return m_delegate.getInstances();<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> public List&lt;String&gt; getInstancesNames() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return m_delegate.getInstancesNames();<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<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>
</pre>
</div>
</body>
</html>