blob: 501f76c2f9764970dde9f35d74062c4ccb15e903 [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.service.provides;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Comparator;<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.HashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Iterator;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Properties;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Set;<a name="line.27"></a>
<span class="sourceLineNo">028</span><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.composite.CompositeManager;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.felix.ipojo.util.DependencyModel;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.felix.ipojo.util.DependencyStateListener;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.felix.ipojo.util.SecurityHelper;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.osgi.framework.BundleContext;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.osgi.framework.Filter;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.osgi.framework.ServiceReference;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.osgi.framework.ServiceRegistration;<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> * Export an service from the scope to the parent context.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class ServiceExporter extends DependencyModel {<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> * Destination context.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private BundleContext m_destination;<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> * Composite Manager.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> private CompositeManager m_manager;<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> * Map of service reference - service registration storing exported services.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> private Map/*&lt;ServiceReference, ServiceRegistration&gt;*/m_registrations = new HashMap();<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> * Constructor.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * <a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param specification : exported service specification.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param filter : LDAP filter<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param multiple : is the export an aggregate export?<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param optional : is the export optional?<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @param cmp : comparator to use in the dependency<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @param policy : binding policy.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param from : internal service context<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param dest : parent bundle context<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param listener : dependency lifecycle listener to notify when the dependency state change. <a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param manager : composite manager<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public ServiceExporter(Class specification, Filter filter, boolean multiple, boolean optional, Comparator cmp, int policy, ServiceContext from, BundleContext dest, DependencyStateListener listener, CompositeManager manager) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> super(specification, multiple, optional, filter, cmp, policy, from, listener, manager);<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> m_destination = dest;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> m_manager = manager;<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> /**<a name="line.83"></a>
<span class="sourceLineNo">084</span> * Transform service reference property in a dictionary.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * instance.name and factory.name are injected too.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @param ref : the service reference.<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @return the dictionary containing all property of the given service reference.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> private Dictionary getProps(ServiceReference ref) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> Properties prop = new Properties();<a name="line.90"></a>
<span class="sourceLineNo">091</span> String[] keys = ref.getPropertyKeys();<a name="line.91"></a>
<span class="sourceLineNo">092</span> for (int i = 0; i &lt; keys.length; i++) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> prop.put(keys[i], ref.getProperty(keys[i]));<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> prop.put("instance.name", m_manager.getInstanceName());<a name="line.96"></a>
<span class="sourceLineNo">097</span> prop.put("factory.name", m_manager.getFactory().getName());<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> return prop;<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> * Stop an exporter.<a name="line.103"></a>
<span class="sourceLineNo">104</span> * Remove the service listener<a name="line.104"></a>
<span class="sourceLineNo">105</span> * Unregister all exported services.<a name="line.105"></a>
<span class="sourceLineNo">106</span> */<a name="line.106"></a>
<span class="sourceLineNo">107</span> public void stop() {<a name="line.107"></a>
<span class="sourceLineNo">108</span> super.stop();<a name="line.108"></a>
<span class="sourceLineNo">109</span> Set refs = m_registrations.keySet();<a name="line.109"></a>
<span class="sourceLineNo">110</span> Iterator iterator = refs.iterator();<a name="line.110"></a>
<span class="sourceLineNo">111</span> while (iterator.hasNext()) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> ServiceReference ref = (ServiceReference) iterator.next();<a name="line.112"></a>
<span class="sourceLineNo">113</span> ServiceRegistration reg = (ServiceRegistration) m_registrations.get(ref);<a name="line.113"></a>
<span class="sourceLineNo">114</span> try {<a name="line.114"></a>
<span class="sourceLineNo">115</span> reg.unregister();<a name="line.115"></a>
<span class="sourceLineNo">116</span> } catch (IllegalStateException e) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> // The service is already unregistered<a name="line.117"></a>
<span class="sourceLineNo">118</span> // Do nothing silently<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> m_registrations.clear();<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * A service has been injected. Register it.<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @param reference : the new reference.<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#addedService(org.osgi.framework.ServiceReference)<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> public void onServiceArrival(ServiceReference reference) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> Object svc = getService(reference);<a name="line.130"></a>
<span class="sourceLineNo">131</span> // Security Check<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (SecurityHelper.hasPermissionToRegisterService(getSpecification().getName(), m_destination)) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> ServiceRegistration reg = m_destination<a name="line.133"></a>
<span class="sourceLineNo">134</span> .registerService(getSpecification().getName(), svc, getProps(reference));<a name="line.134"></a>
<span class="sourceLineNo">135</span> m_registrations.put(reference, reg);<a name="line.135"></a>
<span class="sourceLineNo">136</span> } else {<a name="line.136"></a>
<span class="sourceLineNo">137</span> throw new SecurityException("The bundle " + m_destination.getBundle().getBundleId() + " does not have the "<a name="line.137"></a>
<span class="sourceLineNo">138</span> + "permission to register the service " + getSpecification().getName());<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><a name="line.141"></a>
<span class="sourceLineNo">142</span> /**<a name="line.142"></a>
<span class="sourceLineNo">143</span> * An exported service was modified.<a name="line.143"></a>
<span class="sourceLineNo">144</span> * @param reference : modified reference<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#modifiedService(org.osgi.framework.ServiceReference, java.lang.Object)<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> public void onServiceModification(ServiceReference reference) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> ServiceRegistration reg = (ServiceRegistration) m_registrations.get(reference);<a name="line.148"></a>
<span class="sourceLineNo">149</span> if (reg != null) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> reg.setProperties(getProps(reference));<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * An exported service disappears.<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @param reference : service reference<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @see org.apache.felix.ipojo.util.TrackerCustomizer#removedService(org.osgi.framework.ServiceReference, java.lang.Object)<a name="line.157"></a>
<span class="sourceLineNo">158</span> */<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void onServiceDeparture(ServiceReference reference) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> ServiceRegistration reg = (ServiceRegistration) m_registrations.get(reference);<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (reg != null) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> reg.unregister();<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> m_registrations.remove(reference);<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<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> * On Dependency Reconfiguration notification method.<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @param departs : leaving service references.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @param arrivals : new injected service references.<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @see org.apache.felix.ipojo.util.DependencyModel#onDependencyReconfiguration(org.osgi.framework.ServiceReference[], org.osgi.framework.ServiceReference[])<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> public void onDependencyReconfiguration(ServiceReference[] departs, ServiceReference[] arrivals) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> throw new UnsupportedOperationException("Dynamic dependency reconfiguration is not supported by service exporter");<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>
</pre>
</div>
</body>
</html>