| <!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.context;<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.ConfigurationException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.felix.ipojo.ConstructorInjector;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.felix.ipojo.FieldInterceptor;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.felix.ipojo.PrimitiveHandler;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.felix.ipojo.parser.FieldMetadata;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.felix.ipojo.parser.MethodMetadata;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.felix.ipojo.util.Callback;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.util.Log;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.osgi.framework.BundleContext;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.lang.reflect.InvocationTargetException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.ArrayList;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.Dictionary;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.List;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * A handler injecting the bundle context in the implementation code.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @since 1.11.2<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>public class BundleContextHandler extends PrimitiveHandler {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private List<BundleCallback> m_methods = new ArrayList<BundleCallback>();<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private BundleContext getComponentBundleContext() {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> return getFactory().getBundleContext();<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> }<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private BundleContext getInstanceBundleContext() {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> return getInstanceManager().getInstanceContext();<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> }<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Configures the handler.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * This method collects all `context` element.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param metadata the metadata of the component<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param configuration the instance configuration<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @throws org.apache.felix.ipojo.ConfigurationException if the metadata are not correct.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> @Override<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public void configure(Element metadata, Dictionary configuration) throws ConfigurationException {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Element[] contexts = metadata.getElements("context");<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> for (Element element : contexts) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> BundleContext bc = getBundleContextForConfiguration(element);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> if (element.containsAttribute("constructor-parameter")) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> String idx = element.getAttribute("constructor-parameter");<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> int index = Integer.parseInt(idx);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> final BundleContext injected = bc;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> getLogger().log(Log.DEBUG, "Registering bundle context injection for index " + index + " for instance" +<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> " " + getInstanceManager().getInstanceName());<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> getInstanceManager().register(index, new ConstructorInjector() {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public Object getConstructorParameter(int index) {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> return injected;<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> public Class getConstructorParameterType(int index) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return BundleContext.class;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> });<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> } else if (element.containsAttribute("field")) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> String field = element.getAttribute("field");<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> final BundleContext injected = bc;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> FieldMetadata fm = getFactory().getPojoMetadata().getField(field);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> if (fm == null) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> throw new ConfigurationException("Cannot inject the bundle context in the field " + field + " - " +<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> "reason: the field does not exist in " + getInstanceManager().getClassName());<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (!BundleContext.class.getName().equals(fm.getFieldType())) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> throw new ConfigurationException("Cannot inject the bundle context in the field " + field + " - " +<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> "reason: the field " + field + " from " + getInstanceManager().getClassName() + " is not " +<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> "from the BundleContext type");<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> getInstanceManager().register(fm, new FieldInterceptor() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public void onSet(Object pojo, String fieldName, Object value) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> // Do nothing.<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> public Object onGet(Object pojo, String fieldName, Object value) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return injected;<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> } else if (element.containsAttribute("method")) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> String method = element.getAttribute("method");<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> MethodMetadata mm = getFactory().getPojoMetadata().getMethod(method,<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> new String[]{BundleContext.class.getName()});<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (mm == null) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> getLogger().log(Log.WARNING, "Cannot find the method " + method + " in the class " +<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> getInstanceManager().getClassName() + ", super classes lookup will be attempted");<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> Callback callback = new Callback(method, new Class[]{BundleContext.class}, false,<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> getInstanceManager());<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> m_methods.add(new BundleCallback(callback, bc));<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><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><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> private BundleContext getBundleContextForConfiguration(Element element) throws ConfigurationException {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> String type = element.getAttribute("value");<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> if (type == null) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> // XML case.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> type = element.getAttribute("context");<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> BundleContext context;<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> if ("INSTANCE".equalsIgnoreCase(type)) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> context = getInstanceBundleContext();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> } else if (type == null || "COMPONENT".equalsIgnoreCase(type)) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> context = getComponentBundleContext();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> } else {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> throw new ConfigurationException("Not supported bundle context source : " + type);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return context;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Stops the handler<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * This method stops the management.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> @Override<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> public void stop() {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> // Nothing to do.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<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> * Starts the handler<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * This method starts the management.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> @Override<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public void start() {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> // Nothing to do.<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> * Callback method called when an instance of the component is created, but<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * before someone can use it.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * Injects the bundle context in all declared bundle callbacks.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> *<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param instance the created instance<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> @Override<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> public void onCreation(Object instance) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> for (BundleCallback callback : m_methods) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> try {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> callback.invoke(instance);<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> } catch (Throwable e) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> error("Cannot inject the bundle context in the method " + callback.callback.getMethod() + " - reason:" +<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> " " + e.getMessage(), e);<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> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> private class BundleCallback {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> private final Callback callback;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> private final BundleContext context;<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> public BundleCallback(Callback callback, BundleContext injected) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> this.callback = callback;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> this.context = injected;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> public void invoke(Object target) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> if (context != null) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> callback.call(target, new Object[]{context});<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |