blob: 08120dd2706bb5b6c145c30ae7fa5f8734415262 [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><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.felix.ipojo.handlers.providedservice.strategy;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.reflect.Proxy;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Properties;<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.IPOJOServiceFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.InstanceManager;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.felix.ipojo.handlers.providedservice.CreationStrategy;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.osgi.framework.Bundle;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.osgi.framework.BundleContext;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.osgi.framework.ServiceRegistration;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * This {@link CreationStrategy} is here to ease customization of the strategy<a name="line.33"></a>
<span class="sourceLineNo">034</span> * by hiding all the reflection stuff.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public abstract class ConfigurableCreationStrategy extends CreationStrategy {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * The instance manager passed to the iPOJO ServiceFactory to manage<a name="line.40"></a>
<span class="sourceLineNo">041</span> * instances.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> private InstanceManager m_manager;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * The lists of interfaces provided by this service.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private String[] m_specs;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * The iPOJO ServiceFactory.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> private IPOJOServiceFactory m_factory;<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> * Method called when the underlying iPOJO Service factory<a name="line.56"></a>
<span class="sourceLineNo">057</span> * is published.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param manager the instance manager<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param specifications the provided specifications<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @param props the service properties<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @see org.apache.felix.ipojo.handlers.providedservice.CreationStrategy#onPublication(org.apache.felix.ipojo.InstanceManager, java.lang.String[], java.util.Properties)<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public void onPublication(final InstanceManager manager,<a name="line.63"></a>
<span class="sourceLineNo">064</span> final String[] specifications, final Properties props) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> // Store specifications (aka interfaces)<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.m_specs = specifications;<a name="line.66"></a>
<span class="sourceLineNo">067</span> this.m_manager = manager;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Method called when the underlying iPOJO Service factory is<a name="line.71"></a>
<span class="sourceLineNo">072</span> * un-published.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @see org.apache.felix.ipojo.handlers.providedservice.CreationStrategy#onUnpublication()<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> public void onUnpublication() {<a name="line.75"></a>
<span class="sourceLineNo">076</span> // Try to close the factory<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (m_factory instanceof ServiceObjectFactory) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> ((ServiceObjectFactory) m_factory).close();<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<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> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Method called when a bundle want to access a service. This method is called once per<a name="line.83"></a>
<span class="sourceLineNo">084</span> * asking bundle. To turn around this limitation, a proxy is registered.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @param bundle the asking bundle<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @param registration the service registration<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @return the service object<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @see org.osgi.framework.ServiceFactory#getService(org.osgi.framework.Bundle, org.osgi.framework.ServiceRegistration)<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> public Object getService(final Bundle bundle,<a name="line.90"></a>
<span class="sourceLineNo">091</span> final ServiceRegistration registration) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> // Init the factory if needed<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (m_factory == null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> m_factory = getServiceFactory(m_manager);<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> // Return a proxy wrapping the real iPOJO ServiceFactory<a name="line.96"></a>
<span class="sourceLineNo">097</span> return Proxy.newProxyInstance(m_manager.getClazz().getClassLoader(),<a name="line.97"></a>
<span class="sourceLineNo">098</span> getModifiedSpecifications(m_manager.getContext()),<a name="line.98"></a>
<span class="sourceLineNo">099</span> new ErrorPrintingServiceFactoryProxy(m_factory));<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> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Method called when a bundle release a service.<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @param bundle the bundle<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param registration the service registration<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param service the service object<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @see org.osgi.framework.ServiceFactory#ungetService(org.osgi.framework.Bundle, org.osgi.framework.ServiceRegistration, java.lang.Object)<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public void ungetService(final Bundle bundle,<a name="line.109"></a>
<span class="sourceLineNo">110</span> final ServiceRegistration registration, final Object service) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> // Nothing to do<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<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> * Utility method that transform the specifications names into a Class<a name="line.115"></a>
<span class="sourceLineNo">116</span> * array, appending the IPOJOServiceFactory interface to it.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @param context used for class loading<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return a array of Class<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> private Class[] getModifiedSpecifications(final BundleContext context) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> Class[] classes = new Class[m_specs.length + 1];<a name="line.121"></a>
<span class="sourceLineNo">122</span> int i = 0;<a name="line.122"></a>
<span class="sourceLineNo">123</span> for (i = 0; i &lt; m_specs.length; i++) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> try {<a name="line.124"></a>
<span class="sourceLineNo">125</span> classes[i] = context.getBundle().loadClass(m_specs[i]);<a name="line.125"></a>
<span class="sourceLineNo">126</span> } catch (ClassNotFoundException e) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> // Should not happen.<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> classes[i] = IPOJOServiceFactory.class;<a name="line.130"></a>
<span class="sourceLineNo">131</span> return classes;<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> * User provided {@link CreationStrategy} MUST implement this method to<a name="line.135"></a>
<span class="sourceLineNo">136</span> * provide the real iPOJO ServiceFactory instance.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @param manager {@link InstanceManager} that the factory could use<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @return an instance of {@link IPOJOServiceFactory}<a name="line.138"></a>
<span class="sourceLineNo">139</span> */<a name="line.139"></a>
<span class="sourceLineNo">140</span> protected abstract IPOJOServiceFactory getServiceFactory(<a name="line.140"></a>
<span class="sourceLineNo">141</span> final InstanceManager manager);<a name="line.141"></a>
<span class="sourceLineNo">142</span>}<a name="line.142"></a>
</pre>
</div>
</body>
</html>