blob: 1103f151e3e645957bfe6ff103541af3a2fd3c36 [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.dependency.impl;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.felix.ipojo.Factory;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.dependency.interceptors.ServiceTrackingInterceptor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.util.DependencyModel;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.util.Log;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.osgi.framework.*;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.ArrayList;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Dictionary;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Hashtable;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.List;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Builds the properties used to checks if an interceptor matches a specific dependency.<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class DependencyProperties {<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> //TODO Externalize and use constants<a name="line.38"></a>
<span class="sourceLineNo">039</span> // TODO Cache dependency properties.<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> public static Dictionary&lt;String, ?&gt; getDependencyProperties(DependencyModel dependency) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> Dictionary&lt;String, Object&gt; properties = new Hashtable&lt;String, Object&gt;();<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> // Instance, and Factory and Bundle (name, symbolic name, version)<a name="line.44"></a>
<span class="sourceLineNo">045</span> properties.put(Factory.INSTANCE_NAME_PROPERTY, dependency.getComponentInstance().getInstanceName());<a name="line.45"></a>
<span class="sourceLineNo">046</span> properties.put("instance.state", dependency.getComponentInstance().getState());<a name="line.46"></a>
<span class="sourceLineNo">047</span> properties.put("factory.name", dependency.getComponentInstance().getFactory().getFactoryName());<a name="line.47"></a>
<span class="sourceLineNo">048</span> final Bundle bundle = dependency.getBundleContext().getBundle();<a name="line.48"></a>
<span class="sourceLineNo">049</span> properties.put("bundle.symbolicName", bundle.getSymbolicName());<a name="line.49"></a>
<span class="sourceLineNo">050</span> if (bundle.getVersion() != null) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> properties.put("bundle.version", bundle.getVersion().toString());<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> // Dependency specification, and id<a name="line.54"></a>
<span class="sourceLineNo">055</span> final Class specification = dependency.getSpecification();<a name="line.55"></a>
<span class="sourceLineNo">056</span> properties.put("dependency.specification", specification.getName());<a name="line.56"></a>
<span class="sourceLineNo">057</span> properties.put("dependency.id", dependency.getId());<a name="line.57"></a>
<span class="sourceLineNo">058</span> properties.put("dependency.state", dependency.getState());<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> // We also provide the objectclass property, and to be compliant with the osgi specification,<a name="line.60"></a>
<span class="sourceLineNo">061</span> // all interfaces are collected to this array.<a name="line.61"></a>
<span class="sourceLineNo">062</span> List&lt;String&gt; classes = new ArrayList&lt;String&gt;();<a name="line.62"></a>
<span class="sourceLineNo">063</span> classes.add(specification.getName());<a name="line.63"></a>
<span class="sourceLineNo">064</span> for (Class clazz : specification.getInterfaces()) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> classes.add(clazz.getName());<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> properties.put(Constants.OBJECTCLASS, classes.toArray(new String[classes.size()]));<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> return properties;<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Checks that the 'target' property of the service reference matches the dependency.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param reference the reference<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param dependency the dependency<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param context a bundle context used to build the filter<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @return {@literal true} if the target's property of reference matches the dependency.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> public static boolean match(ServiceReference reference, DependencyModel dependency, BundleContext context) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> Object v = reference.getProperty(ServiceTrackingInterceptor.TARGET_PROPERTY);<a name="line.81"></a>
<span class="sourceLineNo">082</span> Filter filter = null;<a name="line.82"></a>
<span class="sourceLineNo">083</span> if (v == null) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return false; // Invalid interceptor<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (v instanceof Filter) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> filter = (Filter) v;<a name="line.87"></a>
<span class="sourceLineNo">088</span> } else if (v instanceof String) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> try {<a name="line.89"></a>
<span class="sourceLineNo">090</span> filter = context.createFilter((String) v);<a name="line.90"></a>
<span class="sourceLineNo">091</span> } catch (InvalidSyntaxException e) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> dependency.getComponentInstance().getFactory().getLogger().log(Log.ERROR,<a name="line.92"></a>
<span class="sourceLineNo">093</span> "Cannot build filter from the target property : " + v, e);<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><a name="line.96"></a>
<span class="sourceLineNo">097</span> if (filter == null) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return false; // Invalid interceptor.<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> Dictionary&lt;String, ?&gt; properties = getDependencyProperties(dependency);<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> return filter.match(properties);<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> public static boolean match(ServiceReference reference, DependencyModel dependency) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return match(reference, dependency, dependency.getBundleContext());<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span>}<a name="line.109"></a>
</pre>
</div>
</body>
</html>